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 */
426 # define EAPI_MAIN EAPI
429 /* allow usage from c++ */
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
437 typedef struct _Elm_Version
445 EAPI extern Elm_Version *elm_version;
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
452 * @defgroup General General
454 * @brief General Elementary API. Functions that don't relate to
455 * Elementary objects specifically.
457 * Here are documented functions which init/shutdown the library,
458 * that apply to generic Elementary objects, that deal with
459 * configuration, et cetera.
461 * @ref general_functions_example_page "This" example contemplates
462 * some of these functions.
466 * @addtogroup General
471 * Defines couple of standard Evas_Object layers to be used
472 * with evas_object_layer_set().
474 * @note whenever extending with new values, try to keep some padding
475 * to siblings so there is room for further extensions.
477 typedef enum _Elm_Object_Layer
479 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
487 /**************************************************************************/
488 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
491 * Emitted when any Elementary's policy value is changed.
493 EAPI extern int ELM_EVENT_POLICY_CHANGED;
496 * @typedef Elm_Event_Policy_Changed
498 * Data on the event when an Elementary policy has changed
500 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
503 * @struct _Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 struct _Elm_Event_Policy_Changed
509 unsigned int policy; /**< the policy identifier */
510 int new_value; /**< value the policy had before the change */
511 int old_value; /**< new value the policy got */
515 * Policy identifiers.
517 typedef enum _Elm_Policy
519 ELM_POLICY_QUIT, /**< under which circumstances the application
520 * should quit automatically. @see
524 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
527 typedef enum _Elm_Policy_Quit
529 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533 * window is closed */
534 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536 typedef enum _Elm_Focus_Direction
540 } Elm_Focus_Direction;
542 typedef enum _Elm_Text_Format
544 ELM_TEXT_FORMAT_PLAIN_UTF8,
545 ELM_TEXT_FORMAT_MARKUP_UTF8
549 * Line wrapping types.
551 typedef enum _Elm_Wrap_Type
553 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
562 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
563 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
564 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
565 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
566 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
567 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
568 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
569 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
570 ELM_INPUT_PANEL_LAYOUT_INVALID
571 } Elm_Input_Panel_Layout;
574 * @typedef Elm_Object_Item
575 * An Elementary Object item handle.
578 typedef struct _Elm_Object_Item Elm_Object_Item;
582 * Called back when a widget's tooltip is activated and needs content.
583 * @param data user-data given to elm_object_tooltip_content_cb_set()
584 * @param obj owner widget.
585 * @param tooltip The tooltip object (affix content to this!)
587 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
590 * Called back when a widget's item tooltip is activated and needs content.
591 * @param data user-data given to elm_object_tooltip_content_cb_set()
592 * @param obj owner widget.
593 * @param tooltip The tooltip object (affix content to this!)
594 * @param item context dependent item. As an example, if tooltip was
595 * set on Elm_List_Item, then it is of this type.
597 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
599 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. */
601 #ifndef ELM_LIB_QUICKLAUNCH
602 #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 */
604 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
607 /**************************************************************************/
611 * Initialize Elementary
613 * @param[in] argc System's argument count value
614 * @param[in] argv System's pointer to array of argument strings
615 * @return The init counter value.
617 * This function initializes Elementary and increments a counter of
618 * the number of calls to it. It returns the new counter's value.
620 * @warning This call is exported only for use by the @c ELM_MAIN()
621 * macro. There is no need to use this if you use this macro (which
622 * is highly advisable). An elm_main() should contain the entry
623 * point code for your application, having the same prototype as
624 * elm_init(), and @b not being static (putting the @c EAPI symbol
625 * in front of its type declaration is advisable). The @c
626 * ELM_MAIN() call should be placed just after it.
629 * @dontinclude bg_example_01.c
633 * See the full @ref bg_example_01_c "example".
635 * @see elm_shutdown().
638 EAPI int elm_init(int argc, char **argv);
641 * Shut down Elementary
643 * @return The init counter value.
645 * This should be called at the end of your application, just
646 * before it ceases to do any more processing. This will clean up
647 * any permanent resources your application may have allocated via
648 * Elementary that would otherwise persist.
650 * @see elm_init() for an example
654 EAPI int elm_shutdown(void);
657 * Run Elementary's main loop
659 * This call should be issued just after all initialization is
660 * completed. This function will not return until elm_exit() is
661 * called. It will keep looping, running the main
662 * (event/processing) loop for Elementary.
664 * @see elm_init() for an example
668 EAPI void elm_run(void);
671 * Exit Elementary's main loop
673 * If this call is issued, it will flag the main loop to cease
674 * processing and return back to its parent function (usually your
675 * elm_main() function).
677 * @see elm_init() for an example. There, just after a request to
678 * close the window comes, the main loop will be left.
680 * @note By using the #ELM_POLICY_QUIT on your Elementary
681 * applications, you'll this function called automatically for you.
685 EAPI void elm_exit(void);
688 * Provide information in order to make Elementary determine the @b
689 * run time location of the software in question, so other data files
690 * such as images, sound files, executable utilities, libraries,
691 * modules and locale files can be found.
693 * @param mainfunc This is your application's main function name,
694 * whose binary's location is to be found. Providing @c NULL
695 * will make Elementary not to use it
696 * @param dom This will be used as the application's "domain", in the
697 * form of a prefix to any environment variables that may
698 * override prefix detection and the directory name, inside the
699 * standard share or data directories, where the software's
700 * data files will be looked for.
701 * @param checkfile This is an (optional) magic file's path to check
702 * for existence (and it must be located in the data directory,
703 * under the share directory provided above). Its presence will
704 * help determine the prefix found was correct. Pass @c NULL if
705 * the check is not to be done.
707 * This function allows one to re-locate the application somewhere
708 * else after compilation, if the developer wishes for easier
709 * distribution of pre-compiled binaries.
711 * The prefix system is designed to locate where the given software is
712 * installed (under a common path prefix) at run time and then report
713 * specific locations of this prefix and common directories inside
714 * this prefix like the binary, library, data and locale directories,
715 * through the @c elm_app_*_get() family of functions.
717 * Call elm_app_info_set() early on before you change working
718 * directory or anything about @c argv[0], so it gets accurate
721 * It will then try and trace back which file @p mainfunc comes from,
722 * if provided, to determine the application's prefix directory.
724 * The @p dom parameter provides a string prefix to prepend before
725 * environment variables, allowing a fallback to @b specific
726 * environment variables to locate the software. You would most
727 * probably provide a lowercase string there, because it will also
728 * serve as directory domain, explained next. For environment
729 * variables purposes, this string is made uppercase. For example if
730 * @c "myapp" is provided as the prefix, then the program would expect
731 * @c "MYAPP_PREFIX" as a master environment variable to specify the
732 * exact install prefix for the software, or more specific environment
733 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
734 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
735 * the user or scripts before launching. If not provided (@c NULL),
736 * environment variables will not be used to override compiled-in
737 * defaults or auto detections.
739 * The @p dom string also provides a subdirectory inside the system
740 * shared data directory for data files. For example, if the system
741 * directory is @c /usr/local/share, then this directory name is
742 * appended, creating @c /usr/local/share/myapp, if it @p was @c
743 * "myapp". It is expected the application installs data files in
746 * The @p checkfile is a file name or path of something inside the
747 * share or data directory to be used to test that the prefix
748 * detection worked. For example, your app will install a wallpaper
749 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
750 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
753 * @see elm_app_compile_bin_dir_set()
754 * @see elm_app_compile_lib_dir_set()
755 * @see elm_app_compile_data_dir_set()
756 * @see elm_app_compile_locale_set()
757 * @see elm_app_prefix_dir_get()
758 * @see elm_app_bin_dir_get()
759 * @see elm_app_lib_dir_get()
760 * @see elm_app_data_dir_get()
761 * @see elm_app_locale_dir_get()
763 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
766 * Provide information on the @b fallback application's binaries
767 * directory, on scenarios where they get overriden by
768 * elm_app_info_set().
770 * @param dir The path to the default binaries directory (compile time
773 * @note Elementary will as well use this path to determine actual
774 * names of binaries' directory paths, maybe changing it to be @c
775 * something/local/bin instead of @c something/bin, only, for
778 * @warning You should call this function @b before
779 * elm_app_info_set().
781 EAPI void elm_app_compile_bin_dir_set(const char *dir);
784 * Provide information on the @b fallback application's libraries
785 * directory, on scenarios where they get overriden by
786 * elm_app_info_set().
788 * @param dir The path to the default libraries directory (compile
791 * @note Elementary will as well use this path to determine actual
792 * names of libraries' directory paths, maybe changing it to be @c
793 * something/lib32 or @c something/lib64 instead of @c something/lib,
796 * @warning You should call this function @b before
797 * elm_app_info_set().
799 EAPI void elm_app_compile_lib_dir_set(const char *dir);
802 * Provide information on the @b fallback application's data
803 * directory, on scenarios where they get overriden by
804 * elm_app_info_set().
806 * @param dir The path to the default data directory (compile time
809 * @note Elementary will as well use this path to determine actual
810 * names of data directory paths, maybe changing it to be @c
811 * something/local/share instead of @c something/share, only, for
814 * @warning You should call this function @b before
815 * elm_app_info_set().
817 EAPI void elm_app_compile_data_dir_set(const char *dir);
820 * Provide information on the @b fallback application's locale
821 * directory, on scenarios where they get overriden by
822 * elm_app_info_set().
824 * @param dir The path to the default locale directory (compile time
827 * @warning You should call this function @b before
828 * elm_app_info_set().
830 EAPI void elm_app_compile_locale_set(const char *dir);
833 * Retrieve the application's run time prefix directory, as set by
834 * elm_app_info_set() and the way (environment) the application was
837 * @return The directory prefix the application is actually using
839 EAPI const char *elm_app_prefix_dir_get(void);
842 * Retrieve the application's run time binaries prefix directory, as
843 * set by elm_app_info_set() and the way (environment) the application
846 * @return The binaries directory prefix the application is actually
849 EAPI const char *elm_app_bin_dir_get(void);
852 * Retrieve the application's run time libraries prefix directory, as
853 * set by elm_app_info_set() and the way (environment) the application
856 * @return The libraries directory prefix the application is actually
859 EAPI const char *elm_app_lib_dir_get(void);
862 * Retrieve the application's run time data prefix directory, as
863 * set by elm_app_info_set() and the way (environment) the application
866 * @return The data directory prefix the application is actually
869 EAPI const char *elm_app_data_dir_get(void);
872 * Retrieve the application's run time locale prefix directory, as
873 * set by elm_app_info_set() and the way (environment) the application
876 * @return The locale directory prefix the application is actually
879 EAPI const char *elm_app_locale_dir_get(void);
881 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
882 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
883 EAPI int elm_quicklaunch_init(int argc, char **argv);
884 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_shutdown(void);
886 EAPI int elm_quicklaunch_shutdown(void);
887 EAPI void elm_quicklaunch_seed(void);
888 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
889 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
890 EAPI void elm_quicklaunch_cleanup(void);
891 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
892 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
894 EAPI Eina_Bool elm_need_efreet(void);
895 EAPI Eina_Bool elm_need_e_dbus(void);
898 * This must be called before any other function that handle with
899 * elm_thumb objects or ethumb_client instances.
903 EAPI Eina_Bool elm_need_ethumb(void);
906 * Set a new policy's value (for a given policy group/identifier).
908 * @param policy policy identifier, as in @ref Elm_Policy.
909 * @param value policy value, which depends on the identifier
911 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
913 * Elementary policies define applications' behavior,
914 * somehow. These behaviors are divided in policy groups (see
915 * #Elm_Policy enumeration). This call will emit the Ecore event
916 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
917 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
920 * @note Currently, we have only one policy identifier/group
921 * (#ELM_POLICY_QUIT), which has two possible values.
925 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
928 * Gets the policy value set for given policy identifier.
930 * @param policy policy identifier, as in #Elm_Policy.
931 * @return The currently set policy value, for that
932 * identifier. Will be @c 0 if @p policy passed is invalid.
936 EAPI int elm_policy_get(unsigned int policy);
939 * Set a label of an object
941 * @param obj The Elementary object
942 * @param part The text part name to set (NULL for the default label)
943 * @param label The new text of the label
945 * @note Elementary objects may have many labels (e.g. Action Slider)
949 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
951 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
954 * Get a label of an object
956 * @param obj The Elementary object
957 * @param part The text part name to get (NULL for the default label)
958 * @return text of the label or NULL for any error
960 * @note Elementary objects may have many labels (e.g. Action Slider)
964 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
966 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
969 * Set a content of an object
971 * @param obj The Elementary object
972 * @param part The content part name to set (NULL for the default content)
973 * @param content The new content of the object
975 * @note Elementary objects may have many contents
979 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
981 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
984 * Get a content of an object
986 * @param obj The Elementary object
987 * @param item The content part name to get (NULL for the default content)
988 * @return content of the object or NULL for any error
990 * @note Elementary objects may have many contents
994 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
996 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
999 * Unset a content of an object
1001 * @param obj The Elementary object
1002 * @param item The content part name to unset (NULL for the default content)
1004 * @note Elementary objects may have many contents
1008 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1010 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1013 * Set a content of an object item
1015 * @param it The Elementary object item
1016 * @param part The content part name to set (NULL for the default content)
1017 * @param content The new content of the object item
1019 * @note Elementary object items may have many contents
1023 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1025 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1028 * Get a content of an object item
1030 * @param it The Elementary object item
1031 * @param part The content part name to unset (NULL for the default content)
1032 * @return content of the object item or NULL for any error
1034 * @note Elementary object items may have many contents
1038 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1040 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1043 * Unset a content of an object item
1045 * @param it The Elementary object item
1046 * @param part The content part name to unset (NULL for the default content)
1048 * @note Elementary object items may have many contents
1052 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1054 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1057 * Set a label of an objec itemt
1059 * @param it The Elementary object item
1060 * @param part The text part name to set (NULL for the default label)
1061 * @param label The new text of the label
1063 * @note Elementary object items may have many labels
1067 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1069 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1072 * Get a label of an object
1074 * @param it The Elementary object item
1075 * @param part The text part name to get (NULL for the default label)
1076 * @return text of the label or NULL for any error
1078 * @note Elementary object items may have many labels
1082 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1085 * Set the text to read out when in accessibility mode
1087 * @param obj The object which is to be described
1088 * @param txt The text that describes the widget to people with poor or no vision
1092 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1095 * Set the text to read out when in accessibility mode
1097 * @param it The object item which is to be described
1098 * @param txt The text that describes the widget to people with poor or no vision
1102 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1105 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1108 * Get the data associated with an object item
1109 * @param it The object item
1110 * @return The data associated with @p it
1114 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1117 * Set the data associated with an object item
1118 * @param it The object item
1119 * @param data The data to be associated with @p it
1123 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1126 * Send a signal to the edje object of the widget item.
1128 * This function sends a signal to the edje object of the obj item. An
1129 * edje program can respond to a signal by specifying matching
1130 * 'signal' and 'source' fields.
1132 * @param it The Elementary object item
1133 * @param emission The signal's name.
1134 * @param source The signal's source.
1137 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1144 * @defgroup Caches Caches
1146 * These are functions which let one fine-tune some cache values for
1147 * Elementary applications, thus allowing for performance adjustments.
1153 * @brief Flush all caches.
1155 * Frees all data that was in cache and is not currently being used to reduce
1156 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1157 * to calling all of the following functions:
1158 * @li edje_file_cache_flush()
1159 * @li edje_collection_cache_flush()
1160 * @li eet_clearcache()
1161 * @li evas_image_cache_flush()
1162 * @li evas_font_cache_flush()
1163 * @li evas_render_dump()
1164 * @note Evas caches are flushed for every canvas associated with a window.
1168 EAPI void elm_all_flush(void);
1171 * Get the configured cache flush interval time
1173 * This gets the globally configured cache flush interval time, in
1176 * @return The cache flush interval time
1179 * @see elm_all_flush()
1181 EAPI int elm_cache_flush_interval_get(void);
1184 * Set the configured cache flush interval time
1186 * This sets the globally configured cache flush interval time, in ticks
1188 * @param size The cache flush interval time
1191 * @see elm_all_flush()
1193 EAPI void elm_cache_flush_interval_set(int size);
1196 * Set the configured cache flush interval time for all applications on the
1199 * This sets the globally configured cache flush interval time -- in ticks
1200 * -- for all applications on the display.
1202 * @param size The cache flush interval time
1205 EAPI void elm_cache_flush_interval_all_set(int size);
1208 * Get the configured cache flush enabled state
1210 * This gets the globally configured cache flush state - if it is enabled
1211 * or not. When cache flushing is enabled, elementary will regularly
1212 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1213 * memory and allow usage to re-seed caches and data in memory where it
1214 * can do so. An idle application will thus minimise its memory usage as
1215 * data will be freed from memory and not be re-loaded as it is idle and
1216 * not rendering or doing anything graphically right now.
1218 * @return The cache flush state
1221 * @see elm_all_flush()
1223 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1226 * Set the configured cache flush enabled state
1228 * This sets the globally configured cache flush enabled state
1230 * @param size The cache flush enabled state
1233 * @see elm_all_flush()
1235 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1238 * Set the configured cache flush enabled state for all applications on the
1241 * This sets the globally configured cache flush enabled state for all
1242 * applications on the display.
1244 * @param size The cache flush enabled state
1247 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1250 * Get the configured font cache size
1252 * This gets the globally configured font cache size, in bytes
1254 * @return The font cache size
1257 EAPI int elm_font_cache_get(void);
1260 * Set the configured font cache size
1262 * This sets the globally configured font cache size, in bytes
1264 * @param size The font cache size
1267 EAPI void elm_font_cache_set(int size);
1270 * Set the configured font cache size for all applications on the
1273 * This sets the globally configured font cache size -- in bytes
1274 * -- for all applications on the display.
1276 * @param size The font cache size
1279 EAPI void elm_font_cache_all_set(int size);
1282 * Get the configured image cache size
1284 * This gets the globally configured image cache size, in bytes
1286 * @return The image cache size
1289 EAPI int elm_image_cache_get(void);
1292 * Set the configured image cache size
1294 * This sets the globally configured image cache size, in bytes
1296 * @param size The image cache size
1299 EAPI void elm_image_cache_set(int size);
1302 * Set the configured image cache size for all applications on the
1305 * This sets the globally configured image cache size -- in bytes
1306 * -- for all applications on the display.
1308 * @param size The image cache size
1311 EAPI void elm_image_cache_all_set(int size);
1314 * Get the configured edje file cache size.
1316 * This gets the globally configured edje file cache size, in number
1319 * @return The edje file cache size
1322 EAPI int elm_edje_file_cache_get(void);
1325 * Set the configured edje file cache size
1327 * This sets the globally configured edje file cache size, in number
1330 * @param size The edje file cache size
1333 EAPI void elm_edje_file_cache_set(int size);
1336 * Set the configured edje file cache size for all applications on the
1339 * This sets the globally configured edje file cache size -- in number
1340 * of files -- for all applications on the display.
1342 * @param size The edje file cache size
1345 EAPI void elm_edje_file_cache_all_set(int size);
1348 * Get the configured edje collections (groups) cache size.
1350 * This gets the globally configured edje collections cache size, in
1351 * number of collections.
1353 * @return The edje collections cache size
1356 EAPI int elm_edje_collection_cache_get(void);
1359 * Set the configured edje collections (groups) cache size
1361 * This sets the globally configured edje collections cache size, in
1362 * number of collections.
1364 * @param size The edje collections cache size
1367 EAPI void elm_edje_collection_cache_set(int size);
1370 * Set the configured edje collections (groups) cache size for all
1371 * applications on the display
1373 * This sets the globally configured edje collections cache size -- in
1374 * number of collections -- for all applications on the display.
1376 * @param size The edje collections cache size
1379 EAPI void elm_edje_collection_cache_all_set(int size);
1386 * @defgroup Scaling Widget Scaling
1388 * Different widgets can be scaled independently. These functions
1389 * allow you to manipulate this scaling on a per-widget basis. The
1390 * object and all its children get their scaling factors multiplied
1391 * by the scale factor set. This is multiplicative, in that if a
1392 * child also has a scale size set it is in turn multiplied by its
1393 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1394 * double size, @c 0.5 is half, etc.
1396 * @ref general_functions_example_page "This" example contemplates
1397 * some of these functions.
1401 * Get the global scaling factor
1403 * This gets the globally configured scaling factor that is applied to all
1406 * @return The scaling factor
1409 EAPI double elm_scale_get(void);
1412 * Set the global scaling factor
1414 * This sets the globally configured scaling factor that is applied to all
1417 * @param scale The scaling factor to set
1420 EAPI void elm_scale_set(double scale);
1423 * Set the global scaling factor for all applications on the display
1425 * This sets the globally configured scaling factor that is applied to all
1426 * objects for all applications.
1427 * @param scale The scaling factor to set
1430 EAPI void elm_scale_all_set(double scale);
1433 * Set the scaling factor for a given Elementary object
1435 * @param obj The Elementary to operate on
1436 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1441 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1444 * Get the scaling factor for a given Elementary object
1446 * @param obj The object
1447 * @return The scaling factor set by elm_object_scale_set()
1451 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1454 * @defgroup Password_last_show Password last input show
1456 * Last show feature of password mode enables user to view
1457 * the last input entered for few seconds before masking it.
1458 * These functions allow to set this feature in password mode
1459 * of entry widget and also allow to manipulate the duration
1460 * for which the input has to be visible.
1466 * Get show last setting of password mode.
1468 * This gets the show last input setting of password mode which might be
1469 * enabled or disabled.
1471 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1473 * @ingroup Password_last_show
1475 EAPI Eina_Bool elm_password_show_last_get(void);
1478 * Set show last setting in password mode.
1480 * This enables or disables show last setting of password mode.
1482 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1483 * @see elm_password_show_last_timeout_set()
1484 * @ingroup Password_last_show
1486 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1489 * Get's the timeout value in last show password mode.
1491 * This gets the time out value for which the last input entered in password
1492 * mode will be visible.
1494 * @return The timeout value of last show password mode.
1495 * @ingroup Password_last_show
1497 EAPI double elm_password_show_last_timeout_get(void);
1500 * Set's the timeout value in last show password mode.
1502 * This sets the time out value for which the last input entered in password
1503 * mode will be visible.
1505 * @param password_show_last_timeout The timeout value.
1506 * @see elm_password_show_last_set()
1507 * @ingroup Password_last_show
1509 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1516 * @defgroup UI-Mirroring Selective Widget mirroring
1518 * These functions allow you to set ui-mirroring on specific
1519 * widgets or the whole interface. Widgets can be in one of two
1520 * modes, automatic and manual. Automatic means they'll be changed
1521 * according to the system mirroring mode and manual means only
1522 * explicit changes will matter. You are not supposed to change
1523 * mirroring state of a widget set to automatic, will mostly work,
1524 * but the behavior is not really defined.
1529 EAPI Eina_Bool elm_mirrored_get(void);
1530 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1533 * Get the system mirrored mode. This determines the default mirrored mode
1536 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1538 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1541 * Set the system mirrored mode. This determines the default mirrored mode
1544 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1546 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1549 * Returns the widget's mirrored mode setting.
1551 * @param obj The widget.
1552 * @return mirrored mode setting of the object.
1555 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1558 * Sets the widget's mirrored mode setting.
1559 * When widget in automatic mode, it follows the system mirrored mode set by
1560 * elm_mirrored_set().
1561 * @param obj The widget.
1562 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1564 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1571 * Set the style to use by a widget
1573 * Sets the style name that will define the appearance of a widget. Styles
1574 * vary from widget to widget and may also be defined by other themes
1575 * by means of extensions and overlays.
1577 * @param obj The Elementary widget to style
1578 * @param style The style name to use
1580 * @see elm_theme_extension_add()
1581 * @see elm_theme_extension_del()
1582 * @see elm_theme_overlay_add()
1583 * @see elm_theme_overlay_del()
1587 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1589 * Get the style used by the widget
1591 * This gets the style being used for that widget. Note that the string
1592 * pointer is only valid as longas the object is valid and the style doesn't
1595 * @param obj The Elementary widget to query for its style
1596 * @return The style name used
1598 * @see elm_object_style_set()
1602 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1605 * @defgroup Styles Styles
1607 * Widgets can have different styles of look. These generic API's
1608 * set styles of widgets, if they support them (and if the theme(s)
1611 * @ref general_functions_example_page "This" example contemplates
1612 * some of these functions.
1616 * Set the disabled state of an Elementary object.
1618 * @param obj The Elementary object to operate on
1619 * @param disabled The state to put in in: @c EINA_TRUE for
1620 * disabled, @c EINA_FALSE for enabled
1622 * Elementary objects can be @b disabled, in which state they won't
1623 * receive input and, in general, will be themed differently from
1624 * their normal state, usually greyed out. Useful for contexts
1625 * where you don't want your users to interact with some of the
1626 * parts of you interface.
1628 * This sets the state for the widget, either disabling it or
1633 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1636 * Get the disabled state of an Elementary object.
1638 * @param obj The Elementary object to operate on
1639 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1640 * if it's enabled (or on errors)
1642 * This gets the state of the widget, which might be enabled or disabled.
1646 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1649 * @defgroup WidgetNavigation Widget Tree Navigation.
1651 * How to check if an Evas Object is an Elementary widget? How to
1652 * get the first elementary widget that is parent of the given
1653 * object? These are all covered in widget tree navigation.
1655 * @ref general_functions_example_page "This" example contemplates
1656 * some of these functions.
1660 * Check if the given Evas Object is an Elementary widget.
1662 * @param obj the object to query.
1663 * @return @c EINA_TRUE if it is an elementary widget variant,
1664 * @c EINA_FALSE otherwise
1665 * @ingroup WidgetNavigation
1667 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1670 * Get the first parent of the given object that is an Elementary
1673 * @param obj the Elementary object to query parent from.
1674 * @return the parent object that is an Elementary widget, or @c
1675 * NULL, if it was not found.
1677 * Use this to query for an object's parent widget.
1679 * @note Most of Elementary users wouldn't be mixing non-Elementary
1680 * smart objects in the objects tree of an application, as this is
1681 * an advanced usage of Elementary with Evas. So, except for the
1682 * application's window, which is the root of that tree, all other
1683 * objects would have valid Elementary widget parents.
1685 * @ingroup WidgetNavigation
1687 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1690 * Get the top level parent of an Elementary widget.
1692 * @param obj The object to query.
1693 * @return The top level Elementary widget, or @c NULL if parent cannot be
1695 * @ingroup WidgetNavigation
1697 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1700 * Get the string that represents this Elementary widget.
1702 * @note Elementary is weird and exposes itself as a single
1703 * Evas_Object_Smart_Class of type "elm_widget", so
1704 * evas_object_type_get() always return that, making debug and
1705 * language bindings hard. This function tries to mitigate this
1706 * problem, but the solution is to change Elementary to use
1707 * proper inheritance.
1709 * @param obj the object to query.
1710 * @return Elementary widget name, or @c NULL if not a valid widget.
1711 * @ingroup WidgetNavigation
1713 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1716 * @defgroup Config Elementary Config
1718 * Elementary configuration is formed by a set options bounded to a
1719 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1720 * "finger size", etc. These are functions with which one syncronizes
1721 * changes made to those values to the configuration storing files, de
1722 * facto. You most probably don't want to use the functions in this
1723 * group unlees you're writing an elementary configuration manager.
1729 * Save back Elementary's configuration, so that it will persist on
1732 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1735 * This function will take effect -- thus, do I/O -- immediately. Use
1736 * it when you want to apply all configuration changes at once. The
1737 * current configuration set will get saved onto the current profile
1738 * configuration file.
1741 EAPI Eina_Bool elm_config_save(void);
1744 * Reload Elementary's configuration, bounded to current selected
1747 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1750 * Useful when you want to force reloading of configuration values for
1751 * a profile. If one removes user custom configuration directories,
1752 * for example, it will force a reload with system values insted.
1755 EAPI void elm_config_reload(void);
1762 * @defgroup Profile Elementary Profile
1764 * Profiles are pre-set options that affect the whole look-and-feel of
1765 * Elementary-based applications. There are, for example, profiles
1766 * aimed at desktop computer applications and others aimed at mobile,
1767 * touchscreen-based ones. You most probably don't want to use the
1768 * functions in this group unlees you're writing an elementary
1769 * configuration manager.
1775 * Get Elementary's profile in use.
1777 * This gets the global profile that is applied to all Elementary
1780 * @return The profile's name
1783 EAPI const char *elm_profile_current_get(void);
1786 * Get an Elementary's profile directory path in the filesystem. One
1787 * may want to fetch a system profile's dir or an user one (fetched
1790 * @param profile The profile's name
1791 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1792 * or a system one (@c EINA_FALSE)
1793 * @return The profile's directory path.
1796 * @note You must free it with elm_profile_dir_free().
1798 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1801 * Free an Elementary's profile directory path, as returned by
1802 * elm_profile_dir_get().
1804 * @param p_dir The profile's path
1808 EAPI void elm_profile_dir_free(const char *p_dir);
1811 * Get Elementary's list of available profiles.
1813 * @return The profiles list. List node data are the profile name
1817 * @note One must free this list, after usage, with the function
1818 * elm_profile_list_free().
1820 EAPI Eina_List *elm_profile_list_get(void);
1823 * Free Elementary's list of available profiles.
1825 * @param l The profiles list, as returned by elm_profile_list_get().
1829 EAPI void elm_profile_list_free(Eina_List *l);
1832 * Set Elementary's profile.
1834 * This sets the global profile that is applied to Elementary
1835 * applications. Just the process the call comes from will be
1838 * @param profile The profile's name
1842 EAPI void elm_profile_set(const char *profile);
1845 * Set Elementary's profile.
1847 * This sets the global profile that is applied to all Elementary
1848 * applications. All running Elementary windows will be affected.
1850 * @param profile The profile's name
1854 EAPI void elm_profile_all_set(const char *profile);
1861 * @defgroup Engine Elementary Engine
1863 * These are functions setting and querying which rendering engine
1864 * Elementary will use for drawing its windows' pixels.
1866 * The following are the available engines:
1867 * @li "software_x11"
1870 * @li "software_16_x11"
1871 * @li "software_8_x11"
1874 * @li "software_gdi"
1875 * @li "software_16_wince_gdi"
1877 * @li "software_16_sdl"
1885 * @brief Get Elementary's rendering engine in use.
1887 * @return The rendering engine's name
1888 * @note there's no need to free the returned string, here.
1890 * This gets the global rendering engine that is applied to all Elementary
1893 * @see elm_engine_set()
1895 EAPI const char *elm_engine_current_get(void);
1898 * @brief Set Elementary's rendering engine for use.
1900 * @param engine The rendering engine's name
1902 * This sets global rendering engine that is applied to all Elementary
1903 * applications. Note that it will take effect only to Elementary windows
1904 * created after this is called.
1906 * @see elm_win_add()
1908 EAPI void elm_engine_set(const char *engine);
1915 * @defgroup Fonts Elementary Fonts
1917 * These are functions dealing with font rendering, selection and the
1918 * like for Elementary applications. One might fetch which system
1919 * fonts are there to use and set custom fonts for individual classes
1920 * of UI items containing text (text classes).
1925 typedef struct _Elm_Text_Class
1931 typedef struct _Elm_Font_Overlay
1933 const char *text_class;
1935 Evas_Font_Size size;
1938 typedef struct _Elm_Font_Properties
1942 } Elm_Font_Properties;
1945 * Get Elementary's list of supported text classes.
1947 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1950 * Release the list with elm_text_classes_list_free().
1952 EAPI const Eina_List *elm_text_classes_list_get(void);
1955 * Free Elementary's list of supported text classes.
1959 * @see elm_text_classes_list_get().
1961 EAPI void elm_text_classes_list_free(const Eina_List *list);
1964 * Get Elementary's list of font overlays, set with
1965 * elm_font_overlay_set().
1967 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1972 * For each text class, one can set a <b>font overlay</b> for it,
1973 * overriding the default font properties for that class coming from
1974 * the theme in use. There is no need to free this list.
1976 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1978 EAPI const Eina_List *elm_font_overlay_list_get(void);
1981 * Set a font overlay for a given Elementary text class.
1983 * @param text_class Text class name
1984 * @param font Font name and style string
1985 * @param size Font size
1989 * @p font has to be in the format returned by
1990 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1991 * and elm_font_overlay_unset().
1993 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1996 * Unset a font overlay for a given Elementary text class.
1998 * @param text_class Text class name
2002 * This will bring back text elements belonging to text class
2003 * @p text_class back to their default font settings.
2005 EAPI void elm_font_overlay_unset(const char *text_class);
2008 * Apply the changes made with elm_font_overlay_set() and
2009 * elm_font_overlay_unset() on the current Elementary window.
2013 * This applies all font overlays set to all objects in the UI.
2015 EAPI void elm_font_overlay_apply(void);
2018 * Apply the changes made with elm_font_overlay_set() and
2019 * elm_font_overlay_unset() on all Elementary application windows.
2023 * This applies all font overlays set to all objects in the UI.
2025 EAPI void elm_font_overlay_all_apply(void);
2028 * Translate a font (family) name string in fontconfig's font names
2029 * syntax into an @c Elm_Font_Properties struct.
2031 * @param font The font name and styles string
2032 * @return the font properties struct
2036 * @note The reverse translation can be achived with
2037 * elm_font_fontconfig_name_get(), for one style only (single font
2038 * instance, not family).
2040 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2043 * Free font properties return by elm_font_properties_get().
2045 * @param efp the font properties struct
2049 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2052 * Translate a font name, bound to a style, into fontconfig's font names
2055 * @param name The font (family) name
2056 * @param style The given style (may be @c NULL)
2058 * @return the font name and style string
2062 * @note The reverse translation can be achived with
2063 * elm_font_properties_get(), for one style only (single font
2064 * instance, not family).
2066 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2069 * Free the font string return by elm_font_fontconfig_name_get().
2071 * @param efp the font properties struct
2075 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2078 * Create a font hash table of available system fonts.
2080 * One must call it with @p list being the return value of
2081 * evas_font_available_list(). The hash will be indexed by font
2082 * (family) names, being its values @c Elm_Font_Properties blobs.
2084 * @param list The list of available system fonts, as returned by
2085 * evas_font_available_list().
2086 * @return the font hash.
2090 * @note The user is supposed to get it populated at least with 3
2091 * default font families (Sans, Serif, Monospace), which should be
2092 * present on most systems.
2094 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2097 * Free the hash return by elm_font_available_hash_add().
2099 * @param hash the hash to be freed.
2103 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2110 * @defgroup Fingers Fingers
2112 * Elementary is designed to be finger-friendly for touchscreens,
2113 * and so in addition to scaling for display resolution, it can
2114 * also scale based on finger "resolution" (or size). You can then
2115 * customize the granularity of the areas meant to receive clicks
2118 * Different profiles may have pre-set values for finger sizes.
2120 * @ref general_functions_example_page "This" example contemplates
2121 * some of these functions.
2127 * Get the configured "finger size"
2129 * @return The finger size
2131 * This gets the globally configured finger size, <b>in pixels</b>
2135 EAPI Evas_Coord elm_finger_size_get(void);
2138 * Set the configured finger size
2140 * This sets the globally configured finger size in pixels
2142 * @param size The finger size
2145 EAPI void elm_finger_size_set(Evas_Coord size);
2148 * Set the configured finger size for all applications on the display
2150 * This sets the globally configured finger size in pixels for all
2151 * applications on the display
2153 * @param size The finger size
2156 EAPI void elm_finger_size_all_set(Evas_Coord size);
2163 * @defgroup Focus Focus
2165 * An Elementary application has, at all times, one (and only one)
2166 * @b focused object. This is what determines where the input
2167 * events go to within the application's window. Also, focused
2168 * objects can be decorated differently, in order to signal to the
2169 * user where the input is, at a given moment.
2171 * Elementary applications also have the concept of <b>focus
2172 * chain</b>: one can cycle through all the windows' focusable
2173 * objects by input (tab key) or programmatically. The default
2174 * focus chain for an application is the one define by the order in
2175 * which the widgets where added in code. One will cycle through
2176 * top level widgets, and, for each one containg sub-objects, cycle
2177 * through them all, before returning to the level
2178 * above. Elementary also allows one to set @b custom focus chains
2179 * for their applications.
2181 * Besides the focused decoration a widget may exhibit, when it
2182 * gets focus, Elementary has a @b global focus highlight object
2183 * that can be enabled for a window. If one chooses to do so, this
2184 * extra highlight effect will surround the current focused object,
2187 * @note Some Elementary widgets are @b unfocusable, after
2188 * creation, by their very nature: they are not meant to be
2189 * interacted with input events, but are there just for visual
2192 * @ref general_functions_example_page "This" example contemplates
2193 * some of these functions.
2197 * Get the enable status of the focus highlight
2199 * This gets whether the highlight on focused objects is enabled or not
2202 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2205 * Set the enable status of the focus highlight
2207 * Set whether to show or not the highlight on focused objects
2208 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2211 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2214 * Get the enable status of the highlight animation
2216 * Get whether the focus highlight, if enabled, will animate its switch from
2217 * one object to the next
2220 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2223 * Set the enable status of the highlight animation
2225 * Set whether the focus highlight, if enabled, will animate its switch from
2226 * one object to the next
2227 * @param animate Enable animation if EINA_TRUE, disable otherwise
2230 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2233 * Get the whether an Elementary object has the focus or not.
2235 * @param obj The Elementary object to get the information from
2236 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2237 * not (and on errors).
2239 * @see elm_object_focus_set()
2243 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2246 * Set/unset focus to a given Elementary object.
2248 * @param obj The Elementary object to operate on.
2249 * @param enable @c EINA_TRUE Set focus to a given object,
2250 * @c EINA_FALSE Unset focus to a given object.
2252 * @note When you set focus to this object, if it can handle focus, will
2253 * take the focus away from the one who had it previously and will, for
2254 * now on, be the one receiving input events. Unsetting focus will remove
2255 * the focus from @p obj, passing it back to the previous element in the
2258 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2262 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2265 * Make a given Elementary object the focused one.
2267 * @param obj The Elementary object to make focused.
2269 * @note This object, if it can handle focus, will take the focus
2270 * away from the one who had it previously and will, for now on, be
2271 * the one receiving input events.
2273 * @see elm_object_focus_get()
2274 * @deprecated use elm_object_focus_set() instead.
2278 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2281 * Remove the focus from an Elementary object
2283 * @param obj The Elementary to take focus from
2285 * This removes the focus from @p obj, passing it back to the
2286 * previous element in the focus chain list.
2288 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2289 * @deprecated use elm_object_focus_set() instead.
2293 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2296 * Set the ability for an Element object to be focused
2298 * @param obj The Elementary object to operate on
2299 * @param enable @c EINA_TRUE if the object can be focused, @c
2300 * EINA_FALSE if not (and on errors)
2302 * This sets whether the object @p obj is able to take focus or
2303 * not. Unfocusable objects do nothing when programmatically
2304 * focused, being the nearest focusable parent object the one
2305 * really getting focus. Also, when they receive mouse input, they
2306 * will get the event, but not take away the focus from where it
2311 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2314 * Get whether an Elementary object is focusable or not
2316 * @param obj The Elementary object to operate on
2317 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2318 * EINA_FALSE if not (and on errors)
2320 * @note Objects which are meant to be interacted with by input
2321 * events are created able to be focused, by default. All the
2326 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2329 * Set custom focus chain.
2331 * This function overwrites any previous custom focus chain within
2332 * the list of objects. The previous list will be deleted and this list
2333 * will be managed by elementary. After it is set, don't modify it.
2335 * @note On focus cycle, only will be evaluated children of this container.
2337 * @param obj The container object
2338 * @param objs Chain of objects to pass focus
2341 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2344 * Unset a custom focus chain on a given Elementary widget
2346 * @param obj The container object to remove focus chain from
2348 * Any focus chain previously set on @p obj (for its child objects)
2349 * is removed entirely after this call.
2353 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2356 * Get custom focus chain
2358 * @param obj The container object
2361 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2364 * Append object to custom focus chain.
2366 * @note If relative_child equal to NULL or not in custom chain, the object
2367 * will be added in end.
2369 * @note On focus cycle, only will be evaluated children of this container.
2371 * @param obj The container object
2372 * @param child The child to be added in custom chain
2373 * @param relative_child The relative object to position the child
2376 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2379 * Prepend object to custom focus chain.
2381 * @note If relative_child equal to NULL or not in custom chain, the object
2382 * will be added in begin.
2384 * @note On focus cycle, only will be evaluated children of this container.
2386 * @param obj The container object
2387 * @param child The child to be added in custom chain
2388 * @param relative_child The relative object to position the child
2391 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2394 * Give focus to next object in object tree.
2396 * Give focus to next object in focus chain of one object sub-tree.
2397 * If the last object of chain already have focus, the focus will go to the
2398 * first object of chain.
2400 * @param obj The object root of sub-tree
2401 * @param dir Direction to cycle the focus
2405 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2408 * Give focus to near object in one direction.
2410 * Give focus to near object in direction of one object.
2411 * If none focusable object in given direction, the focus will not change.
2413 * @param obj The reference object
2414 * @param x Horizontal component of direction to focus
2415 * @param y Vertical component of direction to focus
2419 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2422 * Make the elementary object and its children to be unfocusable
2425 * @param obj The Elementary object to operate on
2426 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2427 * @c EINA_FALSE for focusable.
2429 * This sets whether the object @p obj and its children objects
2430 * are able to take focus or not. If the tree is set as unfocusable,
2431 * newest focused object which is not in this tree will get focus.
2432 * This API can be helpful for an object to be deleted.
2433 * When an object will be deleted soon, it and its children may not
2434 * want to get focus (by focus reverting or by other focus controls).
2435 * Then, just use this API before deleting.
2437 * @see elm_object_tree_unfocusable_get()
2441 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2444 * Get whether an Elementary object and its children are unfocusable or not.
2446 * @param obj The Elementary object to get the information from
2447 * @return @c EINA_TRUE, if the tree is unfocussable,
2448 * @c EINA_FALSE if not (and on errors).
2450 * @see elm_object_tree_unfocusable_set()
2454 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2457 * @defgroup Scrolling Scrolling
2459 * These are functions setting how scrollable views in Elementary
2460 * widgets should behave on user interaction.
2466 * Get whether scrollers should bounce when they reach their
2467 * viewport's edge during a scroll.
2469 * @return the thumb scroll bouncing state
2471 * This is the default behavior for touch screens, in general.
2472 * @ingroup Scrolling
2474 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2477 * Set whether scrollers should bounce when they reach their
2478 * viewport's edge during a scroll.
2480 * @param enabled the thumb scroll bouncing state
2482 * @see elm_thumbscroll_bounce_enabled_get()
2483 * @ingroup Scrolling
2485 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2488 * Set whether scrollers should bounce when they reach their
2489 * viewport's edge during a scroll, for all Elementary application
2492 * @param enabled the thumb scroll bouncing state
2494 * @see elm_thumbscroll_bounce_enabled_get()
2495 * @ingroup Scrolling
2497 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2500 * Get the amount of inertia a scroller will impose at bounce
2503 * @return the thumb scroll bounce friction
2505 * @ingroup Scrolling
2507 EAPI double elm_scroll_bounce_friction_get(void);
2510 * Set the amount of inertia a scroller will impose at bounce
2513 * @param friction the thumb scroll bounce friction
2515 * @see elm_thumbscroll_bounce_friction_get()
2516 * @ingroup Scrolling
2518 EAPI void elm_scroll_bounce_friction_set(double friction);
2521 * Set the amount of inertia a scroller will impose at bounce
2522 * animations, for all Elementary application windows.
2524 * @param friction the thumb scroll bounce friction
2526 * @see elm_thumbscroll_bounce_friction_get()
2527 * @ingroup Scrolling
2529 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2532 * Get the amount of inertia a <b>paged</b> scroller will impose at
2533 * page fitting animations.
2535 * @return the page scroll friction
2537 * @ingroup Scrolling
2539 EAPI double elm_scroll_page_scroll_friction_get(void);
2542 * Set the amount of inertia a <b>paged</b> scroller will impose at
2543 * page fitting animations.
2545 * @param friction the page scroll friction
2547 * @see elm_thumbscroll_page_scroll_friction_get()
2548 * @ingroup Scrolling
2550 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2553 * Set the amount of inertia a <b>paged</b> scroller will impose at
2554 * page fitting animations, for all Elementary application windows.
2556 * @param friction the page scroll friction
2558 * @see elm_thumbscroll_page_scroll_friction_get()
2559 * @ingroup Scrolling
2561 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2564 * Get the amount of inertia a scroller will impose at region bring
2567 * @return the bring in scroll friction
2569 * @ingroup Scrolling
2571 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2574 * Set the amount of inertia a scroller will impose at region bring
2577 * @param friction the bring in scroll friction
2579 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2580 * @ingroup Scrolling
2582 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2585 * Set the amount of inertia a scroller will impose at region bring
2586 * animations, for all Elementary application windows.
2588 * @param friction the bring in scroll friction
2590 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2591 * @ingroup Scrolling
2593 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2596 * Get the amount of inertia scrollers will impose at animations
2597 * triggered by Elementary widgets' zooming API.
2599 * @return the zoom friction
2601 * @ingroup Scrolling
2603 EAPI double elm_scroll_zoom_friction_get(void);
2606 * Set the amount of inertia scrollers will impose at animations
2607 * triggered by Elementary widgets' zooming API.
2609 * @param friction the zoom friction
2611 * @see elm_thumbscroll_zoom_friction_get()
2612 * @ingroup Scrolling
2614 EAPI void elm_scroll_zoom_friction_set(double friction);
2617 * Set the amount of inertia scrollers will impose at animations
2618 * triggered by Elementary widgets' zooming API, for all Elementary
2619 * application windows.
2621 * @param friction the zoom friction
2623 * @see elm_thumbscroll_zoom_friction_get()
2624 * @ingroup Scrolling
2626 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2629 * Get whether scrollers should be draggable from any point in their
2632 * @return the thumb scroll state
2634 * @note This is the default behavior for touch screens, in general.
2635 * @note All other functions namespaced with "thumbscroll" will only
2636 * have effect if this mode is enabled.
2638 * @ingroup Scrolling
2640 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2643 * Set whether scrollers should be draggable from any point in their
2646 * @param enabled the thumb scroll state
2648 * @see elm_thumbscroll_enabled_get()
2649 * @ingroup Scrolling
2651 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2654 * Set whether scrollers should be draggable from any point in their
2655 * views, for all Elementary application windows.
2657 * @param enabled the thumb scroll state
2659 * @see elm_thumbscroll_enabled_get()
2660 * @ingroup Scrolling
2662 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2665 * Get the number of pixels one should travel while dragging a
2666 * scroller's view to actually trigger scrolling.
2668 * @return the thumb scroll threshould
2670 * One would use higher values for touch screens, in general, because
2671 * of their inherent imprecision.
2672 * @ingroup Scrolling
2674 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2677 * Set the number of pixels one should travel while dragging a
2678 * scroller's view to actually trigger scrolling.
2680 * @param threshold the thumb scroll threshould
2682 * @see elm_thumbscroll_threshould_get()
2683 * @ingroup Scrolling
2685 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2688 * Set the number of pixels one should travel while dragging a
2689 * scroller's view to actually trigger scrolling, for all Elementary
2690 * application windows.
2692 * @param threshold the thumb scroll threshould
2694 * @see elm_thumbscroll_threshould_get()
2695 * @ingroup Scrolling
2697 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2700 * Get the minimum speed of mouse cursor movement which will trigger
2701 * list self scrolling animation after a mouse up event
2704 * @return the thumb scroll momentum threshould
2706 * @ingroup Scrolling
2708 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2711 * Set the minimum speed of mouse cursor movement which will trigger
2712 * list self scrolling animation after a mouse up event
2715 * @param threshold the thumb scroll momentum threshould
2717 * @see elm_thumbscroll_momentum_threshould_get()
2718 * @ingroup Scrolling
2720 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2723 * Set the minimum speed of mouse cursor movement which will trigger
2724 * list self scrolling animation after a mouse up event
2725 * (pixels/second), for all Elementary application windows.
2727 * @param threshold the thumb scroll momentum threshould
2729 * @see elm_thumbscroll_momentum_threshould_get()
2730 * @ingroup Scrolling
2732 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2735 * Get the amount of inertia a scroller will impose at self scrolling
2738 * @return the thumb scroll friction
2740 * @ingroup Scrolling
2742 EAPI double elm_scroll_thumbscroll_friction_get(void);
2745 * Set the amount of inertia a scroller will impose at self scrolling
2748 * @param friction the thumb scroll friction
2750 * @see elm_thumbscroll_friction_get()
2751 * @ingroup Scrolling
2753 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2756 * Set the amount of inertia a scroller will impose at self scrolling
2757 * animations, for all Elementary application windows.
2759 * @param friction the thumb scroll friction
2761 * @see elm_thumbscroll_friction_get()
2762 * @ingroup Scrolling
2764 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2767 * Get the amount of lag between your actual mouse cursor dragging
2768 * movement and a scroller's view movement itself, while pushing it
2769 * into bounce state manually.
2771 * @return the thumb scroll border friction
2773 * @ingroup Scrolling
2775 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2778 * Set the amount of lag between your actual mouse cursor dragging
2779 * movement and a scroller's view movement itself, while pushing it
2780 * into bounce state manually.
2782 * @param friction the thumb scroll border friction. @c 0.0 for
2783 * perfect synchrony between two movements, @c 1.0 for maximum
2786 * @see elm_thumbscroll_border_friction_get()
2787 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2789 * @ingroup Scrolling
2791 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2794 * Set the amount of lag between your actual mouse cursor dragging
2795 * movement and a scroller's view movement itself, while pushing it
2796 * into bounce state manually, for all Elementary application windows.
2798 * @param friction the thumb scroll border friction. @c 0.0 for
2799 * perfect synchrony between two movements, @c 1.0 for maximum
2802 * @see elm_thumbscroll_border_friction_get()
2803 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2805 * @ingroup Scrolling
2807 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2814 * @defgroup Scrollhints Scrollhints
2816 * Objects when inside a scroller can scroll, but this may not always be
2817 * desirable in certain situations. This allows an object to hint to itself
2818 * and parents to "not scroll" in one of 2 ways. If any child object of a
2819 * scroller has pushed a scroll freeze or hold then it affects all parent
2820 * scrollers until all children have released them.
2822 * 1. To hold on scrolling. This means just flicking and dragging may no
2823 * longer scroll, but pressing/dragging near an edge of the scroller will
2824 * still scroll. This is automatically used by the entry object when
2827 * 2. To totally freeze scrolling. This means it stops. until
2834 * Push the scroll hold by 1
2836 * This increments the scroll hold count by one. If it is more than 0 it will
2837 * take effect on the parents of the indicated object.
2839 * @param obj The object
2840 * @ingroup Scrollhints
2842 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2845 * Pop the scroll hold by 1
2847 * This decrements the scroll hold count by one. If it is more than 0 it will
2848 * take effect on the parents of the indicated object.
2850 * @param obj The object
2851 * @ingroup Scrollhints
2853 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2856 * Push the scroll freeze by 1
2858 * This increments the scroll freeze count by one. If it is more
2859 * than 0 it will take effect on the parents of the indicated
2862 * @param obj The object
2863 * @ingroup Scrollhints
2865 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2868 * Pop the scroll freeze by 1
2870 * This decrements the scroll freeze count by one. If it is more
2871 * than 0 it will take effect on the parents of the indicated
2874 * @param obj The object
2875 * @ingroup Scrollhints
2877 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2880 * Lock the scrolling of the given widget (and thus all parents)
2882 * This locks the given object from scrolling in the X axis (and implicitly
2883 * also locks all parent scrollers too from doing the same).
2885 * @param obj The object
2886 * @param lock The lock state (1 == locked, 0 == unlocked)
2887 * @ingroup Scrollhints
2889 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2892 * Lock the scrolling of the given widget (and thus all parents)
2894 * This locks the given object from scrolling in the Y axis (and implicitly
2895 * also locks all parent scrollers too from doing the same).
2897 * @param obj The object
2898 * @param lock The lock state (1 == locked, 0 == unlocked)
2899 * @ingroup Scrollhints
2901 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2904 * Get the scrolling lock of the given widget
2906 * This gets the lock for X axis scrolling.
2908 * @param obj The object
2909 * @ingroup Scrollhints
2911 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2914 * Get the scrolling lock of the given widget
2916 * This gets the lock for X axis scrolling.
2918 * @param obj The object
2919 * @ingroup Scrollhints
2921 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2928 * Send a signal to the widget edje object.
2930 * This function sends a signal to the edje object of the obj. An
2931 * edje program can respond to a signal by specifying matching
2932 * 'signal' and 'source' fields.
2934 * @param obj The object
2935 * @param emission The signal's name.
2936 * @param source The signal's source.
2939 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2942 * Add a callback for a signal emitted by widget edje object.
2944 * This function connects a callback function to a signal emitted by the
2945 * edje object of the obj.
2946 * Globs can occur in either the emission or source name.
2948 * @param obj The object
2949 * @param emission The signal's name.
2950 * @param source The signal's source.
2951 * @param func The callback function to be executed when the signal is
2953 * @param data A pointer to data to pass in to the callback function.
2956 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);
2959 * Remove a signal-triggered callback from a widget edje object.
2961 * This function removes a callback, previoulsy attached to a
2962 * signal emitted by the edje object of the obj. The parameters
2963 * emission, source and func must match exactly those passed to a
2964 * previous call to elm_object_signal_callback_add(). The data
2965 * pointer that was passed to this call will be returned.
2967 * @param obj The object
2968 * @param emission The signal's name.
2969 * @param source The signal's source.
2970 * @param func The callback function to be executed when the signal is
2972 * @return The data pointer
2975 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);
2978 * Add a callback for input events (key up, key down, mouse wheel)
2979 * on a given Elementary widget
2981 * @param obj The widget to add an event callback on
2982 * @param func The callback function to be executed when the event
2984 * @param data Data to pass in to @p func
2986 * Every widget in an Elementary interface set to receive focus,
2987 * with elm_object_focus_allow_set(), will propagate @b all of its
2988 * key up, key down and mouse wheel input events up to its parent
2989 * object, and so on. All of the focusable ones in this chain which
2990 * had an event callback set, with this call, will be able to treat
2991 * those events. There are two ways of making the propagation of
2992 * these event upwards in the tree of widgets to @b cease:
2993 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2994 * the event was @b not processed, so the propagation will go on.
2995 * - The @c event_info pointer passed to @p func will contain the
2996 * event's structure and, if you OR its @c event_flags inner
2997 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2998 * one has already handled it, thus killing the event's
3001 * @note Your event callback will be issued on those events taking
3002 * place only if no other child widget of @obj has consumed the
3005 * @note Not to be confused with @c
3006 * evas_object_event_callback_add(), which will add event callbacks
3007 * per type on general Evas objects (no event propagation
3008 * infrastructure taken in account).
3010 * @note Not to be confused with @c
3011 * elm_object_signal_callback_add(), which will add callbacks to @b
3012 * signals coming from a widget's theme, not input events.
3014 * @note Not to be confused with @c
3015 * edje_object_signal_callback_add(), which does the same as
3016 * elm_object_signal_callback_add(), but directly on an Edje
3019 * @note Not to be confused with @c
3020 * evas_object_smart_callback_add(), which adds callbacks to smart
3021 * objects' <b>smart events</b>, and not input events.
3023 * @see elm_object_event_callback_del()
3027 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3030 * Remove an event callback from a widget.
3032 * This function removes a callback, previoulsy attached to event emission
3034 * The parameters func and data must match exactly those passed to
3035 * a previous call to elm_object_event_callback_add(). The data pointer that
3036 * was passed to this call will be returned.
3038 * @param obj The object
3039 * @param func The callback function to be executed when the event is
3041 * @param data Data to pass in to the callback function.
3042 * @return The data pointer
3045 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3048 * Adjust size of an element for finger usage.
3050 * @param times_w How many fingers should fit horizontally
3051 * @param w Pointer to the width size to adjust
3052 * @param times_h How many fingers should fit vertically
3053 * @param h Pointer to the height size to adjust
3055 * This takes width and height sizes (in pixels) as input and a
3056 * size multiple (which is how many fingers you want to place
3057 * within the area, being "finger" the size set by
3058 * elm_finger_size_set()), and adjusts the size to be large enough
3059 * to accommodate the resulting size -- if it doesn't already
3060 * accommodate it. On return the @p w and @p h sizes pointed to by
3061 * these parameters will be modified, on those conditions.
3063 * @note This is kind of a low level Elementary call, most useful
3064 * on size evaluation times for widgets. An external user wouldn't
3065 * be calling, most of the time.
3069 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3072 * Get the duration for occuring long press event.
3074 * @return Timeout for long press event
3075 * @ingroup Longpress
3077 EAPI double elm_longpress_timeout_get(void);
3080 * Set the duration for occuring long press event.
3082 * @param lonpress_timeout Timeout for long press event
3083 * @ingroup Longpress
3085 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3088 * @defgroup Debug Debug
3089 * don't use it unless you are sure
3095 * Print Tree object hierarchy in stdout
3097 * @param obj The root object
3100 EAPI void elm_object_tree_dump(const Evas_Object *top);
3103 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3105 * @param obj The root object
3106 * @param file The path of output file
3109 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3116 * @defgroup Theme Theme
3118 * Elementary uses Edje to theme its widgets, naturally. But for the most
3119 * part this is hidden behind a simpler interface that lets the user set
3120 * extensions and choose the style of widgets in a much easier way.
3122 * Instead of thinking in terms of paths to Edje files and their groups
3123 * each time you want to change the appearance of a widget, Elementary
3124 * works so you can add any theme file with extensions or replace the
3125 * main theme at one point in the application, and then just set the style
3126 * of widgets with elm_object_style_set() and related functions. Elementary
3127 * will then look in its list of themes for a matching group and apply it,
3128 * and when the theme changes midway through the application, all widgets
3129 * will be updated accordingly.
3131 * There are three concepts you need to know to understand how Elementary
3132 * theming works: default theme, extensions and overlays.
3134 * Default theme, obviously enough, is the one that provides the default
3135 * look of all widgets. End users can change the theme used by Elementary
3136 * by setting the @c ELM_THEME environment variable before running an
3137 * application, or globally for all programs using the @c elementary_config
3138 * utility. Applications can change the default theme using elm_theme_set(),
3139 * but this can go against the user wishes, so it's not an adviced practice.
3141 * Ideally, applications should find everything they need in the already
3142 * provided theme, but there may be occasions when that's not enough and
3143 * custom styles are required to correctly express the idea. For this
3144 * cases, Elementary has extensions.
3146 * Extensions allow the application developer to write styles of its own
3147 * to apply to some widgets. This requires knowledge of how each widget
3148 * is themed, as extensions will always replace the entire group used by
3149 * the widget, so important signals and parts need to be there for the
3150 * object to behave properly (see documentation of Edje for details).
3151 * Once the theme for the extension is done, the application needs to add
3152 * it to the list of themes Elementary will look into, using
3153 * elm_theme_extension_add(), and set the style of the desired widgets as
3154 * he would normally with elm_object_style_set().
3156 * Overlays, on the other hand, can replace the look of all widgets by
3157 * overriding the default style. Like extensions, it's up to the application
3158 * developer to write the theme for the widgets it wants, the difference
3159 * being that when looking for the theme, Elementary will check first the
3160 * list of overlays, then the set theme and lastly the list of extensions,
3161 * so with overlays it's possible to replace the default view and every
3162 * widget will be affected. This is very much alike to setting the whole
3163 * theme for the application and will probably clash with the end user
3164 * options, not to mention the risk of ending up with not matching styles
3165 * across the program. Unless there's a very special reason to use them,
3166 * overlays should be avoided for the resons exposed before.
3168 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3169 * keeps one default internally and every function that receives one of
3170 * these can be called with NULL to refer to this default (except for
3171 * elm_theme_free()). It's possible to create a new instance of a
3172 * ::Elm_Theme to set other theme for a specific widget (and all of its
3173 * children), but this is as discouraged, if not even more so, than using
3174 * overlays. Don't use this unless you really know what you are doing.
3176 * But to be less negative about things, you can look at the following
3178 * @li @ref theme_example_01 "Using extensions"
3179 * @li @ref theme_example_02 "Using overlays"
3184 * @typedef Elm_Theme
3186 * Opaque handler for the list of themes Elementary looks for when
3187 * rendering widgets.
3189 * Stay out of this unless you really know what you are doing. For most
3190 * cases, sticking to the default is all a developer needs.
3192 typedef struct _Elm_Theme Elm_Theme;
3195 * Create a new specific theme
3197 * This creates an empty specific theme that only uses the default theme. A
3198 * specific theme has its own private set of extensions and overlays too
3199 * (which are empty by default). Specific themes do not fall back to themes
3200 * of parent objects. They are not intended for this use. Use styles, overlays
3201 * and extensions when needed, but avoid specific themes unless there is no
3202 * other way (example: you want to have a preview of a new theme you are
3203 * selecting in a "theme selector" window. The preview is inside a scroller
3204 * and should display what the theme you selected will look like, but not
3205 * actually apply it yet. The child of the scroller will have a specific
3206 * theme set to show this preview before the user decides to apply it to all
3209 EAPI Elm_Theme *elm_theme_new(void);
3211 * Free a specific theme
3213 * @param th The theme to free
3215 * This frees a theme created with elm_theme_new().
3217 EAPI void elm_theme_free(Elm_Theme *th);
3219 * Copy the theme fom the source to the destination theme
3221 * @param th The source theme to copy from
3222 * @param thdst The destination theme to copy data to
3224 * This makes a one-time static copy of all the theme config, extensions
3225 * and overlays from @p th to @p thdst. If @p th references a theme, then
3226 * @p thdst is also set to reference it, with all the theme settings,
3227 * overlays and extensions that @p th had.
3229 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3231 * Tell the source theme to reference the ref theme
3233 * @param th The theme that will do the referencing
3234 * @param thref The theme that is the reference source
3236 * This clears @p th to be empty and then sets it to refer to @p thref
3237 * so @p th acts as an override to @p thref, but where its overrides
3238 * don't apply, it will fall through to @p thref for configuration.
3240 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3242 * Return the theme referred to
3244 * @param th The theme to get the reference from
3245 * @return The referenced theme handle
3247 * This gets the theme set as the reference theme by elm_theme_ref_set().
3248 * If no theme is set as a reference, NULL is returned.
3250 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3252 * Return the default theme
3254 * @return The default theme handle
3256 * This returns the internal default theme setup handle that all widgets
3257 * use implicitly unless a specific theme is set. This is also often use
3258 * as a shorthand of NULL.
3260 EAPI Elm_Theme *elm_theme_default_get(void);
3262 * Prepends a theme overlay to the list of overlays
3264 * @param th The theme to add to, or if NULL, the default theme
3265 * @param item The Edje file path to be used
3267 * Use this if your application needs to provide some custom overlay theme
3268 * (An Edje file that replaces some default styles of widgets) where adding
3269 * new styles, or changing system theme configuration is not possible. Do
3270 * NOT use this instead of a proper system theme configuration. Use proper
3271 * configuration files, profiles, environment variables etc. to set a theme
3272 * so that the theme can be altered by simple confiugration by a user. Using
3273 * this call to achieve that effect is abusing the API and will create lots
3276 * @see elm_theme_extension_add()
3278 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3280 * Delete a theme overlay from the list of overlays
3282 * @param th The theme to delete from, or if NULL, the default theme
3283 * @param item The name of the theme overlay
3285 * @see elm_theme_overlay_add()
3287 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3289 * Appends a theme extension to the list of extensions.
3291 * @param th The theme to add to, or if NULL, the default theme
3292 * @param item The Edje file path to be used
3294 * This is intended when an application needs more styles of widgets or new
3295 * widget themes that the default does not provide (or may not provide). The
3296 * application has "extended" usage by coming up with new custom style names
3297 * for widgets for specific uses, but as these are not "standard", they are
3298 * not guaranteed to be provided by a default theme. This means the
3299 * application is required to provide these extra elements itself in specific
3300 * Edje files. This call adds one of those Edje files to the theme search
3301 * path to be search after the default theme. The use of this call is
3302 * encouraged when default styles do not meet the needs of the application.
3303 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3305 * @see elm_object_style_set()
3307 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3309 * Deletes a theme extension from the list of extensions.
3311 * @param th The theme to delete from, or if NULL, the default theme
3312 * @param item The name of the theme extension
3314 * @see elm_theme_extension_add()
3316 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3318 * Set the theme search order for the given theme
3320 * @param th The theme to set the search order, or if NULL, the default theme
3321 * @param theme Theme search string
3323 * This sets the search string for the theme in path-notation from first
3324 * theme to search, to last, delimited by the : character. Example:
3326 * "shiny:/path/to/file.edj:default"
3328 * See the ELM_THEME environment variable for more information.
3330 * @see elm_theme_get()
3331 * @see elm_theme_list_get()
3333 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3335 * Return the theme search order
3337 * @param th The theme to get the search order, or if NULL, the default theme
3338 * @return The internal search order path
3340 * This function returns a colon separated string of theme elements as
3341 * returned by elm_theme_list_get().
3343 * @see elm_theme_set()
3344 * @see elm_theme_list_get()
3346 EAPI const char *elm_theme_get(Elm_Theme *th);
3348 * Return a list of theme elements to be used in a theme.
3350 * @param th Theme to get the list of theme elements from.
3351 * @return The internal list of theme elements
3353 * This returns the internal list of theme elements (will only be valid as
3354 * long as the theme is not modified by elm_theme_set() or theme is not
3355 * freed by elm_theme_free(). This is a list of strings which must not be
3356 * altered as they are also internal. If @p th is NULL, then the default
3357 * theme element list is returned.
3359 * A theme element can consist of a full or relative path to a .edj file,
3360 * or a name, without extension, for a theme to be searched in the known
3361 * theme paths for Elemementary.
3363 * @see elm_theme_set()
3364 * @see elm_theme_get()
3366 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3368 * Return the full patrh for a theme element
3370 * @param f The theme element name
3371 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3372 * @return The full path to the file found.
3374 * This returns a string you should free with free() on success, NULL on
3375 * failure. This will search for the given theme element, and if it is a
3376 * full or relative path element or a simple searchable name. The returned
3377 * path is the full path to the file, if searched, and the file exists, or it
3378 * is simply the full path given in the element or a resolved path if
3379 * relative to home. The @p in_search_path boolean pointed to is set to
3380 * EINA_TRUE if the file was a searchable file andis in the search path,
3381 * and EINA_FALSE otherwise.
3383 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3385 * Flush the current theme.
3387 * @param th Theme to flush
3389 * This flushes caches that let elementary know where to find theme elements
3390 * in the given theme. If @p th is NULL, then the default theme is flushed.
3391 * Call this function if source theme data has changed in such a way as to
3392 * make any caches Elementary kept invalid.
3394 EAPI void elm_theme_flush(Elm_Theme *th);
3396 * This flushes all themes (default and specific ones).
3398 * This will flush all themes in the current application context, by calling
3399 * elm_theme_flush() on each of them.
3401 EAPI void elm_theme_full_flush(void);
3403 * Set the theme for all elementary using applications on the current display
3405 * @param theme The name of the theme to use. Format same as the ELM_THEME
3406 * environment variable.
3408 EAPI void elm_theme_all_set(const char *theme);
3410 * Return a list of theme elements in the theme search path
3412 * @return A list of strings that are the theme element names.
3414 * This lists all available theme files in the standard Elementary search path
3415 * for theme elements, and returns them in alphabetical order as theme
3416 * element names in a list of strings. Free this with
3417 * elm_theme_name_available_list_free() when you are done with the list.
3419 EAPI Eina_List *elm_theme_name_available_list_new(void);
3421 * Free the list returned by elm_theme_name_available_list_new()
3423 * This frees the list of themes returned by
3424 * elm_theme_name_available_list_new(). Once freed the list should no longer
3425 * be used. a new list mys be created.
3427 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3429 * Set a specific theme to be used for this object and its children
3431 * @param obj The object to set the theme on
3432 * @param th The theme to set
3434 * This sets a specific theme that will be used for the given object and any
3435 * child objects it has. If @p th is NULL then the theme to be used is
3436 * cleared and the object will inherit its theme from its parent (which
3437 * ultimately will use the default theme if no specific themes are set).
3439 * Use special themes with great care as this will annoy users and make
3440 * configuration difficult. Avoid any custom themes at all if it can be
3443 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3445 * Get the specific theme to be used
3447 * @param obj The object to get the specific theme from
3448 * @return The specifc theme set.
3450 * This will return a specific theme set, or NULL if no specific theme is
3451 * set on that object. It will not return inherited themes from parents, only
3452 * the specific theme set for that specific object. See elm_object_theme_set()
3453 * for more information.
3455 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3458 * Get a data item from a theme
3460 * @param th The theme, or NULL for default theme
3461 * @param key The data key to search with
3462 * @return The data value, or NULL on failure
3464 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3465 * It works the same way as edje_file_data_get() except that the return is stringshared.
3467 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3473 /** @defgroup Win Win
3475 * @image html img/widget/win/preview-00.png
3476 * @image latex img/widget/win/preview-00.eps
3478 * The window class of Elementary. Contains functions to manipulate
3479 * windows. The Evas engine used to render the window contents is specified
3480 * in the system or user elementary config files (whichever is found last),
3481 * and can be overridden with the ELM_ENGINE environment variable for
3482 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3483 * compilation setup and modules actually installed at runtime) are (listed
3484 * in order of best supported and most likely to be complete and work to
3487 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3488 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3490 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3492 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3494 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3496 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3497 * rendering using SDL as the buffer)
3498 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3499 * GDI with software)
3500 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3501 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3502 * grayscale using dedicated 8bit software engine in X11)
3503 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3504 * X11 using 16bit software engine)
3505 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3506 * (Windows CE rendering via GDI with 16bit software renderer)
3507 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3508 * buffer with 16bit software renderer)
3510 * All engines use a simple string to select the engine to render, EXCEPT
3511 * the "shot" engine. This actually encodes the output of the virtual
3512 * screenshot and how long to delay in the engine string. The engine string
3513 * is encoded in the following way:
3515 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3517 * Where options are separated by a ":" char if more than one option is
3518 * given, with delay, if provided being the first option and file the last
3519 * (order is important). The delay specifies how long to wait after the
3520 * window is shown before doing the virtual "in memory" rendering and then
3521 * save the output to the file specified by the file option (and then exit).
3522 * If no delay is given, the default is 0.5 seconds. If no file is given the
3523 * default output file is "out.png". Repeat option is for continous
3524 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3525 * fixed to "out001.png" Some examples of using the shot engine:
3527 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3528 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3529 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3530 * ELM_ENGINE="shot:delay=2.0" elementary_test
3531 * ELM_ENGINE="shot:" elementary_test
3533 * Signals that you can add callbacks for are:
3535 * @li "delete,request": the user requested to close the window. See
3536 * elm_win_autodel_set().
3537 * @li "focus,in": window got focus
3538 * @li "focus,out": window lost focus
3539 * @li "moved": window that holds the canvas was moved
3542 * @li @ref win_example_01
3547 * Defines the types of window that can be created
3549 * These are hints set on the window so that a running Window Manager knows
3550 * how the window should be handled and/or what kind of decorations it
3553 * Currently, only the X11 backed engines use them.
3555 typedef enum _Elm_Win_Type
3557 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3558 window. Almost every window will be created with this
3560 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3561 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3562 window holding desktop icons. */
3563 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3564 be kept on top of any other window by the Window
3566 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3568 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3569 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3571 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3572 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3573 entry in a menubar is clicked. Typically used
3574 with elm_win_override_set(). This hint exists
3575 for completion only, as the EFL way of
3576 implementing a menu would not normally use a
3577 separate window for its contents. */
3578 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3579 triggered by right-clicking an object. */
3580 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3581 explanatory text that typically appear after the
3582 mouse cursor hovers over an object for a while.
3583 Typically used with elm_win_override_set() and also
3584 not very commonly used in the EFL. */
3585 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3586 battery life or a new E-Mail received. */
3587 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3588 usually used in the EFL. */
3589 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3590 object being dragged across different windows, or even
3591 applications. Typically used with
3592 elm_win_override_set(). */
3593 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3594 buffer. No actual window is created for this
3595 type, instead the window and all of its
3596 contents will be rendered to an image buffer.
3597 This allows to have children window inside a
3598 parent one just like any other object would
3599 be, and do other things like applying @c
3600 Evas_Map effects to it. This is the only type
3601 of window that requires the @c parent
3602 parameter of elm_win_add() to be a valid @c
3607 * The differents layouts that can be requested for the virtual keyboard.
3609 * When the application window is being managed by Illume, it may request
3610 * any of the following layouts for the virtual keyboard.
3612 typedef enum _Elm_Win_Keyboard_Mode
3614 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3615 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3616 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3617 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3618 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3619 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3620 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3621 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3622 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3623 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3624 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3625 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3626 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3627 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3628 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3629 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3630 } Elm_Win_Keyboard_Mode;
3633 * Available commands that can be sent to the Illume manager.
3635 * When running under an Illume session, a window may send commands to the
3636 * Illume manager to perform different actions.
3638 typedef enum _Elm_Illume_Command
3640 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3642 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3644 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3646 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3647 } Elm_Illume_Command;
3650 * Adds a window object. If this is the first window created, pass NULL as
3653 * @param parent Parent object to add the window to, or NULL
3654 * @param name The name of the window
3655 * @param type The window type, one of #Elm_Win_Type.
3657 * The @p parent paramter can be @c NULL for every window @p type except
3658 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3659 * which the image object will be created.
3661 * @return The created object, or NULL on failure
3663 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3665 * Add @p subobj as a resize object of window @p obj.
3668 * Setting an object as a resize object of the window means that the
3669 * @p subobj child's size and position will be controlled by the window
3670 * directly. That is, the object will be resized to match the window size
3671 * and should never be moved or resized manually by the developer.
3673 * In addition, resize objects of the window control what the minimum size
3674 * of it will be, as well as whether it can or not be resized by the user.
3676 * For the end user to be able to resize a window by dragging the handles
3677 * or borders provided by the Window Manager, or using any other similar
3678 * mechanism, all of the resize objects in the window should have their
3679 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3681 * @param obj The window object
3682 * @param subobj The resize object to add
3684 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3686 * Delete @p subobj as a resize object of window @p obj.
3688 * This function removes the object @p subobj from the resize objects of
3689 * the window @p obj. It will not delete the object itself, which will be
3690 * left unmanaged and should be deleted by the developer, manually handled
3691 * or set as child of some other container.
3693 * @param obj The window object
3694 * @param subobj The resize object to add
3696 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3698 * Set the title of the window
3700 * @param obj The window object
3701 * @param title The title to set
3703 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3705 * Get the title of the window
3707 * The returned string is an internal one and should not be freed or
3708 * modified. It will also be rendered invalid if a new title is set or if
3709 * the window is destroyed.
3711 * @param obj The window object
3714 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3716 * Set the window's autodel state.
3718 * When closing the window in any way outside of the program control, like
3719 * pressing the X button in the titlebar or using a command from the
3720 * Window Manager, a "delete,request" signal is emitted to indicate that
3721 * this event occurred and the developer can take any action, which may
3722 * include, or not, destroying the window object.
3724 * When the @p autodel parameter is set, the window will be automatically
3725 * destroyed when this event occurs, after the signal is emitted.
3726 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3727 * and is up to the program to do so when it's required.
3729 * @param obj The window object
3730 * @param autodel If true, the window will automatically delete itself when
3733 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3735 * Get the window's autodel state.
3737 * @param obj The window object
3738 * @return If the window will automatically delete itself when closed
3740 * @see elm_win_autodel_set()
3742 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3744 * Activate a window object.
3746 * This function sends a request to the Window Manager to activate the
3747 * window pointed by @p obj. If honored by the WM, the window will receive
3748 * the keyboard focus.
3750 * @note This is just a request that a Window Manager may ignore, so calling
3751 * this function does not ensure in any way that the window will be the
3752 * active one after it.
3754 * @param obj The window object
3756 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3758 * Lower a window object.
3760 * Places the window pointed by @p obj at the bottom of the stack, so that
3761 * no other window is covered by it.
3763 * If elm_win_override_set() is not set, the Window Manager may ignore this
3766 * @param obj The window object
3768 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3770 * Raise a window object.
3772 * Places the window pointed by @p obj at the top of the stack, so that it's
3773 * not covered by any other window.
3775 * If elm_win_override_set() is not set, the Window Manager may ignore this
3778 * @param obj The window object
3780 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3782 * Set the borderless state of a window.
3784 * This function requests the Window Manager to not draw any decoration
3785 * around the window.
3787 * @param obj The window object
3788 * @param borderless If true, the window is borderless
3790 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3792 * Get the borderless state of a window.
3794 * @param obj The window object
3795 * @return If true, the window is borderless
3797 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3799 * Set the shaped state of a window.
3801 * Shaped windows, when supported, will render the parts of the window that
3802 * has no content, transparent.
3804 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3805 * background object or cover the entire window in any other way, or the
3806 * parts of the canvas that have no data will show framebuffer artifacts.
3808 * @param obj The window object
3809 * @param shaped If true, the window is shaped
3811 * @see elm_win_alpha_set()
3813 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3815 * Get the shaped state of a window.
3817 * @param obj The window object
3818 * @return If true, the window is shaped
3820 * @see elm_win_shaped_set()
3822 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3824 * Set the alpha channel state of a window.
3826 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3827 * possibly making parts of the window completely or partially transparent.
3828 * This is also subject to the underlying system supporting it, like for
3829 * example, running under a compositing manager. If no compositing is
3830 * available, enabling this option will instead fallback to using shaped
3831 * windows, with elm_win_shaped_set().
3833 * @param obj The window object
3834 * @param alpha If true, the window has an alpha channel
3836 * @see elm_win_alpha_set()
3838 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3840 * Get the transparency state of a window.
3842 * @param obj The window object
3843 * @return If true, the window is transparent
3845 * @see elm_win_transparent_set()
3847 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3849 * Set the transparency state of a window.
3851 * Use elm_win_alpha_set() instead.
3853 * @param obj The window object
3854 * @param transparent If true, the window is transparent
3856 * @see elm_win_alpha_set()
3858 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3860 * Get the alpha channel state of a window.
3862 * @param obj The window object
3863 * @return If true, the window has an alpha channel
3865 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3867 * Set the override state of a window.
3869 * A window with @p override set to EINA_TRUE will not be managed by the
3870 * Window Manager. This means that no decorations of any kind will be shown
3871 * for it, moving and resizing must be handled by the application, as well
3872 * as the window visibility.
3874 * This should not be used for normal windows, and even for not so normal
3875 * ones, it should only be used when there's a good reason and with a lot
3876 * of care. Mishandling override windows may result situations that
3877 * disrupt the normal workflow of the end user.
3879 * @param obj The window object
3880 * @param override If true, the window is overridden
3882 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3884 * Get the override state of a window.
3886 * @param obj The window object
3887 * @return If true, the window is overridden
3889 * @see elm_win_override_set()
3891 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3893 * Set the fullscreen state of a window.
3895 * @param obj The window object
3896 * @param fullscreen If true, the window is fullscreen
3898 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3900 * Get the fullscreen state of a window.
3902 * @param obj The window object
3903 * @return If true, the window is fullscreen
3905 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3907 * Set the maximized state of a window.
3909 * @param obj The window object
3910 * @param maximized If true, the window is maximized
3912 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3914 * Get the maximized state of a window.
3916 * @param obj The window object
3917 * @return If true, the window is maximized
3919 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3921 * Set the iconified state of a window.
3923 * @param obj The window object
3924 * @param iconified If true, the window is iconified
3926 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3928 * Get the iconified state of a window.
3930 * @param obj The window object
3931 * @return If true, the window is iconified
3933 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3935 * Set the layer of the window.
3937 * What this means exactly will depend on the underlying engine used.
3939 * In the case of X11 backed engines, the value in @p layer has the
3940 * following meanings:
3941 * @li < 3: The window will be placed below all others.
3942 * @li > 5: The window will be placed above all others.
3943 * @li other: The window will be placed in the default layer.
3945 * @param obj The window object
3946 * @param layer The layer of the window
3948 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3950 * Get the layer of the window.
3952 * @param obj The window object
3953 * @return The layer of the window
3955 * @see elm_win_layer_set()
3957 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3959 * Set the rotation of the window.
3961 * Most engines only work with multiples of 90.
3963 * This function is used to set the orientation of the window @p obj to
3964 * match that of the screen. The window itself will be resized to adjust
3965 * to the new geometry of its contents. If you want to keep the window size,
3966 * see elm_win_rotation_with_resize_set().
3968 * @param obj The window object
3969 * @param rotation The rotation of the window, in degrees (0-360),
3970 * counter-clockwise.
3972 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3974 * Rotates the window and resizes it.
3976 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3977 * that they fit inside the current window geometry.
3979 * @param obj The window object
3980 * @param layer The rotation of the window in degrees (0-360),
3981 * counter-clockwise.
3983 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3985 * Get the rotation of the window.
3987 * @param obj The window object
3988 * @return The rotation of the window in degrees (0-360)
3990 * @see elm_win_rotation_set()
3991 * @see elm_win_rotation_with_resize_set()
3993 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3995 * Set the sticky state of the window.
3997 * Hints the Window Manager that the window in @p obj should be left fixed
3998 * at its position even when the virtual desktop it's on moves or changes.
4000 * @param obj The window object
4001 * @param sticky If true, the window's sticky state is enabled
4003 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4005 * Get the sticky state of the window.
4007 * @param obj The window object
4008 * @return If true, the window's sticky state is enabled
4010 * @see elm_win_sticky_set()
4012 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4014 * Set if this window is an illume conformant window
4016 * @param obj The window object
4017 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4019 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4021 * Get if this window is an illume conformant window
4023 * @param obj The window object
4024 * @return A boolean if this window is illume conformant or not
4026 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4028 * Set a window to be an illume quickpanel window
4030 * By default window objects are not quickpanel windows.
4032 * @param obj The window object
4033 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4035 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4037 * Get if this window is a quickpanel or not
4039 * @param obj The window object
4040 * @return A boolean if this window is a quickpanel or not
4042 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044 * Set the major priority of a quickpanel window
4046 * @param obj The window object
4047 * @param priority The major priority for this quickpanel
4049 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4051 * Get the major priority of a quickpanel window
4053 * @param obj The window object
4054 * @return The major priority of this quickpanel
4056 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4058 * Set the minor priority of a quickpanel window
4060 * @param obj The window object
4061 * @param priority The minor priority for this quickpanel
4063 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4065 * Get the minor priority of a quickpanel window
4067 * @param obj The window object
4068 * @return The minor priority of this quickpanel
4070 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072 * Set which zone this quickpanel should appear in
4074 * @param obj The window object
4075 * @param zone The requested zone for this quickpanel
4077 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4079 * Get which zone this quickpanel should appear in
4081 * @param obj The window object
4082 * @return The requested zone for this quickpanel
4084 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4086 * Set the window to be skipped by keyboard focus
4088 * This sets the window to be skipped by normal keyboard input. This means
4089 * a window manager will be asked to not focus this window as well as omit
4090 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4092 * Call this and enable it on a window BEFORE you show it for the first time,
4093 * otherwise it may have no effect.
4095 * Use this for windows that have only output information or might only be
4096 * interacted with by the mouse or fingers, and never for typing input.
4097 * Be careful that this may have side-effects like making the window
4098 * non-accessible in some cases unless the window is specially handled. Use
4101 * @param obj The window object
4102 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4104 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4106 * Send a command to the windowing environment
4108 * This is intended to work in touchscreen or small screen device
4109 * environments where there is a more simplistic window management policy in
4110 * place. This uses the window object indicated to select which part of the
4111 * environment to control (the part that this window lives in), and provides
4112 * a command and an optional parameter structure (use NULL for this if not
4115 * @param obj The window object that lives in the environment to control
4116 * @param command The command to send
4117 * @param params Optional parameters for the command
4119 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4121 * Get the inlined image object handle
4123 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4124 * then the window is in fact an evas image object inlined in the parent
4125 * canvas. You can get this object (be careful to not manipulate it as it
4126 * is under control of elementary), and use it to do things like get pixel
4127 * data, save the image to a file, etc.
4129 * @param obj The window object to get the inlined image from
4130 * @return The inlined image object, or NULL if none exists
4132 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4134 * Set the enabled status for the focus highlight in a window
4136 * This function will enable or disable the focus highlight only for the
4137 * given window, regardless of the global setting for it
4139 * @param obj The window where to enable the highlight
4140 * @param enabled The enabled value for the highlight
4142 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4144 * Get the enabled value of the focus highlight for this window
4146 * @param obj The window in which to check if the focus highlight is enabled
4148 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4150 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152 * Set the style for the focus highlight on this window
4154 * Sets the style to use for theming the highlight of focused objects on
4155 * the given window. If @p style is NULL, the default will be used.
4157 * @param obj The window where to set the style
4158 * @param style The style to set
4160 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4162 * Get the style set for the focus highlight object
4164 * Gets the style set for this windows highilght object, or NULL if none
4167 * @param obj The window to retrieve the highlights style from
4169 * @return The style set or NULL if none was. Default is used in that case.
4171 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4173 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4174 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4175 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4176 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4177 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4178 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4179 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4181 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4182 * (blank mouse, private mouse obj, defaultmouse)
4186 * Sets the keyboard mode of the window.
4188 * @param obj The window object
4189 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4191 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4193 * Gets the keyboard mode of the window.
4195 * @param obj The window object
4196 * @return The mode, one of #Elm_Win_Keyboard_Mode
4198 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4200 * Sets whether the window is a keyboard.
4202 * @param obj The window object
4203 * @param is_keyboard If true, the window is a virtual keyboard
4205 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4207 * Gets whether the window is a keyboard.
4209 * @param obj The window object
4210 * @return If the window is a virtual keyboard
4212 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4215 * Get the screen position of a window.
4217 * @param obj The window object
4218 * @param x The int to store the x coordinate to
4219 * @param y The int to store the y coordinate to
4221 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4227 * @defgroup Inwin Inwin
4229 * @image html img/widget/inwin/preview-00.png
4230 * @image latex img/widget/inwin/preview-00.eps
4231 * @image html img/widget/inwin/preview-01.png
4232 * @image latex img/widget/inwin/preview-01.eps
4233 * @image html img/widget/inwin/preview-02.png
4234 * @image latex img/widget/inwin/preview-02.eps
4236 * An inwin is a window inside a window that is useful for a quick popup.
4237 * It does not hover.
4239 * It works by creating an object that will occupy the entire window, so it
4240 * must be created using an @ref Win "elm_win" as parent only. The inwin
4241 * object can be hidden or restacked below every other object if it's
4242 * needed to show what's behind it without destroying it. If this is done,
4243 * the elm_win_inwin_activate() function can be used to bring it back to
4244 * full visibility again.
4246 * There are three styles available in the default theme. These are:
4247 * @li default: The inwin is sized to take over most of the window it's
4249 * @li minimal: The size of the inwin will be the minimum necessary to show
4251 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4252 * possible, but it's sized vertically the most it needs to fit its\
4255 * Some examples of Inwin can be found in the following:
4256 * @li @ref inwin_example_01
4261 * Adds an inwin to the current window
4263 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4264 * Never call this function with anything other than the top-most window
4265 * as its parameter, unless you are fond of undefined behavior.
4267 * After creating the object, the widget will set itself as resize object
4268 * for the window with elm_win_resize_object_add(), so when shown it will
4269 * appear to cover almost the entire window (how much of it depends on its
4270 * content and the style used). It must not be added into other container
4271 * objects and it needs not be moved or resized manually.
4273 * @param parent The parent object
4274 * @return The new object or NULL if it cannot be created
4276 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4278 * Activates an inwin object, ensuring its visibility
4280 * This function will make sure that the inwin @p obj is completely visible
4281 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4282 * to the front. It also sets the keyboard focus to it, which will be passed
4285 * The object's theme will also receive the signal "elm,action,show" with
4288 * @param obj The inwin to activate
4290 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4292 * Set the content of an inwin object.
4294 * Once the content object is set, a previously set one will be deleted.
4295 * If you want to keep that old content object, use the
4296 * elm_win_inwin_content_unset() function.
4298 * @param obj The inwin object
4299 * @param content The object to set as content
4301 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4303 * Get the content of an inwin object.
4305 * Return the content object which is set for this widget.
4307 * The returned object is valid as long as the inwin is still alive and no
4308 * other content is set on it. Deleting the object will notify the inwin
4309 * about it and this one will be left empty.
4311 * If you need to remove an inwin's content to be reused somewhere else,
4312 * see elm_win_inwin_content_unset().
4314 * @param obj The inwin object
4315 * @return The content that is being used
4317 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4319 * Unset the content of an inwin object.
4321 * Unparent and return the content object which was set for this widget.
4323 * @param obj The inwin object
4324 * @return The content that was being used
4326 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 /* X specific calls - won't work on non-x engines (return 0) */
4333 * Get the Ecore_X_Window of an Evas_Object
4335 * @param obj The object
4337 * @return The Ecore_X_Window of @p obj
4341 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4343 /* smart callbacks called:
4344 * "delete,request" - the user requested to delete the window
4345 * "focus,in" - window got focus
4346 * "focus,out" - window lost focus
4347 * "moved" - window that holds the canvas was moved
4353 * @image html img/widget/bg/preview-00.png
4354 * @image latex img/widget/bg/preview-00.eps
4356 * @brief Background object, used for setting a solid color, image or Edje
4357 * group as background to a window or any container object.
4359 * The bg object is used for setting a solid background to a window or
4360 * packing into any container object. It works just like an image, but has
4361 * some properties useful to a background, like setting it to tiled,
4362 * centered, scaled or stretched.
4364 * Here is some sample code using it:
4365 * @li @ref bg_01_example_page
4366 * @li @ref bg_02_example_page
4367 * @li @ref bg_03_example_page
4371 typedef enum _Elm_Bg_Option
4373 ELM_BG_OPTION_CENTER, /**< center the background */
4374 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4375 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4376 ELM_BG_OPTION_TILE /**< tile background at its original size */
4380 * Add a new background to the parent
4382 * @param parent The parent object
4383 * @return The new object or NULL if it cannot be created
4387 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4390 * Set the file (image or edje) used for the background
4392 * @param obj The bg object
4393 * @param file The file path
4394 * @param group Optional key (group in Edje) within the file
4396 * This sets the image file used in the background object. The image (or edje)
4397 * will be stretched (retaining aspect if its an image file) to completely fill
4398 * the bg object. This may mean some parts are not visible.
4400 * @note Once the image of @p obj is set, a previously set one will be deleted,
4401 * even if @p file is NULL.
4405 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4408 * Get the file (image or edje) used for the background
4410 * @param obj The bg object
4411 * @param file The file path
4412 * @param group Optional key (group in Edje) within the file
4416 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4419 * Set the option used for the background image
4421 * @param obj The bg object
4422 * @param option The desired background option (TILE, SCALE)
4424 * This sets the option used for manipulating the display of the background
4425 * image. The image can be tiled or scaled.
4429 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4432 * Get the option used for the background image
4434 * @param obj The bg object
4435 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4439 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4441 * Set the option used for the background color
4443 * @param obj The bg object
4448 * This sets the color used for the background rectangle. Its range goes
4453 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4455 * Get the option used for the background color
4457 * @param obj The bg object
4464 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4467 * Set the overlay object used for the background object.
4469 * @param obj The bg object
4470 * @param overlay The overlay object
4472 * This provides a way for elm_bg to have an 'overlay' that will be on top
4473 * of the bg. Once the over object is set, a previously set one will be
4474 * deleted, even if you set the new one to NULL. If you want to keep that
4475 * old content object, use the elm_bg_overlay_unset() function.
4480 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4483 * Get the overlay object used for the background object.
4485 * @param obj The bg object
4486 * @return The content that is being used
4488 * Return the content object which is set for this widget
4492 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4495 * Get the overlay object used for the background object.
4497 * @param obj The bg object
4498 * @return The content that was being used
4500 * Unparent and return the overlay object which was set for this widget
4504 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4507 * Set the size of the pixmap representation of the image.
4509 * This option just makes sense if an image is going to be set in the bg.
4511 * @param obj The bg object
4512 * @param w The new width of the image pixmap representation.
4513 * @param h The new height of the image pixmap representation.
4515 * This function sets a new size for pixmap representation of the given bg
4516 * image. It allows the image to be loaded already in the specified size,
4517 * reducing the memory usage and load time when loading a big image with load
4518 * size set to a smaller size.
4520 * NOTE: this is just a hint, the real size of the pixmap may differ
4521 * depending on the type of image being loaded, being bigger than requested.
4525 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4526 /* smart callbacks called:
4530 * @defgroup Icon Icon
4532 * @image html img/widget/icon/preview-00.png
4533 * @image latex img/widget/icon/preview-00.eps
4535 * An object that provides standard icon images (delete, edit, arrows, etc.)
4536 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4538 * The icon image requested can be in the elementary theme, or in the
4539 * freedesktop.org paths. It's possible to set the order of preference from
4540 * where the image will be used.
4542 * This API is very similar to @ref Image, but with ready to use images.
4544 * Default images provided by the theme are described below.
4546 * The first list contains icons that were first intended to be used in
4547 * toolbars, but can be used in many other places too:
4563 * Now some icons that were designed to be used in menus (but again, you can
4564 * use them anywhere else):
4569 * @li menu/arrow_down
4570 * @li menu/arrow_left
4571 * @li menu/arrow_right
4580 * And here we have some media player specific icons:
4581 * @li media_player/forward
4582 * @li media_player/info
4583 * @li media_player/next
4584 * @li media_player/pause
4585 * @li media_player/play
4586 * @li media_player/prev
4587 * @li media_player/rewind
4588 * @li media_player/stop
4590 * Signals that you can add callbacks for are:
4592 * "clicked" - This is called when a user has clicked the icon
4594 * An example of usage for this API follows:
4595 * @li @ref tutorial_icon
4603 typedef enum _Elm_Icon_Type
4610 * @enum _Elm_Icon_Lookup_Order
4611 * @typedef Elm_Icon_Lookup_Order
4613 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4614 * theme, FDO paths, or both?
4618 typedef enum _Elm_Icon_Lookup_Order
4620 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4621 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4622 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4623 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4624 } Elm_Icon_Lookup_Order;
4627 * Add a new icon object to the parent.
4629 * @param parent The parent object
4630 * @return The new object or NULL if it cannot be created
4632 * @see elm_icon_file_set()
4636 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4638 * Set the file that will be used as icon.
4640 * @param obj The icon object
4641 * @param file The path to file that will be used as icon image
4642 * @param group The group that the icon belongs to in edje file
4644 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4646 * @note The icon image set by this function can be changed by
4647 * elm_icon_standard_set().
4649 * @see elm_icon_file_get()
4653 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4655 * Set a location in memory to be used as an icon
4657 * @param obj The icon object
4658 * @param img The binary data that will be used as an image
4659 * @param size The size of binary data @p img
4660 * @param format Optional format of @p img to pass to the image loader
4661 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4663 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4665 * @note The icon image set by this function can be changed by
4666 * elm_icon_standard_set().
4670 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);
4672 * Get the file that will be used as icon.
4674 * @param obj The icon object
4675 * @param file The path to file that will be used as icon icon image
4676 * @param group The group that the icon belongs to in edje file
4678 * @see elm_icon_file_set()
4682 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4683 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4685 * Set the icon by icon standards names.
4687 * @param obj The icon object
4688 * @param name The icon name
4690 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4692 * For example, freedesktop.org defines standard icon names such as "home",
4693 * "network", etc. There can be different icon sets to match those icon
4694 * keys. The @p name given as parameter is one of these "keys", and will be
4695 * used to look in the freedesktop.org paths and elementary theme. One can
4696 * change the lookup order with elm_icon_order_lookup_set().
4698 * If name is not found in any of the expected locations and it is the
4699 * absolute path of an image file, this image will be used.
4701 * @note The icon image set by this function can be changed by
4702 * elm_icon_file_set().
4704 * @see elm_icon_standard_get()
4705 * @see elm_icon_file_set()
4709 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4711 * Get the icon name set by icon standard names.
4713 * @param obj The icon object
4714 * @return The icon name
4716 * If the icon image was set using elm_icon_file_set() instead of
4717 * elm_icon_standard_set(), then this function will return @c NULL.
4719 * @see elm_icon_standard_set()
4723 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4725 * Set the smooth effect for an icon object.
4727 * @param obj The icon object
4728 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4729 * otherwise. Default is @c EINA_TRUE.
4731 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4732 * scaling provides a better resulting image, but is slower.
4734 * The smooth scaling should be disabled when making animations that change
4735 * the icon size, since they will be faster. Animations that don't require
4736 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4737 * is already scaled, since the scaled icon image will be cached).
4739 * @see elm_icon_smooth_get()
4743 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4745 * Get the smooth effect for an icon object.
4747 * @param obj The icon object
4748 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4750 * @see elm_icon_smooth_set()
4754 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4756 * Disable scaling of this object.
4758 * @param obj The icon object.
4759 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4760 * otherwise. Default is @c EINA_FALSE.
4762 * This function disables scaling of the icon object through the function
4763 * elm_object_scale_set(). However, this does not affect the object
4764 * size/resize in any way. For that effect, take a look at
4765 * elm_icon_scale_set().
4767 * @see elm_icon_no_scale_get()
4768 * @see elm_icon_scale_set()
4769 * @see elm_object_scale_set()
4773 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4775 * Get whether scaling is disabled on the object.
4777 * @param obj The icon object
4778 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4780 * @see elm_icon_no_scale_set()
4784 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4786 * Set if the object is (up/down) resizable.
4788 * @param obj The icon object
4789 * @param scale_up A bool to set if the object is resizable up. Default is
4791 * @param scale_down A bool to set if the object is resizable down. Default
4794 * This function limits the icon object resize ability. If @p scale_up is set to
4795 * @c EINA_FALSE, the object can't have its height or width resized to a value
4796 * higher than the original icon size. Same is valid for @p scale_down.
4798 * @see elm_icon_scale_get()
4802 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4804 * Get if the object is (up/down) resizable.
4806 * @param obj The icon object
4807 * @param scale_up A bool to set if the object is resizable up
4808 * @param scale_down A bool to set if the object is resizable down
4810 * @see elm_icon_scale_set()
4814 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4816 * Get the object's image size
4818 * @param obj The icon object
4819 * @param w A pointer to store the width in
4820 * @param h A pointer to store the height in
4824 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4826 * Set if the icon fill the entire object area.
4828 * @param obj The icon object
4829 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4830 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4832 * When the icon object is resized to a different aspect ratio from the
4833 * original icon image, the icon image will still keep its aspect. This flag
4834 * tells how the image should fill the object's area. They are: keep the
4835 * entire icon inside the limits of height and width of the object (@p
4836 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4837 * of the object, and the icon will fill the entire object (@p fill_outside
4840 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4841 * retain property to false. Thus, the icon image will always keep its
4842 * original aspect ratio.
4844 * @see elm_icon_fill_outside_get()
4845 * @see elm_image_fill_outside_set()
4849 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4851 * Get if the object is filled outside.
4853 * @param obj The icon object
4854 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4856 * @see elm_icon_fill_outside_set()
4860 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4862 * Set the prescale size for the icon.
4864 * @param obj The icon object
4865 * @param size The prescale size. This value is used for both width and
4868 * This function sets a new size for pixmap representation of the given
4869 * icon. It allows the icon to be loaded already in the specified size,
4870 * reducing the memory usage and load time when loading a big icon with load
4871 * size set to a smaller size.
4873 * It's equivalent to the elm_bg_load_size_set() function for bg.
4875 * @note this is just a hint, the real size of the pixmap may differ
4876 * depending on the type of icon being loaded, being bigger than requested.
4878 * @see elm_icon_prescale_get()
4879 * @see elm_bg_load_size_set()
4883 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4885 * Get the prescale size for the icon.
4887 * @param obj The icon object
4888 * @return The prescale size
4890 * @see elm_icon_prescale_set()
4894 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4896 * Sets the icon lookup order used by elm_icon_standard_set().
4898 * @param obj The icon object
4899 * @param order The icon lookup order (can be one of
4900 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4901 * or ELM_ICON_LOOKUP_THEME)
4903 * @see elm_icon_order_lookup_get()
4904 * @see Elm_Icon_Lookup_Order
4908 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4910 * Gets the icon lookup order.
4912 * @param obj The icon object
4913 * @return The icon lookup order
4915 * @see elm_icon_order_lookup_set()
4916 * @see Elm_Icon_Lookup_Order
4920 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4922 * Get if the icon supports animation or not.
4924 * @param obj The icon object
4925 * @return @c EINA_TRUE if the icon supports animation,
4926 * @c EINA_FALSE otherwise.
4928 * Return if this elm icon's image can be animated. Currently Evas only
4929 * supports gif animation. If the return value is EINA_FALSE, other
4930 * elm_icon_animated_XXX APIs won't work.
4933 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4935 * Set animation mode of the icon.
4937 * @param obj The icon object
4938 * @param anim @c EINA_TRUE if the object do animation job,
4939 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4941 * Even though elm icon's file can be animated,
4942 * sometimes appication developer want to just first page of image.
4943 * In that time, don't call this function, because default value is EINA_FALSE
4944 * Only when you want icon support anition,
4945 * use this function and set animated to EINA_TURE
4948 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4950 * Get animation mode of the icon.
4952 * @param obj The icon object
4953 * @return The animation mode of the icon object
4954 * @see elm_icon_animated_set
4957 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4959 * Set animation play mode of the icon.
4961 * @param obj The icon object
4962 * @param play @c EINA_TRUE the object play animation images,
4963 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4965 * If you want to play elm icon's animation, you set play to EINA_TURE.
4966 * For example, you make gif player using this set/get API and click event.
4968 * 1. Click event occurs
4969 * 2. Check play flag using elm_icon_animaged_play_get
4970 * 3. If elm icon was playing, set play to EINA_FALSE.
4971 * Then animation will be stopped and vice versa
4974 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4976 * Get animation play mode of the icon.
4978 * @param obj The icon object
4979 * @return The play mode of the icon object
4981 * @see elm_icon_animated_lay_get
4984 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4991 * @defgroup Image Image
4993 * @image html img/widget/image/preview-00.png
4994 * @image latex img/widget/image/preview-00.eps
4997 * An object that allows one to load an image file to it. It can be used
4998 * anywhere like any other elementary widget.
5000 * This widget provides most of the functionality provided from @ref Bg or @ref
5001 * Icon, but with a slightly different API (use the one that fits better your
5004 * The features not provided by those two other image widgets are:
5005 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5006 * @li change the object orientation with elm_image_orient_set();
5007 * @li and turning the image editable with elm_image_editable_set().
5009 * Signals that you can add callbacks for are:
5011 * @li @c "clicked" - This is called when a user has clicked the image
5013 * An example of usage for this API follows:
5014 * @li @ref tutorial_image
5023 * @enum _Elm_Image_Orient
5024 * @typedef Elm_Image_Orient
5026 * Possible orientation options for elm_image_orient_set().
5028 * @image html elm_image_orient_set.png
5029 * @image latex elm_image_orient_set.eps width=\textwidth
5033 typedef enum _Elm_Image_Orient
5035 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5036 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5037 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5038 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5039 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5040 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5041 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5042 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5046 * Add a new image to the parent.
5048 * @param parent The parent object
5049 * @return The new object or NULL if it cannot be created
5051 * @see elm_image_file_set()
5055 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5057 * Set the file that will be used as image.
5059 * @param obj The image object
5060 * @param file The path to file that will be used as image
5061 * @param group The group that the image belongs in edje file (if it's an
5064 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5066 * @see elm_image_file_get()
5070 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5072 * Get the file that will be used as image.
5074 * @param obj The image object
5075 * @param file The path to file
5076 * @param group The group that the image belongs in edje file
5078 * @see elm_image_file_set()
5082 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5084 * Set the smooth effect for an image.
5086 * @param obj The image object
5087 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5088 * otherwise. Default is @c EINA_TRUE.
5090 * Set the scaling algorithm to be used when scaling the image. Smooth
5091 * scaling provides a better resulting image, but is slower.
5093 * The smooth scaling should be disabled when making animations that change
5094 * the image size, since it will be faster. Animations that don't require
5095 * resizing of the image can keep the smooth scaling enabled (even if the
5096 * image is already scaled, since the scaled image will be cached).
5098 * @see elm_image_smooth_get()
5102 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5104 * Get the smooth effect for an image.
5106 * @param obj The image object
5107 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5109 * @see elm_image_smooth_get()
5113 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5115 * Gets the current size of the image.
5117 * @param obj The image object.
5118 * @param w Pointer to store width, or NULL.
5119 * @param h Pointer to store height, or NULL.
5121 * This is the real size of the image, not the size of the object.
5123 * On error, neither w or h will be written.
5127 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5129 * Disable scaling of this object.
5131 * @param obj The image object.
5132 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5133 * otherwise. Default is @c EINA_FALSE.
5135 * This function disables scaling of the elm_image widget through the
5136 * function elm_object_scale_set(). However, this does not affect the widget
5137 * size/resize in any way. For that effect, take a look at
5138 * elm_image_scale_set().
5140 * @see elm_image_no_scale_get()
5141 * @see elm_image_scale_set()
5142 * @see elm_object_scale_set()
5146 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5148 * Get whether scaling is disabled on the object.
5150 * @param obj The image object
5151 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5153 * @see elm_image_no_scale_set()
5157 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5159 * Set if the object is (up/down) resizable.
5161 * @param obj The image object
5162 * @param scale_up A bool to set if the object is resizable up. Default is
5164 * @param scale_down A bool to set if the object is resizable down. Default
5167 * This function limits the image resize ability. If @p scale_up is set to
5168 * @c EINA_FALSE, the object can't have its height or width resized to a value
5169 * higher than the original image size. Same is valid for @p scale_down.
5171 * @see elm_image_scale_get()
5175 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5177 * Get if the object is (up/down) resizable.
5179 * @param obj The image object
5180 * @param scale_up A bool to set if the object is resizable up
5181 * @param scale_down A bool to set if the object is resizable down
5183 * @see elm_image_scale_set()
5187 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5189 * Set if the image fill the entire object area when keeping the aspect ratio.
5191 * @param obj The image object
5192 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5193 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5195 * When the image should keep its aspect ratio even if resized to another
5196 * aspect ratio, there are two possibilities to resize it: keep the entire
5197 * image inside the limits of height and width of the object (@p fill_outside
5198 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5199 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5201 * @note This option will have no effect if
5202 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5204 * @see elm_image_fill_outside_get()
5205 * @see elm_image_aspect_ratio_retained_set()
5209 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5211 * Get if the object is filled outside
5213 * @param obj The image object
5214 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5216 * @see elm_image_fill_outside_set()
5220 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5222 * Set the prescale size for the image
5224 * @param obj The image object
5225 * @param size The prescale size. This value is used for both width and
5228 * This function sets a new size for pixmap representation of the given
5229 * image. It allows the image to be loaded already in the specified size,
5230 * reducing the memory usage and load time when loading a big image with load
5231 * size set to a smaller size.
5233 * It's equivalent to the elm_bg_load_size_set() function for bg.
5235 * @note this is just a hint, the real size of the pixmap may differ
5236 * depending on the type of image being loaded, being bigger than requested.
5238 * @see elm_image_prescale_get()
5239 * @see elm_bg_load_size_set()
5243 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5245 * Get the prescale size for the image
5247 * @param obj The image object
5248 * @return The prescale size
5250 * @see elm_image_prescale_set()
5254 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5256 * Set the image orientation.
5258 * @param obj The image object
5259 * @param orient The image orientation
5260 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5261 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5262 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5263 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5264 * Default is #ELM_IMAGE_ORIENT_NONE.
5266 * This function allows to rotate or flip the given image.
5268 * @see elm_image_orient_get()
5269 * @see @ref Elm_Image_Orient
5273 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5275 * Get the image orientation.
5277 * @param obj The image object
5278 * @return The image orientation
5279 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5280 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5281 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5282 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5284 * @see elm_image_orient_set()
5285 * @see @ref Elm_Image_Orient
5289 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5291 * Make the image 'editable'.
5293 * @param obj Image object.
5294 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5296 * This means the image is a valid drag target for drag and drop, and can be
5297 * cut or pasted too.
5301 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5303 * Make the image 'editable'.
5305 * @param obj Image object.
5306 * @return Editability.
5308 * This means the image is a valid drag target for drag and drop, and can be
5309 * cut or pasted too.
5313 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5315 * Get the basic Evas_Image object from this object (widget).
5317 * @param obj The image object to get the inlined image from
5318 * @return The inlined image object, or NULL if none exists
5320 * This function allows one to get the underlying @c Evas_Object of type
5321 * Image from this elementary widget. It can be useful to do things like get
5322 * the pixel data, save the image to a file, etc.
5324 * @note Be careful to not manipulate it, as it is under control of
5329 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5331 * Set whether the original aspect ratio of the image should be kept on resize.
5333 * @param obj The image object.
5334 * @param retained @c EINA_TRUE if the image should retain the aspect,
5335 * @c EINA_FALSE otherwise.
5337 * The original aspect ratio (width / height) of the image is usually
5338 * distorted to match the object's size. Enabling this option will retain
5339 * this original aspect, and the way that the image is fit into the object's
5340 * area depends on the option set by elm_image_fill_outside_set().
5342 * @see elm_image_aspect_ratio_retained_get()
5343 * @see elm_image_fill_outside_set()
5347 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5349 * Get if the object retains the original aspect ratio.
5351 * @param obj The image object.
5352 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5357 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5364 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5366 typedef enum _Elm_GLView_Mode
5368 ELM_GLVIEW_ALPHA = 1,
5369 ELM_GLVIEW_DEPTH = 2,
5370 ELM_GLVIEW_STENCIL = 4
5374 * Defines a policy for the glview resizing.
5376 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5378 typedef enum _Elm_GLView_Resize_Policy
5380 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5381 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5382 } Elm_GLView_Resize_Policy;
5384 typedef enum _Elm_GLView_Render_Policy
5386 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5387 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5388 } Elm_GLView_Render_Policy;
5393 * A simple GLView widget that allows GL rendering.
5395 * Signals that you can add callbacks for are:
5401 * Add a new glview to the parent
5403 * @param parent The parent object
5404 * @return The new object or NULL if it cannot be created
5408 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5411 * Sets the size of the glview
5413 * @param obj The glview object
5414 * @param width width of the glview object
5415 * @param height height of the glview object
5419 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5422 * Gets the size of the glview.
5424 * @param obj The glview object
5425 * @param width width of the glview object
5426 * @param height height of the glview object
5428 * Note that this function returns the actual image size of the
5429 * glview. This means that when the scale policy is set to
5430 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5435 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5438 * Gets the gl api struct for gl rendering
5440 * @param obj The glview object
5441 * @return The api object or NULL if it cannot be created
5445 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5448 * Set the mode of the GLView. Supports Three simple modes.
5450 * @param obj The glview object
5451 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5452 * @return True if set properly.
5456 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5459 * Set the resize policy for the glview object.
5461 * @param obj The glview object.
5462 * @param policy The scaling policy.
5464 * By default, the resize policy is set to
5465 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5466 * destroys the previous surface and recreates the newly specified
5467 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5468 * however, glview only scales the image object and not the underlying
5473 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5476 * Set the render policy for the glview object.
5478 * @param obj The glview object.
5479 * @param policy The render policy.
5481 * By default, the render policy is set to
5482 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5483 * that during the render loop, glview is only redrawn if it needs
5484 * to be redrawn. (i.e. When it is visible) If the policy is set to
5485 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5486 * whether it is visible/need redrawing or not.
5490 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5493 * Set the init function that runs once in the main loop.
5495 * @param obj The glview object.
5496 * @param func The init function to be registered.
5498 * The registered init function gets called once during the render loop.
5502 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5505 * Set the render function that runs in the main loop.
5507 * @param obj The glview object.
5508 * @param func The delete function to be registered.
5510 * The registered del function gets called when GLView object is deleted.
5514 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5517 * Set the resize function that gets called when resize happens.
5519 * @param obj The glview object.
5520 * @param func The resize function to be registered.
5524 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5527 * Set the render function that runs in the main loop.
5529 * @param obj The glview object.
5530 * @param func The render function to be registered.
5534 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5537 * Notifies that there has been changes in the GLView.
5539 * @param obj The glview object.
5543 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5553 * @image html img/widget/box/preview-00.png
5554 * @image latex img/widget/box/preview-00.eps width=\textwidth
5556 * @image html img/box.png
5557 * @image latex img/box.eps width=\textwidth
5559 * A box arranges objects in a linear fashion, governed by a layout function
5560 * that defines the details of this arrangement.
5562 * By default, the box will use an internal function to set the layout to
5563 * a single row, either vertical or horizontal. This layout is affected
5564 * by a number of parameters, such as the homogeneous flag set by
5565 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5566 * elm_box_align_set() and the hints set to each object in the box.
5568 * For this default layout, it's possible to change the orientation with
5569 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5570 * placing its elements ordered from top to bottom. When horizontal is set,
5571 * the order will go from left to right. If the box is set to be
5572 * homogeneous, every object in it will be assigned the same space, that
5573 * of the largest object. Padding can be used to set some spacing between
5574 * the cell given to each object. The alignment of the box, set with
5575 * elm_box_align_set(), determines how the bounding box of all the elements
5576 * will be placed within the space given to the box widget itself.
5578 * The size hints of each object also affect how they are placed and sized
5579 * within the box. evas_object_size_hint_min_set() will give the minimum
5580 * size the object can have, and the box will use it as the basis for all
5581 * latter calculations. Elementary widgets set their own minimum size as
5582 * needed, so there's rarely any need to use it manually.
5584 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5585 * used to tell whether the object will be allocated the minimum size it
5586 * needs or if the space given to it should be expanded. It's important
5587 * to realize that expanding the size given to the object is not the same
5588 * thing as resizing the object. It could very well end being a small
5589 * widget floating in a much larger empty space. If not set, the weight
5590 * for objects will normally be 0.0 for both axis, meaning the widget will
5591 * not be expanded. To take as much space possible, set the weight to
5592 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5594 * Besides how much space each object is allocated, it's possible to control
5595 * how the widget will be placed within that space using
5596 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5597 * for both axis, meaning the object will be centered, but any value from
5598 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5599 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5600 * is -1.0, means the object will be resized to fill the entire space it
5603 * In addition, customized functions to define the layout can be set, which
5604 * allow the application developer to organize the objects within the box
5605 * in any number of ways.
5607 * The special elm_box_layout_transition() function can be used
5608 * to switch from one layout to another, animating the motion of the
5609 * children of the box.
5611 * @note Objects should not be added to box objects using _add() calls.
5613 * Some examples on how to use boxes follow:
5614 * @li @ref box_example_01
5615 * @li @ref box_example_02
5620 * @typedef Elm_Box_Transition
5622 * Opaque handler containing the parameters to perform an animated
5623 * transition of the layout the box uses.
5625 * @see elm_box_transition_new()
5626 * @see elm_box_layout_set()
5627 * @see elm_box_layout_transition()
5629 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5632 * Add a new box to the parent
5634 * By default, the box will be in vertical mode and non-homogeneous.
5636 * @param parent The parent object
5637 * @return The new object or NULL if it cannot be created
5639 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5641 * Set the horizontal orientation
5643 * By default, box object arranges their contents vertically from top to
5645 * By calling this function with @p horizontal as EINA_TRUE, the box will
5646 * become horizontal, arranging contents from left to right.
5648 * @note This flag is ignored if a custom layout function is set.
5650 * @param obj The box object
5651 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5652 * EINA_FALSE = vertical)
5654 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5656 * Get the horizontal orientation
5658 * @param obj The box object
5659 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5661 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5663 * Set the box to arrange its children homogeneously
5665 * If enabled, homogeneous layout makes all items the same size, according
5666 * to the size of the largest of its children.
5668 * @note This flag is ignored if a custom layout function is set.
5670 * @param obj The box object
5671 * @param homogeneous The homogeneous flag
5673 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5675 * Get whether the box is using homogeneous mode or not
5677 * @param obj The box object
5678 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5680 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5681 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5682 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5684 * Add an object to the beginning of the pack list
5686 * Pack @p subobj into the box @p obj, placing it first in the list of
5687 * children objects. The actual position the object will get on screen
5688 * depends on the layout used. If no custom layout is set, it will be at
5689 * the top or left, depending if the box is vertical or horizontal,
5692 * @param obj The box object
5693 * @param subobj The object to add to the box
5695 * @see elm_box_pack_end()
5696 * @see elm_box_pack_before()
5697 * @see elm_box_pack_after()
5698 * @see elm_box_unpack()
5699 * @see elm_box_unpack_all()
5700 * @see elm_box_clear()
5702 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5704 * Add an object at the end of the pack list
5706 * Pack @p subobj into the box @p obj, placing it last in the list of
5707 * children objects. The actual position the object will get on screen
5708 * depends on the layout used. If no custom layout is set, it will be at
5709 * the bottom or right, depending if the box is vertical or horizontal,
5712 * @param obj The box object
5713 * @param subobj The object to add to the box
5715 * @see elm_box_pack_start()
5716 * @see elm_box_pack_before()
5717 * @see elm_box_pack_after()
5718 * @see elm_box_unpack()
5719 * @see elm_box_unpack_all()
5720 * @see elm_box_clear()
5722 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5724 * Adds an object to the box before the indicated object
5726 * This will add the @p subobj to the box indicated before the object
5727 * indicated with @p before. If @p before is not already in the box, results
5728 * are undefined. Before means either to the left of the indicated object or
5729 * above it depending on orientation.
5731 * @param obj The box object
5732 * @param subobj The object to add to the box
5733 * @param before The object before which to add it
5735 * @see elm_box_pack_start()
5736 * @see elm_box_pack_end()
5737 * @see elm_box_pack_after()
5738 * @see elm_box_unpack()
5739 * @see elm_box_unpack_all()
5740 * @see elm_box_clear()
5742 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5744 * Adds an object to the box after the indicated object
5746 * This will add the @p subobj to the box indicated after the object
5747 * indicated with @p after. If @p after is not already in the box, results
5748 * are undefined. After means either to the right of the indicated object or
5749 * below it depending on orientation.
5751 * @param obj The box object
5752 * @param subobj The object to add to the box
5753 * @param after The object after which to add it
5755 * @see elm_box_pack_start()
5756 * @see elm_box_pack_end()
5757 * @see elm_box_pack_before()
5758 * @see elm_box_unpack()
5759 * @see elm_box_unpack_all()
5760 * @see elm_box_clear()
5762 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5764 * Clear the box of all children
5766 * Remove all the elements contained by the box, deleting the respective
5769 * @param obj The box object
5771 * @see elm_box_unpack()
5772 * @see elm_box_unpack_all()
5774 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5778 * Remove the object given by @p subobj from the box @p obj without
5781 * @param obj The box object
5783 * @see elm_box_unpack_all()
5784 * @see elm_box_clear()
5786 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5788 * Remove all items from the box, without deleting them
5790 * Clear the box from all children, but don't delete the respective objects.
5791 * If no other references of the box children exist, the objects will never
5792 * be deleted, and thus the application will leak the memory. Make sure
5793 * when using this function that you hold a reference to all the objects
5794 * in the box @p obj.
5796 * @param obj The box object
5798 * @see elm_box_clear()
5799 * @see elm_box_unpack()
5801 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5803 * Retrieve a list of the objects packed into the box
5805 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5806 * The order of the list corresponds to the packing order the box uses.
5808 * You must free this list with eina_list_free() once you are done with it.
5810 * @param obj The box object
5812 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5814 * Set the space (padding) between the box's elements.
5816 * Extra space in pixels that will be added between a box child and its
5817 * neighbors after its containing cell has been calculated. This padding
5818 * is set for all elements in the box, besides any possible padding that
5819 * individual elements may have through their size hints.
5821 * @param obj The box object
5822 * @param horizontal The horizontal space between elements
5823 * @param vertical The vertical space between elements
5825 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5827 * Get the space (padding) between the box's elements.
5829 * @param obj The box object
5830 * @param horizontal The horizontal space between elements
5831 * @param vertical The vertical space between elements
5833 * @see elm_box_padding_set()
5835 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5837 * Set the alignment of the whole bouding box of contents.
5839 * Sets how the bounding box containing all the elements of the box, after
5840 * their sizes and position has been calculated, will be aligned within
5841 * the space given for the whole box widget.
5843 * @param obj The box object
5844 * @param horizontal The horizontal alignment of elements
5845 * @param vertical The vertical alignment of elements
5847 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5849 * Get the alignment of the whole bouding box of contents.
5851 * @param obj The box object
5852 * @param horizontal The horizontal alignment of elements
5853 * @param vertical The vertical alignment of elements
5855 * @see elm_box_align_set()
5857 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5860 * Set the layout defining function to be used by the box
5862 * Whenever anything changes that requires the box in @p obj to recalculate
5863 * the size and position of its elements, the function @p cb will be called
5864 * to determine what the layout of the children will be.
5866 * Once a custom function is set, everything about the children layout
5867 * is defined by it. The flags set by elm_box_horizontal_set() and
5868 * elm_box_homogeneous_set() no longer have any meaning, and the values
5869 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5870 * layout function to decide if they are used and how. These last two
5871 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5872 * passed to @p cb. The @c Evas_Object the function receives is not the
5873 * Elementary widget, but the internal Evas Box it uses, so none of the
5874 * functions described here can be used on it.
5876 * Any of the layout functions in @c Evas can be used here, as well as the
5877 * special elm_box_layout_transition().
5879 * The final @p data argument received by @p cb is the same @p data passed
5880 * here, and the @p free_data function will be called to free it
5881 * whenever the box is destroyed or another layout function is set.
5883 * Setting @p cb to NULL will revert back to the default layout function.
5885 * @param obj The box object
5886 * @param cb The callback function used for layout
5887 * @param data Data that will be passed to layout function
5888 * @param free_data Function called to free @p data
5890 * @see elm_box_layout_transition()
5892 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);
5894 * Special layout function that animates the transition from one layout to another
5896 * Normally, when switching the layout function for a box, this will be
5897 * reflected immediately on screen on the next render, but it's also
5898 * possible to do this through an animated transition.
5900 * This is done by creating an ::Elm_Box_Transition and setting the box
5901 * layout to this function.
5905 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5906 * evas_object_box_layout_vertical, // start
5907 * NULL, // data for initial layout
5908 * NULL, // free function for initial data
5909 * evas_object_box_layout_horizontal, // end
5910 * NULL, // data for final layout
5911 * NULL, // free function for final data
5912 * anim_end, // will be called when animation ends
5913 * NULL); // data for anim_end function\
5914 * elm_box_layout_set(box, elm_box_layout_transition, t,
5915 * elm_box_transition_free);
5918 * @note This function can only be used with elm_box_layout_set(). Calling
5919 * it directly will not have the expected results.
5921 * @see elm_box_transition_new
5922 * @see elm_box_transition_free
5923 * @see elm_box_layout_set
5925 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5927 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5929 * If you want to animate the change from one layout to another, you need
5930 * to set the layout function of the box to elm_box_layout_transition(),
5931 * passing as user data to it an instance of ::Elm_Box_Transition with the
5932 * necessary information to perform this animation. The free function to
5933 * set for the layout is elm_box_transition_free().
5935 * The parameters to create an ::Elm_Box_Transition sum up to how long
5936 * will it be, in seconds, a layout function to describe the initial point,
5937 * another for the final position of the children and one function to be
5938 * called when the whole animation ends. This last function is useful to
5939 * set the definitive layout for the box, usually the same as the end
5940 * layout for the animation, but could be used to start another transition.
5942 * @param start_layout The layout function that will be used to start the animation
5943 * @param start_layout_data The data to be passed the @p start_layout function
5944 * @param start_layout_free_data Function to free @p start_layout_data
5945 * @param end_layout The layout function that will be used to end the animation
5946 * @param end_layout_free_data The data to be passed the @p end_layout function
5947 * @param end_layout_free_data Function to free @p end_layout_data
5948 * @param transition_end_cb Callback function called when animation ends
5949 * @param transition_end_data Data to be passed to @p transition_end_cb
5950 * @return An instance of ::Elm_Box_Transition
5952 * @see elm_box_transition_new
5953 * @see elm_box_layout_transition
5955 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);
5957 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5959 * This function is mostly useful as the @c free_data parameter in
5960 * elm_box_layout_set() when elm_box_layout_transition().
5962 * @param data The Elm_Box_Transition instance to be freed.
5964 * @see elm_box_transition_new
5965 * @see elm_box_layout_transition
5967 EAPI void elm_box_transition_free(void *data);
5974 * @defgroup Button Button
5976 * @image html img/widget/button/preview-00.png
5977 * @image latex img/widget/button/preview-00.eps
5978 * @image html img/widget/button/preview-01.png
5979 * @image latex img/widget/button/preview-01.eps
5980 * @image html img/widget/button/preview-02.png
5981 * @image latex img/widget/button/preview-02.eps
5983 * This is a push-button. Press it and run some function. It can contain
5984 * a simple label and icon object and it also has an autorepeat feature.
5986 * This widgets emits the following signals:
5987 * @li "clicked": the user clicked the button (press/release).
5988 * @li "repeated": the user pressed the button without releasing it.
5989 * @li "pressed": button was pressed.
5990 * @li "unpressed": button was released after being pressed.
5991 * In all three cases, the @c event parameter of the callback will be
5994 * Also, defined in the default theme, the button has the following styles
5996 * @li default: a normal button.
5997 * @li anchor: Like default, but the button fades away when the mouse is not
5998 * over it, leaving only the text or icon.
5999 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6000 * continuous look across its options.
6001 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6003 * Follow through a complete example @ref button_example_01 "here".
6007 * Add a new button to the parent's canvas
6009 * @param parent The parent object
6010 * @return The new object or NULL if it cannot be created
6012 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6014 * Set the label used in the button
6016 * The passed @p label can be NULL to clean any existing text in it and
6017 * leave the button as an icon only object.
6019 * @param obj The button object
6020 * @param label The text will be written on the button
6021 * @deprecated use elm_object_text_set() instead.
6023 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6025 * Get the label set for the button
6027 * The string returned is an internal pointer and should not be freed or
6028 * altered. It will also become invalid when the button is destroyed.
6029 * The string returned, if not NULL, is a stringshare, so if you need to
6030 * keep it around even after the button is destroyed, you can use
6031 * eina_stringshare_ref().
6033 * @param obj The button object
6034 * @return The text set to the label, or NULL if nothing is set
6035 * @deprecated use elm_object_text_set() instead.
6037 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6039 * Set the icon used for the button
6041 * Setting a new icon will delete any other that was previously set, making
6042 * any reference to them invalid. If you need to maintain the previous
6043 * object alive, unset it first with elm_button_icon_unset().
6045 * @param obj The button object
6046 * @param icon The icon object for the button
6048 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6050 * Get the icon used for the button
6052 * Return the icon object which is set for this widget. If the button is
6053 * destroyed or another icon is set, the returned object will be deleted
6054 * and any reference to it will be invalid.
6056 * @param obj The button object
6057 * @return The icon object that is being used
6059 * @see elm_button_icon_unset()
6061 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6063 * Remove the icon set without deleting it and return the object
6065 * This function drops the reference the button holds of the icon object
6066 * and returns this last object. It is used in case you want to remove any
6067 * icon, or set another one, without deleting the actual object. The button
6068 * will be left without an icon set.
6070 * @param obj The button object
6071 * @return The icon object that was being used
6073 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6075 * Turn on/off the autorepeat event generated when the button is kept pressed
6077 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6078 * signal when they are clicked.
6080 * When on, keeping a button pressed will continuously emit a @c repeated
6081 * signal until the button is released. The time it takes until it starts
6082 * emitting the signal is given by
6083 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6084 * new emission by elm_button_autorepeat_gap_timeout_set().
6086 * @param obj The button object
6087 * @param on A bool to turn on/off the event
6089 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6091 * Get whether the autorepeat feature is enabled
6093 * @param obj The button object
6094 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6096 * @see elm_button_autorepeat_set()
6098 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6100 * Set the initial timeout before the autorepeat event is generated
6102 * Sets the timeout, in seconds, since the button is pressed until the
6103 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6104 * won't be any delay and the even will be fired the moment the button is
6107 * @param obj The button object
6108 * @param t Timeout in seconds
6110 * @see elm_button_autorepeat_set()
6111 * @see elm_button_autorepeat_gap_timeout_set()
6113 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6115 * Get the initial timeout before the autorepeat event is generated
6117 * @param obj The button object
6118 * @return Timeout in seconds
6120 * @see elm_button_autorepeat_initial_timeout_set()
6122 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6124 * Set the interval between each generated autorepeat event
6126 * After the first @c repeated event is fired, all subsequent ones will
6127 * follow after a delay of @p t seconds for each.
6129 * @param obj The button object
6130 * @param t Interval in seconds
6132 * @see elm_button_autorepeat_initial_timeout_set()
6134 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6136 * Get the interval between each generated autorepeat event
6138 * @param obj The button object
6139 * @return Interval in seconds
6141 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6147 * @defgroup File_Selector_Button File Selector Button
6149 * @image html img/widget/fileselector_button/preview-00.png
6150 * @image latex img/widget/fileselector_button/preview-00.eps
6151 * @image html img/widget/fileselector_button/preview-01.png
6152 * @image latex img/widget/fileselector_button/preview-01.eps
6153 * @image html img/widget/fileselector_button/preview-02.png
6154 * @image latex img/widget/fileselector_button/preview-02.eps
6156 * This is a button that, when clicked, creates an Elementary
6157 * window (or inner window) <b> with a @ref Fileselector "file
6158 * selector widget" within</b>. When a file is chosen, the (inner)
6159 * window is closed and the button emits a signal having the
6160 * selected file as it's @c event_info.
6162 * This widget encapsulates operations on its internal file
6163 * selector on its own API. There is less control over its file
6164 * selector than that one would have instatiating one directly.
6166 * The following styles are available for this button:
6169 * @li @c "hoversel_vertical"
6170 * @li @c "hoversel_vertical_entry"
6172 * Smart callbacks one can register to:
6173 * - @c "file,chosen" - the user has selected a path, whose string
6174 * pointer comes as the @c event_info data (a stringshared
6177 * Here is an example on its usage:
6178 * @li @ref fileselector_button_example
6180 * @see @ref File_Selector_Entry for a similar widget.
6185 * Add a new file selector button widget to the given parent
6186 * Elementary (container) object
6188 * @param parent The parent object
6189 * @return a new file selector button widget handle or @c NULL, on
6192 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6195 * Set the label for a given file selector button widget
6197 * @param obj The file selector button widget
6198 * @param label The text label to be displayed on @p obj
6200 * @deprecated use elm_object_text_set() instead.
6202 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6205 * Get the label set for a given file selector button widget
6207 * @param obj The file selector button widget
6208 * @return The button label
6210 * @deprecated use elm_object_text_set() instead.
6212 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6215 * Set the icon on a given file selector button widget
6217 * @param obj The file selector button widget
6218 * @param icon The icon object for the button
6220 * Once the icon object is set, a previously set one will be
6221 * deleted. If you want to keep the latter, use the
6222 * elm_fileselector_button_icon_unset() function.
6224 * @see elm_fileselector_button_icon_get()
6226 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6229 * Get the icon set for a given file selector button widget
6231 * @param obj The file selector button widget
6232 * @return The icon object currently set on @p obj or @c NULL, if
6235 * @see elm_fileselector_button_icon_set()
6237 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6240 * Unset the icon used in a given file selector button widget
6242 * @param obj The file selector button widget
6243 * @return The icon object that was being used on @p obj or @c
6246 * Unparent and return the icon object which was set for this
6249 * @see elm_fileselector_button_icon_set()
6251 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6254 * Set the title for a given file selector button widget's window
6256 * @param obj The file selector button widget
6257 * @param title The title string
6259 * This will change the window's title, when the file selector pops
6260 * out after a click on the button. Those windows have the default
6261 * (unlocalized) value of @c "Select a file" as titles.
6263 * @note It will only take any effect if the file selector
6264 * button widget is @b not under "inwin mode".
6266 * @see elm_fileselector_button_window_title_get()
6268 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6271 * Get the title set for a given file selector button widget's
6274 * @param obj The file selector button widget
6275 * @return Title of the file selector button's window
6277 * @see elm_fileselector_button_window_title_get() for more details
6279 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6282 * Set the size of a given file selector button widget's window,
6283 * holding the file selector itself.
6285 * @param obj The file selector button widget
6286 * @param width The window's width
6287 * @param height The window's height
6289 * @note it will only take any effect if the file selector button
6290 * widget is @b not under "inwin mode". The default size for the
6291 * window (when applicable) is 400x400 pixels.
6293 * @see elm_fileselector_button_window_size_get()
6295 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6298 * Get the size of a given file selector button widget's window,
6299 * holding the file selector itself.
6301 * @param obj The file selector button widget
6302 * @param width Pointer into which to store the width value
6303 * @param height Pointer into which to store the height value
6305 * @note Use @c NULL pointers on the size values you're not
6306 * interested in: they'll be ignored by the function.
6308 * @see elm_fileselector_button_window_size_set(), for more details
6310 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6313 * Set the initial file system path for a given file selector
6316 * @param obj The file selector button widget
6317 * @param path The path string
6319 * It must be a <b>directory</b> path, which will have the contents
6320 * displayed initially in the file selector's view, when invoked
6321 * from @p obj. The default initial path is the @c "HOME"
6322 * environment variable's value.
6324 * @see elm_fileselector_button_path_get()
6326 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6329 * Get the initial file system path set for a given file selector
6332 * @param obj The file selector button widget
6333 * @return path The path string
6335 * @see elm_fileselector_button_path_set() for more details
6337 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6340 * Enable/disable a tree view in the given file selector button
6341 * widget's internal file selector
6343 * @param obj The file selector button widget
6344 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6347 * This has the same effect as elm_fileselector_expandable_set(),
6348 * but now applied to a file selector button's internal file
6351 * @note There's no way to put a file selector button's internal
6352 * file selector in "grid mode", as one may do with "pure" file
6355 * @see elm_fileselector_expandable_get()
6357 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6360 * Get whether tree view is enabled for the given file selector
6361 * button widget's internal file selector
6363 * @param obj The file selector button widget
6364 * @return @c EINA_TRUE if @p obj widget's internal file selector
6365 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6367 * @see elm_fileselector_expandable_set() for more details
6369 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6372 * Set whether a given file selector button widget's internal file
6373 * selector is to display folders only or the directory contents,
6376 * @param obj The file selector button widget
6377 * @param only @c EINA_TRUE to make @p obj widget's internal file
6378 * selector only display directories, @c EINA_FALSE to make files
6379 * to be displayed in it too
6381 * This has the same effect as elm_fileselector_folder_only_set(),
6382 * but now applied to a file selector button's internal file
6385 * @see elm_fileselector_folder_only_get()
6387 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6390 * Get whether a given file selector button widget's internal file
6391 * selector is displaying folders only or the directory contents,
6394 * @param obj The file selector button widget
6395 * @return @c EINA_TRUE if @p obj widget's internal file
6396 * selector is only displaying directories, @c EINA_FALSE if files
6397 * are being displayed in it too (and on errors)
6399 * @see elm_fileselector_button_folder_only_set() for more details
6401 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6404 * Enable/disable the file name entry box where the user can type
6405 * in a name for a file, in a given file selector button widget's
6406 * internal file selector.
6408 * @param obj The file selector button widget
6409 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6410 * file selector a "saving dialog", @c EINA_FALSE otherwise
6412 * This has the same effect as elm_fileselector_is_save_set(),
6413 * but now applied to a file selector button's internal file
6416 * @see elm_fileselector_is_save_get()
6418 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6421 * Get whether the given file selector button widget's internal
6422 * file selector is in "saving dialog" mode
6424 * @param obj The file selector button widget
6425 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6426 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6429 * @see elm_fileselector_button_is_save_set() for more details
6431 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6434 * Set whether a given file selector button widget's internal file
6435 * selector will raise an Elementary "inner window", instead of a
6436 * dedicated Elementary window. By default, it won't.
6438 * @param obj The file selector button widget
6439 * @param value @c EINA_TRUE to make it use an inner window, @c
6440 * EINA_TRUE to make it use a dedicated window
6442 * @see elm_win_inwin_add() for more information on inner windows
6443 * @see elm_fileselector_button_inwin_mode_get()
6445 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6448 * Get whether a given file selector button widget's internal file
6449 * selector will raise an Elementary "inner window", instead of a
6450 * dedicated Elementary window.
6452 * @param obj The file selector button widget
6453 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6454 * if it will use a dedicated window
6456 * @see elm_fileselector_button_inwin_mode_set() for more details
6458 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6465 * @defgroup File_Selector_Entry File Selector Entry
6467 * @image html img/widget/fileselector_entry/preview-00.png
6468 * @image latex img/widget/fileselector_entry/preview-00.eps
6470 * This is an entry made to be filled with or display a <b>file
6471 * system path string</b>. Besides the entry itself, the widget has
6472 * a @ref File_Selector_Button "file selector button" on its side,
6473 * which will raise an internal @ref Fileselector "file selector widget",
6474 * when clicked, for path selection aided by file system
6477 * This file selector may appear in an Elementary window or in an
6478 * inner window. When a file is chosen from it, the (inner) window
6479 * is closed and the selected file's path string is exposed both as
6480 * an smart event and as the new text on the entry.
6482 * This widget encapsulates operations on its internal file
6483 * selector on its own API. There is less control over its file
6484 * selector than that one would have instatiating one directly.
6486 * Smart callbacks one can register to:
6487 * - @c "changed" - The text within the entry was changed
6488 * - @c "activated" - The entry has had editing finished and
6489 * changes are to be "committed"
6490 * - @c "press" - The entry has been clicked
6491 * - @c "longpressed" - The entry has been clicked (and held) for a
6493 * - @c "clicked" - The entry has been clicked
6494 * - @c "clicked,double" - The entry has been double clicked
6495 * - @c "focused" - The entry has received focus
6496 * - @c "unfocused" - The entry has lost focus
6497 * - @c "selection,paste" - A paste action has occurred on the
6499 * - @c "selection,copy" - A copy action has occurred on the entry
6500 * - @c "selection,cut" - A cut action has occurred on the entry
6501 * - @c "unpressed" - The file selector entry's button was released
6502 * after being pressed.
6503 * - @c "file,chosen" - The user has selected a path via the file
6504 * selector entry's internal file selector, whose string pointer
6505 * comes as the @c event_info data (a stringshared string)
6507 * Here is an example on its usage:
6508 * @li @ref fileselector_entry_example
6510 * @see @ref File_Selector_Button for a similar widget.
6515 * Add a new file selector entry widget to the given parent
6516 * Elementary (container) object
6518 * @param parent The parent object
6519 * @return a new file selector entry widget handle or @c NULL, on
6522 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6525 * Set the label for a given file selector entry widget's button
6527 * @param obj The file selector entry widget
6528 * @param label The text label to be displayed on @p obj widget's
6531 * @deprecated use elm_object_text_set() instead.
6533 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6536 * Get the label set for a given file selector entry widget's button
6538 * @param obj The file selector entry widget
6539 * @return The widget button's label
6541 * @deprecated use elm_object_text_set() instead.
6543 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6546 * Set the icon on a given file selector entry widget's button
6548 * @param obj The file selector entry widget
6549 * @param icon The icon object for the entry's button
6551 * Once the icon object is set, a previously set one will be
6552 * deleted. If you want to keep the latter, use the
6553 * elm_fileselector_entry_button_icon_unset() function.
6555 * @see elm_fileselector_entry_button_icon_get()
6557 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6560 * Get the icon set for a given file selector entry widget's button
6562 * @param obj The file selector entry widget
6563 * @return The icon object currently set on @p obj widget's button
6564 * or @c NULL, if none is
6566 * @see elm_fileselector_entry_button_icon_set()
6568 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6571 * Unset the icon used in a given file selector entry widget's
6574 * @param obj The file selector entry widget
6575 * @return The icon object that was being used on @p obj widget's
6576 * button or @c NULL, on errors
6578 * Unparent and return the icon object which was set for this
6581 * @see elm_fileselector_entry_button_icon_set()
6583 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6586 * Set the title for a given file selector entry widget's window
6588 * @param obj The file selector entry widget
6589 * @param title The title string
6591 * This will change the window's title, when the file selector pops
6592 * out after a click on the entry's button. Those windows have the
6593 * default (unlocalized) value of @c "Select a file" as titles.
6595 * @note It will only take any effect if the file selector
6596 * entry widget is @b not under "inwin mode".
6598 * @see elm_fileselector_entry_window_title_get()
6600 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6603 * Get the title set for a given file selector entry widget's
6606 * @param obj The file selector entry widget
6607 * @return Title of the file selector entry's window
6609 * @see elm_fileselector_entry_window_title_get() for more details
6611 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6614 * Set the size of a given file selector entry widget's window,
6615 * holding the file selector itself.
6617 * @param obj The file selector entry widget
6618 * @param width The window's width
6619 * @param height The window's height
6621 * @note it will only take any effect if the file selector entry
6622 * widget is @b not under "inwin mode". The default size for the
6623 * window (when applicable) is 400x400 pixels.
6625 * @see elm_fileselector_entry_window_size_get()
6627 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6630 * Get the size of a given file selector entry widget's window,
6631 * holding the file selector itself.
6633 * @param obj The file selector entry widget
6634 * @param width Pointer into which to store the width value
6635 * @param height Pointer into which to store the height value
6637 * @note Use @c NULL pointers on the size values you're not
6638 * interested in: they'll be ignored by the function.
6640 * @see elm_fileselector_entry_window_size_set(), for more details
6642 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6645 * Set the initial file system path and the entry's path string for
6646 * a given file selector entry widget
6648 * @param obj The file selector entry widget
6649 * @param path The path string
6651 * It must be a <b>directory</b> path, which will have the contents
6652 * displayed initially in the file selector's view, when invoked
6653 * from @p obj. The default initial path is the @c "HOME"
6654 * environment variable's value.
6656 * @see elm_fileselector_entry_path_get()
6658 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6661 * Get the entry's path string for a given file selector entry
6664 * @param obj The file selector entry widget
6665 * @return path The path string
6667 * @see elm_fileselector_entry_path_set() for more details
6669 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6672 * Enable/disable a tree view in the given file selector entry
6673 * widget's internal file selector
6675 * @param obj The file selector entry widget
6676 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6679 * This has the same effect as elm_fileselector_expandable_set(),
6680 * but now applied to a file selector entry's internal file
6683 * @note There's no way to put a file selector entry's internal
6684 * file selector in "grid mode", as one may do with "pure" file
6687 * @see elm_fileselector_expandable_get()
6689 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6692 * Get whether tree view is enabled for the given file selector
6693 * entry widget's internal file selector
6695 * @param obj The file selector entry widget
6696 * @return @c EINA_TRUE if @p obj widget's internal file selector
6697 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6699 * @see elm_fileselector_expandable_set() for more details
6701 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6704 * Set whether a given file selector entry widget's internal file
6705 * selector is to display folders only or the directory contents,
6708 * @param obj The file selector entry widget
6709 * @param only @c EINA_TRUE to make @p obj widget's internal file
6710 * selector only display directories, @c EINA_FALSE to make files
6711 * to be displayed in it too
6713 * This has the same effect as elm_fileselector_folder_only_set(),
6714 * but now applied to a file selector entry's internal file
6717 * @see elm_fileselector_folder_only_get()
6719 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6722 * Get whether a given file selector entry widget's internal file
6723 * selector is displaying folders only or the directory contents,
6726 * @param obj The file selector entry widget
6727 * @return @c EINA_TRUE if @p obj widget's internal file
6728 * selector is only displaying directories, @c EINA_FALSE if files
6729 * are being displayed in it too (and on errors)
6731 * @see elm_fileselector_entry_folder_only_set() for more details
6733 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6736 * Enable/disable the file name entry box where the user can type
6737 * in a name for a file, in a given file selector entry widget's
6738 * internal file selector.
6740 * @param obj The file selector entry widget
6741 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6742 * file selector a "saving dialog", @c EINA_FALSE otherwise
6744 * This has the same effect as elm_fileselector_is_save_set(),
6745 * but now applied to a file selector entry's internal file
6748 * @see elm_fileselector_is_save_get()
6750 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6753 * Get whether the given file selector entry widget's internal
6754 * file selector is in "saving dialog" mode
6756 * @param obj The file selector entry widget
6757 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6758 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6761 * @see elm_fileselector_entry_is_save_set() for more details
6763 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6766 * Set whether a given file selector entry widget's internal file
6767 * selector will raise an Elementary "inner window", instead of a
6768 * dedicated Elementary window. By default, it won't.
6770 * @param obj The file selector entry widget
6771 * @param value @c EINA_TRUE to make it use an inner window, @c
6772 * EINA_TRUE to make it use a dedicated window
6774 * @see elm_win_inwin_add() for more information on inner windows
6775 * @see elm_fileselector_entry_inwin_mode_get()
6777 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6780 * Get whether a given file selector entry widget's internal file
6781 * selector will raise an Elementary "inner window", instead of a
6782 * dedicated Elementary window.
6784 * @param obj The file selector entry widget
6785 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6786 * if it will use a dedicated window
6788 * @see elm_fileselector_entry_inwin_mode_set() for more details
6790 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6793 * Set the initial file system path for a given file selector entry
6796 * @param obj The file selector entry widget
6797 * @param path The path string
6799 * It must be a <b>directory</b> path, which will have the contents
6800 * displayed initially in the file selector's view, when invoked
6801 * from @p obj. The default initial path is the @c "HOME"
6802 * environment variable's value.
6804 * @see elm_fileselector_entry_path_get()
6806 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6809 * Get the parent directory's path to the latest file selection on
6810 * a given filer selector entry widget
6812 * @param obj The file selector object
6813 * @return The (full) path of the directory of the last selection
6814 * on @p obj widget, a @b stringshared string
6816 * @see elm_fileselector_entry_path_set()
6818 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6825 * @defgroup Scroller Scroller
6827 * A scroller holds a single object and "scrolls it around". This means that
6828 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6829 * region around, allowing to move through a much larger object that is
6830 * contained in the scroller. The scroiller will always have a small minimum
6831 * size by default as it won't be limited by the contents of the scroller.
6833 * Signals that you can add callbacks for are:
6834 * @li "edge,left" - the left edge of the content has been reached
6835 * @li "edge,right" - the right edge of the content has been reached
6836 * @li "edge,top" - the top edge of the content has been reached
6837 * @li "edge,bottom" - the bottom edge of the content has been reached
6838 * @li "scroll" - the content has been scrolled (moved)
6839 * @li "scroll,anim,start" - scrolling animation has started
6840 * @li "scroll,anim,stop" - scrolling animation has stopped
6841 * @li "scroll,drag,start" - dragging the contents around has started
6842 * @li "scroll,drag,stop" - dragging the contents around has stopped
6843 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6846 * @note When Elemementary is in embedded mode the scrollbars will not be
6847 * dragable, they appear merely as indicators of how much has been scrolled.
6848 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6849 * fingerscroll) won't work.
6851 * In @ref tutorial_scroller you'll find an example of how to use most of
6856 * @brief Type that controls when scrollbars should appear.
6858 * @see elm_scroller_policy_set()
6860 typedef enum _Elm_Scroller_Policy
6862 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6863 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6864 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6865 ELM_SCROLLER_POLICY_LAST
6866 } Elm_Scroller_Policy;
6868 * @brief Add a new scroller to the parent
6870 * @param parent The parent object
6871 * @return The new object or NULL if it cannot be created
6873 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6875 * @brief Set the content of the scroller widget (the object to be scrolled around).
6877 * @param obj The scroller object
6878 * @param content The new content object
6880 * Once the content object is set, a previously set one will be deleted.
6881 * If you want to keep that old content object, use the
6882 * elm_scroller_content_unset() function.
6884 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6886 * @brief Get the content of the scroller widget
6888 * @param obj The slider object
6889 * @return The content that is being used
6891 * Return the content object which is set for this widget
6893 * @see elm_scroller_content_set()
6895 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6897 * @brief Unset the content of the scroller widget
6899 * @param obj The slider object
6900 * @return The content that was being used
6902 * Unparent and return the content object which was set for this widget
6904 * @see elm_scroller_content_set()
6906 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6908 * @brief Set custom theme elements for the scroller
6910 * @param obj The scroller object
6911 * @param widget The widget name to use (default is "scroller")
6912 * @param base The base name to use (default is "base")
6914 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6916 * @brief Make the scroller minimum size limited to the minimum size of the content
6918 * @param obj The scroller object
6919 * @param w Enable limiting minimum size horizontally
6920 * @param h Enable limiting minimum size vertically
6922 * By default the scroller will be as small as its design allows,
6923 * irrespective of its content. This will make the scroller minimum size the
6924 * right size horizontally and/or vertically to perfectly fit its content in
6927 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6929 * @brief Show a specific virtual region within the scroller content object
6931 * @param obj The scroller object
6932 * @param x X coordinate of the region
6933 * @param y Y coordinate of the region
6934 * @param w Width of the region
6935 * @param h Height of the region
6937 * This will ensure all (or part if it does not fit) of the designated
6938 * region in the virtual content object (0, 0 starting at the top-left of the
6939 * virtual content object) is shown within the scroller.
6941 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);
6943 * @brief Set the scrollbar visibility policy
6945 * @param obj The scroller object
6946 * @param policy_h Horizontal scrollbar policy
6947 * @param policy_v Vertical scrollbar policy
6949 * This sets the scrollbar visibility policy for the given scroller.
6950 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6951 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6952 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6953 * respectively for the horizontal and vertical scrollbars.
6955 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6957 * @brief Gets scrollbar visibility policy
6959 * @param obj The scroller object
6960 * @param policy_h Horizontal scrollbar policy
6961 * @param policy_v Vertical scrollbar policy
6963 * @see elm_scroller_policy_set()
6965 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6967 * @brief Get the currently visible content region
6969 * @param obj The scroller object
6970 * @param x X coordinate of the region
6971 * @param y Y coordinate of the region
6972 * @param w Width of the region
6973 * @param h Height of the region
6975 * This gets the current region in the content object that is visible through
6976 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6977 * w, @p h values pointed to.
6979 * @note All coordinates are relative to the content.
6981 * @see elm_scroller_region_show()
6983 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);
6985 * @brief Get the size of the content object
6987 * @param obj The scroller object
6988 * @param w Width return
6989 * @param h Height return
6991 * This gets the size of the content object of the scroller.
6993 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6995 * @brief Set bouncing behavior
6997 * @param obj The scroller object
6998 * @param h_bounce Will the scroller bounce horizontally or not
6999 * @param v_bounce Will the scroller bounce vertically or not
7001 * When scrolling, the scroller may "bounce" when reaching an edge of the
7002 * content object. This is a visual way to indicate the end has been reached.
7003 * This is enabled by default for both axis. This will set if it is enabled
7004 * for that axis with the boolean parameters for each axis.
7006 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7008 * @brief Get the bounce mode
7010 * @param obj The Scroller object
7011 * @param h_bounce Allow bounce horizontally
7012 * @param v_bounce Allow bounce vertically
7014 * @see elm_scroller_bounce_set()
7016 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7018 * @brief Set scroll page size relative to viewport size.
7020 * @param obj The scroller object
7021 * @param h_pagerel The horizontal page relative size
7022 * @param v_pagerel The vertical page relative size
7024 * The scroller is capable of limiting scrolling by the user to "pages". That
7025 * is to jump by and only show a "whole page" at a time as if the continuous
7026 * area of the scroller content is split into page sized pieces. This sets
7027 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7028 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7029 * axis. This is mutually exclusive with page size
7030 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7031 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7032 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7035 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7037 * @brief Set scroll page size.
7039 * @param obj The scroller object
7040 * @param h_pagesize The horizontal page size
7041 * @param v_pagesize The vertical page size
7043 * This sets the page size to an absolute fixed value, with 0 turning it off
7046 * @see elm_scroller_page_relative_set()
7048 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7050 * @brief Get scroll current page number.
7052 * @param obj The scroller object
7053 * @param h_pagenumber The horizoptal page number
7054 * @param v_pagenumber The vertical page number
7056 * The page number starts from 0. 0 is the first page.
7057 * Current page means the page which meet the top-left of the viewport.
7058 * If there are two or more pages in the viewport, it returns the number of page
7059 * which meet the top-left of the viewport.
7061 * @see elm_scroller_last_page_get()
7062 * @see elm_scroller_page_show()
7063 * @see elm_scroller_page_brint_in()
7065 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7067 * @brief Get scroll last page number.
7069 * @param obj The scroller object
7070 * @param h_pagenumber The horizoptal page number
7071 * @param v_pagenumber The vertical page number
7073 * The page number starts from 0. 0 is the first page.
7074 * This returns the last page number among the pages.
7076 * @see elm_scroller_current_page_get()
7077 * @see elm_scroller_page_show()
7078 * @see elm_scroller_page_brint_in()
7080 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7082 * Show a specific virtual region within the scroller content object by page number.
7084 * @param obj The scroller object
7085 * @param h_pagenumber The horizoptal page number
7086 * @param v_pagenumber The vertical page number
7088 * 0, 0 of the indicated page is located at the top-left of the viewport.
7089 * This will jump to the page directly without animation.
7094 * sc = elm_scroller_add(win);
7095 * elm_scroller_content_set(sc, content);
7096 * elm_scroller_page_relative_set(sc, 1, 0);
7097 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7098 * elm_scroller_page_show(sc, h_page + 1, v_page);
7101 * @see elm_scroller_page_bring_in()
7103 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7105 * Show a specific virtual region within the scroller content object by page number.
7107 * @param obj The scroller object
7108 * @param h_pagenumber The horizoptal page number
7109 * @param v_pagenumber The vertical page number
7111 * 0, 0 of the indicated page is located at the top-left of the viewport.
7112 * This will slide to the page with animation.
7117 * sc = elm_scroller_add(win);
7118 * elm_scroller_content_set(sc, content);
7119 * elm_scroller_page_relative_set(sc, 1, 0);
7120 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7121 * elm_scroller_page_bring_in(sc, h_page, v_page);
7124 * @see elm_scroller_page_show()
7126 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7128 * @brief Show a specific virtual region within the scroller content object.
7130 * @param obj The scroller object
7131 * @param x X coordinate of the region
7132 * @param y Y coordinate of the region
7133 * @param w Width of the region
7134 * @param h Height of the region
7136 * This will ensure all (or part if it does not fit) of the designated
7137 * region in the virtual content object (0, 0 starting at the top-left of the
7138 * virtual content object) is shown within the scroller. Unlike
7139 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7140 * to this location (if configuration in general calls for transitions). It
7141 * may not jump immediately to the new location and make take a while and
7142 * show other content along the way.
7144 * @see elm_scroller_region_show()
7146 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);
7148 * @brief Set event propagation on a scroller
7150 * @param obj The scroller object
7151 * @param propagation If propagation is enabled or not
7153 * This enables or disabled event propagation from the scroller content to
7154 * the scroller and its parent. By default event propagation is disabled.
7156 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7158 * @brief Get event propagation for a scroller
7160 * @param obj The scroller object
7161 * @return The propagation state
7163 * This gets the event propagation for a scroller.
7165 * @see elm_scroller_propagate_events_set()
7167 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7173 * @defgroup Label Label
7175 * @image html img/widget/label/preview-00.png
7176 * @image latex img/widget/label/preview-00.eps
7178 * @brief Widget to display text, with simple html-like markup.
7180 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7181 * text doesn't fit the geometry of the label it will be ellipsized or be
7182 * cut. Elementary provides several themes for this widget:
7183 * @li default - No animation
7184 * @li marker - Centers the text in the label and make it bold by default
7185 * @li slide_long - The entire text appears from the right of the screen and
7186 * slides until it disappears in the left of the screen(reappering on the
7188 * @li slide_short - The text appears in the left of the label and slides to
7189 * the right to show the overflow. When all of the text has been shown the
7190 * position is reset.
7191 * @li slide_bounce - The text appears in the left of the label and slides to
7192 * the right to show the overflow. When all of the text has been shown the
7193 * animation reverses, moving the text to the left.
7195 * Custom themes can of course invent new markup tags and style them any way
7198 * See @ref tutorial_label for a demonstration of how to use a label widget.
7202 * @brief Add a new label to the parent
7204 * @param parent The parent object
7205 * @return The new object or NULL if it cannot be created
7207 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7209 * @brief Set the label on the label object
7211 * @param obj The label object
7212 * @param label The label will be used on the label object
7213 * @deprecated See elm_object_text_set()
7215 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 */
7217 * @brief Get the label used on the label object
7219 * @param obj The label object
7220 * @return The string inside the label
7221 * @deprecated See elm_object_text_get()
7223 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7225 * @brief Set the wrapping behavior of the label
7227 * @param obj The label object
7228 * @param wrap To wrap text or not
7230 * By default no wrapping is done. Possible values for @p wrap are:
7231 * @li ELM_WRAP_NONE - No wrapping
7232 * @li ELM_WRAP_CHAR - wrap between characters
7233 * @li ELM_WRAP_WORD - wrap between words
7234 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7236 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7238 * @brief Get the wrapping behavior of the label
7240 * @param obj The label object
7243 * @see elm_label_line_wrap_set()
7245 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7247 * @brief Set wrap width of the label
7249 * @param obj The label object
7250 * @param w The wrap width in pixels at a minimum where words need to wrap
7252 * This function sets the maximum width size hint of the label.
7254 * @warning This is only relevant if the label is inside a container.
7256 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7258 * @brief Get wrap width of the label
7260 * @param obj The label object
7261 * @return The wrap width in pixels at a minimum where words need to wrap
7263 * @see elm_label_wrap_width_set()
7265 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7267 * @brief Set wrap height of the label
7269 * @param obj The label object
7270 * @param h The wrap height in pixels at a minimum where words need to wrap
7272 * This function sets the maximum height size hint of the label.
7274 * @warning This is only relevant if the label is inside a container.
7276 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7278 * @brief get wrap width of the label
7280 * @param obj The label object
7281 * @return The wrap height in pixels at a minimum where words need to wrap
7283 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7285 * @brief Set the font size on the label object.
7287 * @param obj The label object
7288 * @param size font size
7290 * @warning NEVER use this. It is for hyper-special cases only. use styles
7291 * instead. e.g. "big", "medium", "small" - or better name them by use:
7292 * "title", "footnote", "quote" etc.
7294 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7296 * @brief Set the text color on the label object
7298 * @param obj The label object
7299 * @param r Red property background color of The label object
7300 * @param g Green property background color of The label object
7301 * @param b Blue property background color of The label object
7302 * @param a Alpha property background color of The label object
7304 * @warning NEVER use this. It is for hyper-special cases only. use styles
7305 * instead. e.g. "big", "medium", "small" - or better name them by use:
7306 * "title", "footnote", "quote" etc.
7308 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);
7310 * @brief Set the text align on the label object
7312 * @param obj The label object
7313 * @param align align mode ("left", "center", "right")
7315 * @warning NEVER use this. It is for hyper-special cases only. use styles
7316 * instead. e.g. "big", "medium", "small" - or better name them by use:
7317 * "title", "footnote", "quote" etc.
7319 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7321 * @brief Set background color of the label
7323 * @param obj The label object
7324 * @param r Red property background color of The label object
7325 * @param g Green property background color of The label object
7326 * @param b Blue property background color of The label object
7327 * @param a Alpha property background alpha of The label object
7329 * @warning NEVER use this. It is for hyper-special cases only. use styles
7330 * instead. e.g. "big", "medium", "small" - or better name them by use:
7331 * "title", "footnote", "quote" etc.
7333 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);
7335 * @brief Set the ellipsis behavior of the label
7337 * @param obj The label object
7338 * @param ellipsis To ellipsis text or not
7340 * If set to true and the text doesn't fit in the label an ellipsis("...")
7341 * will be shown at the end of the widget.
7343 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7344 * choosen wrap method was ELM_WRAP_WORD.
7346 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7348 * @brief Set the text slide of the label
7350 * @param obj The label object
7351 * @param slide To start slide or stop
7353 * If set to true the text of the label will slide throught the length of
7356 * @warning This only work with the themes "slide_short", "slide_long" and
7359 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7361 * @brief Get the text slide mode of the label
7363 * @param obj The label object
7364 * @return slide slide mode value
7366 * @see elm_label_slide_set()
7368 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7370 * @brief Set the slide duration(speed) of the label
7372 * @param obj The label object
7373 * @return The duration in seconds in moving text from slide begin position
7374 * to slide end position
7376 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7378 * @brief Get the slide duration(speed) of the label
7380 * @param obj The label object
7381 * @return The duration time in moving text from slide begin position to slide end position
7383 * @see elm_label_slide_duration_set()
7385 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7391 * @defgroup Toggle Toggle
7393 * @image html img/widget/toggle/preview-00.png
7394 * @image latex img/widget/toggle/preview-00.eps
7396 * @brief A toggle is a slider which can be used to toggle between
7397 * two values. It has two states: on and off.
7399 * Signals that you can add callbacks for are:
7400 * @li "changed" - Whenever the toggle value has been changed. Is not called
7401 * until the toggle is released by the cursor (assuming it
7402 * has been triggered by the cursor in the first place).
7404 * @ref tutorial_toggle show how to use a toggle.
7408 * @brief Add a toggle to @p parent.
7410 * @param parent The parent object
7412 * @return The toggle object
7414 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7416 * @brief Sets the label to be displayed with the toggle.
7418 * @param obj The toggle object
7419 * @param label The label to be displayed
7421 * @deprecated use elm_object_text_set() instead.
7423 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7425 * @brief Gets the label of the toggle
7427 * @param obj toggle object
7428 * @return The label of the toggle
7430 * @deprecated use elm_object_text_get() instead.
7432 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7434 * @brief Set the icon used for the toggle
7436 * @param obj The toggle object
7437 * @param icon The icon object for the button
7439 * Once the icon object is set, a previously set one will be deleted
7440 * If you want to keep that old content object, use the
7441 * elm_toggle_icon_unset() function.
7443 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7445 * @brief Get the icon used for the toggle
7447 * @param obj The toggle object
7448 * @return The icon object that is being used
7450 * Return the icon object which is set for this widget.
7452 * @see elm_toggle_icon_set()
7454 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7456 * @brief Unset the icon used for the toggle
7458 * @param obj The toggle object
7459 * @return The icon object that was being used
7461 * Unparent and return the icon object which was set for this widget.
7463 * @see elm_toggle_icon_set()
7465 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7467 * @brief Sets the labels to be associated with the on and off states of the toggle.
7469 * @param obj The toggle object
7470 * @param onlabel The label displayed when the toggle is in the "on" state
7471 * @param offlabel The label displayed when the toggle is in the "off" state
7473 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7475 * @brief Gets the labels associated with the on and off states of the toggle.
7477 * @param obj The toggle object
7478 * @param onlabel A char** to place the onlabel of @p obj into
7479 * @param offlabel A char** to place the offlabel of @p obj into
7481 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7483 * @brief Sets the state of the toggle to @p state.
7485 * @param obj The toggle object
7486 * @param state The state of @p obj
7488 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7490 * @brief Gets the state of the toggle to @p state.
7492 * @param obj The toggle object
7493 * @return The state of @p obj
7495 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7497 * @brief Sets the state pointer of the toggle to @p statep.
7499 * @param obj The toggle object
7500 * @param statep The state pointer of @p obj
7502 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7508 * @defgroup Frame Frame
7510 * @image html img/widget/frame/preview-00.png
7511 * @image latex img/widget/frame/preview-00.eps
7513 * @brief Frame is a widget that holds some content and has a title.
7515 * The default look is a frame with a title, but Frame supports multple
7523 * @li outdent_bottom
7525 * Of all this styles only default shows the title. Frame emits no signals.
7527 * For a detailed example see the @ref tutorial_frame.
7532 * @brief Add a new frame to the parent
7534 * @param parent The parent object
7535 * @return The new object or NULL if it cannot be created
7537 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7539 * @brief Set the frame label
7541 * @param obj The frame object
7542 * @param label The label of this frame object
7544 * @deprecated use elm_object_text_set() instead.
7546 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7548 * @brief Get the frame label
7550 * @param obj The frame object
7552 * @return The label of this frame objet or NULL if unable to get frame
7554 * @deprecated use elm_object_text_get() instead.
7556 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7558 * @brief Set the content of the frame widget
7560 * Once the content object is set, a previously set one will be deleted.
7561 * If you want to keep that old content object, use the
7562 * elm_frame_content_unset() function.
7564 * @param obj The frame object
7565 * @param content The content will be filled in this frame object
7567 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7569 * @brief Get the content of the frame widget
7571 * Return the content object which is set for this widget
7573 * @param obj The frame object
7574 * @return The content that is being used
7576 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7578 * @brief Unset the content of the frame widget
7580 * Unparent and return the content object which was set for this widget
7582 * @param obj The frame object
7583 * @return The content that was being used
7585 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7591 * @defgroup Table Table
7593 * A container widget to arrange other widgets in a table where items can
7594 * also span multiple columns or rows - even overlap (and then be raised or
7595 * lowered accordingly to adjust stacking if they do overlap).
7597 * The followin are examples of how to use a table:
7598 * @li @ref tutorial_table_01
7599 * @li @ref tutorial_table_02
7604 * @brief Add a new table to the parent
7606 * @param parent The parent object
7607 * @return The new object or NULL if it cannot be created
7609 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7611 * @brief Set the homogeneous layout in the table
7613 * @param obj The layout object
7614 * @param homogeneous A boolean to set if the layout is homogeneous in the
7615 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7617 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7619 * @brief Get the current table homogeneous mode.
7621 * @param obj The table object
7622 * @return A boolean to indicating if the layout is homogeneous in the table
7623 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7625 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7627 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7629 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7631 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7633 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7635 * @brief Set padding between cells.
7637 * @param obj The layout object.
7638 * @param horizontal set the horizontal padding.
7639 * @param vertical set the vertical padding.
7641 * Default value is 0.
7643 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7645 * @brief Get padding between cells.
7647 * @param obj The layout object.
7648 * @param horizontal set the horizontal padding.
7649 * @param vertical set the vertical padding.
7651 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7653 * @brief Add a subobject on the table with the coordinates passed
7655 * @param obj The table object
7656 * @param subobj The subobject to be added to the table
7657 * @param x Row number
7658 * @param y Column number
7662 * @note All positioning inside the table is relative to rows and columns, so
7663 * a value of 0 for x and y, means the top left cell of the table, and a
7664 * value of 1 for w and h means @p subobj only takes that 1 cell.
7666 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7668 * @brief Remove child from table.
7670 * @param obj The table object
7671 * @param subobj The subobject
7673 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7675 * @brief Faster way to remove all child objects from a table object.
7677 * @param obj The table object
7678 * @param clear If true, will delete children, else just remove from table.
7680 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7682 * @brief Set the packing location of an existing child of the table
7684 * @param subobj The subobject to be modified in the table
7685 * @param x Row number
7686 * @param y Column number
7690 * Modifies the position of an object already in the table.
7692 * @note All positioning inside the table is relative to rows and columns, so
7693 * a value of 0 for x and y, means the top left cell of the table, and a
7694 * value of 1 for w and h means @p subobj only takes that 1 cell.
7696 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7698 * @brief Get the packing location of an existing child of the table
7700 * @param subobj The subobject to be modified in the table
7701 * @param x Row number
7702 * @param y Column number
7706 * @see elm_table_pack_set()
7708 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7714 * @defgroup Gengrid Gengrid (Generic grid)
7716 * This widget aims to position objects in a grid layout while
7717 * actually creating and rendering only the visible ones, using the
7718 * same idea as the @ref Genlist "genlist": the user defines a @b
7719 * class for each item, specifying functions that will be called at
7720 * object creation, deletion, etc. When those items are selected by
7721 * the user, a callback function is issued. Users may interact with
7722 * a gengrid via the mouse (by clicking on items to select them and
7723 * clicking on the grid's viewport and swiping to pan the whole
7724 * view) or via the keyboard, navigating through item with the
7727 * @section Gengrid_Layouts Gengrid layouts
7729 * Gengrids may layout its items in one of two possible layouts:
7733 * When in "horizontal mode", items will be placed in @b columns,
7734 * from top to bottom and, when the space for a column is filled,
7735 * another one is started on the right, thus expanding the grid
7736 * horizontally, making for horizontal scrolling. When in "vertical
7737 * mode" , though, items will be placed in @b rows, from left to
7738 * right and, when the space for a row is filled, another one is
7739 * started below, thus expanding the grid vertically (and making
7740 * for vertical scrolling).
7742 * @section Gengrid_Items Gengrid items
7744 * An item in a gengrid can have 0 or more text labels (they can be
7745 * regular text or textblock Evas objects - that's up to the style
7746 * to determine), 0 or more icons (which are simply objects
7747 * swallowed into the gengrid item's theming Edje object) and 0 or
7748 * more <b>boolean states</b>, which have the behavior left to the
7749 * user to define. The Edje part names for each of these properties
7750 * will be looked up, in the theme file for the gengrid, under the
7751 * Edje (string) data items named @c "labels", @c "icons" and @c
7752 * "states", respectively. For each of those properties, if more
7753 * than one part is provided, they must have names listed separated
7754 * by spaces in the data fields. For the default gengrid item
7755 * theme, we have @b one label part (@c "elm.text"), @b two icon
7756 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7759 * A gengrid item may be at one of several styles. Elementary
7760 * provides one by default - "default", but this can be extended by
7761 * system or application custom themes/overlays/extensions (see
7762 * @ref Theme "themes" for more details).
7764 * @section Gengrid_Item_Class Gengrid item classes
7766 * In order to have the ability to add and delete items on the fly,
7767 * gengrid implements a class (callback) system where the
7768 * application provides a structure with information about that
7769 * type of item (gengrid may contain multiple different items with
7770 * different classes, states and styles). Gengrid will call the
7771 * functions in this struct (methods) when an item is "realized"
7772 * (i.e., created dynamically, while the user is scrolling the
7773 * grid). All objects will simply be deleted when no longer needed
7774 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7775 * contains the following members:
7776 * - @c item_style - This is a constant string and simply defines
7777 * the name of the item style. It @b must be specified and the
7778 * default should be @c "default".
7779 * - @c func.label_get - This function is called when an item
7780 * object is actually created. The @c data parameter will point to
7781 * the same data passed to elm_gengrid_item_append() and related
7782 * item creation functions. The @c obj parameter is the gengrid
7783 * object itself, while the @c part one is the name string of one
7784 * of the existing text parts in the Edje group implementing the
7785 * item's theme. This function @b must return a strdup'()ed string,
7786 * as the caller will free() it when done. See
7787 * #Elm_Gengrid_Item_Label_Get_Cb.
7788 * - @c func.icon_get - This function is called when an item object
7789 * is actually created. The @c data parameter will point to the
7790 * same data passed to elm_gengrid_item_append() and related item
7791 * creation functions. The @c obj parameter is the gengrid object
7792 * itself, while the @c part one is the name string of one of the
7793 * existing (icon) swallow parts in the Edje group implementing the
7794 * item's theme. It must return @c NULL, when no icon is desired,
7795 * or a valid object handle, otherwise. The object will be deleted
7796 * by the gengrid on its deletion or when the item is "unrealized".
7797 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7798 * - @c func.state_get - This function is called when an item
7799 * object is actually created. The @c data parameter will point to
7800 * the same data passed to elm_gengrid_item_append() and related
7801 * item creation functions. The @c obj parameter is the gengrid
7802 * object itself, while the @c part one is the name string of one
7803 * of the state parts in the Edje group implementing the item's
7804 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7805 * true/on. Gengrids will emit a signal to its theming Edje object
7806 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7807 * "source" arguments, respectively, when the state is true (the
7808 * default is false), where @c XXX is the name of the (state) part.
7809 * See #Elm_Gengrid_Item_State_Get_Cb.
7810 * - @c func.del - This is called when elm_gengrid_item_del() is
7811 * called on an item or elm_gengrid_clear() is called on the
7812 * gengrid. This is intended for use when gengrid items are
7813 * deleted, so any data attached to the item (e.g. its data
7814 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7816 * @section Gengrid_Usage_Hints Usage hints
7818 * If the user wants to have multiple items selected at the same
7819 * time, elm_gengrid_multi_select_set() will permit it. If the
7820 * gengrid is single-selection only (the default), then
7821 * elm_gengrid_select_item_get() will return the selected item or
7822 * @c NULL, if none is selected. If the gengrid is under
7823 * multi-selection, then elm_gengrid_selected_items_get() will
7824 * return a list (that is only valid as long as no items are
7825 * modified (added, deleted, selected or unselected) of child items
7828 * If an item changes (internal (boolean) state, label or icon
7829 * changes), then use elm_gengrid_item_update() to have gengrid
7830 * update the item with the new state. A gengrid will re-"realize"
7831 * the item, thus calling the functions in the
7832 * #Elm_Gengrid_Item_Class set for that item.
7834 * To programmatically (un)select an item, use
7835 * elm_gengrid_item_selected_set(). To get its selected state use
7836 * elm_gengrid_item_selected_get(). To make an item disabled
7837 * (unable to be selected and appear differently) use
7838 * elm_gengrid_item_disabled_set() to set this and
7839 * elm_gengrid_item_disabled_get() to get the disabled state.
7841 * Grid cells will only have their selection smart callbacks called
7842 * when firstly getting selected. Any further clicks will do
7843 * nothing, unless you enable the "always select mode", with
7844 * elm_gengrid_always_select_mode_set(), thus making every click to
7845 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7846 * turn off the ability to select items entirely in the widget and
7847 * they will neither appear selected nor call the selection smart
7850 * Remember that you can create new styles and add your own theme
7851 * augmentation per application with elm_theme_extension_add(). If
7852 * you absolutely must have a specific style that overrides any
7853 * theme the user or system sets up you can use
7854 * elm_theme_overlay_add() to add such a file.
7856 * @section Gengrid_Smart_Events Gengrid smart events
7858 * Smart events that you can add callbacks for are:
7859 * - @c "activated" - The user has double-clicked or pressed
7860 * (enter|return|spacebar) on an item. The @c event_info parameter
7861 * is the gengrid item that was activated.
7862 * - @c "clicked,double" - The user has double-clicked an item.
7863 * The @c event_info parameter is the gengrid item that was double-clicked.
7864 * - @c "longpressed" - This is called when the item is pressed for a certain
7865 * amount of time. By default it's 1 second.
7866 * - @c "selected" - The user has made an item selected. The
7867 * @c event_info parameter is the gengrid item that was selected.
7868 * - @c "unselected" - The user has made an item unselected. The
7869 * @c event_info parameter is the gengrid item that was unselected.
7870 * - @c "realized" - This is called when the item in the gengrid
7871 * has its implementing Evas object instantiated, de facto. @c
7872 * event_info is the gengrid item that was created. The object
7873 * may be deleted at any time, so it is highly advised to the
7874 * caller @b not to use the object pointer returned from
7875 * elm_gengrid_item_object_get(), because it may point to freed
7877 * - @c "unrealized" - This is called when the implementing Evas
7878 * object for this item is deleted. @c event_info is the gengrid
7879 * item that was deleted.
7880 * - @c "changed" - Called when an item is added, removed, resized
7881 * or moved and when the gengrid is resized or gets "horizontal"
7883 * - @c "scroll,anim,start" - This is called when scrolling animation has
7885 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7887 * - @c "drag,start,up" - Called when the item in the gengrid has
7888 * been dragged (not scrolled) up.
7889 * - @c "drag,start,down" - Called when the item in the gengrid has
7890 * been dragged (not scrolled) down.
7891 * - @c "drag,start,left" - Called when the item in the gengrid has
7892 * been dragged (not scrolled) left.
7893 * - @c "drag,start,right" - Called when the item in the gengrid has
7894 * been dragged (not scrolled) right.
7895 * - @c "drag,stop" - Called when the item in the gengrid has
7896 * stopped being dragged.
7897 * - @c "drag" - Called when the item in the gengrid is being
7899 * - @c "scroll" - called when the content has been scrolled
7901 * - @c "scroll,drag,start" - called when dragging the content has
7903 * - @c "scroll,drag,stop" - called when dragging the content has
7906 * List of gengrid examples:
7907 * @li @ref gengrid_example
7911 * @addtogroup Gengrid
7915 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7916 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7917 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7918 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7919 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. */
7920 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. */
7921 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7923 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7924 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7925 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7926 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7929 * @struct _Elm_Gengrid_Item_Class
7931 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7934 struct _Elm_Gengrid_Item_Class
7936 const char *item_style;
7937 struct _Elm_Gengrid_Item_Class_Func
7939 Elm_Gengrid_Item_Label_Get_Cb label_get;
7940 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7941 Elm_Gengrid_Item_State_Get_Cb state_get;
7942 Elm_Gengrid_Item_Del_Cb del;
7944 }; /**< #Elm_Gengrid_Item_Class member definitions */
7947 * Add a new gengrid widget to the given parent Elementary
7948 * (container) object
7950 * @param parent The parent object
7951 * @return a new gengrid widget handle or @c NULL, on errors
7953 * This function inserts a new gengrid widget on the canvas.
7955 * @see elm_gengrid_item_size_set()
7956 * @see elm_gengrid_group_item_size_set()
7957 * @see elm_gengrid_horizontal_set()
7958 * @see elm_gengrid_item_append()
7959 * @see elm_gengrid_item_del()
7960 * @see elm_gengrid_clear()
7964 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7967 * Set the size for the items of a given gengrid widget
7969 * @param obj The gengrid object.
7970 * @param w The items' width.
7971 * @param h The items' height;
7973 * A gengrid, after creation, has still no information on the size
7974 * to give to each of its cells. So, you most probably will end up
7975 * with squares one @ref Fingers "finger" wide, the default
7976 * size. Use this function to force a custom size for you items,
7977 * making them as big as you wish.
7979 * @see elm_gengrid_item_size_get()
7983 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7986 * Get the size set for the items of a given gengrid widget
7988 * @param obj The gengrid object.
7989 * @param w Pointer to a variable where to store the items' width.
7990 * @param h Pointer to a variable where to store the items' height.
7992 * @note Use @c NULL pointers on the size values you're not
7993 * interested in: they'll be ignored by the function.
7995 * @see elm_gengrid_item_size_get() for more details
7999 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8002 * Set the size for the group items of a given gengrid widget
8004 * @param obj The gengrid object.
8005 * @param w The group items' width.
8006 * @param h The group items' height;
8008 * A gengrid, after creation, has still no information on the size
8009 * to give to each of its cells. So, you most probably will end up
8010 * with squares one @ref Fingers "finger" wide, the default
8011 * size. Use this function to force a custom size for you group items,
8012 * making them as big as you wish.
8014 * @see elm_gengrid_group_item_size_get()
8018 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8021 * Get the size set for the group items of a given gengrid widget
8023 * @param obj The gengrid object.
8024 * @param w Pointer to a variable where to store the group items' width.
8025 * @param h Pointer to a variable where to store the group items' height.
8027 * @note Use @c NULL pointers on the size values you're not
8028 * interested in: they'll be ignored by the function.
8030 * @see elm_gengrid_group_item_size_get() for more details
8034 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8037 * Set the items grid's alignment within a given gengrid widget
8039 * @param obj The gengrid object.
8040 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8041 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8043 * This sets the alignment of the whole grid of items of a gengrid
8044 * within its given viewport. By default, those values are both
8045 * 0.5, meaning that the gengrid will have its items grid placed
8046 * exactly in the middle of its viewport.
8048 * @note If given alignment values are out of the cited ranges,
8049 * they'll be changed to the nearest boundary values on the valid
8052 * @see elm_gengrid_align_get()
8056 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8059 * Get the items grid's alignment values within a given gengrid
8062 * @param obj The gengrid object.
8063 * @param align_x Pointer to a variable where to store the
8064 * horizontal alignment.
8065 * @param align_y Pointer to a variable where to store the vertical
8068 * @note Use @c NULL pointers on the alignment values you're not
8069 * interested in: they'll be ignored by the function.
8071 * @see elm_gengrid_align_set() for more details
8075 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8078 * Set whether a given gengrid widget is or not able have items
8081 * @param obj The gengrid object
8082 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8083 * @c EINA_FALSE to turn it off
8085 * If a gengrid is set to allow reordering, a click held for more
8086 * than 0.5 over a given item will highlight it specially,
8087 * signalling the gengrid has entered the reordering state. From
8088 * that time on, the user will be able to, while still holding the
8089 * mouse button down, move the item freely in the gengrid's
8090 * viewport, replacing to said item to the locations it goes to.
8091 * The replacements will be animated and, whenever the user
8092 * releases the mouse button, the item being replaced gets a new
8093 * definitive place in the grid.
8095 * @see elm_gengrid_reorder_mode_get()
8099 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8102 * Get whether a given gengrid widget is or not able have items
8105 * @param obj The gengrid object
8106 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8109 * @see elm_gengrid_reorder_mode_set() for more details
8113 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8116 * Append a new item in a given gengrid widget.
8118 * @param obj The gengrid object.
8119 * @param gic The item class for the item.
8120 * @param data The item data.
8121 * @param func Convenience function called when the item is
8123 * @param func_data Data to be passed to @p func.
8124 * @return A handle to the item added or @c NULL, on errors.
8126 * This adds an item to the beginning of the gengrid.
8128 * @see elm_gengrid_item_prepend()
8129 * @see elm_gengrid_item_insert_before()
8130 * @see elm_gengrid_item_insert_after()
8131 * @see elm_gengrid_item_del()
8135 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);
8138 * Prepend a new item in a given gengrid widget.
8140 * @param obj The gengrid object.
8141 * @param gic The item class for the item.
8142 * @param data The item data.
8143 * @param func Convenience function called when the item is
8145 * @param func_data Data to be passed to @p func.
8146 * @return A handle to the item added or @c NULL, on errors.
8148 * This adds an item to the end of the gengrid.
8150 * @see elm_gengrid_item_append()
8151 * @see elm_gengrid_item_insert_before()
8152 * @see elm_gengrid_item_insert_after()
8153 * @see elm_gengrid_item_del()
8157 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);
8160 * Insert an item before another in a gengrid widget
8162 * @param obj The gengrid object.
8163 * @param gic The item class for the item.
8164 * @param data The item data.
8165 * @param relative The item to place this new one before.
8166 * @param func Convenience function called when the item is
8168 * @param func_data Data to be passed to @p func.
8169 * @return A handle to the item added or @c NULL, on errors.
8171 * This inserts an item before another in the gengrid.
8173 * @see elm_gengrid_item_append()
8174 * @see elm_gengrid_item_prepend()
8175 * @see elm_gengrid_item_insert_after()
8176 * @see elm_gengrid_item_del()
8180 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);
8183 * Insert an item after another in a gengrid widget
8185 * @param obj The gengrid object.
8186 * @param gic The item class for the item.
8187 * @param data The item data.
8188 * @param relative The item to place this new one after.
8189 * @param func Convenience function called when the item is
8191 * @param func_data Data to be passed to @p func.
8192 * @return A handle to the item added or @c NULL, on errors.
8194 * This inserts an item after another in the gengrid.
8196 * @see elm_gengrid_item_append()
8197 * @see elm_gengrid_item_prepend()
8198 * @see elm_gengrid_item_insert_after()
8199 * @see elm_gengrid_item_del()
8203 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);
8205 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);
8207 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);
8210 * Set whether items on a given gengrid widget are to get their
8211 * selection callbacks issued for @b every subsequent selection
8212 * click on them or just for the first click.
8214 * @param obj The gengrid object
8215 * @param always_select @c EINA_TRUE to make items "always
8216 * selected", @c EINA_FALSE, otherwise
8218 * By default, grid items will only call their selection callback
8219 * function when firstly getting selected, any subsequent further
8220 * clicks will do nothing. With this call, you make those
8221 * subsequent clicks also to issue the selection callbacks.
8223 * @note <b>Double clicks</b> will @b always be reported on items.
8225 * @see elm_gengrid_always_select_mode_get()
8229 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8232 * Get whether items on a given gengrid widget have their selection
8233 * callbacks issued for @b every subsequent selection click on them
8234 * or just for the first click.
8236 * @param obj The gengrid object.
8237 * @return @c EINA_TRUE if the gengrid items are "always selected",
8238 * @c EINA_FALSE, otherwise
8240 * @see elm_gengrid_always_select_mode_set() for more details
8244 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8247 * Set whether items on a given gengrid widget can be selected or not.
8249 * @param obj The gengrid object
8250 * @param no_select @c EINA_TRUE to make items selectable,
8251 * @c EINA_FALSE otherwise
8253 * This will make items in @p obj selectable or not. In the latter
8254 * case, any user interaction on the gengrid items will neither make
8255 * them appear selected nor them call their selection callback
8258 * @see elm_gengrid_no_select_mode_get()
8262 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8265 * Get whether items on a given gengrid widget can be selected or
8268 * @param obj The gengrid object
8269 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8272 * @see elm_gengrid_no_select_mode_set() for more details
8276 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8279 * Enable or disable multi-selection in a given gengrid widget
8281 * @param obj The gengrid object.
8282 * @param multi @c EINA_TRUE, to enable multi-selection,
8283 * @c EINA_FALSE to disable it.
8285 * Multi-selection is the ability for one to have @b more than one
8286 * item selected, on a given gengrid, simultaneously. When it is
8287 * enabled, a sequence of clicks on different items will make them
8288 * all selected, progressively. A click on an already selected item
8289 * will unselect it. If interecting via the keyboard,
8290 * multi-selection is enabled while holding the "Shift" key.
8292 * @note By default, multi-selection is @b disabled on gengrids
8294 * @see elm_gengrid_multi_select_get()
8298 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8301 * Get whether multi-selection is enabled or disabled for a given
8304 * @param obj The gengrid object.
8305 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8306 * EINA_FALSE otherwise
8308 * @see elm_gengrid_multi_select_set() for more details
8312 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8315 * Enable or disable bouncing effect for a given gengrid widget
8317 * @param obj The gengrid object
8318 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8319 * @c EINA_FALSE to disable it
8320 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8321 * @c EINA_FALSE to disable it
8323 * The bouncing effect occurs whenever one reaches the gengrid's
8324 * edge's while panning it -- it will scroll past its limits a
8325 * little bit and return to the edge again, in a animated for,
8328 * @note By default, gengrids have bouncing enabled on both axis
8330 * @see elm_gengrid_bounce_get()
8334 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8337 * Get whether bouncing effects are enabled or disabled, for a
8338 * given gengrid widget, on each axis
8340 * @param obj The gengrid object
8341 * @param h_bounce Pointer to a variable where to store the
8342 * horizontal bouncing flag.
8343 * @param v_bounce Pointer to a variable where to store the
8344 * vertical bouncing flag.
8346 * @see elm_gengrid_bounce_set() for more details
8350 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8353 * Set a given gengrid widget's scrolling page size, relative to
8354 * its viewport size.
8356 * @param obj The gengrid object
8357 * @param h_pagerel The horizontal page (relative) size
8358 * @param v_pagerel The vertical page (relative) size
8360 * The gengrid's scroller is capable of binding scrolling by the
8361 * user to "pages". It means that, while scrolling and, specially
8362 * after releasing the mouse button, the grid will @b snap to the
8363 * nearest displaying page's area. When page sizes are set, the
8364 * grid's continuous content area is split into (equal) page sized
8367 * This function sets the size of a page <b>relatively to the
8368 * viewport dimensions</b> of the gengrid, for each axis. A value
8369 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8370 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8371 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8372 * 1.0. Values beyond those will make it behave behave
8373 * inconsistently. If you only want one axis to snap to pages, use
8374 * the value @c 0.0 for the other one.
8376 * There is a function setting page size values in @b absolute
8377 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8378 * is mutually exclusive to this one.
8380 * @see elm_gengrid_page_relative_get()
8384 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8387 * Get a given gengrid widget's scrolling page size, relative to
8388 * its viewport size.
8390 * @param obj The gengrid object
8391 * @param h_pagerel Pointer to a variable where to store the
8392 * horizontal page (relative) size
8393 * @param v_pagerel Pointer to a variable where to store the
8394 * vertical page (relative) size
8396 * @see elm_gengrid_page_relative_set() for more details
8400 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8403 * Set a given gengrid widget's scrolling page size
8405 * @param obj The gengrid object
8406 * @param h_pagerel The horizontal page size, in pixels
8407 * @param v_pagerel The vertical page size, in pixels
8409 * The gengrid's scroller is capable of binding scrolling by the
8410 * user to "pages". It means that, while scrolling and, specially
8411 * after releasing the mouse button, the grid will @b snap to the
8412 * nearest displaying page's area. When page sizes are set, the
8413 * grid's continuous content area is split into (equal) page sized
8416 * This function sets the size of a page of the gengrid, in pixels,
8417 * for each axis. Sane usable values are, between @c 0 and the
8418 * dimensions of @p obj, for each axis. Values beyond those will
8419 * make it behave behave inconsistently. If you only want one axis
8420 * to snap to pages, use the value @c 0 for the other one.
8422 * There is a function setting page size values in @b relative
8423 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8424 * use is mutually exclusive to this one.
8428 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8431 * @brief Get gengrid current page number.
8433 * @param obj The gengrid object
8434 * @param h_pagenumber The horizontal page number
8435 * @param v_pagenumber The vertical page number
8437 * The page number starts from 0. 0 is the first page.
8438 * Current page means the page which meet the top-left of the viewport.
8439 * If there are two or more pages in the viewport, it returns the number of page
8440 * which meet the top-left of the viewport.
8442 * @see elm_gengrid_last_page_get()
8443 * @see elm_gengrid_page_show()
8444 * @see elm_gengrid_page_brint_in()
8446 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8449 * @brief Get scroll last page number.
8451 * @param obj The gengrid object
8452 * @param h_pagenumber The horizoptal page number
8453 * @param v_pagenumber The vertical page number
8455 * The page number starts from 0. 0 is the first page.
8456 * This returns the last page number among the pages.
8458 * @see elm_gengrid_current_page_get()
8459 * @see elm_gengrid_page_show()
8460 * @see elm_gengrid_page_brint_in()
8462 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8465 * Show a specific virtual region within the gengrid content object by page number.
8467 * @param obj The gengrid object
8468 * @param h_pagenumber The horizoptal page number
8469 * @param v_pagenumber The vertical page number
8471 * 0, 0 of the indicated page is located at the top-left of the viewport.
8472 * This will jump to the page directly without animation.
8477 * sc = elm_gengrid_add(win);
8478 * elm_gengrid_content_set(sc, content);
8479 * elm_gengrid_page_relative_set(sc, 1, 0);
8480 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8481 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8484 * @see elm_gengrid_page_bring_in()
8486 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8489 * Show a specific virtual region within the gengrid content object by page number.
8491 * @param obj The gengrid object
8492 * @param h_pagenumber The horizoptal page number
8493 * @param v_pagenumber The vertical page number
8495 * 0, 0 of the indicated page is located at the top-left of the viewport.
8496 * This will slide to the page with animation.
8501 * sc = elm_gengrid_add(win);
8502 * elm_gengrid_content_set(sc, content);
8503 * elm_gengrid_page_relative_set(sc, 1, 0);
8504 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8505 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8508 * @see elm_gengrid_page_show()
8510 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8513 * Set for what direction a given gengrid widget will expand while
8514 * placing its items.
8516 * @param obj The gengrid object.
8517 * @param setting @c EINA_TRUE to make the gengrid expand
8518 * horizontally, @c EINA_FALSE to expand vertically.
8520 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8521 * in @b columns, from top to bottom and, when the space for a
8522 * column is filled, another one is started on the right, thus
8523 * expanding the grid horizontally. When in "vertical mode"
8524 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8525 * to right and, when the space for a row is filled, another one is
8526 * started below, thus expanding the grid vertically.
8528 * @see elm_gengrid_horizontal_get()
8532 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8535 * Get for what direction a given gengrid widget will expand while
8536 * placing its items.
8538 * @param obj The gengrid object.
8539 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8540 * @c EINA_FALSE if it's set to expand vertically.
8542 * @see elm_gengrid_horizontal_set() for more detais
8546 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8549 * Get the first item in a given gengrid widget
8551 * @param obj The gengrid object
8552 * @return The first item's handle or @c NULL, if there are no
8553 * items in @p obj (and on errors)
8555 * This returns the first item in the @p obj's internal list of
8558 * @see elm_gengrid_last_item_get()
8562 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8565 * Get the last item in a given gengrid widget
8567 * @param obj The gengrid object
8568 * @return The last item's handle or @c NULL, if there are no
8569 * items in @p obj (and on errors)
8571 * This returns the last item in the @p obj's internal list of
8574 * @see elm_gengrid_first_item_get()
8578 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8581 * Get the @b next item in a gengrid widget's internal list of items,
8582 * given a handle to one of those items.
8584 * @param item The gengrid item to fetch next from
8585 * @return The item after @p item, or @c NULL if there's none (and
8588 * This returns the item placed after the @p item, on the container
8591 * @see elm_gengrid_item_prev_get()
8595 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8598 * Get the @b previous item in a gengrid widget's internal list of items,
8599 * given a handle to one of those items.
8601 * @param item The gengrid item to fetch previous from
8602 * @return The item before @p item, or @c NULL if there's none (and
8605 * This returns the item placed before the @p item, on the container
8608 * @see elm_gengrid_item_next_get()
8612 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8615 * Get the gengrid object's handle which contains a given gengrid
8618 * @param item The item to fetch the container from
8619 * @return The gengrid (parent) object
8621 * This returns the gengrid object itself that an item belongs to.
8625 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8628 * Remove a gengrid item from the its parent, deleting it.
8630 * @param item The item to be removed.
8631 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8633 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8638 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8641 * Update the contents of a given gengrid item
8643 * @param item The gengrid item
8645 * This updates an item by calling all the item class functions
8646 * again to get the icons, labels and states. Use this when the
8647 * original item data has changed and you want thta changes to be
8652 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8653 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8654 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8657 * Return the data associated to a given gengrid item
8659 * @param item The gengrid item.
8660 * @return the data associated to this item.
8662 * This returns the @c data value passed on the
8663 * elm_gengrid_item_append() and related item addition calls.
8665 * @see elm_gengrid_item_append()
8666 * @see elm_gengrid_item_data_set()
8670 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8673 * Set the data associated to a given gengrid item
8675 * @param item The gengrid item
8676 * @param data The new data pointer to set on it
8678 * This @b overrides the @c data value passed on the
8679 * elm_gengrid_item_append() and related item addition calls. This
8680 * function @b won't call elm_gengrid_item_update() automatically,
8681 * so you'd issue it afterwards if you want to hove the item
8682 * updated to reflect the that new data.
8684 * @see elm_gengrid_item_data_get()
8688 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8691 * Get a given gengrid item's position, relative to the whole
8692 * gengrid's grid area.
8694 * @param item The Gengrid item.
8695 * @param x Pointer to variable where to store the item's <b>row
8697 * @param y Pointer to variable where to store the item's <b>column
8700 * This returns the "logical" position of the item whithin the
8701 * gengrid. For example, @c (0, 1) would stand for first row,
8706 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8709 * Set whether a given gengrid item is selected or not
8711 * @param item The gengrid item
8712 * @param selected Use @c EINA_TRUE, to make it selected, @c
8713 * EINA_FALSE to make it unselected
8715 * This sets the selected state of an item. If multi selection is
8716 * not enabled on the containing gengrid and @p selected is @c
8717 * EINA_TRUE, any other previously selected items will get
8718 * unselected in favor of this new one.
8720 * @see elm_gengrid_item_selected_get()
8724 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8727 * Get whether a given gengrid item is selected or not
8729 * @param item The gengrid item
8730 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8732 * @see elm_gengrid_item_selected_set() for more details
8736 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8739 * Get the real Evas object created to implement the view of a
8740 * given gengrid item
8742 * @param item The gengrid item.
8743 * @return the Evas object implementing this item's view.
8745 * This returns the actual Evas object used to implement the
8746 * specified gengrid item's view. This may be @c NULL, as it may
8747 * not have been created or may have been deleted, at any time, by
8748 * the gengrid. <b>Do not modify this object</b> (move, resize,
8749 * show, hide, etc.), as the gengrid is controlling it. This
8750 * function is for querying, emitting custom signals or hooking
8751 * lower level callbacks for events on that object. Do not delete
8752 * this object under any circumstances.
8754 * @see elm_gengrid_item_data_get()
8758 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8761 * Show the portion of a gengrid's internal grid containing a given
8762 * item, @b immediately.
8764 * @param item The item to display
8766 * This causes gengrid to @b redraw its viewport's contents to the
8767 * region contining the given @p item item, if it is not fully
8770 * @see elm_gengrid_item_bring_in()
8774 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8777 * Animatedly bring in, to the visible are of a gengrid, a given
8780 * @param item The gengrid item to display
8782 * This causes gengrig to jump to the given @p item item and show
8783 * it (by scrolling), if it is not fully visible. This will use
8784 * animation to do so and take a period of time to complete.
8786 * @see elm_gengrid_item_show()
8790 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8793 * Set whether a given gengrid item is disabled or not.
8795 * @param item The gengrid item
8796 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8797 * to enable it back.
8799 * A disabled item cannot be selected or unselected. It will also
8800 * change its appearance, to signal the user it's disabled.
8802 * @see elm_gengrid_item_disabled_get()
8806 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8809 * Get whether a given gengrid item is disabled or not.
8811 * @param item The gengrid item
8812 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8815 * @see elm_gengrid_item_disabled_set() for more details
8819 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8822 * Set the text to be shown in a given gengrid item's tooltips.
8824 * @param item The gengrid item
8825 * @param text The text to set in the content
8827 * This call will setup the text to be used as tooltip to that item
8828 * (analogous to elm_object_tooltip_text_set(), but being item
8829 * tooltips with higher precedence than object tooltips). It can
8830 * have only one tooltip at a time, so any previous tooltip data
8835 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8838 * Set the content to be shown in a given gengrid item's tooltips
8840 * @param item The gengrid item.
8841 * @param func The function returning the tooltip contents.
8842 * @param data What to provide to @a func as callback data/context.
8843 * @param del_cb Called when data is not needed anymore, either when
8844 * another callback replaces @p func, the tooltip is unset with
8845 * elm_gengrid_item_tooltip_unset() or the owner @p item
8846 * dies. This callback receives as its first parameter the
8847 * given @p data, being @c event_info the item handle.
8849 * This call will setup the tooltip's contents to @p item
8850 * (analogous to elm_object_tooltip_content_cb_set(), but being
8851 * item tooltips with higher precedence than object tooltips). It
8852 * can have only one tooltip at a time, so any previous tooltip
8853 * content will get removed. @p func (with @p data) will be called
8854 * every time Elementary needs to show the tooltip and it should
8855 * return a valid Evas object, which will be fully managed by the
8856 * tooltip system, getting deleted when the tooltip is gone.
8860 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);
8863 * Unset a tooltip from a given gengrid item
8865 * @param item gengrid item to remove a previously set tooltip from.
8867 * This call removes any tooltip set on @p item. The callback
8868 * provided as @c del_cb to
8869 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8870 * notify it is not used anymore (and have resources cleaned, if
8873 * @see elm_gengrid_item_tooltip_content_cb_set()
8877 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8880 * Set a different @b style for a given gengrid item's tooltip.
8882 * @param item gengrid item with tooltip set
8883 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8884 * "default", @c "transparent", etc)
8886 * Tooltips can have <b>alternate styles</b> to be displayed on,
8887 * which are defined by the theme set on Elementary. This function
8888 * works analogously as elm_object_tooltip_style_set(), but here
8889 * applied only to gengrid item objects. The default style for
8890 * tooltips is @c "default".
8892 * @note before you set a style you should define a tooltip with
8893 * elm_gengrid_item_tooltip_content_cb_set() or
8894 * elm_gengrid_item_tooltip_text_set()
8896 * @see elm_gengrid_item_tooltip_style_get()
8900 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8903 * Get the style set a given gengrid item's tooltip.
8905 * @param item gengrid item with tooltip already set on.
8906 * @return style the theme style in use, which defaults to
8907 * "default". If the object does not have a tooltip set,
8908 * then @c NULL is returned.
8910 * @see elm_gengrid_item_tooltip_style_set() for more details
8914 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8916 * @brief Disable size restrictions on an object's tooltip
8917 * @param item The tooltip's anchor object
8918 * @param disable If EINA_TRUE, size restrictions are disabled
8919 * @return EINA_FALSE on failure, EINA_TRUE on success
8921 * This function allows a tooltip to expand beyond its parant window's canvas.
8922 * It will instead be limited only by the size of the display.
8924 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8926 * @brief Retrieve size restriction state of an object's tooltip
8927 * @param item The tooltip's anchor object
8928 * @return If EINA_TRUE, size restrictions are disabled
8930 * This function returns whether a tooltip is allowed to expand beyond
8931 * its parant window's canvas.
8932 * It will instead be limited only by the size of the display.
8934 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8936 * Set the type of mouse pointer/cursor decoration to be shown,
8937 * when the mouse pointer is over the given gengrid widget item
8939 * @param item gengrid item to customize cursor on
8940 * @param cursor the cursor type's name
8942 * This function works analogously as elm_object_cursor_set(), but
8943 * here the cursor's changing area is restricted to the item's
8944 * area, and not the whole widget's. Note that that item cursors
8945 * have precedence over widget cursors, so that a mouse over @p
8946 * item will always show cursor @p type.
8948 * If this function is called twice for an object, a previously set
8949 * cursor will be unset on the second call.
8951 * @see elm_object_cursor_set()
8952 * @see elm_gengrid_item_cursor_get()
8953 * @see elm_gengrid_item_cursor_unset()
8957 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8960 * Get the type of mouse pointer/cursor decoration set to be shown,
8961 * when the mouse pointer is over the given gengrid widget item
8963 * @param item gengrid item with custom cursor set
8964 * @return the cursor type's name or @c NULL, if no custom cursors
8965 * were set to @p item (and on errors)
8967 * @see elm_object_cursor_get()
8968 * @see elm_gengrid_item_cursor_set() for more details
8969 * @see elm_gengrid_item_cursor_unset()
8973 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8976 * Unset any custom mouse pointer/cursor decoration set to be
8977 * shown, when the mouse pointer is over the given gengrid widget
8978 * item, thus making it show the @b default cursor again.
8980 * @param item a gengrid item
8982 * Use this call to undo any custom settings on this item's cursor
8983 * decoration, bringing it back to defaults (no custom style set).
8985 * @see elm_object_cursor_unset()
8986 * @see elm_gengrid_item_cursor_set() for more details
8990 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8993 * Set a different @b style for a given custom cursor set for a
8996 * @param item gengrid item with custom cursor set
8997 * @param style the <b>theme style</b> to use (e.g. @c "default",
8998 * @c "transparent", etc)
9000 * This function only makes sense when one is using custom mouse
9001 * cursor decorations <b>defined in a theme file</b> , which can
9002 * have, given a cursor name/type, <b>alternate styles</b> on
9003 * it. It works analogously as elm_object_cursor_style_set(), but
9004 * here applied only to gengrid item objects.
9006 * @warning Before you set a cursor style you should have defined a
9007 * custom cursor previously on the item, with
9008 * elm_gengrid_item_cursor_set()
9010 * @see elm_gengrid_item_cursor_engine_only_set()
9011 * @see elm_gengrid_item_cursor_style_get()
9015 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9018 * Get the current @b style set for a given gengrid item's custom
9021 * @param item gengrid item with custom cursor set.
9022 * @return style the cursor style in use. If the object does not
9023 * have a cursor set, then @c NULL is returned.
9025 * @see elm_gengrid_item_cursor_style_set() for more details
9029 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9032 * Set if the (custom) cursor for a given gengrid item should be
9033 * searched in its theme, also, or should only rely on the
9036 * @param item item with custom (custom) cursor already set on
9037 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9038 * only on those provided by the rendering engine, @c EINA_FALSE to
9039 * have them searched on the widget's theme, as well.
9041 * @note This call is of use only if you've set a custom cursor
9042 * for gengrid items, with elm_gengrid_item_cursor_set().
9044 * @note By default, cursors will only be looked for between those
9045 * provided by the rendering engine.
9049 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9052 * Get if the (custom) cursor for a given gengrid item is being
9053 * searched in its theme, also, or is only relying on the rendering
9056 * @param item a gengrid item
9057 * @return @c EINA_TRUE, if cursors are being looked for only on
9058 * those provided by the rendering engine, @c EINA_FALSE if they
9059 * are being searched on the widget's theme, as well.
9061 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9065 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9068 * Remove all items from a given gengrid widget
9070 * @param obj The gengrid object.
9072 * This removes (and deletes) all items in @p obj, leaving it
9075 * @see elm_gengrid_item_del(), to remove just one item.
9079 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9082 * Get the selected item in a given gengrid widget
9084 * @param obj The gengrid object.
9085 * @return The selected item's handleor @c NULL, if none is
9086 * selected at the moment (and on errors)
9088 * This returns the selected item in @p obj. If multi selection is
9089 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9090 * the first item in the list is selected, which might not be very
9091 * useful. For that case, see elm_gengrid_selected_items_get().
9095 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9098 * Get <b>a list</b> of selected items in a given gengrid
9100 * @param obj The gengrid object.
9101 * @return The list of selected items or @c NULL, if none is
9102 * selected at the moment (and on errors)
9104 * This returns a list of the selected items, in the order that
9105 * they appear in the grid. This list is only valid as long as no
9106 * more items are selected or unselected (or unselected implictly
9107 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9110 * @see elm_gengrid_selected_item_get()
9114 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9121 * @defgroup Clock Clock
9123 * @image html img/widget/clock/preview-00.png
9124 * @image latex img/widget/clock/preview-00.eps
9126 * This is a @b digital clock widget. In its default theme, it has a
9127 * vintage "flipping numbers clock" appearance, which will animate
9128 * sheets of individual algarisms individually as time goes by.
9130 * A newly created clock will fetch system's time (already
9131 * considering local time adjustments) to start with, and will tick
9132 * accondingly. It may or may not show seconds.
9134 * Clocks have an @b edition mode. When in it, the sheets will
9135 * display extra arrow indications on the top and bottom and the
9136 * user may click on them to raise or lower the time values. After
9137 * it's told to exit edition mode, it will keep ticking with that
9138 * new time set (it keeps the difference from local time).
9140 * Also, when under edition mode, user clicks on the cited arrows
9141 * which are @b held for some time will make the clock to flip the
9142 * sheet, thus editing the time, continuosly and automatically for
9143 * the user. The interval between sheet flips will keep growing in
9144 * time, so that it helps the user to reach a time which is distant
9147 * The time display is, by default, in military mode (24h), but an
9148 * am/pm indicator may be optionally shown, too, when it will
9151 * Smart callbacks one can register to:
9152 * - "changed" - the clock's user changed the time
9154 * Here is an example on its usage:
9155 * @li @ref clock_example
9164 * Identifiers for which clock digits should be editable, when a
9165 * clock widget is in edition mode. Values may be ORed together to
9166 * make a mask, naturally.
9168 * @see elm_clock_edit_set()
9169 * @see elm_clock_digit_edit_set()
9171 typedef enum _Elm_Clock_Digedit
9173 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9174 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9175 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9176 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9177 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9178 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9179 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9180 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9181 } Elm_Clock_Digedit;
9184 * Add a new clock widget to the given parent Elementary
9185 * (container) object
9187 * @param parent The parent object
9188 * @return a new clock widget handle or @c NULL, on errors
9190 * This function inserts a new clock widget on the canvas.
9194 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9197 * Set a clock widget's time, programmatically
9199 * @param obj The clock widget object
9200 * @param hrs The hours to set
9201 * @param min The minutes to set
9202 * @param sec The secondes to set
9204 * This function updates the time that is showed by the clock
9207 * Values @b must be set within the following ranges:
9208 * - 0 - 23, for hours
9209 * - 0 - 59, for minutes
9210 * - 0 - 59, for seconds,
9212 * even if the clock is not in "military" mode.
9214 * @warning The behavior for values set out of those ranges is @b
9219 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9222 * Get a clock widget's time values
9224 * @param obj The clock object
9225 * @param[out] hrs Pointer to the variable to get the hours value
9226 * @param[out] min Pointer to the variable to get the minutes value
9227 * @param[out] sec Pointer to the variable to get the seconds value
9229 * This function gets the time set for @p obj, returning
9230 * it on the variables passed as the arguments to function
9232 * @note Use @c NULL pointers on the time values you're not
9233 * interested in: they'll be ignored by the function.
9237 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9240 * Set whether a given clock widget is under <b>edition mode</b> or
9241 * under (default) displaying-only mode.
9243 * @param obj The clock object
9244 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9245 * put it back to "displaying only" mode
9247 * This function makes a clock's time to be editable or not <b>by
9248 * user interaction</b>. When in edition mode, clocks @b stop
9249 * ticking, until one brings them back to canonical mode. The
9250 * elm_clock_digit_edit_set() function will influence which digits
9251 * of the clock will be editable. By default, all of them will be
9252 * (#ELM_CLOCK_NONE).
9254 * @note am/pm sheets, if being shown, will @b always be editable
9255 * under edition mode.
9257 * @see elm_clock_edit_get()
9261 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9264 * Retrieve whether a given clock widget is under <b>edition
9265 * mode</b> or under (default) displaying-only mode.
9267 * @param obj The clock object
9268 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9271 * This function retrieves whether the clock's time can be edited
9272 * or not by user interaction.
9274 * @see elm_clock_edit_set() for more details
9278 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9281 * Set what digits of the given clock widget should be editable
9282 * when in edition mode.
9284 * @param obj The clock object
9285 * @param digedit Bit mask indicating the digits to be editable
9286 * (values in #Elm_Clock_Digedit).
9288 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9289 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9292 * @see elm_clock_digit_edit_get()
9296 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9299 * Retrieve what digits of the given clock widget should be
9300 * editable when in edition mode.
9302 * @param obj The clock object
9303 * @return Bit mask indicating the digits to be editable
9304 * (values in #Elm_Clock_Digedit).
9306 * @see elm_clock_digit_edit_set() for more details
9310 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9313 * Set if the given clock widget must show hours in military or
9316 * @param obj The clock object
9317 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9320 * This function sets if the clock must show hours in military or
9321 * am/pm mode. In some countries like Brazil the military mode
9322 * (00-24h-format) is used, in opposition to the USA, where the
9323 * am/pm mode is more commonly used.
9325 * @see elm_clock_show_am_pm_get()
9329 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9332 * Get if the given clock widget shows hours in military or am/pm
9335 * @param obj The clock object
9336 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9339 * This function gets if the clock shows hours in military or am/pm
9342 * @see elm_clock_show_am_pm_set() for more details
9346 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9349 * Set if the given clock widget must show time with seconds or not
9351 * @param obj The clock object
9352 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9354 * This function sets if the given clock must show or not elapsed
9355 * seconds. By default, they are @b not shown.
9357 * @see elm_clock_show_seconds_get()
9361 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9364 * Get whether the given clock widget is showing time with seconds
9367 * @param obj The clock object
9368 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9370 * This function gets whether @p obj is showing or not the elapsed
9373 * @see elm_clock_show_seconds_set()
9377 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9380 * Set the interval on time updates for an user mouse button hold
9381 * on clock widgets' time edition.
9383 * @param obj The clock object
9384 * @param interval The (first) interval value in seconds
9386 * This interval value is @b decreased while the user holds the
9387 * mouse pointer either incrementing or decrementing a given the
9388 * clock digit's value.
9390 * This helps the user to get to a given time distant from the
9391 * current one easier/faster, as it will start to flip quicker and
9392 * quicker on mouse button holds.
9394 * The calculation for the next flip interval value, starting from
9395 * the one set with this call, is the previous interval divided by
9396 * 1.05, so it decreases a little bit.
9398 * The default starting interval value for automatic flips is
9401 * @see elm_clock_interval_get()
9405 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9408 * Get the interval on time updates for an user mouse button hold
9409 * on clock widgets' time edition.
9411 * @param obj The clock object
9412 * @return The (first) interval value, in seconds, set on it
9414 * @see elm_clock_interval_set() for more details
9418 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9425 * @defgroup Layout Layout
9427 * @image html img/widget/layout/preview-00.png
9428 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9430 * @image html img/layout-predefined.png
9431 * @image latex img/layout-predefined.eps width=\textwidth
9433 * This is a container widget that takes a standard Edje design file and
9434 * wraps it very thinly in a widget.
9436 * An Edje design (theme) file has a very wide range of possibilities to
9437 * describe the behavior of elements added to the Layout. Check out the Edje
9438 * documentation and the EDC reference to get more information about what can
9439 * be done with Edje.
9441 * Just like @ref List, @ref Box, and other container widgets, any
9442 * object added to the Layout will become its child, meaning that it will be
9443 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9445 * The Layout widget can contain as many Contents, Boxes or Tables as
9446 * described in its theme file. For instance, objects can be added to
9447 * different Tables by specifying the respective Table part names. The same
9448 * is valid for Content and Box.
9450 * The objects added as child of the Layout will behave as described in the
9451 * part description where they were added. There are 3 possible types of
9452 * parts where a child can be added:
9454 * @section secContent Content (SWALLOW part)
9456 * Only one object can be added to the @c SWALLOW part (but you still can
9457 * have many @c SWALLOW parts and one object on each of them). Use the @c
9458 * elm_layout_content_* set of functions to set, retrieve and unset objects
9459 * as content of the @c SWALLOW. After being set to this part, the object
9460 * size, position, visibility, clipping and other description properties
9461 * will be totally controled by the description of the given part (inside
9462 * the Edje theme file).
9464 * One can use @c evas_object_size_hint_* functions on the child to have some
9465 * kind of control over its behavior, but the resulting behavior will still
9466 * depend heavily on the @c SWALLOW part description.
9468 * The Edje theme also can change the part description, based on signals or
9469 * scripts running inside the theme. This change can also be animated. All of
9470 * this will affect the child object set as content accordingly. The object
9471 * size will be changed if the part size is changed, it will animate move if
9472 * the part is moving, and so on.
9474 * The following picture demonstrates a Layout widget with a child object
9475 * added to its @c SWALLOW:
9477 * @image html layout_swallow.png
9478 * @image latex layout_swallow.eps width=\textwidth
9480 * @section secBox Box (BOX part)
9482 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9483 * allows one to add objects to the box and have them distributed along its
9484 * area, accordingly to the specified @a layout property (now by @a layout we
9485 * mean the chosen layouting design of the Box, not the Layout widget
9488 * A similar effect for having a box with its position, size and other things
9489 * controled by the Layout theme would be to create an Elementary @ref Box
9490 * widget and add it as a Content in the @c SWALLOW part.
9492 * The main difference of using the Layout Box is that its behavior, the box
9493 * properties like layouting format, padding, align, etc. will be all
9494 * controled by the theme. This means, for example, that a signal could be
9495 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9496 * handled the signal by changing the box padding, or align, or both. Using
9497 * the Elementary @ref Box widget is not necessarily harder or easier, it
9498 * just depends on the circunstances and requirements.
9500 * The Layout Box can be used through the @c elm_layout_box_* set of
9503 * The following picture demonstrates a Layout widget with many child objects
9504 * added to its @c BOX part:
9506 * @image html layout_box.png
9507 * @image latex layout_box.eps width=\textwidth
9509 * @section secTable Table (TABLE part)
9511 * Just like the @ref secBox, the Layout Table is very similar to the
9512 * Elementary @ref Table widget. It allows one to add objects to the Table
9513 * specifying the row and column where the object should be added, and any
9514 * column or row span if necessary.
9516 * Again, we could have this design by adding a @ref Table widget to the @c
9517 * SWALLOW part using elm_layout_content_set(). The same difference happens
9518 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9519 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9521 * The Layout Table can be used through the @c elm_layout_table_* set of
9524 * The following picture demonstrates a Layout widget with many child objects
9525 * added to its @c TABLE part:
9527 * @image html layout_table.png
9528 * @image latex layout_table.eps width=\textwidth
9530 * @section secPredef Predefined Layouts
9532 * Another interesting thing about the Layout widget is that it offers some
9533 * predefined themes that come with the default Elementary theme. These
9534 * themes can be set by the call elm_layout_theme_set(), and provide some
9535 * basic functionality depending on the theme used.
9537 * Most of them already send some signals, some already provide a toolbar or
9538 * back and next buttons.
9540 * These are available predefined theme layouts. All of them have class = @c
9541 * layout, group = @c application, and style = one of the following options:
9543 * @li @c toolbar-content - application with toolbar and main content area
9544 * @li @c toolbar-content-back - application with toolbar and main content
9545 * area with a back button and title area
9546 * @li @c toolbar-content-back-next - application with toolbar and main
9547 * content area with a back and next buttons and title area
9548 * @li @c content-back - application with a main content area with a back
9549 * button and title area
9550 * @li @c content-back-next - application with a main content area with a
9551 * back and next buttons and title area
9552 * @li @c toolbar-vbox - application with toolbar and main content area as a
9554 * @li @c toolbar-table - application with toolbar and main content area as a
9557 * @section secExamples Examples
9559 * Some examples of the Layout widget can be found here:
9560 * @li @ref layout_example_01
9561 * @li @ref layout_example_02
9562 * @li @ref layout_example_03
9563 * @li @ref layout_example_edc
9568 * Add a new layout to the parent
9570 * @param parent The parent object
9571 * @return The new object or NULL if it cannot be created
9573 * @see elm_layout_file_set()
9574 * @see elm_layout_theme_set()
9578 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9580 * Set the file that will be used as layout
9582 * @param obj The layout object
9583 * @param file The path to file (edj) that will be used as layout
9584 * @param group The group that the layout belongs in edje file
9586 * @return (1 = success, 0 = error)
9590 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9592 * Set the edje group from the elementary theme that will be used as layout
9594 * @param obj The layout object
9595 * @param clas the clas of the group
9596 * @param group the group
9597 * @param style the style to used
9599 * @return (1 = success, 0 = error)
9603 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9605 * Set the layout content.
9607 * @param obj The layout object
9608 * @param swallow The swallow part name in the edje file
9609 * @param content The child that will be added in this layout object
9611 * Once the content object is set, a previously set one will be deleted.
9612 * If you want to keep that old content object, use the
9613 * elm_layout_content_unset() function.
9615 * @note In an Edje theme, the part used as a content container is called @c
9616 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9617 * expected to be a part name just like the second parameter of
9618 * elm_layout_box_append().
9620 * @see elm_layout_box_append()
9621 * @see elm_layout_content_get()
9622 * @see elm_layout_content_unset()
9627 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9629 * Get the child object in the given content part.
9631 * @param obj The layout object
9632 * @param swallow The SWALLOW part to get its content
9634 * @return The swallowed object or NULL if none or an error occurred
9636 * @see elm_layout_content_set()
9640 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9642 * Unset the layout content.
9644 * @param obj The layout object
9645 * @param swallow The swallow part name in the edje file
9646 * @return The content that was being used
9648 * Unparent and return the content object which was set for this part.
9650 * @see elm_layout_content_set()
9654 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9656 * Set the text of the given part
9658 * @param obj The layout object
9659 * @param part The TEXT part where to set the text
9660 * @param text The text to set
9663 * @deprecated use elm_object_text_* instead.
9665 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9667 * Get the text set in the given part
9669 * @param obj The layout object
9670 * @param part The TEXT part to retrieve the text off
9672 * @return The text set in @p part
9675 * @deprecated use elm_object_text_* instead.
9677 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9679 * Append child to layout box part.
9681 * @param obj the layout object
9682 * @param part the box part to which the object will be appended.
9683 * @param child the child object to append to box.
9685 * Once the object is appended, it will become child of the layout. Its
9686 * lifetime will be bound to the layout, whenever the layout dies the child
9687 * will be deleted automatically. One should use elm_layout_box_remove() to
9688 * make this layout forget about the object.
9690 * @see elm_layout_box_prepend()
9691 * @see elm_layout_box_insert_before()
9692 * @see elm_layout_box_insert_at()
9693 * @see elm_layout_box_remove()
9697 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9699 * Prepend child to layout box part.
9701 * @param obj the layout object
9702 * @param part the box part to prepend.
9703 * @param child the child object to prepend to box.
9705 * Once the object is prepended, it will become child of the layout. Its
9706 * lifetime will be bound to the layout, whenever the layout dies the child
9707 * will be deleted automatically. One should use elm_layout_box_remove() to
9708 * make this layout forget about the object.
9710 * @see elm_layout_box_append()
9711 * @see elm_layout_box_insert_before()
9712 * @see elm_layout_box_insert_at()
9713 * @see elm_layout_box_remove()
9717 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9719 * Insert child to layout box part before a reference object.
9721 * @param obj the layout object
9722 * @param part the box part to insert.
9723 * @param child the child object to insert into box.
9724 * @param reference another reference object to insert before in box.
9726 * Once the object is inserted, it will become child of the layout. Its
9727 * lifetime will be bound to the layout, whenever the layout dies the child
9728 * will be deleted automatically. One should use elm_layout_box_remove() to
9729 * make this layout forget about the object.
9731 * @see elm_layout_box_append()
9732 * @see elm_layout_box_prepend()
9733 * @see elm_layout_box_insert_before()
9734 * @see elm_layout_box_remove()
9738 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9740 * Insert child to layout box part at a given position.
9742 * @param obj the layout object
9743 * @param part the box part to insert.
9744 * @param child the child object to insert into box.
9745 * @param pos the numeric position >=0 to insert the child.
9747 * Once the object is inserted, it will become child of the layout. Its
9748 * lifetime will be bound to the layout, whenever the layout dies the child
9749 * will be deleted automatically. One should use elm_layout_box_remove() to
9750 * make this layout forget about the object.
9752 * @see elm_layout_box_append()
9753 * @see elm_layout_box_prepend()
9754 * @see elm_layout_box_insert_before()
9755 * @see elm_layout_box_remove()
9759 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9761 * Remove a child of the given part box.
9763 * @param obj The layout object
9764 * @param part The box part name to remove child.
9765 * @param child The object to remove from box.
9766 * @return The object that was being used, or NULL if not found.
9768 * The object will be removed from the box part and its lifetime will
9769 * not be handled by the layout anymore. This is equivalent to
9770 * elm_layout_content_unset() for box.
9772 * @see elm_layout_box_append()
9773 * @see elm_layout_box_remove_all()
9777 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9779 * Remove all child of the given part box.
9781 * @param obj The layout object
9782 * @param part The box part name to remove child.
9783 * @param clear If EINA_TRUE, then all objects will be deleted as
9784 * well, otherwise they will just be removed and will be
9785 * dangling on the canvas.
9787 * The objects will be removed from the box part and their lifetime will
9788 * not be handled by the layout anymore. This is equivalent to
9789 * elm_layout_box_remove() for all box children.
9791 * @see elm_layout_box_append()
9792 * @see elm_layout_box_remove()
9796 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9798 * Insert child to layout table part.
9800 * @param obj the layout object
9801 * @param part the box part to pack child.
9802 * @param child_obj the child object to pack into table.
9803 * @param col the column to which the child should be added. (>= 0)
9804 * @param row the row to which the child should be added. (>= 0)
9805 * @param colspan how many columns should be used to store this object. (>=
9807 * @param rowspan how many rows should be used to store this object. (>= 1)
9809 * Once the object is inserted, it will become child of the table. Its
9810 * lifetime will be bound to the layout, and whenever the layout dies the
9811 * child will be deleted automatically. One should use
9812 * elm_layout_table_remove() to make this layout forget about the object.
9814 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9815 * more space than a single cell. For instance, the following code:
9817 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9820 * Would result in an object being added like the following picture:
9822 * @image html layout_colspan.png
9823 * @image latex layout_colspan.eps width=\textwidth
9825 * @see elm_layout_table_unpack()
9826 * @see elm_layout_table_clear()
9830 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);
9832 * Unpack (remove) a child of the given part table.
9834 * @param obj The layout object
9835 * @param part The table part name to remove child.
9836 * @param child_obj The object to remove from table.
9837 * @return The object that was being used, or NULL if not found.
9839 * The object will be unpacked from the table part and its lifetime
9840 * will not be handled by the layout anymore. This is equivalent to
9841 * elm_layout_content_unset() for table.
9843 * @see elm_layout_table_pack()
9844 * @see elm_layout_table_clear()
9848 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9850 * Remove all child of the given part table.
9852 * @param obj The layout object
9853 * @param part The table part name to remove child.
9854 * @param clear If EINA_TRUE, then all objects will be deleted as
9855 * well, otherwise they will just be removed and will be
9856 * dangling on the canvas.
9858 * The objects will be removed from the table part and their lifetime will
9859 * not be handled by the layout anymore. This is equivalent to
9860 * elm_layout_table_unpack() for all table children.
9862 * @see elm_layout_table_pack()
9863 * @see elm_layout_table_unpack()
9867 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9869 * Get the edje layout
9871 * @param obj The layout object
9873 * @return A Evas_Object with the edje layout settings loaded
9874 * with function elm_layout_file_set
9876 * This returns the edje object. It is not expected to be used to then
9877 * swallow objects via edje_object_part_swallow() for example. Use
9878 * elm_layout_content_set() instead so child object handling and sizing is
9881 * @note This function should only be used if you really need to call some
9882 * low level Edje function on this edje object. All the common stuff (setting
9883 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9884 * with proper elementary functions.
9886 * @see elm_object_signal_callback_add()
9887 * @see elm_object_signal_emit()
9888 * @see elm_object_text_part_set()
9889 * @see elm_layout_content_set()
9890 * @see elm_layout_box_append()
9891 * @see elm_layout_table_pack()
9892 * @see elm_layout_data_get()
9896 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9898 * Get the edje data from the given layout
9900 * @param obj The layout object
9901 * @param key The data key
9903 * @return The edje data string
9905 * This function fetches data specified inside the edje theme of this layout.
9906 * This function return NULL if data is not found.
9908 * In EDC this comes from a data block within the group block that @p
9909 * obj was loaded from. E.g.
9916 * item: "key1" "value1";
9917 * item: "key2" "value2";
9925 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9929 * @param obj The layout object
9931 * Manually forces a sizing re-evaluation. This is useful when the minimum
9932 * size required by the edje theme of this layout has changed. The change on
9933 * the minimum size required by the edje theme is not immediately reported to
9934 * the elementary layout, so one needs to call this function in order to tell
9935 * the widget (layout) that it needs to reevaluate its own size.
9937 * The minimum size of the theme is calculated based on minimum size of
9938 * parts, the size of elements inside containers like box and table, etc. All
9939 * of this can change due to state changes, and that's when this function
9942 * Also note that a standard signal of "size,eval" "elm" emitted from the
9943 * edje object will cause this to happen too.
9947 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9950 * Sets a specific cursor for an edje part.
9952 * @param obj The layout object.
9953 * @param part_name a part from loaded edje group.
9954 * @param cursor cursor name to use, see Elementary_Cursor.h
9956 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9957 * part not exists or it has "mouse_events: 0".
9961 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9964 * Get the cursor to be shown when mouse is over an edje part
9966 * @param obj The layout object.
9967 * @param part_name a part from loaded edje group.
9968 * @return the cursor name.
9972 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9975 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9977 * @param obj The layout object.
9978 * @param part_name a part from loaded edje group, that had a cursor set
9979 * with elm_layout_part_cursor_set().
9983 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9986 * Sets a specific cursor style for an edje part.
9988 * @param obj The layout object.
9989 * @param part_name a part from loaded edje group.
9990 * @param style the theme style to use (default, transparent, ...)
9992 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9993 * part not exists or it did not had a cursor set.
9997 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10000 * Gets a specific cursor style for an edje part.
10002 * @param obj The layout object.
10003 * @param part_name a part from loaded edje group.
10005 * @return the theme style in use, defaults to "default". If the
10006 * object does not have a cursor set, then NULL is returned.
10010 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10013 * Sets if the cursor set should be searched on the theme or should use
10014 * the provided by the engine, only.
10016 * @note before you set if should look on theme you should define a
10017 * cursor with elm_layout_part_cursor_set(). By default it will only
10018 * look for cursors provided by the engine.
10020 * @param obj The layout object.
10021 * @param part_name a part from loaded edje group.
10022 * @param engine_only if cursors should be just provided by the engine
10023 * or should also search on widget's theme as well
10025 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10026 * part not exists or it did not had a cursor set.
10030 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);
10033 * Gets a specific cursor engine_only for an edje part.
10035 * @param obj The layout object.
10036 * @param part_name a part from loaded edje group.
10038 * @return whenever the cursor is just provided by engine or also from theme.
10042 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10045 * @def elm_layout_icon_set
10046 * Convienience macro to set the icon object in a layout that follows the
10047 * Elementary naming convention for its parts.
10051 #define elm_layout_icon_set(_ly, _obj) \
10054 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10055 if ((_obj)) sig = "elm,state,icon,visible"; \
10056 else sig = "elm,state,icon,hidden"; \
10057 elm_object_signal_emit((_ly), sig, "elm"); \
10061 * @def elm_layout_icon_get
10062 * Convienience macro to get the icon object from a layout that follows the
10063 * Elementary naming convention for its parts.
10067 #define elm_layout_icon_get(_ly) \
10068 elm_layout_content_get((_ly), "elm.swallow.icon")
10071 * @def elm_layout_end_set
10072 * Convienience macro to set the end object in a layout that follows the
10073 * Elementary naming convention for its parts.
10077 #define elm_layout_end_set(_ly, _obj) \
10080 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10081 if ((_obj)) sig = "elm,state,end,visible"; \
10082 else sig = "elm,state,end,hidden"; \
10083 elm_object_signal_emit((_ly), sig, "elm"); \
10087 * @def elm_layout_end_get
10088 * Convienience macro to get the end object in a layout that follows the
10089 * Elementary naming convention for its parts.
10093 #define elm_layout_end_get(_ly) \
10094 elm_layout_content_get((_ly), "elm.swallow.end")
10097 * @def elm_layout_label_set
10098 * Convienience macro to set the label in a layout that follows the
10099 * Elementary naming convention for its parts.
10102 * @deprecated use elm_object_text_* instead.
10104 #define elm_layout_label_set(_ly, _txt) \
10105 elm_layout_text_set((_ly), "elm.text", (_txt))
10108 * @def elm_layout_label_get
10109 * Convienience macro to get the label in a layout that follows the
10110 * Elementary naming convention for its parts.
10113 * @deprecated use elm_object_text_* instead.
10115 #define elm_layout_label_get(_ly) \
10116 elm_layout_text_get((_ly), "elm.text")
10118 /* smart callbacks called:
10119 * "theme,changed" - when elm theme is changed.
10123 * @defgroup Notify Notify
10125 * @image html img/widget/notify/preview-00.png
10126 * @image latex img/widget/notify/preview-00.eps
10128 * Display a container in a particular region of the parent(top, bottom,
10129 * etc. A timeout can be set to automatically hide the notify. This is so
10130 * that, after an evas_object_show() on a notify object, if a timeout was set
10131 * on it, it will @b automatically get hidden after that time.
10133 * Signals that you can add callbacks for are:
10134 * @li "timeout" - when timeout happens on notify and it's hidden
10135 * @li "block,clicked" - when a click outside of the notify happens
10137 * @ref tutorial_notify show usage of the API.
10142 * @brief Possible orient values for notify.
10144 * This values should be used in conjunction to elm_notify_orient_set() to
10145 * set the position in which the notify should appear(relative to its parent)
10146 * and in conjunction with elm_notify_orient_get() to know where the notify
10149 typedef enum _Elm_Notify_Orient
10151 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10152 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10153 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10154 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10155 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10156 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10157 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10158 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10159 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10160 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10161 } Elm_Notify_Orient;
10163 * @brief Add a new notify to the parent
10165 * @param parent The parent object
10166 * @return The new object or NULL if it cannot be created
10168 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10170 * @brief Set the content of the notify widget
10172 * @param obj The notify object
10173 * @param content The content will be filled in this notify object
10175 * Once the content object is set, a previously set one will be deleted. If
10176 * you want to keep that old content object, use the
10177 * elm_notify_content_unset() function.
10179 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10181 * @brief Unset the content of the notify widget
10183 * @param obj The notify object
10184 * @return The content that was being used
10186 * Unparent and return the content object which was set for this widget
10188 * @see elm_notify_content_set()
10190 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10192 * @brief Return the content of the notify widget
10194 * @param obj The notify object
10195 * @return The content that is being used
10197 * @see elm_notify_content_set()
10199 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10201 * @brief Set the notify parent
10203 * @param obj The notify object
10204 * @param content The new parent
10206 * Once the parent object is set, a previously set one will be disconnected
10209 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10211 * @brief Get the notify parent
10213 * @param obj The notify object
10214 * @return The parent
10216 * @see elm_notify_parent_set()
10218 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10220 * @brief Set the orientation
10222 * @param obj The notify object
10223 * @param orient The new orientation
10225 * Sets the position in which the notify will appear in its parent.
10227 * @see @ref Elm_Notify_Orient for possible values.
10229 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10231 * @brief Return the orientation
10232 * @param obj The notify object
10233 * @return The orientation of the notification
10235 * @see elm_notify_orient_set()
10236 * @see Elm_Notify_Orient
10238 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10240 * @brief Set the time interval after which the notify window is going to be
10243 * @param obj The notify object
10244 * @param time The timeout in seconds
10246 * This function sets a timeout and starts the timer controlling when the
10247 * notify is hidden. Since calling evas_object_show() on a notify restarts
10248 * the timer controlling when the notify is hidden, setting this before the
10249 * notify is shown will in effect mean starting the timer when the notify is
10252 * @note Set a value <= 0.0 to disable a running timer.
10254 * @note If the value > 0.0 and the notify is previously visible, the
10255 * timer will be started with this value, canceling any running timer.
10257 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10259 * @brief Return the timeout value (in seconds)
10260 * @param obj the notify object
10262 * @see elm_notify_timeout_set()
10264 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10266 * @brief Sets whether events should be passed to by a click outside
10269 * @param obj The notify object
10270 * @param repeats EINA_TRUE Events are repeats, else no
10272 * When true if the user clicks outside the window the events will be caught
10273 * by the others widgets, else the events are blocked.
10275 * @note The default value is EINA_TRUE.
10277 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10279 * @brief Return true if events are repeat below the notify object
10280 * @param obj the notify object
10282 * @see elm_notify_repeat_events_set()
10284 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10290 * @defgroup Hover Hover
10292 * @image html img/widget/hover/preview-00.png
10293 * @image latex img/widget/hover/preview-00.eps
10295 * A Hover object will hover over its @p parent object at the @p target
10296 * location. Anything in the background will be given a darker coloring to
10297 * indicate that the hover object is on top (at the default theme). When the
10298 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10299 * clicked that @b doesn't cause the hover to be dismissed.
10301 * @note The hover object will take up the entire space of @p target
10304 * Elementary has the following styles for the hover widget:
10308 * @li hoversel_vertical
10310 * The following are the available position for content:
10322 * Signals that you can add callbacks for are:
10323 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10324 * @li "smart,changed" - a content object placed under the "smart"
10325 * policy was replaced to a new slot direction.
10327 * See @ref tutorial_hover for more information.
10331 typedef enum _Elm_Hover_Axis
10333 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10334 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10335 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10336 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10339 * @brief Adds a hover object to @p parent
10341 * @param parent The parent object
10342 * @return The hover object or NULL if one could not be created
10344 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10346 * @brief Sets the target object for the hover.
10348 * @param obj The hover object
10349 * @param target The object to center the hover onto. The hover
10351 * This function will cause the hover to be centered on the target object.
10353 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10355 * @brief Gets the target object for the hover.
10357 * @param obj The hover object
10358 * @param parent The object to locate the hover over.
10360 * @see elm_hover_target_set()
10362 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10364 * @brief Sets the parent object for the hover.
10366 * @param obj The hover object
10367 * @param parent The object to locate the hover over.
10369 * This function will cause the hover to take up the entire space that the
10370 * parent object fills.
10372 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10374 * @brief Gets the parent object for the hover.
10376 * @param obj The hover object
10377 * @return The parent object to locate the hover over.
10379 * @see elm_hover_parent_set()
10381 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10383 * @brief Sets the content of the hover object and the direction in which it
10386 * @param obj The hover object
10387 * @param swallow The direction that the object will be displayed
10388 * at. Accepted values are "left", "top-left", "top", "top-right",
10389 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10391 * @param content The content to place at @p swallow
10393 * Once the content object is set for a given direction, a previously
10394 * set one (on the same direction) will be deleted. If you want to
10395 * keep that old content object, use the elm_hover_content_unset()
10398 * All directions may have contents at the same time, except for
10399 * "smart". This is a special placement hint and its use case
10400 * independs of the calculations coming from
10401 * elm_hover_best_content_location_get(). Its use is for cases when
10402 * one desires only one hover content, but with a dinamic special
10403 * placement within the hover area. The content's geometry, whenever
10404 * it changes, will be used to decide on a best location not
10405 * extrapolating the hover's parent object view to show it in (still
10406 * being the hover's target determinant of its medium part -- move and
10407 * resize it to simulate finger sizes, for example). If one of the
10408 * directions other than "smart" are used, a previously content set
10409 * using it will be deleted, and vice-versa.
10411 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10413 * @brief Get the content of the hover object, in a given direction.
10415 * Return the content object which was set for this widget in the
10416 * @p swallow direction.
10418 * @param obj The hover object
10419 * @param swallow The direction that the object was display at.
10420 * @return The content that was being used
10422 * @see elm_hover_content_set()
10424 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10426 * @brief Unset the content of the hover object, in a given direction.
10428 * Unparent and return the content object set at @p swallow direction.
10430 * @param obj The hover object
10431 * @param swallow The direction that the object was display at.
10432 * @return The content that was being used.
10434 * @see elm_hover_content_set()
10436 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10438 * @brief Returns the best swallow location for content in the hover.
10440 * @param obj The hover object
10441 * @param pref_axis The preferred orientation axis for the hover object to use
10442 * @return The edje location to place content into the hover or @c
10445 * Best is defined here as the location at which there is the most available
10448 * @p pref_axis may be one of
10449 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10450 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10451 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10452 * - @c ELM_HOVER_AXIS_BOTH -- both
10454 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10455 * nescessarily be along the horizontal axis("left" or "right"). If
10456 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10457 * be along the vertical axis("top" or "bottom"). Chossing
10458 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10459 * returned position may be in either axis.
10461 * @see elm_hover_content_set()
10463 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10470 * @defgroup Entry Entry
10472 * @image html img/widget/entry/preview-00.png
10473 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10474 * @image html img/widget/entry/preview-01.png
10475 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10476 * @image html img/widget/entry/preview-02.png
10477 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10478 * @image html img/widget/entry/preview-03.png
10479 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10481 * An entry is a convenience widget which shows a box that the user can
10482 * enter text into. Entries by default don't scroll, so they grow to
10483 * accomodate the entire text, resizing the parent window as needed. This
10484 * can be changed with the elm_entry_scrollable_set() function.
10486 * They can also be single line or multi line (the default) and when set
10487 * to multi line mode they support text wrapping in any of the modes
10488 * indicated by #Elm_Wrap_Type.
10490 * Other features include password mode, filtering of inserted text with
10491 * elm_entry_text_filter_append() and related functions, inline "items" and
10492 * formatted markup text.
10494 * @section entry-markup Formatted text
10496 * The markup tags supported by the Entry are defined by the theme, but
10497 * even when writing new themes or extensions it's a good idea to stick to
10498 * a sane default, to maintain coherency and avoid application breakages.
10499 * Currently defined by the default theme are the following tags:
10500 * @li \<br\>: Inserts a line break.
10501 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10503 * @li \<tab\>: Inserts a tab.
10504 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10506 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10507 * @li \<link\>...\</link\>: Underlines the enclosed text.
10508 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10510 * @section entry-special Special markups
10512 * Besides those used to format text, entries support two special markup
10513 * tags used to insert clickable portions of text or items inlined within
10516 * @subsection entry-anchors Anchors
10518 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10519 * \</a\> tags and an event will be generated when this text is clicked,
10523 * This text is outside <a href=anc-01>but this one is an anchor</a>
10526 * The @c href attribute in the opening tag gives the name that will be
10527 * used to identify the anchor and it can be any valid utf8 string.
10529 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10530 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10531 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10532 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10535 * @subsection entry-items Items
10537 * Inlined in the text, any other @c Evas_Object can be inserted by using
10538 * \<item\> tags this way:
10541 * <item size=16x16 vsize=full href=emoticon/haha></item>
10544 * Just like with anchors, the @c href identifies each item, but these need,
10545 * in addition, to indicate their size, which is done using any one of
10546 * @c size, @c absize or @c relsize attributes. These attributes take their
10547 * value in the WxH format, where W is the width and H the height of the
10550 * @li absize: Absolute pixel size for the item. Whatever value is set will
10551 * be the item's size regardless of any scale value the object may have
10552 * been set to. The final line height will be adjusted to fit larger items.
10553 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10555 * @li relsize: Size is adjusted for the item to fit within the current
10558 * Besides their size, items are specificed a @c vsize value that affects
10559 * how their final size and position are calculated. The possible values
10561 * @li ascent: Item will be placed within the line's baseline and its
10562 * ascent. That is, the height between the line where all characters are
10563 * positioned and the highest point in the line. For @c size and @c absize
10564 * items, the descent value will be added to the total line height to make
10565 * them fit. @c relsize items will be adjusted to fit within this space.
10566 * @li full: Items will be placed between the descent and ascent, or the
10567 * lowest point in the line and its highest.
10569 * The next image shows different configurations of items and how they
10570 * are the previously mentioned options affect their sizes. In all cases,
10571 * the green line indicates the ascent, blue for the baseline and red for
10574 * @image html entry_item.png
10575 * @image latex entry_item.eps width=\textwidth
10577 * And another one to show how size differs from absize. In the first one,
10578 * the scale value is set to 1.0, while the second one is using one of 2.0.
10580 * @image html entry_item_scale.png
10581 * @image latex entry_item_scale.eps width=\textwidth
10583 * After the size for an item is calculated, the entry will request an
10584 * object to place in its space. For this, the functions set with
10585 * elm_entry_item_provider_append() and related functions will be called
10586 * in order until one of them returns a @c non-NULL value. If no providers
10587 * are available, or all of them return @c NULL, then the entry falls back
10588 * to one of the internal defaults, provided the name matches with one of
10591 * All of the following are currently supported:
10594 * - emoticon/angry-shout
10595 * - emoticon/crazy-laugh
10596 * - emoticon/evil-laugh
10598 * - emoticon/goggle-smile
10599 * - emoticon/grumpy
10600 * - emoticon/grumpy-smile
10601 * - emoticon/guilty
10602 * - emoticon/guilty-smile
10604 * - emoticon/half-smile
10605 * - emoticon/happy-panting
10607 * - emoticon/indifferent
10609 * - emoticon/knowing-grin
10611 * - emoticon/little-bit-sorry
10612 * - emoticon/love-lots
10614 * - emoticon/minimal-smile
10615 * - emoticon/not-happy
10616 * - emoticon/not-impressed
10618 * - emoticon/opensmile
10621 * - emoticon/squint-laugh
10622 * - emoticon/surprised
10623 * - emoticon/suspicious
10624 * - emoticon/tongue-dangling
10625 * - emoticon/tongue-poke
10627 * - emoticon/unhappy
10628 * - emoticon/very-sorry
10631 * - emoticon/worried
10634 * Alternatively, an item may reference an image by its path, using
10635 * the URI form @c file:///path/to/an/image.png and the entry will then
10636 * use that image for the item.
10638 * @section entry-files Loading and saving files
10640 * Entries have convinience functions to load text from a file and save
10641 * changes back to it after a short delay. The automatic saving is enabled
10642 * by default, but can be disabled with elm_entry_autosave_set() and files
10643 * can be loaded directly as plain text or have any markup in them
10644 * recognized. See elm_entry_file_set() for more details.
10646 * @section entry-signals Emitted signals
10648 * This widget emits the following signals:
10650 * @li "changed": The text within the entry was changed.
10651 * @li "changed,user": The text within the entry was changed because of user interaction.
10652 * @li "activated": The enter key was pressed on a single line entry.
10653 * @li "press": A mouse button has been pressed on the entry.
10654 * @li "longpressed": A mouse button has been pressed and held for a couple
10656 * @li "clicked": The entry has been clicked (mouse press and release).
10657 * @li "clicked,double": The entry has been double clicked.
10658 * @li "clicked,triple": The entry has been triple clicked.
10659 * @li "focused": The entry has received focus.
10660 * @li "unfocused": The entry has lost focus.
10661 * @li "selection,paste": A paste of the clipboard contents was requested.
10662 * @li "selection,copy": A copy of the selected text into the clipboard was
10664 * @li "selection,cut": A cut of the selected text into the clipboard was
10666 * @li "selection,start": A selection has begun and no previous selection
10668 * @li "selection,changed": The current selection has changed.
10669 * @li "selection,cleared": The current selection has been cleared.
10670 * @li "cursor,changed": The cursor has changed position.
10671 * @li "anchor,clicked": An anchor has been clicked. The event_info
10672 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10673 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10674 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10675 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10676 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10677 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10678 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10679 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10680 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10681 * @li "preedit,changed": The preedit string has changed.
10683 * @section entry-examples
10685 * An overview of the Entry API can be seen in @ref entry_example_01
10690 * @typedef Elm_Entry_Anchor_Info
10692 * The info sent in the callback for the "anchor,clicked" signals emitted
10695 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10697 * @struct _Elm_Entry_Anchor_Info
10699 * The info sent in the callback for the "anchor,clicked" signals emitted
10702 struct _Elm_Entry_Anchor_Info
10704 const char *name; /**< The name of the anchor, as stated in its href */
10705 int button; /**< The mouse button used to click on it */
10706 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10707 y, /**< Anchor geometry, relative to canvas */
10708 w, /**< Anchor geometry, relative to canvas */
10709 h; /**< Anchor geometry, relative to canvas */
10712 * @typedef Elm_Entry_Filter_Cb
10713 * This callback type is used by entry filters to modify text.
10714 * @param data The data specified as the last param when adding the filter
10715 * @param entry The entry object
10716 * @param text A pointer to the location of the text being filtered. This data can be modified,
10717 * but any additional allocations must be managed by the user.
10718 * @see elm_entry_text_filter_append
10719 * @see elm_entry_text_filter_prepend
10721 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10724 * This adds an entry to @p parent object.
10726 * By default, entries are:
10730 * @li autosave is enabled
10732 * @param parent The parent object
10733 * @return The new object or NULL if it cannot be created
10735 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10737 * Sets the entry to single line mode.
10739 * In single line mode, entries don't ever wrap when the text reaches the
10740 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10741 * key will generate an @c "activate" event instead of adding a new line.
10743 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10744 * and pressing enter will break the text into a different line
10745 * without generating any events.
10747 * @param obj The entry object
10748 * @param single_line If true, the text in the entry
10749 * will be on a single line.
10751 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10753 * Gets whether the entry is set to be single line.
10755 * @param obj The entry object
10756 * @return single_line If true, the text in the entry is set to display
10757 * on a single line.
10759 * @see elm_entry_single_line_set()
10761 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10763 * Sets the entry to password mode.
10765 * In password mode, entries are implicitly single line and the display of
10766 * any text in them is replaced with asterisks (*).
10768 * @param obj The entry object
10769 * @param password If true, password mode is enabled.
10771 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10773 * Gets whether the entry is set to password mode.
10775 * @param obj The entry object
10776 * @return If true, the entry is set to display all characters
10777 * as asterisks (*).
10779 * @see elm_entry_password_set()
10781 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10783 * This sets the text displayed within the entry to @p entry.
10785 * @param obj The entry object
10786 * @param entry The text to be displayed
10788 * @deprecated Use elm_object_text_set() instead.
10790 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10792 * This returns the text currently shown in object @p entry.
10793 * See also elm_entry_entry_set().
10795 * @param obj The entry object
10796 * @return The currently displayed text or NULL on failure
10798 * @deprecated Use elm_object_text_get() instead.
10800 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10802 * Appends @p entry to the text of the entry.
10804 * Adds the text in @p entry to the end of any text already present in the
10807 * The appended text is subject to any filters set for the widget.
10809 * @param obj The entry object
10810 * @param entry The text to be displayed
10812 * @see elm_entry_text_filter_append()
10814 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10816 * Gets whether the entry is empty.
10818 * Empty means no text at all. If there are any markup tags, like an item
10819 * tag for which no provider finds anything, and no text is displayed, this
10820 * function still returns EINA_FALSE.
10822 * @param obj The entry object
10823 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10825 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10827 * Gets any selected text within the entry.
10829 * If there's any selected text in the entry, this function returns it as
10830 * a string in markup format. NULL is returned if no selection exists or
10831 * if an error occurred.
10833 * The returned value points to an internal string and should not be freed
10834 * or modified in any way. If the @p entry object is deleted or its
10835 * contents are changed, the returned pointer should be considered invalid.
10837 * @param obj The entry object
10838 * @return The selected text within the entry or NULL on failure
10840 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10842 * Inserts the given text into the entry at the current cursor position.
10844 * This inserts text at the cursor position as if it was typed
10845 * by the user (note that this also allows markup which a user
10846 * can't just "type" as it would be converted to escaped text, so this
10847 * call can be used to insert things like emoticon items or bold push/pop
10848 * tags, other font and color change tags etc.)
10850 * If any selection exists, it will be replaced by the inserted text.
10852 * The inserted text is subject to any filters set for the widget.
10854 * @param obj The entry object
10855 * @param entry The text to insert
10857 * @see elm_entry_text_filter_append()
10859 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10861 * Set the line wrap type to use on multi-line entries.
10863 * Sets the wrap type used by the entry to any of the specified in
10864 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10865 * line (without inserting a line break or paragraph separator) when it
10866 * reaches the far edge of the widget.
10868 * Note that this only makes sense for multi-line entries. A widget set
10869 * to be single line will never wrap.
10871 * @param obj The entry object
10872 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10874 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10876 * Gets the wrap mode the entry was set to use.
10878 * @param obj The entry object
10879 * @return Wrap type
10881 * @see also elm_entry_line_wrap_set()
10883 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10885 * Sets if the entry is to be editable or not.
10887 * By default, entries are editable and when focused, any text input by the
10888 * user will be inserted at the current cursor position. But calling this
10889 * function with @p editable as EINA_FALSE will prevent the user from
10890 * inputting text into the entry.
10892 * The only way to change the text of a non-editable entry is to use
10893 * elm_object_text_set(), elm_entry_entry_insert() and other related
10896 * @param obj The entry object
10897 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10898 * if not, the entry is read-only and no user input is allowed.
10900 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10902 * Gets whether the entry is editable or not.
10904 * @param obj The entry object
10905 * @return If true, the entry is editable by the user.
10906 * If false, it is not editable by the user
10908 * @see elm_entry_editable_set()
10910 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10912 * This drops any existing text selection within the entry.
10914 * @param obj The entry object
10916 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * This selects all text within the entry.
10920 * @param obj The entry object
10922 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10924 * This moves the cursor one place to the right within the entry.
10926 * @param obj The entry object
10927 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10929 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10931 * This moves the cursor one place to the left within the entry.
10933 * @param obj The entry object
10934 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10936 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10938 * This moves the cursor one line up within the entry.
10940 * @param obj The entry object
10941 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10943 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10945 * This moves the cursor one line down within the entry.
10947 * @param obj The entry object
10948 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10950 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10952 * This moves the cursor to the beginning of the entry.
10954 * @param obj The entry object
10956 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10958 * This moves the cursor to the end of the entry.
10960 * @param obj The entry object
10962 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10964 * This moves the cursor to the beginning of the current line.
10966 * @param obj The entry object
10968 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10970 * This moves the cursor to the end of the current line.
10972 * @param obj The entry object
10974 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10976 * This begins a selection within the entry as though
10977 * the user were holding down the mouse button to make a selection.
10979 * @param obj The entry object
10981 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10983 * This ends a selection within the entry as though
10984 * the user had just released the mouse button while making a selection.
10986 * @param obj The entry object
10988 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10990 * Gets whether a format node exists at the current cursor position.
10992 * A format node is anything that defines how the text is rendered. It can
10993 * be a visible format node, such as a line break or a paragraph separator,
10994 * or an invisible one, such as bold begin or end tag.
10995 * This function returns whether any format node exists at the current
10998 * @param obj The entry object
10999 * @return EINA_TRUE if the current cursor position contains a format node,
11000 * EINA_FALSE otherwise.
11002 * @see elm_entry_cursor_is_visible_format_get()
11004 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11006 * Gets if the current cursor position holds a visible format node.
11008 * @param obj The entry object
11009 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11010 * if it's an invisible one or no format exists.
11012 * @see elm_entry_cursor_is_format_get()
11014 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11016 * Gets the character pointed by the cursor at its current position.
11018 * This function returns a string with the utf8 character stored at the
11019 * current cursor position.
11020 * Only the text is returned, any format that may exist will not be part
11021 * of the return value.
11023 * @param obj The entry object
11024 * @return The text pointed by the cursors.
11026 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11028 * This function returns the geometry of the cursor.
11030 * It's useful if you want to draw something on the cursor (or where it is),
11031 * or for example in the case of scrolled entry where you want to show the
11034 * @param obj The entry object
11035 * @param x returned geometry
11036 * @param y returned geometry
11037 * @param w returned geometry
11038 * @param h returned geometry
11039 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11041 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);
11043 * Sets the cursor position in the entry to the given value
11045 * The value in @p pos is the index of the character position within the
11046 * contents of the string as returned by elm_entry_cursor_pos_get().
11048 * @param obj The entry object
11049 * @param pos The position of the cursor
11051 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11053 * Retrieves the current position of the cursor in the entry
11055 * @param obj The entry object
11056 * @return The cursor position
11058 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11060 * This executes a "cut" action on the selected text in the entry.
11062 * @param obj The entry object
11064 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11066 * This executes a "copy" action on the selected text in the entry.
11068 * @param obj The entry object
11070 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11072 * This executes a "paste" action in the entry.
11074 * @param obj The entry object
11076 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11078 * This clears and frees the items in a entry's contextual (longpress)
11081 * @param obj The entry object
11083 * @see elm_entry_context_menu_item_add()
11085 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11087 * This adds an item to the entry's contextual menu.
11089 * A longpress on an entry will make the contextual menu show up, if this
11090 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11091 * By default, this menu provides a few options like enabling selection mode,
11092 * which is useful on embedded devices that need to be explicit about it,
11093 * and when a selection exists it also shows the copy and cut actions.
11095 * With this function, developers can add other options to this menu to
11096 * perform any action they deem necessary.
11098 * @param obj The entry object
11099 * @param label The item's text label
11100 * @param icon_file The item's icon file
11101 * @param icon_type The item's icon type
11102 * @param func The callback to execute when the item is clicked
11103 * @param data The data to associate with the item for related functions
11105 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);
11107 * This disables the entry's contextual (longpress) menu.
11109 * @param obj The entry object
11110 * @param disabled If true, the menu is disabled
11112 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11114 * This returns whether the entry's contextual (longpress) menu is
11117 * @param obj The entry object
11118 * @return If true, the menu is disabled
11120 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11122 * This appends a custom item provider to the list for that entry
11124 * This appends the given callback. The list is walked from beginning to end
11125 * with each function called given the item href string in the text. If the
11126 * function returns an object handle other than NULL (it should create an
11127 * object to do this), then this object is used to replace that item. If
11128 * not the next provider is called until one provides an item object, or the
11129 * default provider in entry does.
11131 * @param obj The entry object
11132 * @param func The function called to provide the item object
11133 * @param data The data passed to @p func
11135 * @see @ref entry-items
11137 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);
11139 * This prepends a custom item provider to the list for that entry
11141 * This prepends the given callback. See elm_entry_item_provider_append() for
11144 * @param obj The entry object
11145 * @param func The function called to provide the item object
11146 * @param data The data passed to @p func
11148 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);
11150 * This removes a custom item provider to the list for that entry
11152 * This removes the given callback. See elm_entry_item_provider_append() for
11155 * @param obj The entry object
11156 * @param func The function called to provide the item object
11157 * @param data The data passed to @p func
11159 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);
11161 * Append a filter function for text inserted in the entry
11163 * Append the given callback to the list. This functions will be called
11164 * whenever any text is inserted into the entry, with the text to be inserted
11165 * as a parameter. The callback function is free to alter the text in any way
11166 * it wants, but it must remember to free the given pointer and update it.
11167 * If the new text is to be discarded, the function can free it and set its
11168 * text parameter to NULL. This will also prevent any following filters from
11171 * @param obj The entry object
11172 * @param func The function to use as text filter
11173 * @param data User data to pass to @p func
11175 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11177 * Prepend a filter function for text insdrted in the entry
11179 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11180 * for more information
11182 * @param obj The entry object
11183 * @param func The function to use as text filter
11184 * @param data User data to pass to @p func
11186 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11188 * Remove a filter from the list
11190 * Removes the given callback from the filter list. See
11191 * elm_entry_text_filter_append() for more information.
11193 * @param obj The entry object
11194 * @param func The filter function to remove
11195 * @param data The user data passed when adding the function
11197 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11199 * This converts a markup (HTML-like) string into UTF-8.
11201 * The returned string is a malloc'ed buffer and it should be freed when
11202 * not needed anymore.
11204 * @param s The string (in markup) to be converted
11205 * @return The converted string (in UTF-8). It should be freed.
11207 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11209 * This converts a UTF-8 string into markup (HTML-like).
11211 * The returned string is a malloc'ed buffer and it should be freed when
11212 * not needed anymore.
11214 * @param s The string (in UTF-8) to be converted
11215 * @return The converted string (in markup). It should be freed.
11217 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11219 * This sets the file (and implicitly loads it) for the text to display and
11220 * then edit. All changes are written back to the file after a short delay if
11221 * the entry object is set to autosave (which is the default).
11223 * If the entry had any other file set previously, any changes made to it
11224 * will be saved if the autosave feature is enabled, otherwise, the file
11225 * will be silently discarded and any non-saved changes will be lost.
11227 * @param obj The entry object
11228 * @param file The path to the file to load and save
11229 * @param format The file format
11231 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11233 * Gets the file being edited by the entry.
11235 * This function can be used to retrieve any file set on the entry for
11236 * edition, along with the format used to load and save it.
11238 * @param obj The entry object
11239 * @param file The path to the file to load and save
11240 * @param format The file format
11242 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11244 * This function writes any changes made to the file set with
11245 * elm_entry_file_set()
11247 * @param obj The entry object
11249 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11251 * This sets the entry object to 'autosave' the loaded text file or not.
11253 * @param obj The entry object
11254 * @param autosave Autosave the loaded file or not
11256 * @see elm_entry_file_set()
11258 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11260 * This gets the entry object's 'autosave' status.
11262 * @param obj The entry object
11263 * @return Autosave the loaded file or not
11265 * @see elm_entry_file_set()
11267 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11269 * Control pasting of text and images for the widget.
11271 * Normally the entry allows both text and images to be pasted. By setting
11272 * textonly to be true, this prevents images from being pasted.
11274 * Note this only changes the behaviour of text.
11276 * @param obj The entry object
11277 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11278 * text+image+other.
11280 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11282 * Getting elm_entry text paste/drop mode.
11284 * In textonly mode, only text may be pasted or dropped into the widget.
11286 * @param obj The entry object
11287 * @return If the widget only accepts text from pastes.
11289 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11291 * Enable or disable scrolling in entry
11293 * Normally the entry is not scrollable unless you enable it with this call.
11295 * @param obj The entry object
11296 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11298 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11300 * Get the scrollable state of the entry
11302 * Normally the entry is not scrollable. This gets the scrollable state
11303 * of the entry. See elm_entry_scrollable_set() for more information.
11305 * @param obj The entry object
11306 * @return The scrollable state
11308 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11310 * This sets a widget to be displayed to the left of a scrolled entry.
11312 * @param obj The scrolled entry object
11313 * @param icon The widget to display on the left side of the scrolled
11316 * @note A previously set widget will be destroyed.
11317 * @note If the object being set does not have minimum size hints set,
11318 * it won't get properly displayed.
11320 * @see elm_entry_end_set()
11322 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11324 * Gets the leftmost widget of the scrolled entry. This object is
11325 * owned by the scrolled entry and should not be modified.
11327 * @param obj The scrolled entry object
11328 * @return the left widget inside the scroller
11330 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11332 * Unset the leftmost widget of the scrolled entry, unparenting and
11335 * @param obj The scrolled entry object
11336 * @return the previously set icon sub-object of this entry, on
11339 * @see elm_entry_icon_set()
11341 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11343 * Sets the visibility of the left-side widget of the scrolled entry,
11344 * set by elm_entry_icon_set().
11346 * @param obj The scrolled entry object
11347 * @param setting EINA_TRUE if the object should be displayed,
11348 * EINA_FALSE if not.
11350 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11352 * This sets a widget to be displayed to the end of a scrolled entry.
11354 * @param obj The scrolled entry object
11355 * @param end The widget to display on the right side of the scrolled
11358 * @note A previously set widget will be destroyed.
11359 * @note If the object being set does not have minimum size hints set,
11360 * it won't get properly displayed.
11362 * @see elm_entry_icon_set
11364 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11366 * Gets the endmost widget of the scrolled entry. This object is owned
11367 * by the scrolled entry and should not be modified.
11369 * @param obj The scrolled entry object
11370 * @return the right widget inside the scroller
11372 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11374 * Unset the endmost widget of the scrolled entry, unparenting and
11377 * @param obj The scrolled entry object
11378 * @return the previously set icon sub-object of this entry, on
11381 * @see elm_entry_icon_set()
11383 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11385 * Sets the visibility of the end widget of the scrolled entry, set by
11386 * elm_entry_end_set().
11388 * @param obj The scrolled entry object
11389 * @param setting EINA_TRUE if the object should be displayed,
11390 * EINA_FALSE if not.
11392 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11394 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11397 * Setting an entry to single-line mode with elm_entry_single_line_set()
11398 * will automatically disable the display of scrollbars when the entry
11399 * moves inside its scroller.
11401 * @param obj The scrolled entry object
11402 * @param h The horizontal scrollbar policy to apply
11403 * @param v The vertical scrollbar policy to apply
11405 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11407 * This enables/disables bouncing within the entry.
11409 * This function sets whether the entry will bounce when scrolling reaches
11410 * the end of the contained entry.
11412 * @param obj The scrolled entry object
11413 * @param h The horizontal bounce state
11414 * @param v The vertical bounce state
11416 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11418 * Get the bounce mode
11420 * @param obj The Entry object
11421 * @param h_bounce Allow bounce horizontally
11422 * @param v_bounce Allow bounce vertically
11424 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11426 /* pre-made filters for entries */
11428 * @typedef Elm_Entry_Filter_Limit_Size
11430 * Data for the elm_entry_filter_limit_size() entry filter.
11432 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11434 * @struct _Elm_Entry_Filter_Limit_Size
11436 * Data for the elm_entry_filter_limit_size() entry filter.
11438 struct _Elm_Entry_Filter_Limit_Size
11440 int max_char_count; /**< The maximum number of characters allowed. */
11441 int max_byte_count; /**< The maximum number of bytes allowed*/
11444 * Filter inserted text based on user defined character and byte limits
11446 * Add this filter to an entry to limit the characters that it will accept
11447 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11448 * The funtion works on the UTF-8 representation of the string, converting
11449 * it from the set markup, thus not accounting for any format in it.
11451 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11452 * it as data when setting the filter. In it, it's possible to set limits
11453 * by character count or bytes (any of them is disabled if 0), and both can
11454 * be set at the same time. In that case, it first checks for characters,
11457 * The function will cut the inserted text in order to allow only the first
11458 * number of characters that are still allowed. The cut is made in
11459 * characters, even when limiting by bytes, in order to always contain
11460 * valid ones and avoid half unicode characters making it in.
11462 * This filter, like any others, does not apply when setting the entry text
11463 * directly with elm_object_text_set() (or the deprecated
11464 * elm_entry_entry_set()).
11466 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11468 * @typedef Elm_Entry_Filter_Accept_Set
11470 * Data for the elm_entry_filter_accept_set() entry filter.
11472 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11474 * @struct _Elm_Entry_Filter_Accept_Set
11476 * Data for the elm_entry_filter_accept_set() entry filter.
11478 struct _Elm_Entry_Filter_Accept_Set
11480 const char *accepted; /**< Set of characters accepted in the entry. */
11481 const char *rejected; /**< Set of characters rejected from the entry. */
11484 * Filter inserted text based on accepted or rejected sets of characters
11486 * Add this filter to an entry to restrict the set of accepted characters
11487 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11488 * This structure contains both accepted and rejected sets, but they are
11489 * mutually exclusive.
11491 * The @c accepted set takes preference, so if it is set, the filter will
11492 * only work based on the accepted characters, ignoring anything in the
11493 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11495 * In both cases, the function filters by matching utf8 characters to the
11496 * raw markup text, so it can be used to remove formatting tags.
11498 * This filter, like any others, does not apply when setting the entry text
11499 * directly with elm_object_text_set() (or the deprecated
11500 * elm_entry_entry_set()).
11502 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11504 * Set the input panel layout of the entry
11506 * @param obj The entry object
11507 * @param layout layout type
11509 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11511 * Get the input panel layout of the entry
11513 * @param obj The entry object
11514 * @return layout type
11516 * @see elm_entry_input_panel_layout_set
11518 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11523 /* composite widgets - these basically put together basic widgets above
11524 * in convenient packages that do more than basic stuff */
11528 * @defgroup Anchorview Anchorview
11530 * @image html img/widget/anchorview/preview-00.png
11531 * @image latex img/widget/anchorview/preview-00.eps
11533 * Anchorview is for displaying text that contains markup with anchors
11534 * like <c>\<a href=1234\>something\</\></c> in it.
11536 * Besides being styled differently, the anchorview widget provides the
11537 * necessary functionality so that clicking on these anchors brings up a
11538 * popup with user defined content such as "call", "add to contacts" or
11539 * "open web page". This popup is provided using the @ref Hover widget.
11541 * This widget is very similar to @ref Anchorblock, so refer to that
11542 * widget for an example. The only difference Anchorview has is that the
11543 * widget is already provided with scrolling functionality, so if the
11544 * text set to it is too large to fit in the given space, it will scroll,
11545 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11546 * text can be displayed.
11548 * This widget emits the following signals:
11549 * @li "anchor,clicked": will be called when an anchor is clicked. The
11550 * @p event_info parameter on the callback will be a pointer of type
11551 * ::Elm_Entry_Anchorview_Info.
11553 * See @ref Anchorblock for an example on how to use both of them.
11562 * @typedef Elm_Entry_Anchorview_Info
11564 * The info sent in the callback for "anchor,clicked" signals emitted by
11565 * the Anchorview widget.
11567 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11569 * @struct _Elm_Entry_Anchorview_Info
11571 * The info sent in the callback for "anchor,clicked" signals emitted by
11572 * the Anchorview widget.
11574 struct _Elm_Entry_Anchorview_Info
11576 const char *name; /**< Name of the anchor, as indicated in its href
11578 int button; /**< The mouse button used to click on it */
11579 Evas_Object *hover; /**< The hover object to use for the popup */
11581 Evas_Coord x, y, w, h;
11582 } anchor, /**< Geometry selection of text used as anchor */
11583 hover_parent; /**< Geometry of the object used as parent by the
11585 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11586 for content on the left side of
11587 the hover. Before calling the
11588 callback, the widget will make the
11589 necessary calculations to check
11590 which sides are fit to be set with
11591 content, based on the position the
11592 hover is activated and its distance
11593 to the edges of its parent object
11595 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11596 the right side of the hover.
11597 See @ref hover_left */
11598 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11599 of the hover. See @ref hover_left */
11600 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11601 below the hover. See @ref
11605 * Add a new Anchorview object
11607 * @param parent The parent object
11608 * @return The new object or NULL if it cannot be created
11610 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11612 * Set the text to show in the anchorview
11614 * Sets the text of the anchorview to @p text. This text can include markup
11615 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11616 * text that will be specially styled and react to click events, ended with
11617 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11618 * "anchor,clicked" signal that you can attach a callback to with
11619 * evas_object_smart_callback_add(). The name of the anchor given in the
11620 * event info struct will be the one set in the href attribute, in this
11621 * case, anchorname.
11623 * Other markup can be used to style the text in different ways, but it's
11624 * up to the style defined in the theme which tags do what.
11625 * @deprecated use elm_object_text_set() instead.
11627 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11629 * Get the markup text set for the anchorview
11631 * Retrieves the text set on the anchorview, with markup tags included.
11633 * @param obj The anchorview object
11634 * @return The markup text set or @c NULL if nothing was set or an error
11636 * @deprecated use elm_object_text_set() instead.
11638 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11640 * Set the parent of the hover popup
11642 * Sets the parent object to use by the hover created by the anchorview
11643 * when an anchor is clicked. See @ref Hover for more details on this.
11644 * If no parent is set, the same anchorview object will be used.
11646 * @param obj The anchorview object
11647 * @param parent The object to use as parent for the hover
11649 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11651 * Get the parent of the hover popup
11653 * Get the object used as parent for the hover created by the anchorview
11654 * widget. See @ref Hover for more details on this.
11656 * @param obj The anchorview object
11657 * @return The object used as parent for the hover, NULL if none is set.
11659 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11661 * Set the style that the hover should use
11663 * When creating the popup hover, anchorview will request that it's
11664 * themed according to @p style.
11666 * @param obj The anchorview object
11667 * @param style The style to use for the underlying hover
11669 * @see elm_object_style_set()
11671 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11673 * Get the style that the hover should use
11675 * Get the style the hover created by anchorview will use.
11677 * @param obj The anchorview object
11678 * @return The style to use by the hover. NULL means the default is used.
11680 * @see elm_object_style_set()
11682 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11684 * Ends the hover popup in the anchorview
11686 * When an anchor is clicked, the anchorview widget will create a hover
11687 * object to use as a popup with user provided content. This function
11688 * terminates this popup, returning the anchorview to its normal state.
11690 * @param obj The anchorview object
11692 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11694 * Set bouncing behaviour when the scrolled content reaches an edge
11696 * Tell the internal scroller object whether it should bounce or not
11697 * when it reaches the respective edges for each axis.
11699 * @param obj The anchorview object
11700 * @param h_bounce Whether to bounce or not in the horizontal axis
11701 * @param v_bounce Whether to bounce or not in the vertical axis
11703 * @see elm_scroller_bounce_set()
11705 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11707 * Get the set bouncing behaviour of the internal scroller
11709 * Get whether the internal scroller should bounce when the edge of each
11710 * axis is reached scrolling.
11712 * @param obj The anchorview object
11713 * @param h_bounce Pointer where to store the bounce state of the horizontal
11715 * @param v_bounce Pointer where to store the bounce state of the vertical
11718 * @see elm_scroller_bounce_get()
11720 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11722 * Appends a custom item provider to the given anchorview
11724 * Appends the given function to the list of items providers. This list is
11725 * called, one function at a time, with the given @p data pointer, the
11726 * anchorview object and, in the @p item parameter, the item name as
11727 * referenced in its href string. Following functions in the list will be
11728 * called in order until one of them returns something different to NULL,
11729 * which should be an Evas_Object which will be used in place of the item
11732 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11733 * href=item/name\>\</item\>
11735 * @param obj The anchorview object
11736 * @param func The function to add to the list of providers
11737 * @param data User data that will be passed to the callback function
11739 * @see elm_entry_item_provider_append()
11741 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);
11743 * Prepend a custom item provider to the given anchorview
11745 * Like elm_anchorview_item_provider_append(), but it adds the function
11746 * @p func to the beginning of the list, instead of the end.
11748 * @param obj The anchorview object
11749 * @param func The function to add to the list of providers
11750 * @param data User data that will be passed to the callback function
11752 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);
11754 * Remove a custom item provider from the list of the given anchorview
11756 * Removes the function and data pairing that matches @p func and @p data.
11757 * That is, unless the same function and same user data are given, the
11758 * function will not be removed from the list. This allows us to add the
11759 * same callback several times, with different @p data pointers and be
11760 * able to remove them later without conflicts.
11762 * @param obj The anchorview object
11763 * @param func The function to remove from the list
11764 * @param data The data matching the function to remove from the list
11766 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);
11773 * @defgroup Anchorblock Anchorblock
11775 * @image html img/widget/anchorblock/preview-00.png
11776 * @image latex img/widget/anchorblock/preview-00.eps
11778 * Anchorblock is for displaying text that contains markup with anchors
11779 * like <c>\<a href=1234\>something\</\></c> in it.
11781 * Besides being styled differently, the anchorblock widget provides the
11782 * necessary functionality so that clicking on these anchors brings up a
11783 * popup with user defined content such as "call", "add to contacts" or
11784 * "open web page". This popup is provided using the @ref Hover widget.
11786 * This widget emits the following signals:
11787 * @li "anchor,clicked": will be called when an anchor is clicked. The
11788 * @p event_info parameter on the callback will be a pointer of type
11789 * ::Elm_Entry_Anchorblock_Info.
11795 * Since examples are usually better than plain words, we might as well
11796 * try @ref tutorial_anchorblock_example "one".
11799 * @addtogroup Anchorblock
11803 * @typedef Elm_Entry_Anchorblock_Info
11805 * The info sent in the callback for "anchor,clicked" signals emitted by
11806 * the Anchorblock widget.
11808 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11810 * @struct _Elm_Entry_Anchorblock_Info
11812 * The info sent in the callback for "anchor,clicked" signals emitted by
11813 * the Anchorblock widget.
11815 struct _Elm_Entry_Anchorblock_Info
11817 const char *name; /**< Name of the anchor, as indicated in its href
11819 int button; /**< The mouse button used to click on it */
11820 Evas_Object *hover; /**< The hover object to use for the popup */
11822 Evas_Coord x, y, w, h;
11823 } anchor, /**< Geometry selection of text used as anchor */
11824 hover_parent; /**< Geometry of the object used as parent by the
11826 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11827 for content on the left side of
11828 the hover. Before calling the
11829 callback, the widget will make the
11830 necessary calculations to check
11831 which sides are fit to be set with
11832 content, based on the position the
11833 hover is activated and its distance
11834 to the edges of its parent object
11836 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11837 the right side of the hover.
11838 See @ref hover_left */
11839 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11840 of the hover. See @ref hover_left */
11841 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11842 below the hover. See @ref
11846 * Add a new Anchorblock object
11848 * @param parent The parent object
11849 * @return The new object or NULL if it cannot be created
11851 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11853 * Set the text to show in the anchorblock
11855 * Sets the text of the anchorblock to @p text. This text can include markup
11856 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11857 * of text that will be specially styled and react to click events, ended
11858 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11859 * "anchor,clicked" signal that you can attach a callback to with
11860 * evas_object_smart_callback_add(). The name of the anchor given in the
11861 * event info struct will be the one set in the href attribute, in this
11862 * case, anchorname.
11864 * Other markup can be used to style the text in different ways, but it's
11865 * up to the style defined in the theme which tags do what.
11866 * @deprecated use elm_object_text_set() instead.
11868 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11870 * Get the markup text set for the anchorblock
11872 * Retrieves the text set on the anchorblock, with markup tags included.
11874 * @param obj The anchorblock object
11875 * @return The markup text set or @c NULL if nothing was set or an error
11877 * @deprecated use elm_object_text_set() instead.
11879 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11881 * Set the parent of the hover popup
11883 * Sets the parent object to use by the hover created by the anchorblock
11884 * when an anchor is clicked. See @ref Hover for more details on this.
11886 * @param obj The anchorblock object
11887 * @param parent The object to use as parent for the hover
11889 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11891 * Get the parent of the hover popup
11893 * Get the object used as parent for the hover created by the anchorblock
11894 * widget. See @ref Hover for more details on this.
11895 * If no parent is set, the same anchorblock object will be used.
11897 * @param obj The anchorblock object
11898 * @return The object used as parent for the hover, NULL if none is set.
11900 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11902 * Set the style that the hover should use
11904 * When creating the popup hover, anchorblock will request that it's
11905 * themed according to @p style.
11907 * @param obj The anchorblock object
11908 * @param style The style to use for the underlying hover
11910 * @see elm_object_style_set()
11912 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11914 * Get the style that the hover should use
11916 * Get the style the hover created by anchorblock will use.
11918 * @param obj The anchorblock object
11919 * @return The style to use by the hover. NULL means the default is used.
11921 * @see elm_object_style_set()
11923 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11925 * Ends the hover popup in the anchorblock
11927 * When an anchor is clicked, the anchorblock widget will create a hover
11928 * object to use as a popup with user provided content. This function
11929 * terminates this popup, returning the anchorblock to its normal state.
11931 * @param obj The anchorblock object
11933 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11935 * Appends a custom item provider to the given anchorblock
11937 * Appends the given function to the list of items providers. This list is
11938 * called, one function at a time, with the given @p data pointer, the
11939 * anchorblock object and, in the @p item parameter, the item name as
11940 * referenced in its href string. Following functions in the list will be
11941 * called in order until one of them returns something different to NULL,
11942 * which should be an Evas_Object which will be used in place of the item
11945 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11946 * href=item/name\>\</item\>
11948 * @param obj The anchorblock object
11949 * @param func The function to add to the list of providers
11950 * @param data User data that will be passed to the callback function
11952 * @see elm_entry_item_provider_append()
11954 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);
11956 * Prepend a custom item provider to the given anchorblock
11958 * Like elm_anchorblock_item_provider_append(), but it adds the function
11959 * @p func to the beginning of the list, instead of the end.
11961 * @param obj The anchorblock object
11962 * @param func The function to add to the list of providers
11963 * @param data User data that will be passed to the callback function
11965 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);
11967 * Remove a custom item provider from the list of the given anchorblock
11969 * Removes the function and data pairing that matches @p func and @p data.
11970 * That is, unless the same function and same user data are given, the
11971 * function will not be removed from the list. This allows us to add the
11972 * same callback several times, with different @p data pointers and be
11973 * able to remove them later without conflicts.
11975 * @param obj The anchorblock object
11976 * @param func The function to remove from the list
11977 * @param data The data matching the function to remove from the list
11979 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);
11985 * @defgroup Bubble Bubble
11987 * @image html img/widget/bubble/preview-00.png
11988 * @image latex img/widget/bubble/preview-00.eps
11989 * @image html img/widget/bubble/preview-01.png
11990 * @image latex img/widget/bubble/preview-01.eps
11991 * @image html img/widget/bubble/preview-02.png
11992 * @image latex img/widget/bubble/preview-02.eps
11994 * @brief The Bubble is a widget to show text similarly to how speech is
11995 * represented in comics.
11997 * The bubble widget contains 5 important visual elements:
11998 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11999 * @li The @p icon is an image to which the frame's arrow points to.
12000 * @li The @p label is a text which appears to the right of the icon if the
12001 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12003 * @li The @p info is a text which appears to the right of the label. Info's
12004 * font is of a ligther color than label.
12005 * @li The @p content is an evas object that is shown inside the frame.
12007 * The position of the arrow, icon, label and info depends on which corner is
12008 * selected. The four available corners are:
12009 * @li "top_left" - Default
12011 * @li "bottom_left"
12012 * @li "bottom_right"
12014 * Signals that you can add callbacks for are:
12015 * @li "clicked" - This is called when a user has clicked the bubble.
12017 * For an example of using a buble see @ref bubble_01_example_page "this".
12022 * Add a new bubble to the parent
12024 * @param parent The parent object
12025 * @return The new object or NULL if it cannot be created
12027 * This function adds a text bubble to the given parent evas object.
12029 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12031 * Set the label of the bubble
12033 * @param obj The bubble object
12034 * @param label The string to set in the label
12036 * This function sets the title of the bubble. Where this appears depends on
12037 * the selected corner.
12038 * @deprecated use elm_object_text_set() instead.
12040 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12042 * Get the label of the bubble
12044 * @param obj The bubble object
12045 * @return The string of set in the label
12047 * This function gets the title of the bubble.
12048 * @deprecated use elm_object_text_get() instead.
12050 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12052 * Set the info of the bubble
12054 * @param obj The bubble object
12055 * @param info The given info about the bubble
12057 * This function sets the info of the bubble. Where this appears depends on
12058 * the selected corner.
12059 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12061 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12063 * Get the info of the bubble
12065 * @param obj The bubble object
12067 * @return The "info" string of the bubble
12069 * This function gets the info text.
12070 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12072 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12074 * Set the content to be shown in the bubble
12076 * Once the content object is set, a previously set one will be deleted.
12077 * If you want to keep the old content object, use the
12078 * elm_bubble_content_unset() function.
12080 * @param obj The bubble object
12081 * @param content The given content of the bubble
12083 * This function sets the content shown on the middle of the bubble.
12085 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12087 * Get the content shown in the bubble
12089 * Return the content object which is set for this widget.
12091 * @param obj The bubble object
12092 * @return The content that is being used
12094 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12096 * Unset the content shown in the bubble
12098 * Unparent and return the content object which was set for this widget.
12100 * @param obj The bubble object
12101 * @return The content that was being used
12103 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12105 * Set the icon of the bubble
12107 * Once the icon object is set, a previously set one will be deleted.
12108 * If you want to keep the old content object, use the
12109 * elm_icon_content_unset() function.
12111 * @param obj The bubble object
12112 * @param icon The given icon for the bubble
12114 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12116 * Get the icon of the bubble
12118 * @param obj The bubble object
12119 * @return The icon for the bubble
12121 * This function gets the icon shown on the top left of bubble.
12123 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12125 * Unset the icon of the bubble
12127 * Unparent and return the icon object which was set for this widget.
12129 * @param obj The bubble object
12130 * @return The icon that was being used
12132 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12134 * Set the corner of the bubble
12136 * @param obj The bubble object.
12137 * @param corner The given corner for the bubble.
12139 * This function sets the corner of the bubble. The corner will be used to
12140 * determine where the arrow in the frame points to and where label, icon and
12143 * Possible values for corner are:
12144 * @li "top_left" - Default
12146 * @li "bottom_left"
12147 * @li "bottom_right"
12149 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12151 * Get the corner of the bubble
12153 * @param obj The bubble object.
12154 * @return The given corner for the bubble.
12156 * This function gets the selected corner of the bubble.
12158 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12164 * @defgroup Photo Photo
12166 * For displaying the photo of a person (contact). Simple yet
12167 * with a very specific purpose.
12169 * Signals that you can add callbacks for are:
12171 * "clicked" - This is called when a user has clicked the photo
12172 * "drag,start" - Someone started dragging the image out of the object
12173 * "drag,end" - Dragged item was dropped (somewhere)
12179 * Add a new photo to the parent
12181 * @param parent The parent object
12182 * @return The new object or NULL if it cannot be created
12186 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12189 * Set the file that will be used as photo
12191 * @param obj The photo object
12192 * @param file The path to file that will be used as photo
12194 * @return (1 = success, 0 = error)
12198 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12201 * Set the file that will be used as thumbnail in the photo.
12203 * @param obj The photo object.
12204 * @param file The path to file that will be used as thumb.
12205 * @param group The key used in case of an EET file.
12209 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12212 * Set the size that will be used on the photo
12214 * @param obj The photo object
12215 * @param size The size that the photo will be
12219 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12222 * Set if the photo should be completely visible or not.
12224 * @param obj The photo object
12225 * @param fill if true the photo will be completely visible
12229 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12232 * Set editability of the photo.
12234 * An editable photo can be dragged to or from, and can be cut or
12235 * pasted too. Note that pasting an image or dropping an item on
12236 * the image will delete the existing content.
12238 * @param obj The photo object.
12239 * @param set To set of clear editablity.
12241 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12247 /* gesture layer */
12249 * @defgroup Elm_Gesture_Layer Gesture Layer
12250 * Gesture Layer Usage:
12252 * Use Gesture Layer to detect gestures.
12253 * The advantage is that you don't have to implement
12254 * gesture detection, just set callbacks of gesture state.
12255 * By using gesture layer we make standard interface.
12257 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12258 * with a parent object parameter.
12259 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12260 * call. Usually with same object as target (2nd parameter).
12262 * Now you need to tell gesture layer what gestures you follow.
12263 * This is done with @ref elm_gesture_layer_cb_set call.
12264 * By setting the callback you actually saying to gesture layer:
12265 * I would like to know when the gesture @ref Elm_Gesture_Types
12266 * switches to state @ref Elm_Gesture_State.
12268 * Next, you need to implement the actual action that follows the input
12269 * in your callback.
12271 * Note that if you like to stop being reported about a gesture, just set
12272 * all callbacks referring this gesture to NULL.
12273 * (again with @ref elm_gesture_layer_cb_set)
12275 * The information reported by gesture layer to your callback is depending
12276 * on @ref Elm_Gesture_Types:
12277 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12278 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12279 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12281 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12282 * @ref ELM_GESTURE_MOMENTUM.
12284 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12285 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12286 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12287 * Note that we consider a flick as a line-gesture that should be completed
12288 * in flick-time-limit as defined in @ref Config.
12290 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12292 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12295 * Gesture Layer Tweaks:
12297 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12298 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12300 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12301 * so gesture starts when user touches (a *DOWN event) touch-surface
12302 * and ends when no fingers touches surface (a *UP event).
12306 * @enum _Elm_Gesture_Types
12307 * Enum of supported gesture types.
12308 * @ingroup Elm_Gesture_Layer
12310 enum _Elm_Gesture_Types
12312 ELM_GESTURE_FIRST = 0,
12314 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12315 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12316 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12317 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12319 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12321 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12322 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12324 ELM_GESTURE_ZOOM, /**< Zoom */
12325 ELM_GESTURE_ROTATE, /**< Rotate */
12331 * @typedef Elm_Gesture_Types
12332 * gesture types enum
12333 * @ingroup Elm_Gesture_Layer
12335 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12338 * @enum _Elm_Gesture_State
12339 * Enum of gesture states.
12340 * @ingroup Elm_Gesture_Layer
12342 enum _Elm_Gesture_State
12344 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12345 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12346 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12347 ELM_GESTURE_STATE_END, /**< Gesture completed */
12348 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12352 * @typedef Elm_Gesture_State
12353 * gesture states enum
12354 * @ingroup Elm_Gesture_Layer
12356 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12359 * @struct _Elm_Gesture_Taps_Info
12360 * Struct holds taps info for user
12361 * @ingroup Elm_Gesture_Layer
12363 struct _Elm_Gesture_Taps_Info
12365 Evas_Coord x, y; /**< Holds center point between fingers */
12366 unsigned int n; /**< Number of fingers tapped */
12367 unsigned int timestamp; /**< event timestamp */
12371 * @typedef Elm_Gesture_Taps_Info
12372 * holds taps info for user
12373 * @ingroup Elm_Gesture_Layer
12375 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12378 * @struct _Elm_Gesture_Momentum_Info
12379 * Struct holds momentum info for user
12380 * x1 and y1 are not necessarily in sync
12381 * x1 holds x value of x direction starting point
12382 * and same holds for y1.
12383 * This is noticeable when doing V-shape movement
12384 * @ingroup Elm_Gesture_Layer
12386 struct _Elm_Gesture_Momentum_Info
12387 { /* Report line ends, timestamps, and momentum computed */
12388 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12389 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12390 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12391 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12393 unsigned int tx; /**< Timestamp of start of final x-swipe */
12394 unsigned int ty; /**< Timestamp of start of final y-swipe */
12396 Evas_Coord mx; /**< Momentum on X */
12397 Evas_Coord my; /**< Momentum on Y */
12401 * @typedef Elm_Gesture_Momentum_Info
12402 * holds momentum info for user
12403 * @ingroup Elm_Gesture_Layer
12405 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12408 * @struct _Elm_Gesture_Line_Info
12409 * Struct holds line info for user
12410 * @ingroup Elm_Gesture_Layer
12412 struct _Elm_Gesture_Line_Info
12413 { /* Report line ends, timestamps, and momentum computed */
12414 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12415 unsigned int n; /**< Number of fingers (lines) */
12416 /* FIXME should be radians, bot degrees */
12417 double angle; /**< Angle (direction) of lines */
12421 * @typedef Elm_Gesture_Line_Info
12422 * Holds line info for user
12423 * @ingroup Elm_Gesture_Layer
12425 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12428 * @struct _Elm_Gesture_Zoom_Info
12429 * Struct holds zoom info for user
12430 * @ingroup Elm_Gesture_Layer
12432 struct _Elm_Gesture_Zoom_Info
12434 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12435 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12436 double zoom; /**< Zoom value: 1.0 means no zoom */
12437 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12441 * @typedef Elm_Gesture_Zoom_Info
12442 * Holds zoom info for user
12443 * @ingroup Elm_Gesture_Layer
12445 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12448 * @struct _Elm_Gesture_Rotate_Info
12449 * Struct holds rotation info for user
12450 * @ingroup Elm_Gesture_Layer
12452 struct _Elm_Gesture_Rotate_Info
12454 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12455 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12456 double base_angle; /**< Holds start-angle */
12457 double angle; /**< Rotation value: 0.0 means no rotation */
12458 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12462 * @typedef Elm_Gesture_Rotate_Info
12463 * Holds rotation info for user
12464 * @ingroup Elm_Gesture_Layer
12466 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12469 * @typedef Elm_Gesture_Event_Cb
12470 * User callback used to stream gesture info from gesture layer
12471 * @param data user data
12472 * @param event_info gesture report info
12473 * Returns a flag field to be applied on the causing event.
12474 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12475 * upon the event, in an irreversible way.
12477 * @ingroup Elm_Gesture_Layer
12479 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12482 * Use function to set callbacks to be notified about
12483 * change of state of gesture.
12484 * When a user registers a callback with this function
12485 * this means this gesture has to be tested.
12487 * When ALL callbacks for a gesture are set to NULL
12488 * it means user isn't interested in gesture-state
12489 * and it will not be tested.
12491 * @param obj Pointer to gesture-layer.
12492 * @param idx The gesture you would like to track its state.
12493 * @param cb callback function pointer.
12494 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12495 * @param data user info to be sent to callback (usually, Smart Data)
12497 * @ingroup Elm_Gesture_Layer
12499 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);
12502 * Call this function to get repeat-events settings.
12504 * @param obj Pointer to gesture-layer.
12506 * @return repeat events settings.
12507 * @see elm_gesture_layer_hold_events_set()
12508 * @ingroup Elm_Gesture_Layer
12510 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12513 * This function called in order to make gesture-layer repeat events.
12514 * Set this of you like to get the raw events only if gestures were not detected.
12515 * Clear this if you like gesture layer to fwd events as testing gestures.
12517 * @param obj Pointer to gesture-layer.
12518 * @param r Repeat: TRUE/FALSE
12520 * @ingroup Elm_Gesture_Layer
12522 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12525 * This function sets step-value for zoom action.
12526 * Set step to any positive value.
12527 * Cancel step setting by setting to 0.0
12529 * @param obj Pointer to gesture-layer.
12530 * @param s new zoom step value.
12532 * @ingroup Elm_Gesture_Layer
12534 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12537 * This function sets step-value for rotate action.
12538 * Set step to any positive value.
12539 * Cancel step setting by setting to 0.0
12541 * @param obj Pointer to gesture-layer.
12542 * @param s new roatate step value.
12544 * @ingroup Elm_Gesture_Layer
12546 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12549 * This function called to attach gesture-layer to an Evas_Object.
12550 * @param obj Pointer to gesture-layer.
12551 * @param t Pointer to underlying object (AKA Target)
12553 * @return TRUE, FALSE on success, failure.
12555 * @ingroup Elm_Gesture_Layer
12557 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12560 * Call this function to construct a new gesture-layer object.
12561 * This does not activate the gesture layer. You have to
12562 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12564 * @param parent the parent object.
12566 * @return Pointer to new gesture-layer object.
12568 * @ingroup Elm_Gesture_Layer
12570 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12573 * @defgroup Thumb Thumb
12575 * @image html img/widget/thumb/preview-00.png
12576 * @image latex img/widget/thumb/preview-00.eps
12578 * A thumb object is used for displaying the thumbnail of an image or video.
12579 * You must have compiled Elementary with Ethumb_Client support and the DBus
12580 * service must be present and auto-activated in order to have thumbnails to
12583 * Once the thumbnail object becomes visible, it will check if there is a
12584 * previously generated thumbnail image for the file set on it. If not, it
12585 * will start generating this thumbnail.
12587 * Different config settings will cause different thumbnails to be generated
12588 * even on the same file.
12590 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12591 * Ethumb documentation to change this path, and to see other configuration
12594 * Signals that you can add callbacks for are:
12596 * - "clicked" - This is called when a user has clicked the thumb without dragging
12598 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12599 * - "press" - This is called when a user has pressed down the thumb.
12600 * - "generate,start" - The thumbnail generation started.
12601 * - "generate,stop" - The generation process stopped.
12602 * - "generate,error" - The generation failed.
12603 * - "load,error" - The thumbnail image loading failed.
12605 * available styles:
12609 * An example of use of thumbnail:
12611 * - @ref thumb_example_01
12615 * @addtogroup Thumb
12620 * @enum _Elm_Thumb_Animation_Setting
12621 * @typedef Elm_Thumb_Animation_Setting
12623 * Used to set if a video thumbnail is animating or not.
12627 typedef enum _Elm_Thumb_Animation_Setting
12629 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12630 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12631 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12632 ELM_THUMB_ANIMATION_LAST
12633 } Elm_Thumb_Animation_Setting;
12636 * Add a new thumb object to the parent.
12638 * @param parent The parent object.
12639 * @return The new object or NULL if it cannot be created.
12641 * @see elm_thumb_file_set()
12642 * @see elm_thumb_ethumb_client_get()
12646 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12648 * Reload thumbnail if it was generated before.
12650 * @param obj The thumb object to reload
12652 * This is useful if the ethumb client configuration changed, like its
12653 * size, aspect or any other property one set in the handle returned
12654 * by elm_thumb_ethumb_client_get().
12656 * If the options didn't change, the thumbnail won't be generated again, but
12657 * the old one will still be used.
12659 * @see elm_thumb_file_set()
12663 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12665 * Set the file that will be used as thumbnail.
12667 * @param obj The thumb object.
12668 * @param file The path to file that will be used as thumb.
12669 * @param key The key used in case of an EET file.
12671 * The file can be an image or a video (in that case, acceptable extensions are:
12672 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12673 * function elm_thumb_animate().
12675 * @see elm_thumb_file_get()
12676 * @see elm_thumb_reload()
12677 * @see elm_thumb_animate()
12681 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12683 * Get the image or video path and key used to generate the thumbnail.
12685 * @param obj The thumb object.
12686 * @param file Pointer to filename.
12687 * @param key Pointer to key.
12689 * @see elm_thumb_file_set()
12690 * @see elm_thumb_path_get()
12694 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12696 * Get the path and key to the image or video generated by ethumb.
12698 * One just need to make sure that the thumbnail was generated before getting
12699 * its path; otherwise, the path will be NULL. One way to do that is by asking
12700 * for the path when/after the "generate,stop" smart callback is called.
12702 * @param obj The thumb object.
12703 * @param file Pointer to thumb path.
12704 * @param key Pointer to thumb key.
12706 * @see elm_thumb_file_get()
12710 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12712 * Set the animation state for the thumb object. If its content is an animated
12713 * video, you may start/stop the animation or tell it to play continuously and
12716 * @param obj The thumb object.
12717 * @param setting The animation setting.
12719 * @see elm_thumb_file_set()
12723 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12725 * Get the animation state for the thumb object.
12727 * @param obj The thumb object.
12728 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12731 * @see elm_thumb_animate_set()
12735 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12737 * Get the ethumb_client handle so custom configuration can be made.
12739 * @return Ethumb_Client instance or NULL.
12741 * This must be called before the objects are created to be sure no object is
12742 * visible and no generation started.
12744 * Example of usage:
12747 * #include <Elementary.h>
12748 * #ifndef ELM_LIB_QUICKLAUNCH
12750 * elm_main(int argc, char **argv)
12752 * Ethumb_Client *client;
12754 * elm_need_ethumb();
12758 * client = elm_thumb_ethumb_client_get();
12761 * ERR("could not get ethumb_client");
12764 * ethumb_client_size_set(client, 100, 100);
12765 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12768 * // Create elm_thumb objects here
12778 * @note There's only one client handle for Ethumb, so once a configuration
12779 * change is done to it, any other request for thumbnails (for any thumbnail
12780 * object) will use that configuration. Thus, this configuration is global.
12784 EAPI void *elm_thumb_ethumb_client_get(void);
12786 * Get the ethumb_client connection state.
12788 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12791 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12793 * Make the thumbnail 'editable'.
12795 * @param obj Thumb object.
12796 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12798 * This means the thumbnail is a valid drag target for drag and drop, and can be
12799 * cut or pasted too.
12801 * @see elm_thumb_editable_get()
12805 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12807 * Make the thumbnail 'editable'.
12809 * @param obj Thumb object.
12810 * @return Editability.
12812 * This means the thumbnail is a valid drag target for drag and drop, and can be
12813 * cut or pasted too.
12815 * @see elm_thumb_editable_set()
12819 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12826 * @defgroup Hoversel Hoversel
12828 * @image html img/widget/hoversel/preview-00.png
12829 * @image latex img/widget/hoversel/preview-00.eps
12831 * A hoversel is a button that pops up a list of items (automatically
12832 * choosing the direction to display) that have a label and, optionally, an
12833 * icon to select from. It is a convenience widget to avoid the need to do
12834 * all the piecing together yourself. It is intended for a small number of
12835 * items in the hoversel menu (no more than 8), though is capable of many
12838 * Signals that you can add callbacks for are:
12839 * "clicked" - the user clicked the hoversel button and popped up the sel
12840 * "selected" - an item in the hoversel list is selected. event_info is the item
12841 * "dismissed" - the hover is dismissed
12843 * See @ref tutorial_hoversel for an example.
12846 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12848 * @brief Add a new Hoversel object
12850 * @param parent The parent object
12851 * @return The new object or NULL if it cannot be created
12853 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12855 * @brief This sets the hoversel to expand horizontally.
12857 * @param obj The hoversel object
12858 * @param horizontal If true, the hover will expand horizontally to the
12861 * @note The initial button will display horizontally regardless of this
12864 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12866 * @brief This returns whether the hoversel is set to expand horizontally.
12868 * @param obj The hoversel object
12869 * @return If true, the hover will expand horizontally to the right.
12871 * @see elm_hoversel_horizontal_set()
12873 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12875 * @brief Set the Hover parent
12877 * @param obj The hoversel object
12878 * @param parent The parent to use
12880 * Sets the hover parent object, the area that will be darkened when the
12881 * hoversel is clicked. Should probably be the window that the hoversel is
12882 * in. See @ref Hover objects for more information.
12884 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12886 * @brief Get the Hover parent
12888 * @param obj The hoversel object
12889 * @return The used parent
12891 * Gets the hover parent object.
12893 * @see elm_hoversel_hover_parent_set()
12895 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12897 * @brief Set the hoversel button label
12899 * @param obj The hoversel object
12900 * @param label The label text.
12902 * This sets the label of the button that is always visible (before it is
12903 * clicked and expanded).
12905 * @deprecated elm_object_text_set()
12907 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12909 * @brief Get the hoversel button label
12911 * @param obj The hoversel object
12912 * @return The label text.
12914 * @deprecated elm_object_text_get()
12916 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12918 * @brief Set the icon of the hoversel button
12920 * @param obj The hoversel object
12921 * @param icon The icon object
12923 * Sets the icon of the button that is always visible (before it is clicked
12924 * and expanded). Once the icon object is set, a previously set one will be
12925 * deleted, if you want to keep that old content object, use the
12926 * elm_hoversel_icon_unset() function.
12928 * @see elm_button_icon_set()
12930 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12932 * @brief Get the icon of the hoversel button
12934 * @param obj The hoversel object
12935 * @return The icon object
12937 * Get the icon of the button that is always visible (before it is clicked
12938 * and expanded). Also see elm_button_icon_get().
12940 * @see elm_hoversel_icon_set()
12942 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12944 * @brief Get and unparent the icon of the hoversel button
12946 * @param obj The hoversel object
12947 * @return The icon object that was being used
12949 * Unparent and return the icon of the button that is always visible
12950 * (before it is clicked and expanded).
12952 * @see elm_hoversel_icon_set()
12953 * @see elm_button_icon_unset()
12955 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12957 * @brief This triggers the hoversel popup from code, the same as if the user
12958 * had clicked the button.
12960 * @param obj The hoversel object
12962 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12964 * @brief This dismisses the hoversel popup as if the user had clicked
12965 * outside the hover.
12967 * @param obj The hoversel object
12969 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12971 * @brief Returns whether the hoversel is expanded.
12973 * @param obj The hoversel object
12974 * @return This will return EINA_TRUE if the hoversel is expanded or
12975 * EINA_FALSE if it is not expanded.
12977 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12979 * @brief This will remove all the children items from the hoversel.
12981 * @param obj The hoversel object
12983 * @warning Should @b not be called while the hoversel is active; use
12984 * elm_hoversel_expanded_get() to check first.
12986 * @see elm_hoversel_item_del_cb_set()
12987 * @see elm_hoversel_item_del()
12989 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12991 * @brief Get the list of items within the given hoversel.
12993 * @param obj The hoversel object
12994 * @return Returns a list of Elm_Hoversel_Item*
12996 * @see elm_hoversel_item_add()
12998 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13000 * @brief Add an item to the hoversel button
13002 * @param obj The hoversel object
13003 * @param label The text label to use for the item (NULL if not desired)
13004 * @param icon_file An image file path on disk to use for the icon or standard
13005 * icon name (NULL if not desired)
13006 * @param icon_type The icon type if relevant
13007 * @param func Convenience function to call when this item is selected
13008 * @param data Data to pass to item-related functions
13009 * @return A handle to the item added.
13011 * This adds an item to the hoversel to show when it is clicked. Note: if you
13012 * need to use an icon from an edje file then use
13013 * elm_hoversel_item_icon_set() right after the this function, and set
13014 * icon_file to NULL here.
13016 * For more information on what @p icon_file and @p icon_type are see the
13017 * @ref Icon "icon documentation".
13019 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);
13021 * @brief Delete an item from the hoversel
13023 * @param item The item to delete
13025 * This deletes the item from the hoversel (should not be called while the
13026 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13028 * @see elm_hoversel_item_add()
13029 * @see elm_hoversel_item_del_cb_set()
13031 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13033 * @brief Set the function to be called when an item from the hoversel is
13036 * @param item The item to set the callback on
13037 * @param func The function called
13039 * That function will receive these parameters:
13040 * @li void *item_data
13041 * @li Evas_Object *the_item_object
13042 * @li Elm_Hoversel_Item *the_object_struct
13044 * @see elm_hoversel_item_add()
13046 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13048 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13049 * that will be passed to associated function callbacks.
13051 * @param item The item to get the data from
13052 * @return The data pointer set with elm_hoversel_item_add()
13054 * @see elm_hoversel_item_add()
13056 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13058 * @brief This returns the label text of the given hoversel item.
13060 * @param item The item to get the label
13061 * @return The label text of the hoversel item
13063 * @see elm_hoversel_item_add()
13065 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13067 * @brief This sets the icon for the given hoversel item.
13069 * @param item The item to set the icon
13070 * @param icon_file An image file path on disk to use for the icon or standard
13072 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13073 * to NULL if the icon is not an edje file
13074 * @param icon_type The icon type
13076 * The icon can be loaded from the standard set, from an image file, or from
13079 * @see elm_hoversel_item_add()
13081 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);
13083 * @brief Get the icon object of the hoversel item
13085 * @param item The item to get the icon from
13086 * @param icon_file The image file path on disk used for the icon or standard
13088 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13089 * if the icon is not an edje file
13090 * @param icon_type The icon type
13092 * @see elm_hoversel_item_icon_set()
13093 * @see elm_hoversel_item_add()
13095 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);
13101 * @defgroup Toolbar Toolbar
13102 * @ingroup Elementary
13104 * @image html img/widget/toolbar/preview-00.png
13105 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13107 * @image html img/toolbar.png
13108 * @image latex img/toolbar.eps width=\textwidth
13110 * A toolbar is a widget that displays a list of items inside
13111 * a box. It can be scrollable, show a menu with items that don't fit
13112 * to toolbar size or even crop them.
13114 * Only one item can be selected at a time.
13116 * Items can have multiple states, or show menus when selected by the user.
13118 * Smart callbacks one can listen to:
13119 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13121 * Available styles for it:
13123 * - @c "transparent" - no background or shadow, just show the content
13125 * List of examples:
13126 * @li @ref toolbar_example_01
13127 * @li @ref toolbar_example_02
13128 * @li @ref toolbar_example_03
13132 * @addtogroup Toolbar
13137 * @enum _Elm_Toolbar_Shrink_Mode
13138 * @typedef Elm_Toolbar_Shrink_Mode
13140 * Set toolbar's items display behavior, it can be scrollabel,
13141 * show a menu with exceeding items, or simply hide them.
13143 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13146 * Values <b> don't </b> work as bitmask, only one can be choosen.
13148 * @see elm_toolbar_mode_shrink_set()
13149 * @see elm_toolbar_mode_shrink_get()
13153 typedef enum _Elm_Toolbar_Shrink_Mode
13155 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
13156 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
13157 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13158 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
13159 } Elm_Toolbar_Shrink_Mode;
13161 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(). */
13163 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(). */
13166 * Add a new toolbar widget to the given parent Elementary
13167 * (container) object.
13169 * @param parent The parent object.
13170 * @return a new toolbar widget handle or @c NULL, on errors.
13172 * This function inserts a new toolbar widget on the canvas.
13176 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13179 * Set the icon size, in pixels, to be used by toolbar items.
13181 * @param obj The toolbar object
13182 * @param icon_size The icon size in pixels
13184 * @note Default value is @c 32. It reads value from elm config.
13186 * @see elm_toolbar_icon_size_get()
13190 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13193 * Get the icon size, in pixels, to be used by toolbar items.
13195 * @param obj The toolbar object.
13196 * @return The icon size in pixels.
13198 * @see elm_toolbar_icon_size_set() for details.
13202 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13205 * Sets icon lookup order, for toolbar items' icons.
13207 * @param obj The toolbar object.
13208 * @param order The icon lookup order.
13210 * Icons added before calling this function will not be affected.
13211 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13213 * @see elm_toolbar_icon_order_lookup_get()
13217 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13220 * Gets the icon lookup order.
13222 * @param obj The toolbar object.
13223 * @return The icon lookup order.
13225 * @see elm_toolbar_icon_order_lookup_set() for details.
13229 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13232 * Set whether the toolbar items' should be selected by the user or not.
13234 * @param obj The toolbar object.
13235 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13238 * This will turn off the ability to select items entirely and they will
13239 * neither appear selected nor emit selected signals. The clicked
13240 * callback function will still be called.
13242 * Selection is enabled by default.
13244 * @see elm_toolbar_no_select_mode_get().
13248 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13251 * Set whether the toolbar items' should be selected by the user or not.
13253 * @param obj The toolbar object.
13254 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13255 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13257 * @see elm_toolbar_no_select_mode_set() for details.
13261 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13264 * Append item to the toolbar.
13266 * @param obj The toolbar object.
13267 * @param icon A string with icon name or the absolute path of an image file.
13268 * @param label The label of the item.
13269 * @param func The function to call when the item is clicked.
13270 * @param data The data to associate with the item for related callbacks.
13271 * @return The created item or @c NULL upon failure.
13273 * A new item will be created and appended to the toolbar, i.e., will
13274 * be set as @b last item.
13276 * Items created with this method can be deleted with
13277 * elm_toolbar_item_del().
13279 * Associated @p data can be properly freed when item is deleted if a
13280 * callback function is set with elm_toolbar_item_del_cb_set().
13282 * If a function is passed as argument, it will be called everytime this item
13283 * is selected, i.e., the user clicks over an unselected item.
13284 * If such function isn't needed, just passing
13285 * @c NULL as @p func is enough. The same should be done for @p data.
13287 * Toolbar will load icon image from fdo or current theme.
13288 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13289 * If an absolute path is provided it will load it direct from a file.
13291 * @see elm_toolbar_item_icon_set()
13292 * @see elm_toolbar_item_del()
13293 * @see elm_toolbar_item_del_cb_set()
13297 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);
13300 * Prepend item to the toolbar.
13302 * @param obj The toolbar object.
13303 * @param icon A string with icon name or the absolute path of an image file.
13304 * @param label The label of the item.
13305 * @param func The function to call when the item is clicked.
13306 * @param data The data to associate with the item for related callbacks.
13307 * @return The created item or @c NULL upon failure.
13309 * A new item will be created and prepended to the toolbar, i.e., will
13310 * be set as @b first item.
13312 * Items created with this method can be deleted with
13313 * elm_toolbar_item_del().
13315 * Associated @p data can be properly freed when item is deleted if a
13316 * callback function is set with elm_toolbar_item_del_cb_set().
13318 * If a function is passed as argument, it will be called everytime this item
13319 * is selected, i.e., the user clicks over an unselected item.
13320 * If such function isn't needed, just passing
13321 * @c NULL as @p func is enough. The same should be done for @p data.
13323 * Toolbar will load icon image from fdo or current theme.
13324 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13325 * If an absolute path is provided it will load it direct from a file.
13327 * @see elm_toolbar_item_icon_set()
13328 * @see elm_toolbar_item_del()
13329 * @see elm_toolbar_item_del_cb_set()
13333 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);
13336 * Insert a new item into the toolbar object before item @p before.
13338 * @param obj The toolbar object.
13339 * @param before The toolbar item to insert before.
13340 * @param icon A string with icon name or the absolute path of an image file.
13341 * @param label The label of the item.
13342 * @param func The function to call when the item is clicked.
13343 * @param data The data to associate with the item for related callbacks.
13344 * @return The created item or @c NULL upon failure.
13346 * A new item will be created and added to the toolbar. Its position in
13347 * this toolbar will be just before item @p before.
13349 * Items created with this method can be deleted with
13350 * elm_toolbar_item_del().
13352 * Associated @p data can be properly freed when item is deleted if a
13353 * callback function is set with elm_toolbar_item_del_cb_set().
13355 * If a function is passed as argument, it will be called everytime this item
13356 * is selected, i.e., the user clicks over an unselected item.
13357 * If such function isn't needed, just passing
13358 * @c NULL as @p func is enough. The same should be done for @p data.
13360 * Toolbar will load icon image from fdo or current theme.
13361 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13362 * If an absolute path is provided it will load it direct from a file.
13364 * @see elm_toolbar_item_icon_set()
13365 * @see elm_toolbar_item_del()
13366 * @see elm_toolbar_item_del_cb_set()
13370 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);
13373 * Insert a new item into the toolbar object after item @p after.
13375 * @param obj The toolbar object.
13376 * @param before The toolbar item to insert before.
13377 * @param icon A string with icon name or the absolute path of an image file.
13378 * @param label The label of the item.
13379 * @param func The function to call when the item is clicked.
13380 * @param data The data to associate with the item for related callbacks.
13381 * @return The created item or @c NULL upon failure.
13383 * A new item will be created and added to the toolbar. Its position in
13384 * this toolbar will be just after item @p after.
13386 * Items created with this method can be deleted with
13387 * elm_toolbar_item_del().
13389 * Associated @p data can be properly freed when item is deleted if a
13390 * callback function is set with elm_toolbar_item_del_cb_set().
13392 * If a function is passed as argument, it will be called everytime this item
13393 * is selected, i.e., the user clicks over an unselected item.
13394 * If such function isn't needed, just passing
13395 * @c NULL as @p func is enough. The same should be done for @p data.
13397 * Toolbar will load icon image from fdo or current theme.
13398 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13399 * If an absolute path is provided it will load it direct from a file.
13401 * @see elm_toolbar_item_icon_set()
13402 * @see elm_toolbar_item_del()
13403 * @see elm_toolbar_item_del_cb_set()
13407 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);
13410 * Get the first item in the given toolbar widget's list of
13413 * @param obj The toolbar object
13414 * @return The first item or @c NULL, if it has no items (and on
13417 * @see elm_toolbar_item_append()
13418 * @see elm_toolbar_last_item_get()
13422 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13425 * Get the last item in the given toolbar widget's list of
13428 * @param obj The toolbar object
13429 * @return The last item or @c NULL, if it has no items (and on
13432 * @see elm_toolbar_item_prepend()
13433 * @see elm_toolbar_first_item_get()
13437 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13440 * Get the item after @p item in toolbar.
13442 * @param item The toolbar item.
13443 * @return The item after @p item, or @c NULL if none or on failure.
13445 * @note If it is the last item, @c NULL will be returned.
13447 * @see elm_toolbar_item_append()
13451 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13454 * Get the item before @p item in toolbar.
13456 * @param item The toolbar item.
13457 * @return The item before @p item, or @c NULL if none or on failure.
13459 * @note If it is the first item, @c NULL will be returned.
13461 * @see elm_toolbar_item_prepend()
13465 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13468 * Get the toolbar object from an item.
13470 * @param item The item.
13471 * @return The toolbar object.
13473 * This returns the toolbar object itself that an item belongs to.
13477 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13480 * Set the priority of a toolbar item.
13482 * @param item The toolbar item.
13483 * @param priority The item priority. The default is zero.
13485 * This is used only when the toolbar shrink mode is set to
13486 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13487 * When space is less than required, items with low priority
13488 * will be removed from the toolbar and added to a dynamically-created menu,
13489 * while items with higher priority will remain on the toolbar,
13490 * with the same order they were added.
13492 * @see elm_toolbar_item_priority_get()
13496 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13499 * Get the priority of a toolbar item.
13501 * @param item The toolbar item.
13502 * @return The @p item priority, or @c 0 on failure.
13504 * @see elm_toolbar_item_priority_set() for details.
13508 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13511 * Get the label of item.
13513 * @param item The item of toolbar.
13514 * @return The label of item.
13516 * The return value is a pointer to the label associated to @p item when
13517 * it was created, with function elm_toolbar_item_append() or similar,
13519 * with function elm_toolbar_item_label_set. If no label
13520 * was passed as argument, it will return @c NULL.
13522 * @see elm_toolbar_item_label_set() for more details.
13523 * @see elm_toolbar_item_append()
13527 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13530 * Set the label of item.
13532 * @param item The item of toolbar.
13533 * @param text The label of item.
13535 * The label to be displayed by the item.
13536 * Label will be placed at icons bottom (if set).
13538 * If a label was passed as argument on item creation, with function
13539 * elm_toolbar_item_append() or similar, it will be already
13540 * displayed by the item.
13542 * @see elm_toolbar_item_label_get()
13543 * @see elm_toolbar_item_append()
13547 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13550 * Return the data associated with a given toolbar widget item.
13552 * @param item The toolbar widget item handle.
13553 * @return The data associated with @p item.
13555 * @see elm_toolbar_item_data_set()
13559 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13562 * Set the data associated with a given toolbar widget item.
13564 * @param item The toolbar widget item handle.
13565 * @param data The new data pointer to set to @p item.
13567 * This sets new item data on @p item.
13569 * @warning The old data pointer won't be touched by this function, so
13570 * the user had better to free that old data himself/herself.
13574 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13577 * Returns a pointer to a toolbar item by its label.
13579 * @param obj The toolbar object.
13580 * @param label The label of the item to find.
13582 * @return The pointer to the toolbar item matching @p label or @c NULL
13587 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13590 * Get whether the @p item is selected or not.
13592 * @param item The toolbar item.
13593 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13594 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13596 * @see elm_toolbar_selected_item_set() for details.
13597 * @see elm_toolbar_item_selected_get()
13601 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13604 * Set the selected state of an item.
13606 * @param item The toolbar item
13607 * @param selected The selected state
13609 * This sets the selected state of the given item @p it.
13610 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13612 * If a new item is selected the previosly selected will be unselected.
13613 * Previoulsy selected item can be get with function
13614 * elm_toolbar_selected_item_get().
13616 * Selected items will be highlighted.
13618 * @see elm_toolbar_item_selected_get()
13619 * @see elm_toolbar_selected_item_get()
13623 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13626 * Get the selected item.
13628 * @param obj The toolbar object.
13629 * @return The selected toolbar item.
13631 * The selected item can be unselected with function
13632 * elm_toolbar_item_selected_set().
13634 * The selected item always will be highlighted on toolbar.
13636 * @see elm_toolbar_selected_items_get()
13640 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13643 * Set the icon associated with @p item.
13645 * @param obj The parent of this item.
13646 * @param item The toolbar item.
13647 * @param icon A string with icon name or the absolute path of an image file.
13649 * Toolbar will load icon image from fdo or current theme.
13650 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13651 * If an absolute path is provided it will load it direct from a file.
13653 * @see elm_toolbar_icon_order_lookup_set()
13654 * @see elm_toolbar_icon_order_lookup_get()
13658 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13661 * Get the string used to set the icon of @p item.
13663 * @param item The toolbar item.
13664 * @return The string associated with the icon object.
13666 * @see elm_toolbar_item_icon_set() for details.
13670 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13673 * Delete them item from the toolbar.
13675 * @param item The item of toolbar to be deleted.
13677 * @see elm_toolbar_item_append()
13678 * @see elm_toolbar_item_del_cb_set()
13682 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13685 * Set the function called when a toolbar item is freed.
13687 * @param item The item to set the callback on.
13688 * @param func The function called.
13690 * If there is a @p func, then it will be called prior item's memory release.
13691 * That will be called with the following arguments:
13693 * @li item's Evas object;
13696 * This way, a data associated to a toolbar item could be properly freed.
13700 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13703 * Get a value whether toolbar item is disabled or not.
13705 * @param item The item.
13706 * @return The disabled state.
13708 * @see elm_toolbar_item_disabled_set() for more details.
13712 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13715 * Sets the disabled/enabled state of a toolbar item.
13717 * @param item The item.
13718 * @param disabled The disabled state.
13720 * A disabled item cannot be selected or unselected. It will also
13721 * change its appearance (generally greyed out). This sets the
13722 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13727 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13730 * Set or unset item as a separator.
13732 * @param item The toolbar item.
13733 * @param setting @c EINA_TRUE to set item @p item as separator or
13734 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13736 * Items aren't set as separator by default.
13738 * If set as separator it will display separator theme, so won't display
13741 * @see elm_toolbar_item_separator_get()
13745 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13748 * Get a value whether item is a separator or not.
13750 * @param item The toolbar item.
13751 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13752 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13754 * @see elm_toolbar_item_separator_set() for details.
13758 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13761 * Set the shrink state of toolbar @p obj.
13763 * @param obj The toolbar object.
13764 * @param shrink_mode Toolbar's items display behavior.
13766 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13767 * but will enforce a minimun size so all the items will fit, won't scroll
13768 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13769 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13770 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13774 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13777 * Get the shrink mode of toolbar @p obj.
13779 * @param obj The toolbar object.
13780 * @return Toolbar's items display behavior.
13782 * @see elm_toolbar_mode_shrink_set() for details.
13786 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13789 * Enable/disable homogenous mode.
13791 * @param obj The toolbar object
13792 * @param homogeneous Assume the items within the toolbar are of the
13793 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13795 * This will enable the homogeneous mode where items are of the same size.
13796 * @see elm_toolbar_homogeneous_get()
13800 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13803 * Get whether the homogenous mode is enabled.
13805 * @param obj The toolbar object.
13806 * @return Assume the items within the toolbar are of the same height
13807 * and width (EINA_TRUE = on, EINA_FALSE = off).
13809 * @see elm_toolbar_homogeneous_set()
13813 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13816 * Enable/disable homogenous mode.
13818 * @param obj The toolbar object
13819 * @param homogeneous Assume the items within the toolbar are of the
13820 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13822 * This will enable the homogeneous mode where items are of the same size.
13823 * @see elm_toolbar_homogeneous_get()
13825 * @deprecated use elm_toolbar_homogeneous_set() instead.
13829 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13832 * Get whether the homogenous mode is enabled.
13834 * @param obj The toolbar object.
13835 * @return Assume the items within the toolbar are of the same height
13836 * and width (EINA_TRUE = on, EINA_FALSE = off).
13838 * @see elm_toolbar_homogeneous_set()
13839 * @deprecated use elm_toolbar_homogeneous_get() instead.
13843 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13846 * Set the parent object of the toolbar items' menus.
13848 * @param obj The toolbar object.
13849 * @param parent The parent of the menu objects.
13851 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13853 * For more details about setting the parent for toolbar menus, see
13854 * elm_menu_parent_set().
13856 * @see elm_menu_parent_set() for details.
13857 * @see elm_toolbar_item_menu_set() for details.
13861 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13864 * Get the parent object of the toolbar items' menus.
13866 * @param obj The toolbar object.
13867 * @return The parent of the menu objects.
13869 * @see elm_toolbar_menu_parent_set() for details.
13873 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13876 * Set the alignment of the items.
13878 * @param obj The toolbar object.
13879 * @param align The new alignment, a float between <tt> 0.0 </tt>
13880 * and <tt> 1.0 </tt>.
13882 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13883 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13886 * Centered items by default.
13888 * @see elm_toolbar_align_get()
13892 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13895 * Get the alignment of the items.
13897 * @param obj The toolbar object.
13898 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13901 * @see elm_toolbar_align_set() for details.
13905 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13908 * Set whether the toolbar item opens a menu.
13910 * @param item The toolbar item.
13911 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13913 * A toolbar item can be set to be a menu, using this function.
13915 * Once it is set to be a menu, it can be manipulated through the
13916 * menu-like function elm_toolbar_menu_parent_set() and the other
13917 * elm_menu functions, using the Evas_Object @c menu returned by
13918 * elm_toolbar_item_menu_get().
13920 * So, items to be displayed in this item's menu should be added with
13921 * elm_menu_item_add().
13923 * The following code exemplifies the most basic usage:
13925 * tb = elm_toolbar_add(win)
13926 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13927 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13928 * elm_toolbar_menu_parent_set(tb, win);
13929 * menu = elm_toolbar_item_menu_get(item);
13930 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13931 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13935 * @see elm_toolbar_item_menu_get()
13939 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13942 * Get toolbar item's menu.
13944 * @param item The toolbar item.
13945 * @return Item's menu object or @c NULL on failure.
13947 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13948 * this function will set it.
13950 * @see elm_toolbar_item_menu_set() for details.
13954 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13957 * Add a new state to @p item.
13959 * @param item The item.
13960 * @param icon A string with icon name or the absolute path of an image file.
13961 * @param label The label of the new state.
13962 * @param func The function to call when the item is clicked when this
13963 * state is selected.
13964 * @param data The data to associate with the state.
13965 * @return The toolbar item state, or @c NULL upon failure.
13967 * Toolbar will load icon image from fdo or current theme.
13968 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13969 * If an absolute path is provided it will load it direct from a file.
13971 * States created with this function can be removed with
13972 * elm_toolbar_item_state_del().
13974 * @see elm_toolbar_item_state_del()
13975 * @see elm_toolbar_item_state_sel()
13976 * @see elm_toolbar_item_state_get()
13980 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);
13983 * Delete a previoulsy added state to @p item.
13985 * @param item The toolbar item.
13986 * @param state The state to be deleted.
13987 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13989 * @see elm_toolbar_item_state_add()
13991 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13994 * Set @p state as the current state of @p it.
13996 * @param it The item.
13997 * @param state The state to use.
13998 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14000 * If @p state is @c NULL, it won't select any state and the default item's
14001 * icon and label will be used. It's the same behaviour than
14002 * elm_toolbar_item_state_unser().
14004 * @see elm_toolbar_item_state_unset()
14008 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14011 * Unset the state of @p it.
14013 * @param it The item.
14015 * The default icon and label from this item will be displayed.
14017 * @see elm_toolbar_item_state_set() for more details.
14021 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14024 * Get the current state of @p it.
14026 * @param item The item.
14027 * @return The selected state or @c NULL if none is selected or on failure.
14029 * @see elm_toolbar_item_state_set() for details.
14030 * @see elm_toolbar_item_state_unset()
14031 * @see elm_toolbar_item_state_add()
14035 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14038 * Get the state after selected state in toolbar's @p item.
14040 * @param it The toolbar item to change state.
14041 * @return The state after current state, or @c NULL on failure.
14043 * If last state is selected, this function will return first state.
14045 * @see elm_toolbar_item_state_set()
14046 * @see elm_toolbar_item_state_add()
14050 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14053 * Get the state before selected state in toolbar's @p item.
14055 * @param it The toolbar item to change state.
14056 * @return The state before current state, or @c NULL on failure.
14058 * If first state is selected, this function will return last state.
14060 * @see elm_toolbar_item_state_set()
14061 * @see elm_toolbar_item_state_add()
14065 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14068 * Set the text to be shown in a given toolbar item's tooltips.
14070 * @param item Target item.
14071 * @param text The text to set in the content.
14073 * Setup the text as tooltip to object. The item can have only one tooltip,
14074 * so any previous tooltip data - set with this function or
14075 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14077 * @see elm_object_tooltip_text_set() for more details.
14081 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14084 * Set the content to be shown in the tooltip item.
14086 * Setup the tooltip to item. The item can have only one tooltip,
14087 * so any previous tooltip data is removed. @p func(with @p data) will
14088 * be called every time that need show the tooltip and it should
14089 * return a valid Evas_Object. This object is then managed fully by
14090 * tooltip system and is deleted when the tooltip is gone.
14092 * @param item the toolbar item being attached a tooltip.
14093 * @param func the function used to create the tooltip contents.
14094 * @param data what to provide to @a func as callback data/context.
14095 * @param del_cb called when data is not needed anymore, either when
14096 * another callback replaces @a func, the tooltip is unset with
14097 * elm_toolbar_item_tooltip_unset() or the owner @a item
14098 * dies. This callback receives as the first parameter the
14099 * given @a data, and @c event_info is the item.
14101 * @see elm_object_tooltip_content_cb_set() for more details.
14105 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);
14108 * Unset tooltip from item.
14110 * @param item toolbar item to remove previously set tooltip.
14112 * Remove tooltip from item. The callback provided as del_cb to
14113 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14114 * it is not used anymore.
14116 * @see elm_object_tooltip_unset() for more details.
14117 * @see elm_toolbar_item_tooltip_content_cb_set()
14121 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14124 * Sets a different style for this item tooltip.
14126 * @note before you set a style you should define a tooltip with
14127 * elm_toolbar_item_tooltip_content_cb_set() or
14128 * elm_toolbar_item_tooltip_text_set()
14130 * @param item toolbar item with tooltip already set.
14131 * @param style the theme style to use (default, transparent, ...)
14133 * @see elm_object_tooltip_style_set() for more details.
14137 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14140 * Get the style for this item tooltip.
14142 * @param item toolbar item with tooltip already set.
14143 * @return style the theme style in use, defaults to "default". If the
14144 * object does not have a tooltip set, then NULL is returned.
14146 * @see elm_object_tooltip_style_get() for more details.
14147 * @see elm_toolbar_item_tooltip_style_set()
14151 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14154 * Set the type of mouse pointer/cursor decoration to be shown,
14155 * when the mouse pointer is over the given toolbar widget item
14157 * @param item toolbar item to customize cursor on
14158 * @param cursor the cursor type's name
14160 * This function works analogously as elm_object_cursor_set(), but
14161 * here the cursor's changing area is restricted to the item's
14162 * area, and not the whole widget's. Note that that item cursors
14163 * have precedence over widget cursors, so that a mouse over an
14164 * item with custom cursor set will always show @b that cursor.
14166 * If this function is called twice for an object, a previously set
14167 * cursor will be unset on the second call.
14169 * @see elm_object_cursor_set()
14170 * @see elm_toolbar_item_cursor_get()
14171 * @see elm_toolbar_item_cursor_unset()
14175 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14178 * Get the type of mouse pointer/cursor decoration set to be shown,
14179 * when the mouse pointer is over the given toolbar widget item
14181 * @param item toolbar item with custom cursor set
14182 * @return the cursor type's name or @c NULL, if no custom cursors
14183 * were set to @p item (and on errors)
14185 * @see elm_object_cursor_get()
14186 * @see elm_toolbar_item_cursor_set()
14187 * @see elm_toolbar_item_cursor_unset()
14191 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14194 * Unset any custom mouse pointer/cursor decoration set to be
14195 * shown, when the mouse pointer is over the given toolbar widget
14196 * item, thus making it show the @b default cursor again.
14198 * @param item a toolbar item
14200 * Use this call to undo any custom settings on this item's cursor
14201 * decoration, bringing it back to defaults (no custom style set).
14203 * @see elm_object_cursor_unset()
14204 * @see elm_toolbar_item_cursor_set()
14208 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14211 * Set a different @b style for a given custom cursor set for a
14214 * @param item toolbar item with custom cursor set
14215 * @param style the <b>theme style</b> to use (e.g. @c "default",
14216 * @c "transparent", etc)
14218 * This function only makes sense when one is using custom mouse
14219 * cursor decorations <b>defined in a theme file</b>, which can have,
14220 * given a cursor name/type, <b>alternate styles</b> on it. It
14221 * works analogously as elm_object_cursor_style_set(), but here
14222 * applyed only to toolbar item objects.
14224 * @warning Before you set a cursor style you should have definen a
14225 * custom cursor previously on the item, with
14226 * elm_toolbar_item_cursor_set()
14228 * @see elm_toolbar_item_cursor_engine_only_set()
14229 * @see elm_toolbar_item_cursor_style_get()
14233 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14236 * Get the current @b style set for a given toolbar item's custom
14239 * @param item toolbar item with custom cursor set.
14240 * @return style the cursor style in use. If the object does not
14241 * have a cursor set, then @c NULL is returned.
14243 * @see elm_toolbar_item_cursor_style_set() for more details
14247 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14250 * Set if the (custom)cursor for a given toolbar item should be
14251 * searched in its theme, also, or should only rely on the
14252 * rendering engine.
14254 * @param item item with custom (custom) cursor already set on
14255 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14256 * only on those provided by the rendering engine, @c EINA_FALSE to
14257 * have them searched on the widget's theme, as well.
14259 * @note This call is of use only if you've set a custom cursor
14260 * for toolbar items, with elm_toolbar_item_cursor_set().
14262 * @note By default, cursors will only be looked for between those
14263 * provided by the rendering engine.
14267 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14270 * Get if the (custom) cursor for a given toolbar item is being
14271 * searched in its theme, also, or is only relying on the rendering
14274 * @param item a toolbar item
14275 * @return @c EINA_TRUE, if cursors are being looked for only on
14276 * those provided by the rendering engine, @c EINA_FALSE if they
14277 * are being searched on the widget's theme, as well.
14279 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14283 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14286 * Change a toolbar's orientation
14287 * @param obj The toolbar object
14288 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14289 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14292 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14295 * Get a toolbar's orientation
14296 * @param obj The toolbar object
14297 * @return If @c EINA_TRUE, the toolbar is vertical
14298 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14301 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14308 * @defgroup Tooltips Tooltips
14310 * The Tooltip is an (internal, for now) smart object used to show a
14311 * content in a frame on mouse hover of objects(or widgets), with
14312 * tips/information about them.
14317 EAPI double elm_tooltip_delay_get(void);
14318 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14319 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14320 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14321 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14322 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);
14323 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14324 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14325 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14326 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14327 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14334 * @defgroup Cursors Cursors
14336 * The Elementary cursor is an internal smart object used to
14337 * customize the mouse cursor displayed over objects (or
14338 * widgets). In the most common scenario, the cursor decoration
14339 * comes from the graphical @b engine Elementary is running
14340 * on. Those engines may provide different decorations for cursors,
14341 * and Elementary provides functions to choose them (think of X11
14342 * cursors, as an example).
14344 * There's also the possibility of, besides using engine provided
14345 * cursors, also use ones coming from Edje theming files. Both
14346 * globally and per widget, Elementary makes it possible for one to
14347 * make the cursors lookup to be held on engines only or on
14348 * Elementary's theme file, too.
14354 * Set the cursor to be shown when mouse is over the object
14356 * Set the cursor that will be displayed when mouse is over the
14357 * object. The object can have only one cursor set to it, so if
14358 * this function is called twice for an object, the previous set
14360 * If using X cursors, a definition of all the valid cursor names
14361 * is listed on Elementary_Cursors.h. If an invalid name is set
14362 * the default cursor will be used.
14364 * @param obj the object being set a cursor.
14365 * @param cursor the cursor name to be used.
14369 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14372 * Get the cursor to be shown when mouse is over the object
14374 * @param obj an object with cursor already set.
14375 * @return the cursor name.
14379 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14382 * Unset cursor for object
14384 * Unset cursor for object, and set the cursor to default if the mouse
14385 * was over this object.
14387 * @param obj Target object
14388 * @see elm_object_cursor_set()
14392 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14395 * Sets a different style for this object cursor.
14397 * @note before you set a style you should define a cursor with
14398 * elm_object_cursor_set()
14400 * @param obj an object with cursor already set.
14401 * @param style the theme style to use (default, transparent, ...)
14405 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14408 * Get the style for this object cursor.
14410 * @param obj an object with cursor already set.
14411 * @return style the theme style in use, defaults to "default". If the
14412 * object does not have a cursor set, then NULL is returned.
14416 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14419 * Set if the cursor set should be searched on the theme or should use
14420 * the provided by the engine, only.
14422 * @note before you set if should look on theme you should define a cursor
14423 * with elm_object_cursor_set(). By default it will only look for cursors
14424 * provided by the engine.
14426 * @param obj an object with cursor already set.
14427 * @param engine_only boolean to define it cursors should be looked only
14428 * between the provided by the engine or searched on widget's theme as well.
14432 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14435 * Get the cursor engine only usage for this object cursor.
14437 * @param obj an object with cursor already set.
14438 * @return engine_only boolean to define it cursors should be
14439 * looked only between the provided by the engine or searched on
14440 * widget's theme as well. If the object does not have a cursor
14441 * set, then EINA_FALSE is returned.
14445 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14448 * Get the configured cursor engine only usage
14450 * This gets the globally configured exclusive usage of engine cursors.
14452 * @return 1 if only engine cursors should be used
14455 EAPI int elm_cursor_engine_only_get(void);
14458 * Set the configured cursor engine only usage
14460 * This sets the globally configured exclusive usage of engine cursors.
14461 * It won't affect cursors set before changing this value.
14463 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14464 * look for them on theme before.
14465 * @return EINA_TRUE if value is valid and setted (0 or 1)
14468 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14475 * @defgroup Menu Menu
14477 * @image html img/widget/menu/preview-00.png
14478 * @image latex img/widget/menu/preview-00.eps
14480 * A menu is a list of items displayed above its parent. When the menu is
14481 * showing its parent is darkened. Each item can have a sub-menu. The menu
14482 * object can be used to display a menu on a right click event, in a toolbar,
14485 * Signals that you can add callbacks for are:
14486 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14487 * event_info is NULL.
14489 * @see @ref tutorial_menu
14492 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14494 * @brief Add a new menu to the parent
14496 * @param parent The parent object.
14497 * @return The new object or NULL if it cannot be created.
14499 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14501 * @brief Set the parent for the given menu widget
14503 * @param obj The menu object.
14504 * @param parent The new parent.
14506 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14508 * @brief Get the parent for the given menu widget
14510 * @param obj The menu object.
14511 * @return The parent.
14513 * @see elm_menu_parent_set()
14515 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14517 * @brief Move the menu to a new position
14519 * @param obj The menu object.
14520 * @param x The new position.
14521 * @param y The new position.
14523 * Sets the top-left position of the menu to (@p x,@p y).
14525 * @note @p x and @p y coordinates are relative to parent.
14527 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14529 * @brief Close a opened menu
14531 * @param obj the menu object
14534 * Hides the menu and all it's sub-menus.
14536 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14538 * @brief Returns a list of @p item's items.
14540 * @param obj The menu object
14541 * @return An Eina_List* of @p item's items
14543 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14545 * @brief Get the Evas_Object of an Elm_Menu_Item
14547 * @param item The menu item object.
14548 * @return The edje object containing the swallowed content
14550 * @warning Don't manipulate this object!
14552 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14554 * @brief Add an item at the end of the given menu widget
14556 * @param obj The menu object.
14557 * @param parent The parent menu item (optional)
14558 * @param icon A icon display on the item. The icon will be destryed by the menu.
14559 * @param label The label of the item.
14560 * @param func Function called when the user select the item.
14561 * @param data Data sent by the callback.
14562 * @return Returns the new item.
14564 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);
14566 * @brief Add an object swallowed in an item at the end of the given menu
14569 * @param obj The menu object.
14570 * @param parent The parent menu item (optional)
14571 * @param subobj The object to swallow
14572 * @param func Function called when the user select the item.
14573 * @param data Data sent by the callback.
14574 * @return Returns the new item.
14576 * Add an evas object as an item to the menu.
14578 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);
14580 * @brief Set the label of a menu item
14582 * @param item The menu item object.
14583 * @param label The label to set for @p item
14585 * @warning Don't use this funcion on items created with
14586 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14588 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14590 * @brief Get the label of a menu item
14592 * @param item The menu item object.
14593 * @return The label of @p item
14595 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14597 * @brief Set the icon of a menu item to the standard icon with name @p icon
14599 * @param item The menu item object.
14600 * @param icon The icon object to set for the content of @p item
14602 * Once this icon is set, any previously set icon will be deleted.
14604 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14606 * @brief Get the string representation from the icon of a menu item
14608 * @param item The menu item object.
14609 * @return The string representation of @p item's icon or NULL
14611 * @see elm_menu_item_object_icon_name_set()
14613 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14615 * @brief Set the content object of a menu item
14617 * @param item The menu item object
14618 * @param The content object or NULL
14619 * @return EINA_TRUE on success, else EINA_FALSE
14621 * Use this function to change the object swallowed by a menu item, deleting
14622 * any previously swallowed object.
14624 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14626 * @brief Get the content object of a menu item
14628 * @param item The menu item object
14629 * @return The content object or NULL
14630 * @note If @p item was added with elm_menu_item_add_object, this
14631 * function will return the object passed, else it will return the
14634 * @see elm_menu_item_object_content_set()
14636 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14638 * @brief Set the selected state of @p item.
14640 * @param item The menu item object.
14641 * @param selected The selected/unselected state of the item
14643 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14645 * @brief Get the selected state of @p item.
14647 * @param item The menu item object.
14648 * @return The selected/unselected state of the item
14650 * @see elm_menu_item_selected_set()
14652 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14654 * @brief Set the disabled state of @p item.
14656 * @param item The menu item object.
14657 * @param disabled The enabled/disabled state of the item
14659 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14661 * @brief Get the disabled state of @p item.
14663 * @param item The menu item object.
14664 * @return The enabled/disabled state of the item
14666 * @see elm_menu_item_disabled_set()
14668 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14670 * @brief Add a separator item to menu @p obj under @p parent.
14672 * @param obj The menu object
14673 * @param parent The item to add the separator under
14674 * @return The created item or NULL on failure
14676 * This is item is a @ref Separator.
14678 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14680 * @brief Returns whether @p item is a separator.
14682 * @param item The item to check
14683 * @return If true, @p item is a separator
14685 * @see elm_menu_item_separator_add()
14687 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14689 * @brief Deletes an item from the menu.
14691 * @param item The item to delete.
14693 * @see elm_menu_item_add()
14695 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14697 * @brief Set the function called when a menu item is deleted.
14699 * @param item The item to set the callback on
14700 * @param func The function called
14702 * @see elm_menu_item_add()
14703 * @see elm_menu_item_del()
14705 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14707 * @brief Returns the data associated with menu item @p item.
14709 * @param item The item
14710 * @return The data associated with @p item or NULL if none was set.
14712 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14714 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14716 * @brief Sets the data to be associated with menu item @p item.
14718 * @param item The item
14719 * @param data The data to be associated with @p item
14721 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14723 * @brief Returns a list of @p item's subitems.
14725 * @param item The item
14726 * @return An Eina_List* of @p item's subitems
14728 * @see elm_menu_add()
14730 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14732 * @brief Get the position of a menu item
14734 * @param item The menu item
14735 * @return The item's index
14737 * This function returns the index position of a menu item in a menu.
14738 * For a sub-menu, this number is relative to the first item in the sub-menu.
14740 * @note Index values begin with 0
14742 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14744 * @brief @brief Return a menu item's owner menu
14746 * @param item The menu item
14747 * @return The menu object owning @p item, or NULL on failure
14749 * Use this function to get the menu object owning an item.
14751 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14753 * @brief Get the selected item in the menu
14755 * @param obj The menu object
14756 * @return The selected item, or NULL if none
14758 * @see elm_menu_item_selected_get()
14759 * @see elm_menu_item_selected_set()
14761 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14763 * @brief Get the last item in the menu
14765 * @param obj The menu object
14766 * @return The last item, or NULL if none
14768 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14770 * @brief Get the first item in the menu
14772 * @param obj The menu object
14773 * @return The first item, or NULL if none
14775 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14777 * @brief Get the next item in the menu.
14779 * @param item The menu item object.
14780 * @return The item after it, or NULL if none
14782 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14784 * @brief Get the previous item in the menu.
14786 * @param item The menu item object.
14787 * @return The item before it, or NULL if none
14789 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14795 * @defgroup List List
14796 * @ingroup Elementary
14798 * @image html img/widget/list/preview-00.png
14799 * @image latex img/widget/list/preview-00.eps width=\textwidth
14801 * @image html img/list.png
14802 * @image latex img/list.eps width=\textwidth
14804 * A list widget is a container whose children are displayed vertically or
14805 * horizontally, in order, and can be selected.
14806 * The list can accept only one or multiple items selection. Also has many
14807 * modes of items displaying.
14809 * A list is a very simple type of list widget. For more robust
14810 * lists, @ref Genlist should probably be used.
14812 * Smart callbacks one can listen to:
14813 * - @c "activated" - The user has double-clicked or pressed
14814 * (enter|return|spacebar) on an item. The @c event_info parameter
14815 * is the item that was activated.
14816 * - @c "clicked,double" - The user has double-clicked an item.
14817 * The @c event_info parameter is the item that was double-clicked.
14818 * - "selected" - when the user selected an item
14819 * - "unselected" - when the user unselected an item
14820 * - "longpressed" - an item in the list is long-pressed
14821 * - "scroll,edge,top" - the list is scrolled until the top edge
14822 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14823 * - "scroll,edge,left" - the list is scrolled until the left edge
14824 * - "scroll,edge,right" - the list is scrolled until the right edge
14826 * Available styles for it:
14829 * List of examples:
14830 * @li @ref list_example_01
14831 * @li @ref list_example_02
14832 * @li @ref list_example_03
14841 * @enum _Elm_List_Mode
14842 * @typedef Elm_List_Mode
14844 * Set list's resize behavior, transverse axis scroll and
14845 * items cropping. See each mode's description for more details.
14847 * @note Default value is #ELM_LIST_SCROLL.
14849 * Values <b> don't </b> work as bitmask, only one can be choosen.
14851 * @see elm_list_mode_set()
14852 * @see elm_list_mode_get()
14856 typedef enum _Elm_List_Mode
14858 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. */
14859 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). */
14860 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. */
14861 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. */
14862 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14865 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(). */
14868 * Add a new list widget to the given parent Elementary
14869 * (container) object.
14871 * @param parent The parent object.
14872 * @return a new list widget handle or @c NULL, on errors.
14874 * This function inserts a new list widget on the canvas.
14878 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14883 * @param obj The list object
14885 * @note Call before running show() on the list object.
14886 * @warning If not called, it won't display the list properly.
14889 * li = elm_list_add(win);
14890 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14891 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14893 * evas_object_show(li);
14898 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14901 * Enable or disable multiple items selection on the list object.
14903 * @param obj The list object
14904 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14907 * Disabled by default. If disabled, the user can select a single item of
14908 * the list each time. Selected items are highlighted on list.
14909 * If enabled, many items can be selected.
14911 * If a selected item is selected again, it will be unselected.
14913 * @see elm_list_multi_select_get()
14917 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14920 * Get a value whether multiple items selection is enabled or not.
14922 * @see elm_list_multi_select_set() for details.
14924 * @param obj The list object.
14925 * @return @c EINA_TRUE means multiple items selection is enabled.
14926 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14927 * @c EINA_FALSE is returned.
14931 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14934 * Set which mode to use for the list object.
14936 * @param obj The list object
14937 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14938 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14940 * Set list's resize behavior, transverse axis scroll and
14941 * items cropping. See each mode's description for more details.
14943 * @note Default value is #ELM_LIST_SCROLL.
14945 * Only one can be set, if a previous one was set, it will be changed
14946 * by the new mode set. Bitmask won't work as well.
14948 * @see elm_list_mode_get()
14952 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14955 * Get the mode the list is at.
14957 * @param obj The list object
14958 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14959 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14961 * @note see elm_list_mode_set() for more information.
14965 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14968 * Enable or disable horizontal mode on the list object.
14970 * @param obj The list object.
14971 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14972 * disable it, i.e., to enable vertical mode.
14974 * @note Vertical mode is set by default.
14976 * On horizontal mode items are displayed on list from left to right,
14977 * instead of from top to bottom. Also, the list will scroll horizontally.
14978 * Each item will presents left icon on top and right icon, or end, at
14981 * @see elm_list_horizontal_get()
14985 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14988 * Get a value whether horizontal mode is enabled or not.
14990 * @param obj The list object.
14991 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14992 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14993 * @c EINA_FALSE is returned.
14995 * @see elm_list_horizontal_set() for details.
14999 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15002 * Enable or disable always select mode on the list object.
15004 * @param obj The list object
15005 * @param always_select @c EINA_TRUE to enable always select mode or
15006 * @c EINA_FALSE to disable it.
15008 * @note Always select mode is disabled by default.
15010 * Default behavior of list items is to only call its callback function
15011 * the first time it's pressed, i.e., when it is selected. If a selected
15012 * item is pressed again, and multi-select is disabled, it won't call
15013 * this function (if multi-select is enabled it will unselect the item).
15015 * If always select is enabled, it will call the callback function
15016 * everytime a item is pressed, so it will call when the item is selected,
15017 * and again when a selected item is pressed.
15019 * @see elm_list_always_select_mode_get()
15020 * @see elm_list_multi_select_set()
15024 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15027 * Get a value whether always select mode is enabled or not, meaning that
15028 * an item will always call its callback function, even if already selected.
15030 * @param obj The list object
15031 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15032 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15033 * @c EINA_FALSE is returned.
15035 * @see elm_list_always_select_mode_set() for details.
15039 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15042 * Set bouncing behaviour when the scrolled content reaches an edge.
15044 * Tell the internal scroller object whether it should bounce or not
15045 * when it reaches the respective edges for each axis.
15047 * @param obj The list object
15048 * @param h_bounce Whether to bounce or not in the horizontal axis.
15049 * @param v_bounce Whether to bounce or not in the vertical axis.
15051 * @see elm_scroller_bounce_set()
15055 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15058 * Get the bouncing behaviour of the internal scroller.
15060 * Get whether the internal scroller should bounce when the edge of each
15061 * axis is reached scrolling.
15063 * @param obj The list object.
15064 * @param h_bounce Pointer where to store the bounce state of the horizontal
15066 * @param v_bounce Pointer where to store the bounce state of the vertical
15069 * @see elm_scroller_bounce_get()
15070 * @see elm_list_bounce_set()
15074 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15077 * Set the scrollbar policy.
15079 * @param obj The list object
15080 * @param policy_h Horizontal scrollbar policy.
15081 * @param policy_v Vertical scrollbar policy.
15083 * This sets the scrollbar visibility policy for the given scroller.
15084 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15085 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15086 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15087 * This applies respectively for the horizontal and vertical scrollbars.
15089 * The both are disabled by default, i.e., are set to
15090 * #ELM_SCROLLER_POLICY_OFF.
15094 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15097 * Get the scrollbar policy.
15099 * @see elm_list_scroller_policy_get() for details.
15101 * @param obj The list object.
15102 * @param policy_h Pointer where to store horizontal scrollbar policy.
15103 * @param policy_v Pointer where to store vertical scrollbar policy.
15107 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);
15110 * Append a new item to the list object.
15112 * @param obj The list object.
15113 * @param label The label of the list item.
15114 * @param icon The icon object to use for the left side of the item. An
15115 * icon can be any Evas object, but usually it is an icon created
15116 * with elm_icon_add().
15117 * @param end The icon object to use for the right side of the item. An
15118 * icon can be any Evas object.
15119 * @param func The function to call when the item is clicked.
15120 * @param data The data to associate with the item for related callbacks.
15122 * @return The created item or @c NULL upon failure.
15124 * A new item will be created and appended to the list, i.e., will
15125 * be set as @b last item.
15127 * Items created with this method can be deleted with
15128 * elm_list_item_del().
15130 * Associated @p data can be properly freed when item is deleted if a
15131 * callback function is set with elm_list_item_del_cb_set().
15133 * If a function is passed as argument, it will be called everytime this item
15134 * is selected, i.e., the user clicks over an unselected item.
15135 * If always select is enabled it will call this function every time
15136 * user clicks over an item (already selected or not).
15137 * If such function isn't needed, just passing
15138 * @c NULL as @p func is enough. The same should be done for @p data.
15140 * Simple example (with no function callback or data associated):
15142 * li = elm_list_add(win);
15143 * ic = elm_icon_add(win);
15144 * elm_icon_file_set(ic, "path/to/image", NULL);
15145 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15146 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15148 * evas_object_show(li);
15151 * @see elm_list_always_select_mode_set()
15152 * @see elm_list_item_del()
15153 * @see elm_list_item_del_cb_set()
15154 * @see elm_list_clear()
15155 * @see elm_icon_add()
15159 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);
15162 * Prepend a new item to the list object.
15164 * @param obj The list object.
15165 * @param label The label of the list item.
15166 * @param icon The icon object to use for the left side of the item. An
15167 * icon can be any Evas object, but usually it is an icon created
15168 * with elm_icon_add().
15169 * @param end The icon object to use for the right side of the item. An
15170 * icon can be any Evas object.
15171 * @param func The function to call when the item is clicked.
15172 * @param data The data to associate with the item for related callbacks.
15174 * @return The created item or @c NULL upon failure.
15176 * A new item will be created and prepended to the list, i.e., will
15177 * be set as @b first item.
15179 * Items created with this method can be deleted with
15180 * elm_list_item_del().
15182 * Associated @p data can be properly freed when item is deleted if a
15183 * callback function is set with elm_list_item_del_cb_set().
15185 * If a function is passed as argument, it will be called everytime this item
15186 * is selected, i.e., the user clicks over an unselected item.
15187 * If always select is enabled it will call this function every time
15188 * user clicks over an item (already selected or not).
15189 * If such function isn't needed, just passing
15190 * @c NULL as @p func is enough. The same should be done for @p data.
15192 * @see elm_list_item_append() for a simple code example.
15193 * @see elm_list_always_select_mode_set()
15194 * @see elm_list_item_del()
15195 * @see elm_list_item_del_cb_set()
15196 * @see elm_list_clear()
15197 * @see elm_icon_add()
15201 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);
15204 * Insert a new item into the list object before item @p before.
15206 * @param obj The list object.
15207 * @param before The list item to insert before.
15208 * @param label The label of the list item.
15209 * @param icon The icon object to use for the left side of the item. An
15210 * icon can be any Evas object, but usually it is an icon created
15211 * with elm_icon_add().
15212 * @param end The icon object to use for the right side of the item. An
15213 * icon can be any Evas object.
15214 * @param func The function to call when the item is clicked.
15215 * @param data The data to associate with the item for related callbacks.
15217 * @return The created item or @c NULL upon failure.
15219 * A new item will be created and added to the list. Its position in
15220 * this list will be just before item @p before.
15222 * Items created with this method can be deleted with
15223 * elm_list_item_del().
15225 * Associated @p data can be properly freed when item is deleted if a
15226 * callback function is set with elm_list_item_del_cb_set().
15228 * If a function is passed as argument, it will be called everytime this item
15229 * is selected, i.e., the user clicks over an unselected item.
15230 * If always select is enabled it will call this function every time
15231 * user clicks over an item (already selected or not).
15232 * If such function isn't needed, just passing
15233 * @c NULL as @p func is enough. The same should be done for @p data.
15235 * @see elm_list_item_append() for a simple code example.
15236 * @see elm_list_always_select_mode_set()
15237 * @see elm_list_item_del()
15238 * @see elm_list_item_del_cb_set()
15239 * @see elm_list_clear()
15240 * @see elm_icon_add()
15244 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);
15247 * Insert a new item into the list object after item @p after.
15249 * @param obj The list object.
15250 * @param after The list item to insert after.
15251 * @param label The label of the list item.
15252 * @param icon The icon object to use for the left side of the item. An
15253 * icon can be any Evas object, but usually it is an icon created
15254 * with elm_icon_add().
15255 * @param end The icon object to use for the right side of the item. An
15256 * icon can be any Evas object.
15257 * @param func The function to call when the item is clicked.
15258 * @param data The data to associate with the item for related callbacks.
15260 * @return The created item or @c NULL upon failure.
15262 * A new item will be created and added to the list. Its position in
15263 * this list will be just after item @p after.
15265 * Items created with this method can be deleted with
15266 * elm_list_item_del().
15268 * Associated @p data can be properly freed when item is deleted if a
15269 * callback function is set with elm_list_item_del_cb_set().
15271 * If a function is passed as argument, it will be called everytime this item
15272 * is selected, i.e., the user clicks over an unselected item.
15273 * If always select is enabled it will call this function every time
15274 * user clicks over an item (already selected or not).
15275 * If such function isn't needed, just passing
15276 * @c NULL as @p func is enough. The same should be done for @p data.
15278 * @see elm_list_item_append() for a simple code example.
15279 * @see elm_list_always_select_mode_set()
15280 * @see elm_list_item_del()
15281 * @see elm_list_item_del_cb_set()
15282 * @see elm_list_clear()
15283 * @see elm_icon_add()
15287 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);
15290 * Insert a new item into the sorted list object.
15292 * @param obj The list object.
15293 * @param label The label of the list item.
15294 * @param icon The icon object to use for the left side of the item. An
15295 * icon can be any Evas object, but usually it is an icon created
15296 * with elm_icon_add().
15297 * @param end The icon object to use for the right side of the item. An
15298 * icon can be any Evas object.
15299 * @param func The function to call when the item is clicked.
15300 * @param data The data to associate with the item for related callbacks.
15301 * @param cmp_func The comparing function to be used to sort list
15302 * items <b>by #Elm_List_Item item handles</b>. This function will
15303 * receive two items and compare them, returning a non-negative integer
15304 * if the second item should be place after the first, or negative value
15305 * if should be placed before.
15307 * @return The created item or @c NULL upon failure.
15309 * @note This function inserts values into a list object assuming it was
15310 * sorted and the result will be sorted.
15312 * A new item will be created and added to the list. Its position in
15313 * this list will be found comparing the new item with previously inserted
15314 * items using function @p cmp_func.
15316 * Items created with this method can be deleted with
15317 * elm_list_item_del().
15319 * Associated @p data can be properly freed when item is deleted if a
15320 * callback function is set with elm_list_item_del_cb_set().
15322 * If a function is passed as argument, it will be called everytime this item
15323 * is selected, i.e., the user clicks over an unselected item.
15324 * If always select is enabled it will call this function every time
15325 * user clicks over an item (already selected or not).
15326 * If such function isn't needed, just passing
15327 * @c NULL as @p func is enough. The same should be done for @p data.
15329 * @see elm_list_item_append() for a simple code example.
15330 * @see elm_list_always_select_mode_set()
15331 * @see elm_list_item_del()
15332 * @see elm_list_item_del_cb_set()
15333 * @see elm_list_clear()
15334 * @see elm_icon_add()
15338 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);
15341 * Remove all list's items.
15343 * @param obj The list object
15345 * @see elm_list_item_del()
15346 * @see elm_list_item_append()
15350 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15353 * Get a list of all the list items.
15355 * @param obj The list object
15356 * @return An @c Eina_List of list items, #Elm_List_Item,
15357 * or @c NULL on failure.
15359 * @see elm_list_item_append()
15360 * @see elm_list_item_del()
15361 * @see elm_list_clear()
15365 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15368 * Get the selected item.
15370 * @param obj The list object.
15371 * @return The selected list item.
15373 * The selected item can be unselected with function
15374 * elm_list_item_selected_set().
15376 * The selected item always will be highlighted on list.
15378 * @see elm_list_selected_items_get()
15382 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15385 * Return a list of the currently selected list items.
15387 * @param obj The list object.
15388 * @return An @c Eina_List of list items, #Elm_List_Item,
15389 * or @c NULL on failure.
15391 * Multiple items can be selected if multi select is enabled. It can be
15392 * done with elm_list_multi_select_set().
15394 * @see elm_list_selected_item_get()
15395 * @see elm_list_multi_select_set()
15399 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15402 * Set the selected state of an item.
15404 * @param item The list item
15405 * @param selected The selected state
15407 * This sets the selected state of the given item @p it.
15408 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15410 * If a new item is selected the previosly selected will be unselected,
15411 * unless multiple selection is enabled with elm_list_multi_select_set().
15412 * Previoulsy selected item can be get with function
15413 * elm_list_selected_item_get().
15415 * Selected items will be highlighted.
15417 * @see elm_list_item_selected_get()
15418 * @see elm_list_selected_item_get()
15419 * @see elm_list_multi_select_set()
15423 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15426 * Get whether the @p item is selected or not.
15428 * @param item The list item.
15429 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15430 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15432 * @see elm_list_selected_item_set() for details.
15433 * @see elm_list_item_selected_get()
15437 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15440 * Set or unset item as a separator.
15442 * @param it The list item.
15443 * @param setting @c EINA_TRUE to set item @p it as separator or
15444 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15446 * Items aren't set as separator by default.
15448 * If set as separator it will display separator theme, so won't display
15451 * @see elm_list_item_separator_get()
15455 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15458 * Get a value whether item is a separator or not.
15460 * @see elm_list_item_separator_set() for details.
15462 * @param it The list item.
15463 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15464 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15468 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15471 * Show @p item in the list view.
15473 * @param item The list item to be shown.
15475 * It won't animate list until item is visible. If such behavior is wanted,
15476 * use elm_list_bring_in() intead.
15480 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15483 * Bring in the given item to list view.
15485 * @param item The item.
15487 * This causes list to jump to the given item @p item and show it
15488 * (by scrolling), if it is not fully visible.
15490 * This may use animation to do so and take a period of time.
15492 * If animation isn't wanted, elm_list_item_show() can be used.
15496 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15499 * Delete them item from the list.
15501 * @param item The item of list to be deleted.
15503 * If deleting all list items is required, elm_list_clear()
15504 * should be used instead of getting items list and deleting each one.
15506 * @see elm_list_clear()
15507 * @see elm_list_item_append()
15508 * @see elm_list_item_del_cb_set()
15512 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15515 * Set the function called when a list item is freed.
15517 * @param item The item to set the callback on
15518 * @param func The function called
15520 * If there is a @p func, then it will be called prior item's memory release.
15521 * That will be called with the following arguments:
15523 * @li item's Evas object;
15526 * This way, a data associated to a list item could be properly freed.
15530 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15533 * Get the data associated to the item.
15535 * @param item The list item
15536 * @return The data associated to @p item
15538 * The return value is a pointer to data associated to @p item when it was
15539 * created, with function elm_list_item_append() or similar. If no data
15540 * was passed as argument, it will return @c NULL.
15542 * @see elm_list_item_append()
15546 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15549 * Get the left side icon associated to the item.
15551 * @param item The list item
15552 * @return The left side icon associated to @p item
15554 * The return value is a pointer to the icon associated to @p item when
15556 * created, with function elm_list_item_append() or similar, or later
15557 * with function elm_list_item_icon_set(). If no icon
15558 * was passed as argument, it will return @c NULL.
15560 * @see elm_list_item_append()
15561 * @see elm_list_item_icon_set()
15565 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15568 * Set the left side icon associated to the item.
15570 * @param item The list item
15571 * @param icon The left side icon object to associate with @p item
15573 * The icon object to use at left side of the item. An
15574 * icon can be any Evas object, but usually it is an icon created
15575 * with elm_icon_add().
15577 * Once the icon object is set, a previously set one will be deleted.
15578 * @warning Setting the same icon for two items will cause the icon to
15579 * dissapear from the first item.
15581 * If an icon was passed as argument on item creation, with function
15582 * elm_list_item_append() or similar, it will be already
15583 * associated to the item.
15585 * @see elm_list_item_append()
15586 * @see elm_list_item_icon_get()
15590 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15593 * Get the right side icon associated to the item.
15595 * @param item The list item
15596 * @return The right side icon associated to @p item
15598 * The return value is a pointer to the icon associated to @p item when
15600 * created, with function elm_list_item_append() or similar, or later
15601 * with function elm_list_item_icon_set(). If no icon
15602 * was passed as argument, it will return @c NULL.
15604 * @see elm_list_item_append()
15605 * @see elm_list_item_icon_set()
15609 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15612 * Set the right side icon associated to the item.
15614 * @param item The list item
15615 * @param end The right side icon object to associate with @p item
15617 * The icon object to use at right side of the item. An
15618 * icon can be any Evas object, but usually it is an icon created
15619 * with elm_icon_add().
15621 * Once the icon object is set, a previously set one will be deleted.
15622 * @warning Setting the same icon for two items will cause the icon to
15623 * dissapear from the first item.
15625 * If an icon was passed as argument on item creation, with function
15626 * elm_list_item_append() or similar, it will be already
15627 * associated to the item.
15629 * @see elm_list_item_append()
15630 * @see elm_list_item_end_get()
15634 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15637 * Gets the base object of the item.
15639 * @param item The list item
15640 * @return The base object associated with @p item
15642 * Base object is the @c Evas_Object that represents that item.
15646 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15647 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15650 * Get the label of item.
15652 * @param item The item of list.
15653 * @return The label of item.
15655 * The return value is a pointer to the label associated to @p item when
15656 * it was created, with function elm_list_item_append(), or later
15657 * with function elm_list_item_label_set. If no label
15658 * was passed as argument, it will return @c NULL.
15660 * @see elm_list_item_label_set() for more details.
15661 * @see elm_list_item_append()
15665 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15668 * Set the label of item.
15670 * @param item The item of list.
15671 * @param text The label of item.
15673 * The label to be displayed by the item.
15674 * Label will be placed between left and right side icons (if set).
15676 * If a label was passed as argument on item creation, with function
15677 * elm_list_item_append() or similar, it will be already
15678 * displayed by the item.
15680 * @see elm_list_item_label_get()
15681 * @see elm_list_item_append()
15685 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15689 * Get the item before @p it in list.
15691 * @param it The list item.
15692 * @return The item before @p it, or @c NULL if none or on failure.
15694 * @note If it is the first item, @c NULL will be returned.
15696 * @see elm_list_item_append()
15697 * @see elm_list_items_get()
15701 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15704 * Get the item after @p it in list.
15706 * @param it The list item.
15707 * @return The item after @p it, or @c NULL if none or on failure.
15709 * @note If it is the last item, @c NULL will be returned.
15711 * @see elm_list_item_append()
15712 * @see elm_list_items_get()
15716 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15719 * Sets the disabled/enabled state of a list item.
15721 * @param it The item.
15722 * @param disabled The disabled state.
15724 * A disabled item cannot be selected or unselected. It will also
15725 * change its appearance (generally greyed out). This sets the
15726 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15731 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15734 * Get a value whether list item is disabled or not.
15736 * @param it The item.
15737 * @return The disabled state.
15739 * @see elm_list_item_disabled_set() for more details.
15743 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15746 * Set the text to be shown in a given list item's tooltips.
15748 * @param item Target item.
15749 * @param text The text to set in the content.
15751 * Setup the text as tooltip to object. The item can have only one tooltip,
15752 * so any previous tooltip data - set with this function or
15753 * elm_list_item_tooltip_content_cb_set() - is removed.
15755 * @see elm_object_tooltip_text_set() for more details.
15759 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15763 * @brief Disable size restrictions on an object's tooltip
15764 * @param item The tooltip's anchor object
15765 * @param disable If EINA_TRUE, size restrictions are disabled
15766 * @return EINA_FALSE on failure, EINA_TRUE on success
15768 * This function allows a tooltip to expand beyond its parant window's canvas.
15769 * It will instead be limited only by the size of the display.
15771 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15773 * @brief Retrieve size restriction state of an object's tooltip
15774 * @param obj The tooltip's anchor object
15775 * @return If EINA_TRUE, size restrictions are disabled
15777 * This function returns whether a tooltip is allowed to expand beyond
15778 * its parant window's canvas.
15779 * It will instead be limited only by the size of the display.
15781 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15784 * Set the content to be shown in the tooltip item.
15786 * Setup the tooltip to item. The item can have only one tooltip,
15787 * so any previous tooltip data is removed. @p func(with @p data) will
15788 * be called every time that need show the tooltip and it should
15789 * return a valid Evas_Object. This object is then managed fully by
15790 * tooltip system and is deleted when the tooltip is gone.
15792 * @param item the list item being attached a tooltip.
15793 * @param func the function used to create the tooltip contents.
15794 * @param data what to provide to @a func as callback data/context.
15795 * @param del_cb called when data is not needed anymore, either when
15796 * another callback replaces @a func, the tooltip is unset with
15797 * elm_list_item_tooltip_unset() or the owner @a item
15798 * dies. This callback receives as the first parameter the
15799 * given @a data, and @c event_info is the item.
15801 * @see elm_object_tooltip_content_cb_set() for more details.
15805 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);
15808 * Unset tooltip from item.
15810 * @param item list item to remove previously set tooltip.
15812 * Remove tooltip from item. The callback provided as del_cb to
15813 * elm_list_item_tooltip_content_cb_set() will be called to notify
15814 * it is not used anymore.
15816 * @see elm_object_tooltip_unset() for more details.
15817 * @see elm_list_item_tooltip_content_cb_set()
15821 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15824 * Sets a different style for this item tooltip.
15826 * @note before you set a style you should define a tooltip with
15827 * elm_list_item_tooltip_content_cb_set() or
15828 * elm_list_item_tooltip_text_set()
15830 * @param item list item with tooltip already set.
15831 * @param style the theme style to use (default, transparent, ...)
15833 * @see elm_object_tooltip_style_set() for more details.
15837 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15840 * Get the style for this item tooltip.
15842 * @param item list item with tooltip already set.
15843 * @return style the theme style in use, defaults to "default". If the
15844 * object does not have a tooltip set, then NULL is returned.
15846 * @see elm_object_tooltip_style_get() for more details.
15847 * @see elm_list_item_tooltip_style_set()
15851 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15854 * Set the type of mouse pointer/cursor decoration to be shown,
15855 * when the mouse pointer is over the given list widget item
15857 * @param item list item to customize cursor on
15858 * @param cursor the cursor type's name
15860 * This function works analogously as elm_object_cursor_set(), but
15861 * here the cursor's changing area is restricted to the item's
15862 * area, and not the whole widget's. Note that that item cursors
15863 * have precedence over widget cursors, so that a mouse over an
15864 * item with custom cursor set will always show @b that cursor.
15866 * If this function is called twice for an object, a previously set
15867 * cursor will be unset on the second call.
15869 * @see elm_object_cursor_set()
15870 * @see elm_list_item_cursor_get()
15871 * @see elm_list_item_cursor_unset()
15875 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15878 * Get the type of mouse pointer/cursor decoration set to be shown,
15879 * when the mouse pointer is over the given list widget item
15881 * @param item list item with custom cursor set
15882 * @return the cursor type's name or @c NULL, if no custom cursors
15883 * were set to @p item (and on errors)
15885 * @see elm_object_cursor_get()
15886 * @see elm_list_item_cursor_set()
15887 * @see elm_list_item_cursor_unset()
15891 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15894 * Unset any custom mouse pointer/cursor decoration set to be
15895 * shown, when the mouse pointer is over the given list widget
15896 * item, thus making it show the @b default cursor again.
15898 * @param item a list item
15900 * Use this call to undo any custom settings on this item's cursor
15901 * decoration, bringing it back to defaults (no custom style set).
15903 * @see elm_object_cursor_unset()
15904 * @see elm_list_item_cursor_set()
15908 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15911 * Set a different @b style for a given custom cursor set for a
15914 * @param item list item with custom cursor set
15915 * @param style the <b>theme style</b> to use (e.g. @c "default",
15916 * @c "transparent", etc)
15918 * This function only makes sense when one is using custom mouse
15919 * cursor decorations <b>defined in a theme file</b>, which can have,
15920 * given a cursor name/type, <b>alternate styles</b> on it. It
15921 * works analogously as elm_object_cursor_style_set(), but here
15922 * applyed only to list item objects.
15924 * @warning Before you set a cursor style you should have definen a
15925 * custom cursor previously on the item, with
15926 * elm_list_item_cursor_set()
15928 * @see elm_list_item_cursor_engine_only_set()
15929 * @see elm_list_item_cursor_style_get()
15933 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15936 * Get the current @b style set for a given list item's custom
15939 * @param item list item with custom cursor set.
15940 * @return style the cursor style in use. If the object does not
15941 * have a cursor set, then @c NULL is returned.
15943 * @see elm_list_item_cursor_style_set() for more details
15947 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15950 * Set if the (custom)cursor for a given list item should be
15951 * searched in its theme, also, or should only rely on the
15952 * rendering engine.
15954 * @param item item with custom (custom) cursor already set on
15955 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15956 * only on those provided by the rendering engine, @c EINA_FALSE to
15957 * have them searched on the widget's theme, as well.
15959 * @note This call is of use only if you've set a custom cursor
15960 * for list items, with elm_list_item_cursor_set().
15962 * @note By default, cursors will only be looked for between those
15963 * provided by the rendering engine.
15967 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15970 * Get if the (custom) cursor for a given list item is being
15971 * searched in its theme, also, or is only relying on the rendering
15974 * @param item a list item
15975 * @return @c EINA_TRUE, if cursors are being looked for only on
15976 * those provided by the rendering engine, @c EINA_FALSE if they
15977 * are being searched on the widget's theme, as well.
15979 * @see elm_list_item_cursor_engine_only_set(), for more details
15983 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15990 * @defgroup Slider Slider
15991 * @ingroup Elementary
15993 * @image html img/widget/slider/preview-00.png
15994 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15996 * The slider adds a dragable “slider” widget for selecting the value of
15997 * something within a range.
15999 * A slider can be horizontal or vertical. It can contain an Icon and has a
16000 * primary label as well as a units label (that is formatted with floating
16001 * point values and thus accepts a printf-style format string, like
16002 * “%1.2f units”. There is also an indicator string that may be somewhere
16003 * else (like on the slider itself) that also accepts a format string like
16004 * units. Label, Icon Unit and Indicator strings/objects are optional.
16006 * A slider may be inverted which means values invert, with high vales being
16007 * on the left or top and low values on the right or bottom (as opposed to
16008 * normally being low on the left or top and high on the bottom and right).
16010 * The slider should have its minimum and maximum values set by the
16011 * application with elm_slider_min_max_set() and value should also be set by
16012 * the application before use with elm_slider_value_set(). The span of the
16013 * slider is its length (horizontally or vertically). This will be scaled by
16014 * the object or applications scaling factor. At any point code can query the
16015 * slider for its value with elm_slider_value_get().
16017 * Smart callbacks one can listen to:
16018 * - "changed" - Whenever the slider value is changed by the user.
16019 * - "slider,drag,start" - dragging the slider indicator around has started.
16020 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16021 * - "delay,changed" - A short time after the value is changed by the user.
16022 * This will be called only when the user stops dragging for
16023 * a very short period or when they release their
16024 * finger/mouse, so it avoids possibly expensive reactions to
16025 * the value change.
16027 * Available styles for it:
16030 * Here is an example on its usage:
16031 * @li @ref slider_example
16035 * @addtogroup Slider
16040 * Add a new slider widget to the given parent Elementary
16041 * (container) object.
16043 * @param parent The parent object.
16044 * @return a new slider widget handle or @c NULL, on errors.
16046 * This function inserts a new slider widget on the canvas.
16050 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16053 * Set the label of a given slider widget
16055 * @param obj The progress bar object
16056 * @param label The text label string, in UTF-8
16059 * @deprecated use elm_object_text_set() instead.
16061 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16064 * Get the label of a given slider widget
16066 * @param obj The progressbar object
16067 * @return The text label string, in UTF-8
16070 * @deprecated use elm_object_text_get() instead.
16072 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16075 * Set the icon object of the slider object.
16077 * @param obj The slider object.
16078 * @param icon The icon object.
16080 * On horizontal mode, icon is placed at left, and on vertical mode,
16083 * @note Once the icon object is set, a previously set one will be deleted.
16084 * If you want to keep that old content object, use the
16085 * elm_slider_icon_unset() function.
16087 * @warning If the object being set does not have minimum size hints set,
16088 * it won't get properly displayed.
16092 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16095 * Unset an icon set on a given slider widget.
16097 * @param obj The slider object.
16098 * @return The icon object that was being used, if any was set, or
16099 * @c NULL, otherwise (and on errors).
16101 * On horizontal mode, icon is placed at left, and on vertical mode,
16104 * This call will unparent and return the icon object which was set
16105 * for this widget, previously, on success.
16107 * @see elm_slider_icon_set() for more details
16108 * @see elm_slider_icon_get()
16112 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16115 * Retrieve the icon object set for a given slider widget.
16117 * @param obj The slider object.
16118 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16119 * otherwise (and on errors).
16121 * On horizontal mode, icon is placed at left, and on vertical mode,
16124 * @see elm_slider_icon_set() for more details
16125 * @see elm_slider_icon_unset()
16129 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16132 * Set the end object of the slider object.
16134 * @param obj The slider object.
16135 * @param end The end object.
16137 * On horizontal mode, end is placed at left, and on vertical mode,
16138 * placed at bottom.
16140 * @note Once the icon object is set, a previously set one will be deleted.
16141 * If you want to keep that old content object, use the
16142 * elm_slider_end_unset() function.
16144 * @warning If the object being set does not have minimum size hints set,
16145 * it won't get properly displayed.
16149 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16152 * Unset an end object set on a given slider widget.
16154 * @param obj The slider object.
16155 * @return The end object that was being used, if any was set, or
16156 * @c NULL, otherwise (and on errors).
16158 * On horizontal mode, end is placed at left, and on vertical mode,
16159 * placed at bottom.
16161 * This call will unparent and return the icon object which was set
16162 * for this widget, previously, on success.
16164 * @see elm_slider_end_set() for more details.
16165 * @see elm_slider_end_get()
16169 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16172 * Retrieve the end object set for a given slider widget.
16174 * @param obj The slider object.
16175 * @return The end object's handle, if @p obj had one set, or @c NULL,
16176 * otherwise (and on errors).
16178 * On horizontal mode, icon is placed at right, and on vertical mode,
16179 * placed at bottom.
16181 * @see elm_slider_end_set() for more details.
16182 * @see elm_slider_end_unset()
16186 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16189 * Set the (exact) length of the bar region of a given slider widget.
16191 * @param obj The slider object.
16192 * @param size The length of the slider's bar region.
16194 * This sets the minimum width (when in horizontal mode) or height
16195 * (when in vertical mode) of the actual bar area of the slider
16196 * @p obj. This in turn affects the object's minimum size. Use
16197 * this when you're not setting other size hints expanding on the
16198 * given direction (like weight and alignment hints) and you would
16199 * like it to have a specific size.
16201 * @note Icon, end, label, indicator and unit text around @p obj
16202 * will require their
16203 * own space, which will make @p obj to require more the @p size,
16206 * @see elm_slider_span_size_get()
16210 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16213 * Get the length set for the bar region of a given slider widget
16215 * @param obj The slider object.
16216 * @return The length of the slider's bar region.
16218 * If that size was not set previously, with
16219 * elm_slider_span_size_set(), this call will return @c 0.
16223 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16226 * Set the format string for the unit label.
16228 * @param obj The slider object.
16229 * @param format The format string for the unit display.
16231 * Unit label is displayed all the time, if set, after slider's bar.
16232 * In horizontal mode, at right and in vertical mode, at bottom.
16234 * If @c NULL, unit label won't be visible. If not it sets the format
16235 * string for the label text. To the label text is provided a floating point
16236 * value, so the label text can display up to 1 floating point value.
16237 * Note that this is optional.
16239 * Use a format string such as "%1.2f meters" for example, and it will
16240 * display values like: "3.14 meters" for a value equal to 3.14159.
16242 * Default is unit label disabled.
16244 * @see elm_slider_indicator_format_get()
16248 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16251 * Get the unit label format of the slider.
16253 * @param obj The slider object.
16254 * @return The unit label format string in UTF-8.
16256 * Unit label is displayed all the time, if set, after slider's bar.
16257 * In horizontal mode, at right and in vertical mode, at bottom.
16259 * @see elm_slider_unit_format_set() for more
16260 * information on how this works.
16264 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16267 * Set the format string for the indicator label.
16269 * @param obj The slider object.
16270 * @param indicator The format string for the indicator display.
16272 * The slider may display its value somewhere else then unit label,
16273 * for example, above the slider knob that is dragged around. This function
16274 * sets the format string used for this.
16276 * If @c NULL, indicator label won't be visible. If not it sets the format
16277 * string for the label text. To the label text is provided a floating point
16278 * value, so the label text can display up to 1 floating point value.
16279 * Note that this is optional.
16281 * Use a format string such as "%1.2f meters" for example, and it will
16282 * display values like: "3.14 meters" for a value equal to 3.14159.
16284 * Default is indicator label disabled.
16286 * @see elm_slider_indicator_format_get()
16290 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16293 * Get the indicator label format of the slider.
16295 * @param obj The slider object.
16296 * @return The indicator label format string in UTF-8.
16298 * The slider may display its value somewhere else then unit label,
16299 * for example, above the slider knob that is dragged around. This function
16300 * gets the format string used for this.
16302 * @see elm_slider_indicator_format_set() for more
16303 * information on how this works.
16307 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16310 * Set the format function pointer for the indicator label
16312 * @param obj The slider object.
16313 * @param func The indicator format function.
16314 * @param free_func The freeing function for the format string.
16316 * Set the callback function to format the indicator string.
16318 * @see elm_slider_indicator_format_set() for more info on how this works.
16322 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);
16325 * Set the format function pointer for the units label
16327 * @param obj The slider object.
16328 * @param func The units format function.
16329 * @param free_func The freeing function for the format string.
16331 * Set the callback function to format the indicator string.
16333 * @see elm_slider_units_format_set() for more info on how this works.
16337 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);
16340 * Set the orientation of a given slider widget.
16342 * @param obj The slider object.
16343 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16344 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16346 * Use this function to change how your slider is to be
16347 * disposed: vertically or horizontally.
16349 * By default it's displayed horizontally.
16351 * @see elm_slider_horizontal_get()
16355 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16358 * Retrieve the orientation of a given slider widget
16360 * @param obj The slider object.
16361 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16362 * @c EINA_FALSE if it's @b vertical (and on errors).
16364 * @see elm_slider_horizontal_set() for more details.
16368 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16371 * Set the minimum and maximum values for the slider.
16373 * @param obj The slider object.
16374 * @param min The minimum value.
16375 * @param max The maximum value.
16377 * Define the allowed range of values to be selected by the user.
16379 * If actual value is less than @p min, it will be updated to @p min. If it
16380 * is bigger then @p max, will be updated to @p max. Actual value can be
16381 * get with elm_slider_value_get().
16383 * By default, min is equal to 0.0, and max is equal to 1.0.
16385 * @warning Maximum must be greater than minimum, otherwise behavior
16388 * @see elm_slider_min_max_get()
16392 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16395 * Get the minimum and maximum values of the slider.
16397 * @param obj The slider object.
16398 * @param min Pointer where to store the minimum value.
16399 * @param max Pointer where to store the maximum value.
16401 * @note If only one value is needed, the other pointer can be passed
16404 * @see elm_slider_min_max_set() for details.
16408 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16411 * Set the value the slider displays.
16413 * @param obj The slider object.
16414 * @param val The value to be displayed.
16416 * Value will be presented on the unit label following format specified with
16417 * elm_slider_unit_format_set() and on indicator with
16418 * elm_slider_indicator_format_set().
16420 * @warning The value must to be between min and max values. This values
16421 * are set by elm_slider_min_max_set().
16423 * @see elm_slider_value_get()
16424 * @see elm_slider_unit_format_set()
16425 * @see elm_slider_indicator_format_set()
16426 * @see elm_slider_min_max_set()
16430 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16433 * Get the value displayed by the spinner.
16435 * @param obj The spinner object.
16436 * @return The value displayed.
16438 * @see elm_spinner_value_set() for details.
16442 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16445 * Invert a given slider widget's displaying values order
16447 * @param obj The slider object.
16448 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16449 * @c EINA_FALSE to bring it back to default, non-inverted values.
16451 * A slider may be @b inverted, in which state it gets its
16452 * values inverted, with high vales being on the left or top and
16453 * low values on the right or bottom, as opposed to normally have
16454 * the low values on the former and high values on the latter,
16455 * respectively, for horizontal and vertical modes.
16457 * @see elm_slider_inverted_get()
16461 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16464 * Get whether a given slider widget's displaying values are
16467 * @param obj The slider object.
16468 * @return @c EINA_TRUE, if @p obj has inverted values,
16469 * @c EINA_FALSE otherwise (and on errors).
16471 * @see elm_slider_inverted_set() for more details.
16475 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16478 * Set whether to enlarge slider indicator (augmented knob) or not.
16480 * @param obj The slider object.
16481 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16482 * let the knob always at default size.
16484 * By default, indicator will be bigger while dragged by the user.
16486 * @warning It won't display values set with
16487 * elm_slider_indicator_format_set() if you disable indicator.
16491 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16494 * Get whether a given slider widget's enlarging indicator or not.
16496 * @param obj The slider object.
16497 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16498 * @c EINA_FALSE otherwise (and on errors).
16500 * @see elm_slider_indicator_show_set() for details.
16504 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16511 * @addtogroup Actionslider Actionslider
16513 * @image html img/widget/actionslider/preview-00.png
16514 * @image latex img/widget/actionslider/preview-00.eps
16516 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16517 * properties. The indicator is the element the user drags to choose a label.
16518 * When the position is set with magnet, when released the indicator will be
16519 * moved to it if it's nearest the magnetized position.
16521 * @note By default all positions are set as enabled.
16523 * Signals that you can add callbacks for are:
16525 * "selected" - when user selects an enabled position (the label is passed
16528 * "pos_changed" - when the indicator reaches any of the positions("left",
16529 * "right" or "center").
16531 * See an example of actionslider usage @ref actionslider_example_page "here"
16534 typedef enum _Elm_Actionslider_Pos
16536 ELM_ACTIONSLIDER_NONE = 0,
16537 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16538 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16539 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16540 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16541 } Elm_Actionslider_Pos;
16544 * Add a new actionslider to the parent.
16546 * @param parent The parent object
16547 * @return The new actionslider object or NULL if it cannot be created
16549 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16551 * Set actionslider labels.
16553 * @param obj The actionslider object
16554 * @param left_label The label to be set on the left.
16555 * @param center_label The label to be set on the center.
16556 * @param right_label The label to be set on the right.
16557 * @deprecated use elm_object_text_set() instead.
16559 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);
16561 * Get actionslider labels.
16563 * @param obj The actionslider object
16564 * @param left_label A char** to place the left_label of @p obj into.
16565 * @param center_label A char** to place the center_label of @p obj into.
16566 * @param right_label A char** to place the right_label of @p obj into.
16567 * @deprecated use elm_object_text_set() instead.
16569 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);
16571 * Get actionslider selected label.
16573 * @param obj The actionslider object
16574 * @return The selected label
16576 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16578 * Set actionslider indicator position.
16580 * @param obj The actionslider object.
16581 * @param pos The position of the indicator.
16583 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16585 * Get actionslider indicator position.
16587 * @param obj The actionslider object.
16588 * @return The position of the indicator.
16590 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16592 * Set actionslider magnet position. To make multiple positions magnets @c or
16593 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16595 * @param obj The actionslider object.
16596 * @param pos Bit mask indicating the magnet positions.
16598 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16600 * Get actionslider magnet position.
16602 * @param obj The actionslider object.
16603 * @return The positions with magnet property.
16605 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16607 * Set actionslider enabled position. To set multiple positions as enabled @c or
16608 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16610 * @note All the positions are enabled by default.
16612 * @param obj The actionslider object.
16613 * @param pos Bit mask indicating the enabled positions.
16615 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16617 * Get actionslider enabled position.
16619 * @param obj The actionslider object.
16620 * @return The enabled positions.
16622 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16624 * Set the label used on the indicator.
16626 * @param obj The actionslider object
16627 * @param label The label to be set on the indicator.
16628 * @deprecated use elm_object_text_set() instead.
16630 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16632 * Get the label used on the indicator object.
16634 * @param obj The actionslider object
16635 * @return The indicator label
16636 * @deprecated use elm_object_text_get() instead.
16638 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16644 * @defgroup Genlist Genlist
16646 * @image html img/widget/genlist/preview-00.png
16647 * @image latex img/widget/genlist/preview-00.eps
16648 * @image html img/genlist.png
16649 * @image latex img/genlist.eps
16651 * This widget aims to have more expansive list than the simple list in
16652 * Elementary that could have more flexible items and allow many more entries
16653 * while still being fast and low on memory usage. At the same time it was
16654 * also made to be able to do tree structures. But the price to pay is more
16655 * complexity when it comes to usage. If all you want is a simple list with
16656 * icons and a single label, use the normal @ref List object.
16658 * Genlist has a fairly large API, mostly because it's relatively complex,
16659 * trying to be both expansive, powerful and efficient. First we will begin
16660 * an overview on the theory behind genlist.
16662 * @section Genlist_Item_Class Genlist item classes - creating items
16664 * In order to have the ability to add and delete items on the fly, genlist
16665 * implements a class (callback) system where the application provides a
16666 * structure with information about that type of item (genlist may contain
16667 * multiple different items with different classes, states and styles).
16668 * Genlist will call the functions in this struct (methods) when an item is
16669 * "realized" (i.e., created dynamically, while the user is scrolling the
16670 * grid). All objects will simply be deleted when no longer needed with
16671 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16672 * following members:
16673 * - @c item_style - This is a constant string and simply defines the name
16674 * of the item style. It @b must be specified and the default should be @c
16676 * - @c mode_item_style - This is a constant string and simply defines the
16677 * name of the style that will be used for mode animations. It can be left
16678 * as @c NULL if you don't plan to use Genlist mode. See
16679 * elm_genlist_item_mode_set() for more info.
16681 * - @c func - A struct with pointers to functions that will be called when
16682 * an item is going to be actually created. All of them receive a @c data
16683 * parameter that will point to the same data passed to
16684 * elm_genlist_item_append() and related item creation functions, and a @c
16685 * obj parameter that points to the genlist object itself.
16687 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16688 * state_get and @c del. The 3 first functions also receive a @c part
16689 * parameter described below. A brief description of these functions follows:
16691 * - @c label_get - The @c part parameter is the name string of one of the
16692 * existing text parts in the Edje group implementing the item's theme.
16693 * This function @b must return a strdup'()ed string, as the caller will
16694 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16695 * - @c icon_get - The @c part parameter is the name string of one of the
16696 * existing (icon) swallow parts in the Edje group implementing the item's
16697 * theme. It must return @c NULL, when no icon is desired, or a valid
16698 * object handle, otherwise. The object will be deleted by the genlist on
16699 * its deletion or when the item is "unrealized". See
16700 * #Elm_Genlist_Item_Icon_Get_Cb.
16701 * - @c func.state_get - The @c part parameter is the name string of one of
16702 * the state parts in the Edje group implementing the item's theme. Return
16703 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16704 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16705 * and @c "elm" as "emission" and "source" arguments, respectively, when
16706 * the state is true (the default is false), where @c XXX is the name of
16707 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16708 * - @c func.del - This is intended for use when genlist items are deleted,
16709 * so any data attached to the item (e.g. its data parameter on creation)
16710 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16712 * available item styles:
16714 * - default_style - The text part is a textblock
16716 * @image html img/widget/genlist/preview-04.png
16717 * @image latex img/widget/genlist/preview-04.eps
16721 * @image html img/widget/genlist/preview-01.png
16722 * @image latex img/widget/genlist/preview-01.eps
16724 * - icon_top_text_bottom
16726 * @image html img/widget/genlist/preview-02.png
16727 * @image latex img/widget/genlist/preview-02.eps
16731 * @image html img/widget/genlist/preview-03.png
16732 * @image latex img/widget/genlist/preview-03.eps
16734 * @section Genlist_Items Structure of items
16736 * An item in a genlist can have 0 or more text labels (they can be regular
16737 * text or textblock Evas objects - that's up to the style to determine), 0
16738 * or more icons (which are simply objects swallowed into the genlist item's
16739 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16740 * behavior left to the user to define. The Edje part names for each of
16741 * these properties will be looked up, in the theme file for the genlist,
16742 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16743 * "states", respectively. For each of those properties, if more than one
16744 * part is provided, they must have names listed separated by spaces in the
16745 * data fields. For the default genlist item theme, we have @b one label
16746 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16747 * "elm.swallow.end") and @b no state parts.
16749 * A genlist item may be at one of several styles. Elementary provides one
16750 * by default - "default", but this can be extended by system or application
16751 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16754 * @section Genlist_Manipulation Editing and Navigating
16756 * Items can be added by several calls. All of them return a @ref
16757 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16758 * They all take a data parameter that is meant to be used for a handle to
16759 * the applications internal data (eg the struct with the original item
16760 * data). The parent parameter is the parent genlist item this belongs to if
16761 * it is a tree or an indexed group, and NULL if there is no parent. The
16762 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16763 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16764 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16765 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16766 * is set then this item is group index item that is displayed at the top
16767 * until the next group comes. The func parameter is a convenience callback
16768 * that is called when the item is selected and the data parameter will be
16769 * the func_data parameter, obj be the genlist object and event_info will be
16770 * the genlist item.
16772 * elm_genlist_item_append() adds an item to the end of the list, or if
16773 * there is a parent, to the end of all the child items of the parent.
16774 * elm_genlist_item_prepend() is the same but adds to the beginning of
16775 * the list or children list. elm_genlist_item_insert_before() inserts at
16776 * item before another item and elm_genlist_item_insert_after() inserts after
16777 * the indicated item.
16779 * The application can clear the list with elm_genlist_clear() which deletes
16780 * all the items in the list and elm_genlist_item_del() will delete a specific
16781 * item. elm_genlist_item_subitems_clear() will clear all items that are
16782 * children of the indicated parent item.
16784 * To help inspect list items you can jump to the item at the top of the list
16785 * with elm_genlist_first_item_get() which will return the item pointer, and
16786 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16787 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16788 * and previous items respectively relative to the indicated item. Using
16789 * these calls you can walk the entire item list/tree. Note that as a tree
16790 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16791 * let you know which item is the parent (and thus know how to skip them if
16794 * @section Genlist_Muti_Selection Multi-selection
16796 * If the application wants multiple items to be able to be selected,
16797 * elm_genlist_multi_select_set() can enable this. If the list is
16798 * single-selection only (the default), then elm_genlist_selected_item_get()
16799 * will return the selected item, if any, or NULL I none is selected. If the
16800 * list is multi-select then elm_genlist_selected_items_get() will return a
16801 * list (that is only valid as long as no items are modified (added, deleted,
16802 * selected or unselected)).
16804 * @section Genlist_Usage_Hints Usage hints
16806 * There are also convenience functions. elm_genlist_item_genlist_get() will
16807 * return the genlist object the item belongs to. elm_genlist_item_show()
16808 * will make the scroller scroll to show that specific item so its visible.
16809 * elm_genlist_item_data_get() returns the data pointer set by the item
16810 * creation functions.
16812 * If an item changes (state of boolean changes, label or icons change),
16813 * then use elm_genlist_item_update() to have genlist update the item with
16814 * the new state. Genlist will re-realize the item thus call the functions
16815 * in the _Elm_Genlist_Item_Class for that item.
16817 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16818 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16819 * to expand/contract an item and get its expanded state, use
16820 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16821 * again to make an item disabled (unable to be selected and appear
16822 * differently) use elm_genlist_item_disabled_set() to set this and
16823 * elm_genlist_item_disabled_get() to get the disabled state.
16825 * In general to indicate how the genlist should expand items horizontally to
16826 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16827 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16828 * mode means that if items are too wide to fit, the scroller will scroll
16829 * horizontally. Otherwise items are expanded to fill the width of the
16830 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16831 * to the viewport width and limited to that size. This can be combined with
16832 * a different style that uses edjes' ellipsis feature (cutting text off like
16835 * Items will only call their selection func and callback when first becoming
16836 * selected. Any further clicks will do nothing, unless you enable always
16837 * select with elm_genlist_always_select_mode_set(). This means even if
16838 * selected, every click will make the selected callbacks be called.
16839 * elm_genlist_no_select_mode_set() will turn off the ability to select
16840 * items entirely and they will neither appear selected nor call selected
16841 * callback functions.
16843 * Remember that you can create new styles and add your own theme augmentation
16844 * per application with elm_theme_extension_add(). If you absolutely must
16845 * have a specific style that overrides any theme the user or system sets up
16846 * you can use elm_theme_overlay_add() to add such a file.
16848 * @section Genlist_Implementation Implementation
16850 * Evas tracks every object you create. Every time it processes an event
16851 * (mouse move, down, up etc.) it needs to walk through objects and find out
16852 * what event that affects. Even worse every time it renders display updates,
16853 * in order to just calculate what to re-draw, it needs to walk through many
16854 * many many objects. Thus, the more objects you keep active, the more
16855 * overhead Evas has in just doing its work. It is advisable to keep your
16856 * active objects to the minimum working set you need. Also remember that
16857 * object creation and deletion carries an overhead, so there is a
16858 * middle-ground, which is not easily determined. But don't keep massive lists
16859 * of objects you can't see or use. Genlist does this with list objects. It
16860 * creates and destroys them dynamically as you scroll around. It groups them
16861 * into blocks so it can determine the visibility etc. of a whole block at
16862 * once as opposed to having to walk the whole list. This 2-level list allows
16863 * for very large numbers of items to be in the list (tests have used up to
16864 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16865 * may be different sizes, every item added needs to be calculated as to its
16866 * size and thus this presents a lot of overhead on populating the list, this
16867 * genlist employs a queue. Any item added is queued and spooled off over
16868 * time, actually appearing some time later, so if your list has many members
16869 * you may find it takes a while for them to all appear, with your process
16870 * consuming a lot of CPU while it is busy spooling.
16872 * Genlist also implements a tree structure, but it does so with callbacks to
16873 * the application, with the application filling in tree structures when
16874 * requested (allowing for efficient building of a very deep tree that could
16875 * even be used for file-management). See the above smart signal callbacks for
16878 * @section Genlist_Smart_Events Genlist smart events
16880 * Signals that you can add callbacks for are:
16881 * - @c "activated" - The user has double-clicked or pressed
16882 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16883 * item that was activated.
16884 * - @c "clicked,double" - The user has double-clicked an item. The @c
16885 * event_info parameter is the item that was double-clicked.
16886 * - @c "selected" - This is called when a user has made an item selected.
16887 * The event_info parameter is the genlist item that was selected.
16888 * - @c "unselected" - This is called when a user has made an item
16889 * unselected. The event_info parameter is the genlist item that was
16891 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16892 * called and the item is now meant to be expanded. The event_info
16893 * parameter is the genlist item that was indicated to expand. It is the
16894 * job of this callback to then fill in the child items.
16895 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16896 * called and the item is now meant to be contracted. The event_info
16897 * parameter is the genlist item that was indicated to contract. It is the
16898 * job of this callback to then delete the child items.
16899 * - @c "expand,request" - This is called when a user has indicated they want
16900 * to expand a tree branch item. The callback should decide if the item can
16901 * expand (has any children) and then call elm_genlist_item_expanded_set()
16902 * appropriately to set the state. The event_info parameter is the genlist
16903 * item that was indicated to expand.
16904 * - @c "contract,request" - This is called when a user has indicated they
16905 * want to contract a tree branch item. The callback should decide if the
16906 * item can contract (has any children) and then call
16907 * elm_genlist_item_expanded_set() appropriately to set the state. The
16908 * event_info parameter is the genlist item that was indicated to contract.
16909 * - @c "realized" - This is called when the item in the list is created as a
16910 * real evas object. event_info parameter is the genlist item that was
16911 * created. The object may be deleted at any time, so it is up to the
16912 * caller to not use the object pointer from elm_genlist_item_object_get()
16913 * in a way where it may point to freed objects.
16914 * - @c "unrealized" - This is called just before an item is unrealized.
16915 * After this call icon objects provided will be deleted and the item
16916 * object itself delete or be put into a floating cache.
16917 * - @c "drag,start,up" - This is called when the item in the list has been
16918 * dragged (not scrolled) up.
16919 * - @c "drag,start,down" - This is called when the item in the list has been
16920 * dragged (not scrolled) down.
16921 * - @c "drag,start,left" - This is called when the item in the list has been
16922 * dragged (not scrolled) left.
16923 * - @c "drag,start,right" - This is called when the item in the list has
16924 * been dragged (not scrolled) right.
16925 * - @c "drag,stop" - This is called when the item in the list has stopped
16927 * - @c "drag" - This is called when the item in the list is being dragged.
16928 * - @c "longpressed" - This is called when the item is pressed for a certain
16929 * amount of time. By default it's 1 second.
16930 * - @c "scroll,anim,start" - This is called when scrolling animation has
16932 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16934 * - @c "scroll,drag,start" - This is called when dragging the content has
16936 * - @c "scroll,drag,stop" - This is called when dragging the content has
16938 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16940 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16941 * until the bottom edge.
16942 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16943 * until the left edge.
16944 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16945 * until the right edge.
16946 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16948 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16950 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16952 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16954 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16955 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16956 * multi-touch pinched in.
16957 * - @c "swipe" - This is called when the genlist is swiped.
16959 * @section Genlist_Examples Examples
16961 * Here is a list of examples that use the genlist, trying to show some of
16962 * its capabilities:
16963 * - @ref genlist_example_01
16964 * - @ref genlist_example_02
16965 * - @ref genlist_example_03
16966 * - @ref genlist_example_04
16967 * - @ref genlist_example_05
16971 * @addtogroup Genlist
16976 * @enum _Elm_Genlist_Item_Flags
16977 * @typedef Elm_Genlist_Item_Flags
16979 * Defines if the item is of any special type (has subitems or it's the
16980 * index of a group), or is just a simple item.
16984 typedef enum _Elm_Genlist_Item_Flags
16986 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16987 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16988 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16989 } Elm_Genlist_Item_Flags;
16990 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16991 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16992 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16993 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16994 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. */
16995 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. */
16996 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16997 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16999 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17000 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17001 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17002 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17005 * @struct _Elm_Genlist_Item_Class
17007 * Genlist item class definition structs.
17009 * This struct contains the style and fetching functions that will define the
17010 * contents of each item.
17012 * @see @ref Genlist_Item_Class
17014 struct _Elm_Genlist_Item_Class
17016 const char *item_style; /**< style of this class. */
17019 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
17020 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
17021 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
17022 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
17023 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
17025 const char *mode_item_style;
17029 * Add a new genlist widget to the given parent Elementary
17030 * (container) object
17032 * @param parent The parent object
17033 * @return a new genlist widget handle or @c NULL, on errors
17035 * This function inserts a new genlist widget on the canvas.
17037 * @see elm_genlist_item_append()
17038 * @see elm_genlist_item_del()
17039 * @see elm_genlist_clear()
17043 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17045 * Remove all items from a given genlist widget.
17047 * @param obj The genlist object
17049 * This removes (and deletes) all items in @p obj, leaving it empty.
17051 * @see elm_genlist_item_del(), to remove just one item.
17055 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17057 * Enable or disable multi-selection in the genlist
17059 * @param obj The genlist object
17060 * @param multi Multi-select enable/disable. Default is disabled.
17062 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17063 * the list. This allows more than 1 item to be selected. To retrieve the list
17064 * of selected items, use elm_genlist_selected_items_get().
17066 * @see elm_genlist_selected_items_get()
17067 * @see elm_genlist_multi_select_get()
17071 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17073 * Gets if multi-selection in genlist is enabled or disabled.
17075 * @param obj The genlist object
17076 * @return Multi-select enabled/disabled
17077 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17079 * @see elm_genlist_multi_select_set()
17083 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17085 * This sets the horizontal stretching mode.
17087 * @param obj The genlist object
17088 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17090 * This sets the mode used for sizing items horizontally. Valid modes
17091 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17092 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17093 * the scroller will scroll horizontally. Otherwise items are expanded
17094 * to fill the width of the viewport of the scroller. If it is
17095 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17096 * limited to that size.
17098 * @see elm_genlist_horizontal_get()
17102 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17103 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17105 * Gets the horizontal stretching mode.
17107 * @param obj The genlist object
17108 * @return The mode to use
17109 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17111 * @see elm_genlist_horizontal_set()
17115 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17116 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17118 * Set the always select mode.
17120 * @param obj The genlist object
17121 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17122 * EINA_FALSE = off). Default is @c EINA_FALSE.
17124 * Items will only call their selection func and callback when first
17125 * becoming selected. Any further clicks will do nothing, unless you
17126 * enable always select with elm_genlist_always_select_mode_set().
17127 * This means that, even if selected, every click will make the selected
17128 * callbacks be called.
17130 * @see elm_genlist_always_select_mode_get()
17134 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17136 * Get the always select mode.
17138 * @param obj The genlist object
17139 * @return The always select mode
17140 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17142 * @see elm_genlist_always_select_mode_set()
17146 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17148 * Enable/disable the no select mode.
17150 * @param obj The genlist object
17151 * @param no_select The no select mode
17152 * (EINA_TRUE = on, EINA_FALSE = off)
17154 * This will turn off the ability to select items entirely and they
17155 * will neither appear selected nor call selected callback functions.
17157 * @see elm_genlist_no_select_mode_get()
17161 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17163 * Gets whether the no select mode is enabled.
17165 * @param obj The genlist object
17166 * @return The no select mode
17167 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17169 * @see elm_genlist_no_select_mode_set()
17173 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17175 * Enable/disable compress mode.
17177 * @param obj The genlist object
17178 * @param compress The compress mode
17179 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17181 * This will enable the compress mode where items are "compressed"
17182 * horizontally to fit the genlist scrollable viewport width. This is
17183 * special for genlist. Do not rely on
17184 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17185 * work as genlist needs to handle it specially.
17187 * @see elm_genlist_compress_mode_get()
17191 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17193 * Get whether the compress mode is enabled.
17195 * @param obj The genlist object
17196 * @return The compress mode
17197 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17199 * @see elm_genlist_compress_mode_set()
17203 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17205 * Enable/disable height-for-width mode.
17207 * @param obj The genlist object
17208 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17209 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17211 * With height-for-width mode the item width will be fixed (restricted
17212 * to a minimum of) to the list width when calculating its size in
17213 * order to allow the height to be calculated based on it. This allows,
17214 * for instance, text block to wrap lines if the Edje part is
17215 * configured with "text.min: 0 1".
17217 * @note This mode will make list resize slower as it will have to
17218 * recalculate every item height again whenever the list width
17221 * @note When height-for-width mode is enabled, it also enables
17222 * compress mode (see elm_genlist_compress_mode_set()) and
17223 * disables homogeneous (see elm_genlist_homogeneous_set()).
17227 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17229 * Get whether the height-for-width mode is enabled.
17231 * @param obj The genlist object
17232 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17237 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17239 * Enable/disable horizontal and vertical bouncing effect.
17241 * @param obj The genlist object
17242 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17243 * EINA_FALSE = off). Default is @c EINA_FALSE.
17244 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17245 * EINA_FALSE = off). Default is @c EINA_TRUE.
17247 * This will enable or disable the scroller bouncing effect for the
17248 * genlist. See elm_scroller_bounce_set() for details.
17250 * @see elm_scroller_bounce_set()
17251 * @see elm_genlist_bounce_get()
17255 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17257 * Get whether the horizontal and vertical bouncing effect is enabled.
17259 * @param obj The genlist object
17260 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17262 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17265 * @see elm_genlist_bounce_set()
17269 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17271 * Enable/disable homogenous mode.
17273 * @param obj The genlist object
17274 * @param homogeneous Assume the items within the genlist are of the
17275 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17278 * This will enable the homogeneous mode where items are of the same
17279 * height and width so that genlist may do the lazy-loading at its
17280 * maximum (which increases the performance for scrolling the list). This
17281 * implies 'compressed' mode.
17283 * @see elm_genlist_compress_mode_set()
17284 * @see elm_genlist_homogeneous_get()
17288 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17290 * Get whether the homogenous mode is enabled.
17292 * @param obj The genlist object
17293 * @return Assume the items within the genlist are of the same height
17294 * and width (EINA_TRUE = on, EINA_FALSE = off)
17296 * @see elm_genlist_homogeneous_set()
17300 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17302 * Set the maximum number of items within an item block
17304 * @param obj The genlist object
17305 * @param n Maximum number of items within an item block. Default is 32.
17307 * This will configure the block count to tune to the target with
17308 * particular performance matrix.
17310 * A block of objects will be used to reduce the number of operations due to
17311 * many objects in the screen. It can determine the visibility, or if the
17312 * object has changed, it theme needs to be updated, etc. doing this kind of
17313 * calculation to the entire block, instead of per object.
17315 * The default value for the block count is enough for most lists, so unless
17316 * you know you will have a lot of objects visible in the screen at the same
17317 * time, don't try to change this.
17319 * @see elm_genlist_block_count_get()
17320 * @see @ref Genlist_Implementation
17324 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17326 * Get the maximum number of items within an item block
17328 * @param obj The genlist object
17329 * @return Maximum number of items within an item block
17331 * @see elm_genlist_block_count_set()
17335 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17337 * Set the timeout in seconds for the longpress event.
17339 * @param obj The genlist object
17340 * @param timeout timeout in seconds. Default is 1.
17342 * This option will change how long it takes to send an event "longpressed"
17343 * after the mouse down signal is sent to the list. If this event occurs, no
17344 * "clicked" event will be sent.
17346 * @see elm_genlist_longpress_timeout_set()
17350 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17352 * Get the timeout in seconds for the longpress event.
17354 * @param obj The genlist object
17355 * @return timeout in seconds
17357 * @see elm_genlist_longpress_timeout_get()
17361 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17363 * Append a new item in a given genlist widget.
17365 * @param obj The genlist object
17366 * @param itc The item class for the item
17367 * @param data The item data
17368 * @param parent The parent item, or NULL if none
17369 * @param flags Item flags
17370 * @param func Convenience function called when the item is selected
17371 * @param func_data Data passed to @p func above.
17372 * @return A handle to the item added or @c NULL if not possible
17374 * This adds the given item to the end of the list or the end of
17375 * the children list if the @p parent is given.
17377 * @see elm_genlist_item_prepend()
17378 * @see elm_genlist_item_insert_before()
17379 * @see elm_genlist_item_insert_after()
17380 * @see elm_genlist_item_del()
17384 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);
17386 * Prepend a new item in a given genlist widget.
17388 * @param obj The genlist object
17389 * @param itc The item class for the item
17390 * @param data The item data
17391 * @param parent The parent item, or NULL if none
17392 * @param flags Item flags
17393 * @param func Convenience function called when the item is selected
17394 * @param func_data Data passed to @p func above.
17395 * @return A handle to the item added or NULL if not possible
17397 * This adds an item to the beginning of the list or beginning of the
17398 * children of the parent if given.
17400 * @see elm_genlist_item_append()
17401 * @see elm_genlist_item_insert_before()
17402 * @see elm_genlist_item_insert_after()
17403 * @see elm_genlist_item_del()
17407 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);
17409 * Insert an item before another in a genlist widget
17411 * @param obj The genlist object
17412 * @param itc The item class for the item
17413 * @param data The item data
17414 * @param before The item to place this new one before.
17415 * @param flags Item flags
17416 * @param func Convenience function called when the item is selected
17417 * @param func_data Data passed to @p func above.
17418 * @return A handle to the item added or @c NULL if not possible
17420 * This inserts an item before another in the list. It will be in the
17421 * same tree level or group as the item it is inserted before.
17423 * @see elm_genlist_item_append()
17424 * @see elm_genlist_item_prepend()
17425 * @see elm_genlist_item_insert_after()
17426 * @see elm_genlist_item_del()
17430 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);
17432 * Insert an item after another in a genlist widget
17434 * @param obj The genlist object
17435 * @param itc The item class for the item
17436 * @param data The item data
17437 * @param after The item to place this new one after.
17438 * @param flags Item flags
17439 * @param func Convenience function called when the item is selected
17440 * @param func_data Data passed to @p func above.
17441 * @return A handle to the item added or @c NULL if not possible
17443 * This inserts an item after another in the list. It will be in the
17444 * same tree level or group as the item it is inserted after.
17446 * @see elm_genlist_item_append()
17447 * @see elm_genlist_item_prepend()
17448 * @see elm_genlist_item_insert_before()
17449 * @see elm_genlist_item_del()
17453 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);
17455 * Insert a new item into the sorted genlist object
17457 * @param obj The genlist object
17458 * @param itc The item class for the item
17459 * @param data The item data
17460 * @param parent The parent item, or NULL if none
17461 * @param flags Item flags
17462 * @param comp The function called for the sort
17463 * @param func Convenience function called when item selected
17464 * @param func_data Data passed to @p func above.
17465 * @return A handle to the item added or NULL if not possible
17469 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);
17470 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);
17471 /* operations to retrieve existing items */
17473 * Get the selectd item in the genlist.
17475 * @param obj The genlist object
17476 * @return The selected item, or NULL if none is selected.
17478 * This gets the selected item in the list (if multi-selection is enabled, only
17479 * the item that was first selected in the list is returned - which is not very
17480 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17483 * If no item is selected, NULL is returned.
17485 * @see elm_genlist_selected_items_get()
17489 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17491 * Get a list of selected items in the genlist.
17493 * @param obj The genlist object
17494 * @return The list of selected items, or NULL if none are selected.
17496 * It returns a list of the selected items. This list pointer is only valid so
17497 * long as the selection doesn't change (no items are selected or unselected, or
17498 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17499 * pointers. The order of the items in this list is the order which they were
17500 * selected, i.e. the first item in this list is the first item that was
17501 * selected, and so on.
17503 * @note If not in multi-select mode, consider using function
17504 * elm_genlist_selected_item_get() instead.
17506 * @see elm_genlist_multi_select_set()
17507 * @see elm_genlist_selected_item_get()
17511 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17513 * Get a list of realized items in genlist
17515 * @param obj The genlist object
17516 * @return The list of realized items, nor NULL if none are realized.
17518 * This returns a list of the realized items in the genlist. The list
17519 * contains Elm_Genlist_Item pointers. The list must be freed by the
17520 * caller when done with eina_list_free(). The item pointers in the
17521 * list are only valid so long as those items are not deleted or the
17522 * genlist is not deleted.
17524 * @see elm_genlist_realized_items_update()
17528 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17530 * Get the item that is at the x, y canvas coords.
17532 * @param obj The gelinst object.
17533 * @param x The input x coordinate
17534 * @param y The input y coordinate
17535 * @param posret The position relative to the item returned here
17536 * @return The item at the coordinates or NULL if none
17538 * This returns the item at the given coordinates (which are canvas
17539 * relative, not object-relative). If an item is at that coordinate,
17540 * that item handle is returned, and if @p posret is not NULL, the
17541 * integer pointed to is set to a value of -1, 0 or 1, depending if
17542 * the coordinate is on the upper portion of that item (-1), on the
17543 * middle section (0) or on the lower part (1). If NULL is returned as
17544 * an item (no item found there), then posret may indicate -1 or 1
17545 * based if the coordinate is above or below all items respectively in
17550 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);
17552 * Get the first item in the genlist
17554 * This returns the first item in the list.
17556 * @param obj The genlist object
17557 * @return The first item, or NULL if none
17561 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17563 * Get the last item in the genlist
17565 * This returns the last item in the list.
17567 * @return The last item, or NULL if none
17571 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17573 * Set the scrollbar policy
17575 * @param obj The genlist object
17576 * @param policy_h Horizontal scrollbar policy.
17577 * @param policy_v Vertical scrollbar policy.
17579 * This sets the scrollbar visibility policy for the given genlist
17580 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17581 * made visible if it is needed, and otherwise kept hidden.
17582 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17583 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17584 * respectively for the horizontal and vertical scrollbars. Default is
17585 * #ELM_SMART_SCROLLER_POLICY_AUTO
17587 * @see elm_genlist_scroller_policy_get()
17591 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17593 * Get the scrollbar policy
17595 * @param obj The genlist object
17596 * @param policy_h Pointer to store the horizontal scrollbar policy.
17597 * @param policy_v Pointer to store the vertical scrollbar policy.
17599 * @see elm_genlist_scroller_policy_set()
17603 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);
17605 * Get the @b next item in a genlist widget's internal list of items,
17606 * given a handle to one of those items.
17608 * @param item The genlist item to fetch next from
17609 * @return The item after @p item, or @c NULL if there's none (and
17612 * This returns the item placed after the @p item, on the container
17615 * @see elm_genlist_item_prev_get()
17619 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17621 * Get the @b previous item in a genlist widget's internal list of items,
17622 * given a handle to one of those items.
17624 * @param item The genlist item to fetch previous from
17625 * @return The item before @p item, or @c NULL if there's none (and
17628 * This returns the item placed before the @p item, on the container
17631 * @see elm_genlist_item_next_get()
17635 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17637 * Get the genlist object's handle which contains a given genlist
17640 * @param item The item to fetch the container from
17641 * @return The genlist (parent) object
17643 * This returns the genlist object itself that an item belongs to.
17647 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17649 * Get the parent item of the given item
17651 * @param it The item
17652 * @return The parent of the item or @c NULL if it has no parent.
17654 * This returns the item that was specified as parent of the item @p it on
17655 * elm_genlist_item_append() and insertion related functions.
17659 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17661 * Remove all sub-items (children) of the given item
17663 * @param it The item
17665 * This removes all items that are children (and their descendants) of the
17666 * given item @p it.
17668 * @see elm_genlist_clear()
17669 * @see elm_genlist_item_del()
17673 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17675 * Set whether a given genlist item is selected or not
17677 * @param it The item
17678 * @param selected Use @c EINA_TRUE, to make it selected, @c
17679 * EINA_FALSE to make it unselected
17681 * This sets the selected state of an item. If multi selection is
17682 * not enabled on the containing genlist and @p selected is @c
17683 * EINA_TRUE, any other previously selected items will get
17684 * unselected in favor of this new one.
17686 * @see elm_genlist_item_selected_get()
17690 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17692 * Get whether a given genlist item is selected or not
17694 * @param it The item
17695 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17697 * @see elm_genlist_item_selected_set() for more details
17701 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17703 * Sets the expanded state of an item.
17705 * @param it The item
17706 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17708 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17711 * The theme will respond to this change visually, and a signal "expanded" or
17712 * "contracted" will be sent from the genlist with a pointer to the item that
17713 * has been expanded/contracted.
17715 * Calling this function won't show or hide any child of this item (if it is
17716 * a parent). You must manually delete and create them on the callbacks fo
17717 * the "expanded" or "contracted" signals.
17719 * @see elm_genlist_item_expanded_get()
17723 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17725 * Get the expanded state of an item
17727 * @param it The item
17728 * @return The expanded state
17730 * This gets the expanded state of an item.
17732 * @see elm_genlist_item_expanded_set()
17736 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17738 * Get the depth of expanded item
17740 * @param it The genlist item object
17741 * @return The depth of expanded item
17745 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17747 * Set whether a given genlist item is disabled or not.
17749 * @param it The item
17750 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17751 * to enable it back.
17753 * A disabled item cannot be selected or unselected. It will also
17754 * change its appearance, to signal the user it's disabled.
17756 * @see elm_genlist_item_disabled_get()
17760 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17762 * Get whether a given genlist item is disabled or not.
17764 * @param it The item
17765 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17768 * @see elm_genlist_item_disabled_set() for more details
17772 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17774 * Sets the display only state of an item.
17776 * @param it The item
17777 * @param display_only @c EINA_TRUE if the item is display only, @c
17778 * EINA_FALSE otherwise.
17780 * A display only item cannot be selected or unselected. It is for
17781 * display only and not selecting or otherwise clicking, dragging
17782 * etc. by the user, thus finger size rules will not be applied to
17785 * It's good to set group index items to display only state.
17787 * @see elm_genlist_item_display_only_get()
17791 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17793 * Get the display only state of an item
17795 * @param it The item
17796 * @return @c EINA_TRUE if the item is display only, @c
17797 * EINA_FALSE otherwise.
17799 * @see elm_genlist_item_display_only_set()
17803 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17805 * Show the portion of a genlist's internal list containing a given
17806 * item, immediately.
17808 * @param it The item to display
17810 * This causes genlist to jump to the given item @p it and show it (by
17811 * immediately scrolling to that position), if it is not fully visible.
17813 * @see elm_genlist_item_bring_in()
17814 * @see elm_genlist_item_top_show()
17815 * @see elm_genlist_item_middle_show()
17819 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17821 * Animatedly bring in, to the visible are of a genlist, a given
17824 * @param it The item to display
17826 * This causes genlist to jump to the given item @p it and show it (by
17827 * animatedly scrolling), if it is not fully visible. This may use animation
17828 * to do so and take a period of time
17830 * @see elm_genlist_item_show()
17831 * @see elm_genlist_item_top_bring_in()
17832 * @see elm_genlist_item_middle_bring_in()
17836 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17838 * Show the portion of a genlist's internal list containing a given
17839 * item, immediately.
17841 * @param it The item to display
17843 * This causes genlist to jump to the given item @p it and show it (by
17844 * immediately scrolling to that position), if it is not fully visible.
17846 * The item will be positioned at the top of the genlist viewport.
17848 * @see elm_genlist_item_show()
17849 * @see elm_genlist_item_top_bring_in()
17853 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17855 * Animatedly bring in, to the visible are of a genlist, a given
17858 * @param it The item
17860 * This causes genlist to jump to the given item @p it and show it (by
17861 * animatedly scrolling), if it is not fully visible. This may use animation
17862 * to do so and take a period of time
17864 * The item will be positioned at the top of the genlist viewport.
17866 * @see elm_genlist_item_bring_in()
17867 * @see elm_genlist_item_top_show()
17871 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17873 * Show the portion of a genlist's internal list containing a given
17874 * item, immediately.
17876 * @param it The item to display
17878 * This causes genlist to jump to the given item @p it and show it (by
17879 * immediately scrolling to that position), if it is not fully visible.
17881 * The item will be positioned at the middle of the genlist viewport.
17883 * @see elm_genlist_item_show()
17884 * @see elm_genlist_item_middle_bring_in()
17888 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17890 * Animatedly bring in, to the visible are of a genlist, a given
17893 * @param it The item
17895 * This causes genlist to jump to the given item @p it and show it (by
17896 * animatedly scrolling), if it is not fully visible. This may use animation
17897 * to do so and take a period of time
17899 * The item will be positioned at the middle of the genlist viewport.
17901 * @see elm_genlist_item_bring_in()
17902 * @see elm_genlist_item_middle_show()
17906 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17908 * Remove a genlist item from the its parent, deleting it.
17910 * @param item The item to be removed.
17911 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17913 * @see elm_genlist_clear(), to remove all items in a genlist at
17918 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17920 * Return the data associated to a given genlist item
17922 * @param item The genlist item.
17923 * @return the data associated to this item.
17925 * This returns the @c data value passed on the
17926 * elm_genlist_item_append() and related item addition calls.
17928 * @see elm_genlist_item_append()
17929 * @see elm_genlist_item_data_set()
17933 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17935 * Set the data associated to a given genlist item
17937 * @param item The genlist item
17938 * @param data The new data pointer to set on it
17940 * This @b overrides the @c data value passed on the
17941 * elm_genlist_item_append() and related item addition calls. This
17942 * function @b won't call elm_genlist_item_update() automatically,
17943 * so you'd issue it afterwards if you want to hove the item
17944 * updated to reflect the that new data.
17946 * @see elm_genlist_item_data_get()
17950 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17952 * Tells genlist to "orphan" icons fetchs by the item class
17954 * @param it The item
17956 * This instructs genlist to release references to icons in the item,
17957 * meaning that they will no longer be managed by genlist and are
17958 * floating "orphans" that can be re-used elsewhere if the user wants
17963 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17965 * Get the real Evas object created to implement the view of a
17966 * given genlist item
17968 * @param item The genlist item.
17969 * @return the Evas object implementing this item's view.
17971 * This returns the actual Evas object used to implement the
17972 * specified genlist item's view. This may be @c NULL, as it may
17973 * not have been created or may have been deleted, at any time, by
17974 * the genlist. <b>Do not modify this object</b> (move, resize,
17975 * show, hide, etc.), as the genlist is controlling it. This
17976 * function is for querying, emitting custom signals or hooking
17977 * lower level callbacks for events on that object. Do not delete
17978 * this object under any circumstances.
17980 * @see elm_genlist_item_data_get()
17984 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17986 * Update the contents of an item
17988 * @param it The item
17990 * This updates an item by calling all the item class functions again
17991 * to get the icons, labels and states. Use this when the original
17992 * item data has changed and the changes are desired to be reflected.
17994 * Use elm_genlist_realized_items_update() to update all already realized
17997 * @see elm_genlist_realized_items_update()
18001 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18003 * Update the item class of an item
18005 * @param it The item
18006 * @param itc The item class for the item
18008 * This sets another class fo the item, changing the way that it is
18009 * displayed. After changing the item class, elm_genlist_item_update() is
18010 * called on the item @p it.
18014 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18015 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18017 * Set the text to be shown in a given genlist item's tooltips.
18019 * @param item The genlist item
18020 * @param text The text to set in the content
18022 * This call will setup the text to be used as tooltip to that item
18023 * (analogous to elm_object_tooltip_text_set(), but being item
18024 * tooltips with higher precedence than object tooltips). It can
18025 * have only one tooltip at a time, so any previous tooltip data
18026 * will get removed.
18028 * In order to set an icon or something else as a tooltip, look at
18029 * elm_genlist_item_tooltip_content_cb_set().
18033 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18035 * Set the content to be shown in a given genlist item's tooltips
18037 * @param item The genlist item.
18038 * @param func The function returning the tooltip contents.
18039 * @param data What to provide to @a func as callback data/context.
18040 * @param del_cb Called when data is not needed anymore, either when
18041 * another callback replaces @p func, the tooltip is unset with
18042 * elm_genlist_item_tooltip_unset() or the owner @p item
18043 * dies. This callback receives as its first parameter the
18044 * given @p data, being @c event_info the item handle.
18046 * This call will setup the tooltip's contents to @p item
18047 * (analogous to elm_object_tooltip_content_cb_set(), but being
18048 * item tooltips with higher precedence than object tooltips). It
18049 * can have only one tooltip at a time, so any previous tooltip
18050 * content will get removed. @p func (with @p data) will be called
18051 * every time Elementary needs to show the tooltip and it should
18052 * return a valid Evas object, which will be fully managed by the
18053 * tooltip system, getting deleted when the tooltip is gone.
18055 * In order to set just a text as a tooltip, look at
18056 * elm_genlist_item_tooltip_text_set().
18060 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);
18062 * Unset a tooltip from a given genlist item
18064 * @param item genlist item to remove a previously set tooltip from.
18066 * This call removes any tooltip set on @p item. The callback
18067 * provided as @c del_cb to
18068 * elm_genlist_item_tooltip_content_cb_set() will be called to
18069 * notify it is not used anymore (and have resources cleaned, if
18072 * @see elm_genlist_item_tooltip_content_cb_set()
18076 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18078 * Set a different @b style for a given genlist item's tooltip.
18080 * @param item genlist item with tooltip set
18081 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18082 * "default", @c "transparent", etc)
18084 * Tooltips can have <b>alternate styles</b> to be displayed on,
18085 * which are defined by the theme set on Elementary. This function
18086 * works analogously as elm_object_tooltip_style_set(), but here
18087 * applied only to genlist item objects. The default style for
18088 * tooltips is @c "default".
18090 * @note before you set a style you should define a tooltip with
18091 * elm_genlist_item_tooltip_content_cb_set() or
18092 * elm_genlist_item_tooltip_text_set()
18094 * @see elm_genlist_item_tooltip_style_get()
18098 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18100 * Get the style set a given genlist item's tooltip.
18102 * @param item genlist item with tooltip already set on.
18103 * @return style the theme style in use, which defaults to
18104 * "default". If the object does not have a tooltip set,
18105 * then @c NULL is returned.
18107 * @see elm_genlist_item_tooltip_style_set() for more details
18111 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18113 * @brief Disable size restrictions on an object's tooltip
18114 * @param item The tooltip's anchor object
18115 * @param disable If EINA_TRUE, size restrictions are disabled
18116 * @return EINA_FALSE on failure, EINA_TRUE on success
18118 * This function allows a tooltip to expand beyond its parant window's canvas.
18119 * It will instead be limited only by the size of the display.
18121 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18123 * @brief Retrieve size restriction state of an object's tooltip
18124 * @param item The tooltip's anchor object
18125 * @return If EINA_TRUE, size restrictions are disabled
18127 * This function returns whether a tooltip is allowed to expand beyond
18128 * its parant window's canvas.
18129 * It will instead be limited only by the size of the display.
18131 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18133 * Set the type of mouse pointer/cursor decoration to be shown,
18134 * when the mouse pointer is over the given genlist widget item
18136 * @param item genlist item to customize cursor on
18137 * @param cursor the cursor type's name
18139 * This function works analogously as elm_object_cursor_set(), but
18140 * here the cursor's changing area is restricted to the item's
18141 * area, and not the whole widget's. Note that that item cursors
18142 * have precedence over widget cursors, so that a mouse over @p
18143 * item will always show cursor @p type.
18145 * If this function is called twice for an object, a previously set
18146 * cursor will be unset on the second call.
18148 * @see elm_object_cursor_set()
18149 * @see elm_genlist_item_cursor_get()
18150 * @see elm_genlist_item_cursor_unset()
18154 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18156 * Get the type of mouse pointer/cursor decoration set to be shown,
18157 * when the mouse pointer is over the given genlist widget item
18159 * @param item genlist item with custom cursor set
18160 * @return the cursor type's name or @c NULL, if no custom cursors
18161 * were set to @p item (and on errors)
18163 * @see elm_object_cursor_get()
18164 * @see elm_genlist_item_cursor_set() for more details
18165 * @see elm_genlist_item_cursor_unset()
18169 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18171 * Unset any custom mouse pointer/cursor decoration set to be
18172 * shown, when the mouse pointer is over the given genlist widget
18173 * item, thus making it show the @b default cursor again.
18175 * @param item a genlist item
18177 * Use this call to undo any custom settings on this item's cursor
18178 * decoration, bringing it back to defaults (no custom style set).
18180 * @see elm_object_cursor_unset()
18181 * @see elm_genlist_item_cursor_set() for more details
18185 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18187 * Set a different @b style for a given custom cursor set for a
18190 * @param item genlist item with custom cursor set
18191 * @param style the <b>theme style</b> to use (e.g. @c "default",
18192 * @c "transparent", etc)
18194 * This function only makes sense when one is using custom mouse
18195 * cursor decorations <b>defined in a theme file</b> , which can
18196 * have, given a cursor name/type, <b>alternate styles</b> on
18197 * it. It works analogously as elm_object_cursor_style_set(), but
18198 * here applied only to genlist item objects.
18200 * @warning Before you set a cursor style you should have defined a
18201 * custom cursor previously on the item, with
18202 * elm_genlist_item_cursor_set()
18204 * @see elm_genlist_item_cursor_engine_only_set()
18205 * @see elm_genlist_item_cursor_style_get()
18209 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18211 * Get the current @b style set for a given genlist item's custom
18214 * @param item genlist item with custom cursor set.
18215 * @return style the cursor style in use. If the object does not
18216 * have a cursor set, then @c NULL is returned.
18218 * @see elm_genlist_item_cursor_style_set() for more details
18222 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18224 * Set if the (custom) cursor for a given genlist item should be
18225 * searched in its theme, also, or should only rely on the
18226 * rendering engine.
18228 * @param item item with custom (custom) cursor already set on
18229 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18230 * only on those provided by the rendering engine, @c EINA_FALSE to
18231 * have them searched on the widget's theme, as well.
18233 * @note This call is of use only if you've set a custom cursor
18234 * for genlist items, with elm_genlist_item_cursor_set().
18236 * @note By default, cursors will only be looked for between those
18237 * provided by the rendering engine.
18241 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18243 * Get if the (custom) cursor for a given genlist item is being
18244 * searched in its theme, also, or is only relying on the rendering
18247 * @param item a genlist item
18248 * @return @c EINA_TRUE, if cursors are being looked for only on
18249 * those provided by the rendering engine, @c EINA_FALSE if they
18250 * are being searched on the widget's theme, as well.
18252 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18256 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18258 * Update the contents of all realized items.
18260 * @param obj The genlist object.
18262 * This updates all realized items by calling all the item class functions again
18263 * to get the icons, labels and states. Use this when the original
18264 * item data has changed and the changes are desired to be reflected.
18266 * To update just one item, use elm_genlist_item_update().
18268 * @see elm_genlist_realized_items_get()
18269 * @see elm_genlist_item_update()
18273 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18275 * Activate a genlist mode on an item
18277 * @param item The genlist item
18278 * @param mode Mode name
18279 * @param mode_set Boolean to define set or unset mode.
18281 * A genlist mode is a different way of selecting an item. Once a mode is
18282 * activated on an item, any other selected item is immediately unselected.
18283 * This feature provides an easy way of implementing a new kind of animation
18284 * for selecting an item, without having to entirely rewrite the item style
18285 * theme. However, the elm_genlist_selected_* API can't be used to get what
18286 * item is activate for a mode.
18288 * The current item style will still be used, but applying a genlist mode to
18289 * an item will select it using a different kind of animation.
18291 * The current active item for a mode can be found by
18292 * elm_genlist_mode_item_get().
18294 * The characteristics of genlist mode are:
18295 * - Only one mode can be active at any time, and for only one item.
18296 * - Genlist handles deactivating other items when one item is activated.
18297 * - A mode is defined in the genlist theme (edc), and more modes can easily
18299 * - A mode style and the genlist item style are different things. They
18300 * can be combined to provide a default style to the item, with some kind
18301 * of animation for that item when the mode is activated.
18303 * When a mode is activated on an item, a new view for that item is created.
18304 * The theme of this mode defines the animation that will be used to transit
18305 * the item from the old view to the new view. This second (new) view will be
18306 * active for that item while the mode is active on the item, and will be
18307 * destroyed after the mode is totally deactivated from that item.
18309 * @see elm_genlist_mode_get()
18310 * @see elm_genlist_mode_item_get()
18314 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18316 * Get the last (or current) genlist mode used.
18318 * @param obj The genlist object
18320 * This function just returns the name of the last used genlist mode. It will
18321 * be the current mode if it's still active.
18323 * @see elm_genlist_item_mode_set()
18324 * @see elm_genlist_mode_item_get()
18328 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18330 * Get active genlist mode item
18332 * @param obj The genlist object
18333 * @return The active item for that current mode. Or @c NULL if no item is
18334 * activated with any mode.
18336 * This function returns the item that was activated with a mode, by the
18337 * function elm_genlist_item_mode_set().
18339 * @see elm_genlist_item_mode_set()
18340 * @see elm_genlist_mode_get()
18344 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18349 * @param obj The genlist object
18350 * @param reorder_mode The reorder mode
18351 * (EINA_TRUE = on, EINA_FALSE = off)
18355 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18358 * Get the reorder mode
18360 * @param obj The genlist object
18361 * @return The reorder mode
18362 * (EINA_TRUE = on, EINA_FALSE = off)
18366 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18373 * @defgroup Check Check
18375 * @image html img/widget/check/preview-00.png
18376 * @image latex img/widget/check/preview-00.eps
18377 * @image html img/widget/check/preview-01.png
18378 * @image latex img/widget/check/preview-01.eps
18379 * @image html img/widget/check/preview-02.png
18380 * @image latex img/widget/check/preview-02.eps
18382 * @brief The check widget allows for toggling a value between true and
18385 * Check objects are a lot like radio objects in layout and functionality
18386 * except they do not work as a group, but independently and only toggle the
18387 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18388 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18389 * returns the current state. For convenience, like the radio objects, you
18390 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18391 * for it to modify.
18393 * Signals that you can add callbacks for are:
18394 * "changed" - This is called whenever the user changes the state of one of
18395 * the check object(event_info is NULL).
18397 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18401 * @brief Add a new Check object
18403 * @param parent The parent object
18404 * @return The new object or NULL if it cannot be created
18406 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18408 * @brief Set the text label of the check object
18410 * @param obj The check object
18411 * @param label The text label string in UTF-8
18413 * @deprecated use elm_object_text_set() instead.
18415 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18417 * @brief Get the text label of the check object
18419 * @param obj The check object
18420 * @return The text label string in UTF-8
18422 * @deprecated use elm_object_text_get() instead.
18424 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18426 * @brief Set the icon object of the check object
18428 * @param obj The check object
18429 * @param icon The icon object
18431 * Once the icon object is set, a previously set one will be deleted.
18432 * If you want to keep that old content object, use the
18433 * elm_check_icon_unset() function.
18435 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18437 * @brief Get the icon object of the check object
18439 * @param obj The check object
18440 * @return The icon object
18442 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18444 * @brief Unset the icon used for the check object
18446 * @param obj The check object
18447 * @return The icon object that was being used
18449 * Unparent and return the icon object which was set for this widget.
18451 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18453 * @brief Set the on/off state of the check object
18455 * @param obj The check object
18456 * @param state The state to use (1 == on, 0 == off)
18458 * This sets the state of the check. If set
18459 * with elm_check_state_pointer_set() the state of that variable is also
18460 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18462 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18464 * @brief Get the state of the check object
18466 * @param obj The check object
18467 * @return The boolean state
18469 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18471 * @brief Set a convenience pointer to a boolean to change
18473 * @param obj The check object
18474 * @param statep Pointer to the boolean to modify
18476 * This sets a pointer to a boolean, that, in addition to the check objects
18477 * state will also be modified directly. To stop setting the object pointed
18478 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18479 * then when this is called, the check objects state will also be modified to
18480 * reflect the value of the boolean @p statep points to, just like calling
18481 * elm_check_state_set().
18483 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18489 * @defgroup Radio Radio
18491 * @image html img/widget/radio/preview-00.png
18492 * @image latex img/widget/radio/preview-00.eps
18494 * @brief Radio is a widget that allows for 1 or more options to be displayed
18495 * and have the user choose only 1 of them.
18497 * A radio object contains an indicator, an optional Label and an optional
18498 * icon object. While it's possible to have a group of only one radio they,
18499 * are normally used in groups of 2 or more. To add a radio to a group use
18500 * elm_radio_group_add(). The radio object(s) will select from one of a set
18501 * of integer values, so any value they are configuring needs to be mapped to
18502 * a set of integers. To configure what value that radio object represents,
18503 * use elm_radio_state_value_set() to set the integer it represents. To set
18504 * the value the whole group(which one is currently selected) is to indicate
18505 * use elm_radio_value_set() on any group member, and to get the groups value
18506 * use elm_radio_value_get(). For convenience the radio objects are also able
18507 * to directly set an integer(int) to the value that is selected. To specify
18508 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18509 * The radio objects will modify this directly. That implies the pointer must
18510 * point to valid memory for as long as the radio objects exist.
18512 * Signals that you can add callbacks for are:
18513 * @li changed - This is called whenever the user changes the state of one of
18514 * the radio objects within the group of radio objects that work together.
18516 * @ref tutorial_radio show most of this API in action.
18520 * @brief Add a new radio to the parent
18522 * @param parent The parent object
18523 * @return The new object or NULL if it cannot be created
18525 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18527 * @brief Set the text label of the radio object
18529 * @param obj The radio object
18530 * @param label The text label string in UTF-8
18532 * @deprecated use elm_object_text_set() instead.
18534 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18536 * @brief Get the text label of the radio object
18538 * @param obj The radio object
18539 * @return The text label string in UTF-8
18541 * @deprecated use elm_object_text_set() instead.
18543 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18545 * @brief Set the icon object of the radio object
18547 * @param obj The radio object
18548 * @param icon The icon object
18550 * Once the icon object is set, a previously set one will be deleted. If you
18551 * want to keep that old content object, use the elm_radio_icon_unset()
18554 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18556 * @brief Get the icon object of the radio object
18558 * @param obj The radio object
18559 * @return The icon object
18561 * @see elm_radio_icon_set()
18563 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18565 * @brief Unset the icon used for the radio object
18567 * @param obj The radio object
18568 * @return The icon object that was being used
18570 * Unparent and return the icon object which was set for this widget.
18572 * @see elm_radio_icon_set()
18574 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18576 * @brief Add this radio to a group of other radio objects
18578 * @param obj The radio object
18579 * @param group Any object whose group the @p obj is to join.
18581 * Radio objects work in groups. Each member should have a different integer
18582 * value assigned. In order to have them work as a group, they need to know
18583 * about each other. This adds the given radio object to the group of which
18584 * the group object indicated is a member.
18586 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18588 * @brief Set the integer value that this radio object represents
18590 * @param obj The radio object
18591 * @param value The value to use if this radio object is selected
18593 * This sets the value of the radio.
18595 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18597 * @brief Get the integer value that this radio object represents
18599 * @param obj The radio object
18600 * @return The value used if this radio object is selected
18602 * This gets the value of the radio.
18604 * @see elm_radio_value_set()
18606 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18608 * @brief Set the value of the radio.
18610 * @param obj The radio object
18611 * @param value The value to use for the group
18613 * This sets the value of the radio group and will also set the value if
18614 * pointed to, to the value supplied, but will not call any callbacks.
18616 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18618 * @brief Get the state of the radio object
18620 * @param obj The radio object
18621 * @return The integer state
18623 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18625 * @brief Set a convenience pointer to a integer to change
18627 * @param obj The radio object
18628 * @param valuep Pointer to the integer to modify
18630 * This sets a pointer to a integer, that, in addition to the radio objects
18631 * state will also be modified directly. To stop setting the object pointed
18632 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18633 * when this is called, the radio objects state will also be modified to
18634 * reflect the value of the integer valuep points to, just like calling
18635 * elm_radio_value_set().
18637 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18643 * @defgroup Pager Pager
18645 * @image html img/widget/pager/preview-00.png
18646 * @image latex img/widget/pager/preview-00.eps
18648 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18650 * The flipping between “pages” of objects is animated. All content in pager
18651 * is kept in a stack, the last content to be added will be on the top of the
18652 * stack(be visible).
18654 * Objects can be pushed or popped from the stack or deleted as normal.
18655 * Pushes and pops will animate (and a pop will delete the object once the
18656 * animation is finished). Any object already in the pager can be promoted to
18657 * the top(from its current stacking position) through the use of
18658 * elm_pager_content_promote(). Objects are pushed to the top with
18659 * elm_pager_content_push() and when the top item is no longer wanted, simply
18660 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18661 * object is no longer needed and is not the top item, just delete it as
18662 * normal. You can query which objects are the top and bottom with
18663 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18665 * Signals that you can add callbacks for are:
18666 * "hide,finished" - when the previous page is hided
18668 * This widget has the following styles available:
18671 * @li fade_translucide
18672 * @li fade_invisible
18673 * @note This styles affect only the flipping animations, the appearance when
18674 * not animating is unaffected by styles.
18676 * @ref tutorial_pager gives a good overview of the usage of the API.
18680 * Add a new pager to the parent
18682 * @param parent The parent object
18683 * @return The new object or NULL if it cannot be created
18687 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18689 * @brief Push an object to the top of the pager stack (and show it).
18691 * @param obj The pager object
18692 * @param content The object to push
18694 * The object pushed becomes a child of the pager, it will be controlled and
18695 * deleted when the pager is deleted.
18697 * @note If the content is already in the stack use
18698 * elm_pager_content_promote().
18699 * @warning Using this function on @p content already in the stack results in
18700 * undefined behavior.
18702 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18704 * @brief Pop the object that is on top of the stack
18706 * @param obj The pager object
18708 * This pops the object that is on the top(visible) of the pager, makes it
18709 * disappear, then deletes the object. The object that was underneath it on
18710 * the stack will become visible.
18712 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18714 * @brief Moves an object already in the pager stack to the top of the stack.
18716 * @param obj The pager object
18717 * @param content The object to promote
18719 * This will take the @p content and move it to the top of the stack as
18720 * if it had been pushed there.
18722 * @note If the content isn't already in the stack use
18723 * elm_pager_content_push().
18724 * @warning Using this function on @p content not already in the stack
18725 * results in undefined behavior.
18727 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18729 * @brief Return the object at the bottom of the pager stack
18731 * @param obj The pager object
18732 * @return The bottom object or NULL if none
18734 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18736 * @brief Return the object at the top of the pager stack
18738 * @param obj The pager object
18739 * @return The top object or NULL if none
18741 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18747 * @defgroup Slideshow Slideshow
18749 * @image html img/widget/slideshow/preview-00.png
18750 * @image latex img/widget/slideshow/preview-00.eps
18752 * This widget, as the name indicates, is a pre-made image
18753 * slideshow panel, with API functions acting on (child) image
18754 * items presentation. Between those actions, are:
18755 * - advance to next/previous image
18756 * - select the style of image transition animation
18757 * - set the exhibition time for each image
18758 * - start/stop the slideshow
18760 * The transition animations are defined in the widget's theme,
18761 * consequently new animations can be added without having to
18762 * update the widget's code.
18764 * @section Slideshow_Items Slideshow items
18766 * For slideshow items, just like for @ref Genlist "genlist" ones,
18767 * the user defines a @b classes, specifying functions that will be
18768 * called on the item's creation and deletion times.
18770 * The #Elm_Slideshow_Item_Class structure contains the following
18773 * - @c func.get - When an item is displayed, this function is
18774 * called, and it's where one should create the item object, de
18775 * facto. For example, the object can be a pure Evas image object
18776 * or an Elementary @ref Photocam "photocam" widget. See
18777 * #SlideshowItemGetFunc.
18778 * - @c func.del - When an item is no more displayed, this function
18779 * is called, where the user must delete any data associated to
18780 * the item. See #SlideshowItemDelFunc.
18782 * @section Slideshow_Caching Slideshow caching
18784 * The slideshow provides facilities to have items adjacent to the
18785 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18786 * you, so that the system does not have to decode image data
18787 * anymore at the time it has to actually switch images on its
18788 * viewport. The user is able to set the numbers of items to be
18789 * cached @b before and @b after the current item, in the widget's
18792 * Smart events one can add callbacks for are:
18794 * - @c "changed" - when the slideshow switches its view to a new
18797 * List of examples for the slideshow widget:
18798 * @li @ref slideshow_example
18802 * @addtogroup Slideshow
18806 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18807 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18808 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18809 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18810 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18813 * @struct _Elm_Slideshow_Item_Class
18815 * Slideshow item class definition. See @ref Slideshow_Items for
18818 struct _Elm_Slideshow_Item_Class
18820 struct _Elm_Slideshow_Item_Class_Func
18822 SlideshowItemGetFunc get;
18823 SlideshowItemDelFunc del;
18825 }; /**< #Elm_Slideshow_Item_Class member definitions */
18828 * Add a new slideshow widget to the given parent Elementary
18829 * (container) object
18831 * @param parent The parent object
18832 * @return A new slideshow widget handle or @c NULL, on errors
18834 * This function inserts a new slideshow widget on the canvas.
18836 * @ingroup Slideshow
18838 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18841 * Add (append) a new item in a given slideshow widget.
18843 * @param obj The slideshow object
18844 * @param itc The item class for the item
18845 * @param data The item's data
18846 * @return A handle to the item added or @c NULL, on errors
18848 * Add a new item to @p obj's internal list of items, appending it.
18849 * The item's class must contain the function really fetching the
18850 * image object to show for this item, which could be an Evas image
18851 * object or an Elementary photo, for example. The @p data
18852 * parameter is going to be passed to both class functions of the
18855 * @see #Elm_Slideshow_Item_Class
18856 * @see elm_slideshow_item_sorted_insert()
18858 * @ingroup Slideshow
18860 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18863 * Insert a new item into the given slideshow widget, using the @p func
18864 * function to sort items (by item handles).
18866 * @param obj The slideshow object
18867 * @param itc The item class for the item
18868 * @param data The item's data
18869 * @param func The comparing function to be used to sort slideshow
18870 * items <b>by #Elm_Slideshow_Item item handles</b>
18871 * @return Returns The slideshow item handle, on success, or
18872 * @c NULL, on errors
18874 * Add a new item to @p obj's internal list of items, in a position
18875 * determined by the @p func comparing function. The item's class
18876 * must contain the function really fetching the image object to
18877 * show for this item, which could be an Evas image object or an
18878 * Elementary photo, for example. The @p data parameter is going to
18879 * be passed to both class functions of the item.
18881 * @see #Elm_Slideshow_Item_Class
18882 * @see elm_slideshow_item_add()
18884 * @ingroup Slideshow
18886 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);
18889 * Display a given slideshow widget's item, programmatically.
18891 * @param obj The slideshow object
18892 * @param item The item to display on @p obj's viewport
18894 * The change between the current item and @p item will use the
18895 * transition @p obj is set to use (@see
18896 * elm_slideshow_transition_set()).
18898 * @ingroup Slideshow
18900 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18903 * Slide to the @b next item, in a given slideshow widget
18905 * @param obj The slideshow object
18907 * The sliding animation @p obj is set to use will be the
18908 * transition effect used, after this call is issued.
18910 * @note If the end of the slideshow's internal list of items is
18911 * reached, it'll wrap around to the list's beginning, again.
18913 * @ingroup Slideshow
18915 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18918 * Slide to the @b previous item, in a given slideshow widget
18920 * @param obj The slideshow object
18922 * The sliding animation @p obj is set to use will be the
18923 * transition effect used, after this call is issued.
18925 * @note If the beginning of the slideshow's internal list of items
18926 * is reached, it'll wrap around to the list's end, again.
18928 * @ingroup Slideshow
18930 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18933 * Returns the list of sliding transition/effect names available, for a
18934 * given slideshow widget.
18936 * @param obj The slideshow object
18937 * @return The list of transitions (list of @b stringshared strings
18940 * The transitions, which come from @p obj's theme, must be an EDC
18941 * data item named @c "transitions" on the theme file, with (prefix)
18942 * names of EDC programs actually implementing them.
18944 * The available transitions for slideshows on the default theme are:
18945 * - @c "fade" - the current item fades out, while the new one
18946 * fades in to the slideshow's viewport.
18947 * - @c "black_fade" - the current item fades to black, and just
18948 * then, the new item will fade in.
18949 * - @c "horizontal" - the current item slides horizontally, until
18950 * it gets out of the slideshow's viewport, while the new item
18951 * comes from the left to take its place.
18952 * - @c "vertical" - the current item slides vertically, until it
18953 * gets out of the slideshow's viewport, while the new item comes
18954 * from the bottom to take its place.
18955 * - @c "square" - the new item starts to appear from the middle of
18956 * the current one, but with a tiny size, growing until its
18957 * target (full) size and covering the old one.
18959 * @warning The stringshared strings get no new references
18960 * exclusive to the user grabbing the list, here, so if you'd like
18961 * to use them out of this call's context, you'd better @c
18962 * eina_stringshare_ref() them.
18964 * @see elm_slideshow_transition_set()
18966 * @ingroup Slideshow
18968 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18971 * Set the current slide transition/effect in use for a given
18974 * @param obj The slideshow object
18975 * @param transition The new transition's name string
18977 * If @p transition is implemented in @p obj's theme (i.e., is
18978 * contained in the list returned by
18979 * elm_slideshow_transitions_get()), this new sliding effect will
18980 * be used on the widget.
18982 * @see elm_slideshow_transitions_get() for more details
18984 * @ingroup Slideshow
18986 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18989 * Get the current slide transition/effect in use for a given
18992 * @param obj The slideshow object
18993 * @return The current transition's name
18995 * @see elm_slideshow_transition_set() for more details
18997 * @ingroup Slideshow
18999 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19002 * Set the interval between each image transition on a given
19003 * slideshow widget, <b>and start the slideshow, itself</b>
19005 * @param obj The slideshow object
19006 * @param timeout The new displaying timeout for images
19008 * After this call, the slideshow widget will start cycling its
19009 * view, sequentially and automatically, with the images of the
19010 * items it has. The time between each new image displayed is going
19011 * to be @p timeout, in @b seconds. If a different timeout was set
19012 * previously and an slideshow was in progress, it will continue
19013 * with the new time between transitions, after this call.
19015 * @note A value less than or equal to 0 on @p timeout will disable
19016 * the widget's internal timer, thus halting any slideshow which
19017 * could be happening on @p obj.
19019 * @see elm_slideshow_timeout_get()
19021 * @ingroup Slideshow
19023 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19026 * Get the interval set for image transitions on a given slideshow
19029 * @param obj The slideshow object
19030 * @return Returns the timeout set on it
19032 * @see elm_slideshow_timeout_set() for more details
19034 * @ingroup Slideshow
19036 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19039 * Set if, after a slideshow is started, for a given slideshow
19040 * widget, its items should be displayed cyclically or not.
19042 * @param obj The slideshow object
19043 * @param loop Use @c EINA_TRUE to make it cycle through items or
19044 * @c EINA_FALSE for it to stop at the end of @p obj's internal
19047 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19048 * ignore what is set by this functions, i.e., they'll @b always
19049 * cycle through items. This affects only the "automatic"
19050 * slideshow, as set by elm_slideshow_timeout_set().
19052 * @see elm_slideshow_loop_get()
19054 * @ingroup Slideshow
19056 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19059 * Get if, after a slideshow is started, for a given slideshow
19060 * widget, its items are to be displayed cyclically or not.
19062 * @param obj The slideshow object
19063 * @return @c EINA_TRUE, if the items in @p obj will be cycled
19064 * through or @c EINA_FALSE, otherwise
19066 * @see elm_slideshow_loop_set() for more details
19068 * @ingroup Slideshow
19070 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19073 * Remove all items from a given slideshow widget
19075 * @param obj The slideshow object
19077 * This removes (and deletes) all items in @p obj, leaving it
19080 * @see elm_slideshow_item_del(), to remove just one item.
19082 * @ingroup Slideshow
19084 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19087 * Get the internal list of items in a given slideshow widget.
19089 * @param obj The slideshow object
19090 * @return The list of items (#Elm_Slideshow_Item as data) or
19091 * @c NULL on errors.
19093 * This list is @b not to be modified in any way and must not be
19094 * freed. Use the list members with functions like
19095 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19097 * @warning This list is only valid until @p obj object's internal
19098 * items list is changed. It should be fetched again with another
19099 * call to this function when changes happen.
19101 * @ingroup Slideshow
19103 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19106 * Delete a given item from a slideshow widget.
19108 * @param item The slideshow item
19110 * @ingroup Slideshow
19112 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19115 * Return the data associated with a given slideshow item
19117 * @param item The slideshow item
19118 * @return Returns the data associated to this item
19120 * @ingroup Slideshow
19122 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19125 * Returns the currently displayed item, in a given slideshow widget
19127 * @param obj The slideshow object
19128 * @return A handle to the item being displayed in @p obj or
19129 * @c NULL, if none is (and on errors)
19131 * @ingroup Slideshow
19133 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19136 * Get the real Evas object created to implement the view of a
19137 * given slideshow item
19139 * @param item The slideshow item.
19140 * @return the Evas object implementing this item's view.
19142 * This returns the actual Evas object used to implement the
19143 * specified slideshow item's view. This may be @c NULL, as it may
19144 * not have been created or may have been deleted, at any time, by
19145 * the slideshow. <b>Do not modify this object</b> (move, resize,
19146 * show, hide, etc.), as the slideshow is controlling it. This
19147 * function is for querying, emitting custom signals or hooking
19148 * lower level callbacks for events on that object. Do not delete
19149 * this object under any circumstances.
19151 * @see elm_slideshow_item_data_get()
19153 * @ingroup Slideshow
19155 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19158 * Get the the item, in a given slideshow widget, placed at
19159 * position @p nth, in its internal items list
19161 * @param obj The slideshow object
19162 * @param nth The number of the item to grab a handle to (0 being
19164 * @return The item stored in @p obj at position @p nth or @c NULL,
19165 * if there's no item with that index (and on errors)
19167 * @ingroup Slideshow
19169 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19172 * Set the current slide layout in use for a given slideshow widget
19174 * @param obj The slideshow object
19175 * @param layout The new layout's name string
19177 * If @p layout is implemented in @p obj's theme (i.e., is contained
19178 * in the list returned by elm_slideshow_layouts_get()), this new
19179 * images layout will be used on the widget.
19181 * @see elm_slideshow_layouts_get() for more details
19183 * @ingroup Slideshow
19185 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19188 * Get the current slide layout in use for a given slideshow widget
19190 * @param obj The slideshow object
19191 * @return The current layout's name
19193 * @see elm_slideshow_layout_set() for more details
19195 * @ingroup Slideshow
19197 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19200 * Returns the list of @b layout names available, for a given
19201 * slideshow widget.
19203 * @param obj The slideshow object
19204 * @return The list of layouts (list of @b stringshared strings
19207 * Slideshow layouts will change how the widget is to dispose each
19208 * image item in its viewport, with regard to cropping, scaling,
19211 * The layouts, which come from @p obj's theme, must be an EDC
19212 * data item name @c "layouts" on the theme file, with (prefix)
19213 * names of EDC programs actually implementing them.
19215 * The available layouts for slideshows on the default theme are:
19216 * - @c "fullscreen" - item images with original aspect, scaled to
19217 * touch top and down slideshow borders or, if the image's heigh
19218 * is not enough, left and right slideshow borders.
19219 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19220 * one, but always leaving 10% of the slideshow's dimensions of
19221 * distance between the item image's borders and the slideshow
19222 * borders, for each axis.
19224 * @warning The stringshared strings get no new references
19225 * exclusive to the user grabbing the list, here, so if you'd like
19226 * to use them out of this call's context, you'd better @c
19227 * eina_stringshare_ref() them.
19229 * @see elm_slideshow_layout_set()
19231 * @ingroup Slideshow
19233 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19236 * Set the number of items to cache, on a given slideshow widget,
19237 * <b>before the current item</b>
19239 * @param obj The slideshow object
19240 * @param count Number of items to cache before the current one
19242 * The default value for this property is @c 2. See
19243 * @ref Slideshow_Caching "slideshow caching" for more details.
19245 * @see elm_slideshow_cache_before_get()
19247 * @ingroup Slideshow
19249 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19252 * Retrieve the number of items to cache, on a given slideshow widget,
19253 * <b>before the current item</b>
19255 * @param obj The slideshow object
19256 * @return The number of items set to be cached before the current one
19258 * @see elm_slideshow_cache_before_set() for more details
19260 * @ingroup Slideshow
19262 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19265 * Set the number of items to cache, on a given slideshow widget,
19266 * <b>after the current item</b>
19268 * @param obj The slideshow object
19269 * @param count Number of items to cache after the current one
19271 * The default value for this property is @c 2. See
19272 * @ref Slideshow_Caching "slideshow caching" for more details.
19274 * @see elm_slideshow_cache_after_get()
19276 * @ingroup Slideshow
19278 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19281 * Retrieve the number of items to cache, on a given slideshow widget,
19282 * <b>after the current item</b>
19284 * @param obj The slideshow object
19285 * @return The number of items set to be cached after the current one
19287 * @see elm_slideshow_cache_after_set() for more details
19289 * @ingroup Slideshow
19291 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19294 * Get the number of items stored in a given slideshow widget
19296 * @param obj The slideshow object
19297 * @return The number of items on @p obj, at the moment of this call
19299 * @ingroup Slideshow
19301 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19308 * @defgroup Fileselector File Selector
19310 * @image html img/widget/fileselector/preview-00.png
19311 * @image latex img/widget/fileselector/preview-00.eps
19313 * A file selector is a widget that allows a user to navigate
19314 * through a file system, reporting file selections back via its
19317 * It contains shortcut buttons for home directory (@c ~) and to
19318 * jump one directory upwards (..), as well as cancel/ok buttons to
19319 * confirm/cancel a given selection. After either one of those two
19320 * former actions, the file selector will issue its @c "done" smart
19323 * There's a text entry on it, too, showing the name of the current
19324 * selection. There's the possibility of making it editable, so it
19325 * is useful on file saving dialogs on applications, where one
19326 * gives a file name to save contents to, in a given directory in
19327 * the system. This custom file name will be reported on the @c
19328 * "done" smart callback (explained in sequence).
19330 * Finally, it has a view to display file system items into in two
19335 * If Elementary is built with support of the Ethumb thumbnailing
19336 * library, the second form of view will display preview thumbnails
19337 * of files which it supports.
19339 * Smart callbacks one can register to:
19341 * - @c "selected" - the user has clicked on a file (when not in
19342 * folders-only mode) or directory (when in folders-only mode)
19343 * - @c "directory,open" - the list has been populated with new
19344 * content (@c event_info is a pointer to the directory's
19345 * path, a @b stringshared string)
19346 * - @c "done" - the user has clicked on the "ok" or "cancel"
19347 * buttons (@c event_info is a pointer to the selection's
19348 * path, a @b stringshared string)
19350 * Here is an example on its usage:
19351 * @li @ref fileselector_example
19355 * @addtogroup Fileselector
19360 * Defines how a file selector widget is to layout its contents
19361 * (file system entries).
19363 typedef enum _Elm_Fileselector_Mode
19365 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19366 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19367 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19368 } Elm_Fileselector_Mode;
19371 * Add a new file selector widget to the given parent Elementary
19372 * (container) object
19374 * @param parent The parent object
19375 * @return a new file selector widget handle or @c NULL, on errors
19377 * This function inserts a new file selector widget on the canvas.
19379 * @ingroup Fileselector
19381 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19384 * Enable/disable the file name entry box where the user can type
19385 * in a name for a file, in a given file selector widget
19387 * @param obj The file selector object
19388 * @param is_save @c EINA_TRUE to make the file selector a "saving
19389 * dialog", @c EINA_FALSE otherwise
19391 * Having the entry editable is useful on file saving dialogs on
19392 * applications, where one gives a file name to save contents to,
19393 * in a given directory in the system. This custom file name will
19394 * be reported on the @c "done" smart callback.
19396 * @see elm_fileselector_is_save_get()
19398 * @ingroup Fileselector
19400 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19403 * Get whether the given file selector is in "saving dialog" mode
19405 * @param obj The file selector object
19406 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19407 * mode, @c EINA_FALSE otherwise (and on errors)
19409 * @see elm_fileselector_is_save_set() for more details
19411 * @ingroup Fileselector
19413 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19416 * Enable/disable folder-only view for a given file selector widget
19418 * @param obj The file selector object
19419 * @param only @c EINA_TRUE to make @p obj only display
19420 * directories, @c EINA_FALSE to make files to be displayed in it
19423 * If enabled, the widget's view will only display folder items,
19426 * @see elm_fileselector_folder_only_get()
19428 * @ingroup Fileselector
19430 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19433 * Get whether folder-only view is set for a given file selector
19436 * @param obj The file selector object
19437 * @return only @c EINA_TRUE if @p obj is only displaying
19438 * directories, @c EINA_FALSE if files are being displayed in it
19439 * too (and on errors)
19441 * @see elm_fileselector_folder_only_get()
19443 * @ingroup Fileselector
19445 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19448 * Enable/disable the "ok" and "cancel" buttons on a given file
19451 * @param obj The file selector object
19452 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19454 * @note A file selector without those buttons will never emit the
19455 * @c "done" smart event, and is only usable if one is just hooking
19456 * to the other two events.
19458 * @see elm_fileselector_buttons_ok_cancel_get()
19460 * @ingroup Fileselector
19462 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19465 * Get whether the "ok" and "cancel" buttons on a given file
19466 * selector widget are being shown.
19468 * @param obj The file selector object
19469 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19470 * otherwise (and on errors)
19472 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19474 * @ingroup Fileselector
19476 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19479 * Enable/disable a tree view in the given file selector widget,
19480 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19482 * @param obj The file selector object
19483 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19486 * In a tree view, arrows are created on the sides of directories,
19487 * allowing them to expand in place.
19489 * @note If it's in other mode, the changes made by this function
19490 * will only be visible when one switches back to "list" mode.
19492 * @see elm_fileselector_expandable_get()
19494 * @ingroup Fileselector
19496 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19499 * Get whether tree view is enabled for the given file selector
19502 * @param obj The file selector object
19503 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19504 * otherwise (and or errors)
19506 * @see elm_fileselector_expandable_set() for more details
19508 * @ingroup Fileselector
19510 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19513 * Set, programmatically, the @b directory that a given file
19514 * selector widget will display contents from
19516 * @param obj The file selector object
19517 * @param path The path to display in @p obj
19519 * This will change the @b directory that @p obj is displaying. It
19520 * will also clear the text entry area on the @p obj object, which
19521 * displays select files' names.
19523 * @see elm_fileselector_path_get()
19525 * @ingroup Fileselector
19527 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19530 * Get the parent directory's path that a given file selector
19531 * widget is displaying
19533 * @param obj The file selector object
19534 * @return The (full) path of the directory the file selector is
19535 * displaying, a @b stringshared string
19537 * @see elm_fileselector_path_set()
19539 * @ingroup Fileselector
19541 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19544 * Set, programmatically, the currently selected file/directory in
19545 * the given file selector widget
19547 * @param obj The file selector object
19548 * @param path The (full) path to a file or directory
19549 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19550 * latter case occurs if the directory or file pointed to do not
19553 * @see elm_fileselector_selected_get()
19555 * @ingroup Fileselector
19557 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19560 * Get the currently selected item's (full) path, in the given file
19563 * @param obj The file selector object
19564 * @return The absolute path of the selected item, a @b
19565 * stringshared string
19567 * @note Custom editions on @p obj object's text entry, if made,
19568 * will appear on the return string of this function, naturally.
19570 * @see elm_fileselector_selected_set() for more details
19572 * @ingroup Fileselector
19574 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19577 * Set the mode in which a given file selector widget will display
19578 * (layout) file system entries in its view
19580 * @param obj The file selector object
19581 * @param mode The mode of the fileselector, being it one of
19582 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19583 * first one, naturally, will display the files in a list. The
19584 * latter will make the widget to display its entries in a grid
19587 * @note By using elm_fileselector_expandable_set(), the user may
19588 * trigger a tree view for that list.
19590 * @note If Elementary is built with support of the Ethumb
19591 * thumbnailing library, the second form of view will display
19592 * preview thumbnails of files which it supports. You must have
19593 * elm_need_ethumb() called in your Elementary for thumbnailing to
19596 * @see elm_fileselector_expandable_set().
19597 * @see elm_fileselector_mode_get().
19599 * @ingroup Fileselector
19601 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19604 * Get the mode in which a given file selector widget is displaying
19605 * (layouting) file system entries in its view
19607 * @param obj The fileselector object
19608 * @return The mode in which the fileselector is at
19610 * @see elm_fileselector_mode_set() for more details
19612 * @ingroup Fileselector
19614 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19621 * @defgroup Progressbar Progress bar
19623 * The progress bar is a widget for visually representing the
19624 * progress status of a given job/task.
19626 * A progress bar may be horizontal or vertical. It may display an
19627 * icon besides it, as well as primary and @b units labels. The
19628 * former is meant to label the widget as a whole, while the
19629 * latter, which is formatted with floating point values (and thus
19630 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19631 * units"</c>), is meant to label the widget's <b>progress
19632 * value</b>. Label, icon and unit strings/objects are @b optional
19633 * for progress bars.
19635 * A progress bar may be @b inverted, in which state it gets its
19636 * values inverted, with high values being on the left or top and
19637 * low values on the right or bottom, as opposed to normally have
19638 * the low values on the former and high values on the latter,
19639 * respectively, for horizontal and vertical modes.
19641 * The @b span of the progress, as set by
19642 * elm_progressbar_span_size_set(), is its length (horizontally or
19643 * vertically), unless one puts size hints on the widget to expand
19644 * on desired directions, by any container. That length will be
19645 * scaled by the object or applications scaling factor. At any
19646 * point code can query the progress bar for its value with
19647 * elm_progressbar_value_get().
19649 * Available widget styles for progress bars:
19651 * - @c "wheel" (simple style, no text, no progression, only
19652 * "pulse" effect is available)
19654 * Here is an example on its usage:
19655 * @li @ref progressbar_example
19659 * Add a new progress bar widget to the given parent Elementary
19660 * (container) object
19662 * @param parent The parent object
19663 * @return a new progress bar widget handle or @c NULL, on errors
19665 * This function inserts a new progress bar widget on the canvas.
19667 * @ingroup Progressbar
19669 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19672 * Set whether a given progress bar widget is at "pulsing mode" or
19675 * @param obj The progress bar object
19676 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19677 * @c EINA_FALSE to put it back to its default one
19679 * By default, progress bars will display values from the low to
19680 * high value boundaries. There are, though, contexts in which the
19681 * state of progression of a given task is @b unknown. For those,
19682 * one can set a progress bar widget to a "pulsing state", to give
19683 * the user an idea that some computation is being held, but
19684 * without exact progress values. In the default theme it will
19685 * animate its bar with the contents filling in constantly and back
19686 * to non-filled, in a loop. To start and stop this pulsing
19687 * animation, one has to explicitly call elm_progressbar_pulse().
19689 * @see elm_progressbar_pulse_get()
19690 * @see elm_progressbar_pulse()
19692 * @ingroup Progressbar
19694 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19697 * Get whether a given progress bar widget is at "pulsing mode" or
19700 * @param obj The progress bar object
19701 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19702 * if it's in the default one (and on errors)
19704 * @ingroup Progressbar
19706 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19709 * Start/stop a given progress bar "pulsing" animation, if its
19712 * @param obj The progress bar object
19713 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19714 * @c EINA_FALSE to @b stop it
19716 * @note This call won't do anything if @p obj is not under "pulsing mode".
19718 * @see elm_progressbar_pulse_set() for more details.
19720 * @ingroup Progressbar
19722 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19725 * Set the progress value (in percentage) on a given progress bar
19728 * @param obj The progress bar object
19729 * @param val The progress value (@b must be between @c 0.0 and @c
19732 * Use this call to set progress bar levels.
19734 * @note If you passes a value out of the specified range for @p
19735 * val, it will be interpreted as the @b closest of the @b boundary
19736 * values in the range.
19738 * @ingroup Progressbar
19740 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19743 * Get the progress value (in percentage) on a given progress bar
19746 * @param obj The progress bar object
19747 * @return The value of the progressbar
19749 * @see elm_progressbar_value_set() for more details
19751 * @ingroup Progressbar
19753 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19756 * Set the label of a given progress bar widget
19758 * @param obj The progress bar object
19759 * @param label The text label string, in UTF-8
19761 * @ingroup Progressbar
19762 * @deprecated use elm_object_text_set() instead.
19764 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19767 * Get the label of a given progress bar widget
19769 * @param obj The progressbar object
19770 * @return The text label string, in UTF-8
19772 * @ingroup Progressbar
19773 * @deprecated use elm_object_text_set() instead.
19775 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19778 * Set the icon object of a given progress bar widget
19780 * @param obj The progress bar object
19781 * @param icon The icon object
19783 * Use this call to decorate @p obj with an icon next to it.
19785 * @note Once the icon object is set, a previously set one will be
19786 * deleted. If you want to keep that old content object, use the
19787 * elm_progressbar_icon_unset() function.
19789 * @see elm_progressbar_icon_get()
19791 * @ingroup Progressbar
19793 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19796 * Retrieve the icon object set for a given progress bar widget
19798 * @param obj The progress bar object
19799 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19800 * otherwise (and on errors)
19802 * @see elm_progressbar_icon_set() for more details
19804 * @ingroup Progressbar
19806 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19809 * Unset an icon set on a given progress bar widget
19811 * @param obj The progress bar object
19812 * @return The icon object that was being used, if any was set, or
19813 * @c NULL, otherwise (and on errors)
19815 * This call will unparent and return the icon object which was set
19816 * for this widget, previously, on success.
19818 * @see elm_progressbar_icon_set() for more details
19820 * @ingroup Progressbar
19822 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19825 * Set the (exact) length of the bar region of a given progress bar
19828 * @param obj The progress bar object
19829 * @param size The length of the progress bar's bar region
19831 * This sets the minimum width (when in horizontal mode) or height
19832 * (when in vertical mode) of the actual bar area of the progress
19833 * bar @p obj. This in turn affects the object's minimum size. Use
19834 * this when you're not setting other size hints expanding on the
19835 * given direction (like weight and alignment hints) and you would
19836 * like it to have a specific size.
19838 * @note Icon, label and unit text around @p obj will require their
19839 * own space, which will make @p obj to require more the @p size,
19842 * @see elm_progressbar_span_size_get()
19844 * @ingroup Progressbar
19846 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19849 * Get the length set for the bar region of a given progress bar
19852 * @param obj The progress bar object
19853 * @return The length of the progress bar's bar region
19855 * If that size was not set previously, with
19856 * elm_progressbar_span_size_set(), this call will return @c 0.
19858 * @ingroup Progressbar
19860 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19863 * Set the format string for a given progress bar widget's units
19866 * @param obj The progress bar object
19867 * @param format The format string for @p obj's units label
19869 * If @c NULL is passed on @p format, it will make @p obj's units
19870 * area to be hidden completely. If not, it'll set the <b>format
19871 * string</b> for the units label's @b text. The units label is
19872 * provided a floating point value, so the units text is up display
19873 * at most one floating point falue. Note that the units label is
19874 * optional. Use a format string such as "%1.2f meters" for
19877 * @note The default format string for a progress bar is an integer
19878 * percentage, as in @c "%.0f %%".
19880 * @see elm_progressbar_unit_format_get()
19882 * @ingroup Progressbar
19884 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19887 * Retrieve the format string set for a given progress bar widget's
19890 * @param obj The progress bar object
19891 * @return The format set string for @p obj's units label or
19892 * @c NULL, if none was set (and on errors)
19894 * @see elm_progressbar_unit_format_set() for more details
19896 * @ingroup Progressbar
19898 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19901 * Set the orientation of a given progress bar widget
19903 * @param obj The progress bar object
19904 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19905 * @b horizontal, @c EINA_FALSE to make it @b vertical
19907 * Use this function to change how your progress bar is to be
19908 * disposed: vertically or horizontally.
19910 * @see elm_progressbar_horizontal_get()
19912 * @ingroup Progressbar
19914 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19917 * Retrieve the orientation of a given progress bar widget
19919 * @param obj The progress bar object
19920 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19921 * @c EINA_FALSE if it's @b vertical (and on errors)
19923 * @see elm_progressbar_horizontal_set() for more details
19925 * @ingroup Progressbar
19927 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19930 * Invert a given progress bar widget's displaying values order
19932 * @param obj The progress bar object
19933 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19934 * @c EINA_FALSE to bring it back to default, non-inverted values.
19936 * A progress bar may be @b inverted, in which state it gets its
19937 * values inverted, with high values being on the left or top and
19938 * low values on the right or bottom, as opposed to normally have
19939 * the low values on the former and high values on the latter,
19940 * respectively, for horizontal and vertical modes.
19942 * @see elm_progressbar_inverted_get()
19944 * @ingroup Progressbar
19946 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19949 * Get whether a given progress bar widget's displaying values are
19952 * @param obj The progress bar object
19953 * @return @c EINA_TRUE, if @p obj has inverted values,
19954 * @c EINA_FALSE otherwise (and on errors)
19956 * @see elm_progressbar_inverted_set() for more details
19958 * @ingroup Progressbar
19960 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19963 * @defgroup Separator Separator
19965 * @brief Separator is a very thin object used to separate other objects.
19967 * A separator can be vertical or horizontal.
19969 * @ref tutorial_separator is a good example of how to use a separator.
19973 * @brief Add a separator object to @p parent
19975 * @param parent The parent object
19977 * @return The separator object, or NULL upon failure
19979 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19981 * @brief Set the horizontal mode of a separator object
19983 * @param obj The separator object
19984 * @param horizontal If true, the separator is horizontal
19986 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19988 * @brief Get the horizontal mode of a separator object
19990 * @param obj The separator object
19991 * @return If true, the separator is horizontal
19993 * @see elm_separator_horizontal_set()
19995 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20001 * @defgroup Spinner Spinner
20002 * @ingroup Elementary
20004 * @image html img/widget/spinner/preview-00.png
20005 * @image latex img/widget/spinner/preview-00.eps
20007 * A spinner is a widget which allows the user to increase or decrease
20008 * numeric values using arrow buttons, or edit values directly, clicking
20009 * over it and typing the new value.
20011 * By default the spinner will not wrap and has a label
20012 * of "%.0f" (just showing the integer value of the double).
20014 * A spinner has a label that is formatted with floating
20015 * point values and thus accepts a printf-style format string, like
20018 * It also allows specific values to be replaced by pre-defined labels.
20020 * Smart callbacks one can register to:
20022 * - "changed" - Whenever the spinner value is changed.
20023 * - "delay,changed" - A short time after the value is changed by the user.
20024 * This will be called only when the user stops dragging for a very short
20025 * period or when they release their finger/mouse, so it avoids possibly
20026 * expensive reactions to the value change.
20028 * Available styles for it:
20030 * - @c "vertical": up/down buttons at the right side and text left aligned.
20032 * Here is an example on its usage:
20033 * @ref spinner_example
20037 * @addtogroup Spinner
20042 * Add a new spinner widget to the given parent Elementary
20043 * (container) object.
20045 * @param parent The parent object.
20046 * @return a new spinner widget handle or @c NULL, on errors.
20048 * This function inserts a new spinner widget on the canvas.
20053 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20056 * Set the format string of the displayed label.
20058 * @param obj The spinner object.
20059 * @param fmt The format string for the label display.
20061 * If @c NULL, this sets the format to "%.0f". If not it sets the format
20062 * string for the label text. The label text is provided a floating point
20063 * value, so the label text can display up to 1 floating point value.
20064 * Note that this is optional.
20066 * Use a format string such as "%1.2f meters" for example, and it will
20067 * display values like: "3.14 meters" for a value equal to 3.14159.
20069 * Default is "%0.f".
20071 * @see elm_spinner_label_format_get()
20075 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20078 * Get the label format of the spinner.
20080 * @param obj The spinner object.
20081 * @return The text label format string in UTF-8.
20083 * @see elm_spinner_label_format_set() for details.
20087 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20090 * Set the minimum and maximum values for the spinner.
20092 * @param obj The spinner object.
20093 * @param min The minimum value.
20094 * @param max The maximum value.
20096 * Define the allowed range of values to be selected by the user.
20098 * If actual value is less than @p min, it will be updated to @p min. If it
20099 * is bigger then @p max, will be updated to @p max. Actual value can be
20100 * get with elm_spinner_value_get().
20102 * By default, min is equal to 0, and max is equal to 100.
20104 * @warning Maximum must be greater than minimum.
20106 * @see elm_spinner_min_max_get()
20110 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20113 * Get the minimum and maximum values of the spinner.
20115 * @param obj The spinner object.
20116 * @param min Pointer where to store the minimum value.
20117 * @param max Pointer where to store the maximum value.
20119 * @note If only one value is needed, the other pointer can be passed
20122 * @see elm_spinner_min_max_set() for details.
20126 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20129 * Set the step used to increment or decrement the spinner value.
20131 * @param obj The spinner object.
20132 * @param step The step value.
20134 * This value will be incremented or decremented to the displayed value.
20135 * It will be incremented while the user keep right or top arrow pressed,
20136 * and will be decremented while the user keep left or bottom arrow pressed.
20138 * The interval to increment / decrement can be set with
20139 * elm_spinner_interval_set().
20141 * By default step value is equal to 1.
20143 * @see elm_spinner_step_get()
20147 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20150 * Get the step used to increment or decrement the spinner value.
20152 * @param obj The spinner object.
20153 * @return The step value.
20155 * @see elm_spinner_step_get() for more details.
20159 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20162 * Set the value the spinner displays.
20164 * @param obj The spinner object.
20165 * @param val The value to be displayed.
20167 * Value will be presented on the label following format specified with
20168 * elm_spinner_format_set().
20170 * @warning The value must to be between min and max values. This values
20171 * are set by elm_spinner_min_max_set().
20173 * @see elm_spinner_value_get().
20174 * @see elm_spinner_format_set().
20175 * @see elm_spinner_min_max_set().
20179 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20182 * Get the value displayed by the spinner.
20184 * @param obj The spinner object.
20185 * @return The value displayed.
20187 * @see elm_spinner_value_set() for details.
20191 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20194 * Set whether the spinner should wrap when it reaches its
20195 * minimum or maximum value.
20197 * @param obj The spinner object.
20198 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20201 * Disabled by default. If disabled, when the user tries to increment the
20203 * but displayed value plus step value is bigger than maximum value,
20205 * won't allow it. The same happens when the user tries to decrement it,
20206 * but the value less step is less than minimum value.
20208 * When wrap is enabled, in such situations it will allow these changes,
20209 * but will get the value that would be less than minimum and subtracts
20210 * from maximum. Or add the value that would be more than maximum to
20214 * @li min value = 10
20215 * @li max value = 50
20216 * @li step value = 20
20217 * @li displayed value = 20
20219 * When the user decrement value (using left or bottom arrow), it will
20220 * displays @c 40, because max - (min - (displayed - step)) is
20221 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20223 * @see elm_spinner_wrap_get().
20227 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20230 * Get whether the spinner should wrap when it reaches its
20231 * minimum or maximum value.
20233 * @param obj The spinner object
20234 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20235 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20237 * @see elm_spinner_wrap_set() for details.
20241 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20244 * Set whether the spinner can be directly edited by the user or not.
20246 * @param obj The spinner object.
20247 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20248 * don't allow users to edit it directly.
20250 * Spinner objects can have edition @b disabled, in which state they will
20251 * be changed only by arrows.
20252 * Useful for contexts
20253 * where you don't want your users to interact with it writting the value.
20255 * when using special values, the user can see real value instead
20256 * of special label on edition.
20258 * It's enabled by default.
20260 * @see elm_spinner_editable_get()
20264 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20267 * Get whether the spinner can be directly edited by the user or not.
20269 * @param obj The spinner object.
20270 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20271 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20273 * @see elm_spinner_editable_set() for details.
20277 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20280 * Set a special string to display in the place of the numerical value.
20282 * @param obj The spinner object.
20283 * @param value The value to be replaced.
20284 * @param label The label to be used.
20286 * It's useful for cases when a user should select an item that is
20287 * better indicated by a label than a value. For example, weekdays or months.
20291 * sp = elm_spinner_add(win);
20292 * elm_spinner_min_max_set(sp, 1, 3);
20293 * elm_spinner_special_value_add(sp, 1, "January");
20294 * elm_spinner_special_value_add(sp, 2, "February");
20295 * elm_spinner_special_value_add(sp, 3, "March");
20296 * evas_object_show(sp);
20301 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20304 * Set the interval on time updates for an user mouse button hold
20305 * on spinner widgets' arrows.
20307 * @param obj The spinner object.
20308 * @param interval The (first) interval value in seconds.
20310 * This interval value is @b decreased while the user holds the
20311 * mouse pointer either incrementing or decrementing spinner's value.
20313 * This helps the user to get to a given value distant from the
20314 * current one easier/faster, as it will start to change quicker and
20315 * quicker on mouse button holds.
20317 * The calculation for the next change interval value, starting from
20318 * the one set with this call, is the previous interval divided by
20319 * @c 1.05, so it decreases a little bit.
20321 * The default starting interval value for automatic changes is
20324 * @see elm_spinner_interval_get()
20328 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20331 * Get the interval on time updates for an user mouse button hold
20332 * on spinner widgets' arrows.
20334 * @param obj The spinner object.
20335 * @return The (first) interval value, in seconds, set on it.
20337 * @see elm_spinner_interval_set() for more details.
20341 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20348 * @defgroup Index Index
20350 * @image html img/widget/index/preview-00.png
20351 * @image latex img/widget/index/preview-00.eps
20353 * An index widget gives you an index for fast access to whichever
20354 * group of other UI items one might have. It's a list of text
20355 * items (usually letters, for alphabetically ordered access).
20357 * Index widgets are by default hidden and just appear when the
20358 * user clicks over it's reserved area in the canvas. In its
20359 * default theme, it's an area one @ref Fingers "finger" wide on
20360 * the right side of the index widget's container.
20362 * When items on the index are selected, smart callbacks get
20363 * called, so that its user can make other container objects to
20364 * show a given area or child object depending on the index item
20365 * selected. You'd probably be using an index together with @ref
20366 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20369 * Smart events one can add callbacks for are:
20370 * - @c "changed" - When the selected index item changes. @c
20371 * event_info is the selected item's data pointer.
20372 * - @c "delay,changed" - When the selected index item changes, but
20373 * after a small idling period. @c event_info is the selected
20374 * item's data pointer.
20375 * - @c "selected" - When the user releases a mouse button and
20376 * selects an item. @c event_info is the selected item's data
20378 * - @c "level,up" - when the user moves a finger from the first
20379 * level to the second level
20380 * - @c "level,down" - when the user moves a finger from the second
20381 * level to the first level
20383 * The @c "delay,changed" event is so that it'll wait a small time
20384 * before actually reporting those events and, moreover, just the
20385 * last event happening on those time frames will actually be
20388 * Here are some examples on its usage:
20389 * @li @ref index_example_01
20390 * @li @ref index_example_02
20394 * @addtogroup Index
20398 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20401 * Add a new index widget to the given parent Elementary
20402 * (container) object
20404 * @param parent The parent object
20405 * @return a new index widget handle or @c NULL, on errors
20407 * This function inserts a new index widget on the canvas.
20411 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20414 * Set whether a given index widget is or not visible,
20417 * @param obj The index object
20418 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20420 * Not to be confused with visible as in @c evas_object_show() --
20421 * visible with regard to the widget's auto hiding feature.
20423 * @see elm_index_active_get()
20427 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20430 * Get whether a given index widget is currently visible or not.
20432 * @param obj The index object
20433 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20435 * @see elm_index_active_set() for more details
20439 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20442 * Set the items level for a given index widget.
20444 * @param obj The index object.
20445 * @param level @c 0 or @c 1, the currently implemented levels.
20447 * @see elm_index_item_level_get()
20451 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20454 * Get the items level set for a given index widget.
20456 * @param obj The index object.
20457 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20459 * @see elm_index_item_level_set() for more information
20463 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20466 * Returns the last selected item's data, for a given index widget.
20468 * @param obj The index object.
20469 * @return The item @b data associated to the last selected item on
20470 * @p obj (or @c NULL, on errors).
20472 * @warning The returned value is @b not an #Elm_Index_Item item
20473 * handle, but the data associated to it (see the @c item parameter
20474 * in elm_index_item_append(), as an example).
20478 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20481 * Append a new item on a given index widget.
20483 * @param obj The index object.
20484 * @param letter Letter under which the item should be indexed
20485 * @param item The item data to set for the index's item
20487 * Despite the most common usage of the @p letter argument is for
20488 * single char strings, one could use arbitrary strings as index
20491 * @c item will be the pointer returned back on @c "changed", @c
20492 * "delay,changed" and @c "selected" smart events.
20496 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20499 * Prepend a new item on a given index widget.
20501 * @param obj The index object.
20502 * @param letter Letter under which the item should be indexed
20503 * @param item The item data to set for the index's item
20505 * Despite the most common usage of the @p letter argument is for
20506 * single char strings, one could use arbitrary strings as index
20509 * @c item will be the pointer returned back on @c "changed", @c
20510 * "delay,changed" and @c "selected" smart events.
20514 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20517 * Append a new item, on a given index widget, <b>after the item
20518 * having @p relative as data</b>.
20520 * @param obj The index object.
20521 * @param letter Letter under which the item should be indexed
20522 * @param item The item data to set for the index's item
20523 * @param relative The item data of the index item to be the
20524 * predecessor of this new one
20526 * Despite the most common usage of the @p letter argument is for
20527 * single char strings, one could use arbitrary strings as index
20530 * @c item will be the pointer returned back on @c "changed", @c
20531 * "delay,changed" and @c "selected" smart events.
20533 * @note If @p relative is @c NULL or if it's not found to be data
20534 * set on any previous item on @p obj, this function will behave as
20535 * elm_index_item_append().
20539 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20542 * Prepend a new item, on a given index widget, <b>after the item
20543 * having @p relative as data</b>.
20545 * @param obj The index object.
20546 * @param letter Letter under which the item should be indexed
20547 * @param item The item data to set for the index's item
20548 * @param relative The item data of the index item to be the
20549 * successor of this new one
20551 * Despite the most common usage of the @p letter argument is for
20552 * single char strings, one could use arbitrary strings as index
20555 * @c item will be the pointer returned back on @c "changed", @c
20556 * "delay,changed" and @c "selected" smart events.
20558 * @note If @p relative is @c NULL or if it's not found to be data
20559 * set on any previous item on @p obj, this function will behave as
20560 * elm_index_item_prepend().
20564 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20567 * Insert a new item into the given index widget, using @p cmp_func
20568 * function to sort items (by item handles).
20570 * @param obj The index object.
20571 * @param letter Letter under which the item should be indexed
20572 * @param item The item data to set for the index's item
20573 * @param cmp_func The comparing function to be used to sort index
20574 * items <b>by #Elm_Index_Item item handles</b>
20575 * @param cmp_data_func A @b fallback function to be called for the
20576 * sorting of index items <b>by item data</b>). It will be used
20577 * when @p cmp_func returns @c 0 (equality), which means an index
20578 * item with provided item data already exists. To decide which
20579 * data item should be pointed to by the index item in question, @p
20580 * cmp_data_func will be used. If @p cmp_data_func returns a
20581 * non-negative value, the previous index item data will be
20582 * replaced by the given @p item pointer. If the previous data need
20583 * to be freed, it should be done by the @p cmp_data_func function,
20584 * because all references to it will be lost. If this function is
20585 * not provided (@c NULL is given), index items will be @b
20586 * duplicated, if @p cmp_func returns @c 0.
20588 * Despite the most common usage of the @p letter argument is for
20589 * single char strings, one could use arbitrary strings as index
20592 * @c item will be the pointer returned back on @c "changed", @c
20593 * "delay,changed" and @c "selected" smart events.
20597 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);
20600 * Remove an item from a given index widget, <b>to be referenced by
20601 * it's data value</b>.
20603 * @param obj The index object
20604 * @param item The item's data pointer for the item to be removed
20607 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20608 * that callback function will be called by this one.
20610 * @warning The item to be removed from @p obj will be found via
20611 * its item data pointer, and not by an #Elm_Index_Item handle.
20615 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20618 * Find a given index widget's item, <b>using item data</b>.
20620 * @param obj The index object
20621 * @param item The item data pointed to by the desired index item
20622 * @return The index item handle, if found, or @c NULL otherwise
20626 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20629 * Removes @b all items from a given index widget.
20631 * @param obj The index object.
20633 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20634 * that callback function will be called for each item in @p obj.
20638 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20641 * Go to a given items level on a index widget
20643 * @param obj The index object
20644 * @param level The index level (one of @c 0 or @c 1)
20648 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20651 * Return the data associated with a given index widget item
20653 * @param it The index widget item handle
20654 * @return The data associated with @p it
20656 * @see elm_index_item_data_set()
20660 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20663 * Set the data associated with a given index widget item
20665 * @param it The index widget item handle
20666 * @param data The new data pointer to set to @p it
20668 * This sets new item data on @p it.
20670 * @warning The old data pointer won't be touched by this function, so
20671 * the user had better to free that old data himself/herself.
20675 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20678 * Set the function to be called when a given index widget item is freed.
20680 * @param it The item to set the callback on
20681 * @param func The function to call on the item's deletion
20683 * When called, @p func will have both @c data and @c event_info
20684 * arguments with the @p it item's data value and, naturally, the
20685 * @c obj argument with a handle to the parent index widget.
20689 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20692 * Get the letter (string) set on a given index widget item.
20694 * @param it The index item handle
20695 * @return The letter string set on @p it
20699 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20706 * @defgroup Photocam Photocam
20708 * @image html img/widget/photocam/preview-00.png
20709 * @image latex img/widget/photocam/preview-00.eps
20711 * This is a widget specifically for displaying high-resolution digital
20712 * camera photos giving speedy feedback (fast load), low memory footprint
20713 * and zooming and panning as well as fitting logic. It is entirely focused
20714 * on jpeg images, and takes advantage of properties of the jpeg format (via
20715 * evas loader features in the jpeg loader).
20717 * Signals that you can add callbacks for are:
20718 * @li "clicked" - This is called when a user has clicked the photo without
20720 * @li "press" - This is called when a user has pressed down on the photo.
20721 * @li "longpressed" - This is called when a user has pressed down on the
20722 * photo for a long time without dragging around.
20723 * @li "clicked,double" - This is called when a user has double-clicked the
20725 * @li "load" - Photo load begins.
20726 * @li "loaded" - This is called when the image file load is complete for the
20727 * first view (low resolution blurry version).
20728 * @li "load,detail" - Photo detailed data load begins.
20729 * @li "loaded,detail" - This is called when the image file load is complete
20730 * for the detailed image data (full resolution needed).
20731 * @li "zoom,start" - Zoom animation started.
20732 * @li "zoom,stop" - Zoom animation stopped.
20733 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20734 * @li "scroll" - the content has been scrolled (moved)
20735 * @li "scroll,anim,start" - scrolling animation has started
20736 * @li "scroll,anim,stop" - scrolling animation has stopped
20737 * @li "scroll,drag,start" - dragging the contents around has started
20738 * @li "scroll,drag,stop" - dragging the contents around has stopped
20740 * @ref tutorial_photocam shows the API in action.
20744 * @brief Types of zoom available.
20746 typedef enum _Elm_Photocam_Zoom_Mode
20748 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20749 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20750 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20751 ELM_PHOTOCAM_ZOOM_MODE_LAST
20752 } Elm_Photocam_Zoom_Mode;
20754 * @brief Add a new Photocam object
20756 * @param parent The parent object
20757 * @return The new object or NULL if it cannot be created
20759 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20761 * @brief Set the photo file to be shown
20763 * @param obj The photocam object
20764 * @param file The photo file
20765 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20767 * This sets (and shows) the specified file (with a relative or absolute
20768 * path) and will return a load error (same error that
20769 * evas_object_image_load_error_get() will return). The image will change and
20770 * adjust its size at this point and begin a background load process for this
20771 * photo that at some time in the future will be displayed at the full
20774 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20776 * @brief Returns the path of the current image file
20778 * @param obj The photocam object
20779 * @return Returns the path
20781 * @see elm_photocam_file_set()
20783 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20785 * @brief Set the zoom level of the photo
20787 * @param obj The photocam object
20788 * @param zoom The zoom level to set
20790 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20791 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20792 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20793 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20796 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20798 * @brief Get the zoom level of the photo
20800 * @param obj The photocam object
20801 * @return The current zoom level
20803 * This returns the current zoom level of the photocam object. Note that if
20804 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20805 * (which is the default), the zoom level may be changed at any time by the
20806 * photocam object itself to account for photo size and photocam viewpoer
20809 * @see elm_photocam_zoom_set()
20810 * @see elm_photocam_zoom_mode_set()
20812 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20814 * @brief Set the zoom mode
20816 * @param obj The photocam object
20817 * @param mode The desired mode
20819 * This sets the zoom mode to manual or one of several automatic levels.
20820 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20821 * elm_photocam_zoom_set() and will stay at that level until changed by code
20822 * or until zoom mode is changed. This is the default mode. The Automatic
20823 * modes will allow the photocam object to automatically adjust zoom mode
20824 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20825 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20826 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20827 * pixels within the frame are left unfilled.
20829 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20831 * @brief Get the zoom mode
20833 * @param obj The photocam object
20834 * @return The current zoom mode
20836 * This gets the current zoom mode of the photocam object.
20838 * @see elm_photocam_zoom_mode_set()
20840 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20842 * @brief Get the current image pixel width and height
20844 * @param obj The photocam object
20845 * @param w A pointer to the width return
20846 * @param h A pointer to the height return
20848 * This gets the current photo pixel width and height (for the original).
20849 * The size will be returned in the integers @p w and @p h that are pointed
20852 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20854 * @brief Get the area of the image that is currently shown
20857 * @param x A pointer to the X-coordinate of region
20858 * @param y A pointer to the Y-coordinate of region
20859 * @param w A pointer to the width
20860 * @param h A pointer to the height
20862 * @see elm_photocam_image_region_show()
20863 * @see elm_photocam_image_region_bring_in()
20865 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20867 * @brief Set the viewed portion of the image
20869 * @param obj The photocam object
20870 * @param x X-coordinate of region in image original pixels
20871 * @param y Y-coordinate of region in image original pixels
20872 * @param w Width of region in image original pixels
20873 * @param h Height of region in image original pixels
20875 * This shows the region of the image without using animation.
20877 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20879 * @brief Bring in the viewed portion of the image
20881 * @param obj The photocam object
20882 * @param x X-coordinate of region in image original pixels
20883 * @param y Y-coordinate of region in image original pixels
20884 * @param w Width of region in image original pixels
20885 * @param h Height of region in image original pixels
20887 * This shows the region of the image using animation.
20889 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20891 * @brief Set the paused state for photocam
20893 * @param obj The photocam object
20894 * @param paused The pause state to set
20896 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20897 * photocam. The default is off. This will stop zooming using animation on
20898 * zoom levels changes and change instantly. This will stop any existing
20899 * animations that are running.
20901 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20903 * @brief Get the paused state for photocam
20905 * @param obj The photocam object
20906 * @return The current paused state
20908 * This gets the current paused state for the photocam object.
20910 * @see elm_photocam_paused_set()
20912 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20914 * @brief Get the internal low-res image used for photocam
20916 * @param obj The photocam object
20917 * @return The internal image object handle, or NULL if none exists
20919 * This gets the internal image object inside photocam. Do not modify it. It
20920 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20921 * deleted at any time as well.
20923 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20925 * @brief Set the photocam scrolling bouncing.
20927 * @param obj The photocam object
20928 * @param h_bounce bouncing for horizontal
20929 * @param v_bounce bouncing for vertical
20931 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20933 * @brief Get the photocam scrolling bouncing.
20935 * @param obj The photocam object
20936 * @param h_bounce bouncing for horizontal
20937 * @param v_bounce bouncing for vertical
20939 * @see elm_photocam_bounce_set()
20941 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20947 * @defgroup Map Map
20948 * @ingroup Elementary
20950 * @image html img/widget/map/preview-00.png
20951 * @image latex img/widget/map/preview-00.eps
20953 * This is a widget specifically for displaying a map. It uses basically
20954 * OpenStreetMap provider http://www.openstreetmap.org/,
20955 * but custom providers can be added.
20957 * It supports some basic but yet nice features:
20958 * @li zoom and scroll
20959 * @li markers with content to be displayed when user clicks over it
20960 * @li group of markers
20963 * Smart callbacks one can listen to:
20965 * - "clicked" - This is called when a user has clicked the map without
20967 * - "press" - This is called when a user has pressed down on the map.
20968 * - "longpressed" - This is called when a user has pressed down on the map
20969 * for a long time without dragging around.
20970 * - "clicked,double" - This is called when a user has double-clicked
20972 * - "load,detail" - Map detailed data load begins.
20973 * - "loaded,detail" - This is called when all currently visible parts of
20974 * the map are loaded.
20975 * - "zoom,start" - Zoom animation started.
20976 * - "zoom,stop" - Zoom animation stopped.
20977 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20978 * - "scroll" - the content has been scrolled (moved).
20979 * - "scroll,anim,start" - scrolling animation has started.
20980 * - "scroll,anim,stop" - scrolling animation has stopped.
20981 * - "scroll,drag,start" - dragging the contents around has started.
20982 * - "scroll,drag,stop" - dragging the contents around has stopped.
20983 * - "downloaded" - This is called when all currently required map images
20985 * - "route,load" - This is called when route request begins.
20986 * - "route,loaded" - This is called when route request ends.
20987 * - "name,load" - This is called when name request begins.
20988 * - "name,loaded- This is called when name request ends.
20990 * Available style for map widget:
20993 * Available style for markers:
20998 * Available style for marker bubble:
21001 * List of examples:
21002 * @li @ref map_example_01
21003 * @li @ref map_example_02
21004 * @li @ref map_example_03
21013 * @enum _Elm_Map_Zoom_Mode
21014 * @typedef Elm_Map_Zoom_Mode
21016 * Set map's zoom behavior. It can be set to manual or automatic.
21018 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21020 * Values <b> don't </b> work as bitmask, only one can be choosen.
21022 * @note Valid sizes are 2^zoom, consequently the map may be smaller
21023 * than the scroller view.
21025 * @see elm_map_zoom_mode_set()
21026 * @see elm_map_zoom_mode_get()
21030 typedef enum _Elm_Map_Zoom_Mode
21032 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21033 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21034 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21035 ELM_MAP_ZOOM_MODE_LAST
21036 } Elm_Map_Zoom_Mode;
21039 * @enum _Elm_Map_Route_Sources
21040 * @typedef Elm_Map_Route_Sources
21042 * Set route service to be used. By default used source is
21043 * #ELM_MAP_ROUTE_SOURCE_YOURS.
21045 * @see elm_map_route_source_set()
21046 * @see elm_map_route_source_get()
21050 typedef enum _Elm_Map_Route_Sources
21052 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21053 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. */
21054 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21055 ELM_MAP_ROUTE_SOURCE_LAST
21056 } Elm_Map_Route_Sources;
21058 typedef enum _Elm_Map_Name_Sources
21060 ELM_MAP_NAME_SOURCE_NOMINATIM,
21061 ELM_MAP_NAME_SOURCE_LAST
21062 } Elm_Map_Name_Sources;
21065 * @enum _Elm_Map_Route_Type
21066 * @typedef Elm_Map_Route_Type
21068 * Set type of transport used on route.
21070 * @see elm_map_route_add()
21074 typedef enum _Elm_Map_Route_Type
21076 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21077 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21078 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21079 ELM_MAP_ROUTE_TYPE_LAST
21080 } Elm_Map_Route_Type;
21083 * @enum _Elm_Map_Route_Method
21084 * @typedef Elm_Map_Route_Method
21086 * Set the routing method, what should be priorized, time or distance.
21088 * @see elm_map_route_add()
21092 typedef enum _Elm_Map_Route_Method
21094 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21095 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21096 ELM_MAP_ROUTE_METHOD_LAST
21097 } Elm_Map_Route_Method;
21099 typedef enum _Elm_Map_Name_Method
21101 ELM_MAP_NAME_METHOD_SEARCH,
21102 ELM_MAP_NAME_METHOD_REVERSE,
21103 ELM_MAP_NAME_METHOD_LAST
21104 } Elm_Map_Name_Method;
21106 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(). */
21107 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(). */
21108 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(). */
21109 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(). */
21110 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
21111 typedef struct _Elm_Map_Track Elm_Map_Track;
21113 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. */
21114 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21115 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21116 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21118 typedef char *(*ElmMapModuleSourceFunc) (void);
21119 typedef int (*ElmMapModuleZoomMinFunc) (void);
21120 typedef int (*ElmMapModuleZoomMaxFunc) (void);
21121 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21122 typedef int (*ElmMapModuleRouteSourceFunc) (void);
21123 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21124 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21125 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21126 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21129 * Add a new map widget to the given parent Elementary (container) object.
21131 * @param parent The parent object.
21132 * @return a new map widget handle or @c NULL, on errors.
21134 * This function inserts a new map widget on the canvas.
21138 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21141 * Set the zoom level of the map.
21143 * @param obj The map object.
21144 * @param zoom The zoom level to set.
21146 * This sets the zoom level.
21148 * It will respect limits defined by elm_map_source_zoom_min_set() and
21149 * elm_map_source_zoom_max_set().
21151 * By default these values are 0 (world map) and 18 (maximum zoom).
21153 * This function should be used when zoom mode is set to
21154 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21155 * with elm_map_zoom_mode_set().
21157 * @see elm_map_zoom_mode_set().
21158 * @see elm_map_zoom_get().
21162 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21165 * Get the zoom level of the map.
21167 * @param obj The map object.
21168 * @return The current zoom level.
21170 * This returns the current zoom level of the map object.
21172 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21173 * (which is the default), the zoom level may be changed at any time by the
21174 * map object itself to account for map size and map viewport size.
21176 * @see elm_map_zoom_set() for details.
21180 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21183 * Set the zoom mode used by the map object.
21185 * @param obj The map object.
21186 * @param mode The zoom mode of the map, being it one of
21187 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21188 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21190 * This sets the zoom mode to manual or one of the automatic levels.
21191 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21192 * elm_map_zoom_set() and will stay at that level until changed by code
21193 * or until zoom mode is changed. This is the default mode.
21195 * The Automatic modes will allow the map object to automatically
21196 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21197 * adjust zoom so the map fits inside the scroll frame with no pixels
21198 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21199 * ensure no pixels within the frame are left unfilled. Do not forget that
21200 * the valid sizes are 2^zoom, consequently the map may be smaller than
21201 * the scroller view.
21203 * @see elm_map_zoom_set()
21207 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21210 * Get the zoom mode used by the map object.
21212 * @param obj The map object.
21213 * @return The zoom mode of the map, being it one of
21214 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21215 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21217 * This function returns the current zoom mode used by the map object.
21219 * @see elm_map_zoom_mode_set() for more details.
21223 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21226 * Get the current coordinates of the map.
21228 * @param obj The map object.
21229 * @param lon Pointer where to store longitude.
21230 * @param lat Pointer where to store latitude.
21232 * This gets the current center coordinates of the map object. It can be
21233 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21235 * @see elm_map_geo_region_bring_in()
21236 * @see elm_map_geo_region_show()
21240 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21243 * Animatedly bring in given coordinates to the center of the map.
21245 * @param obj The map object.
21246 * @param lon Longitude to center at.
21247 * @param lat Latitude to center at.
21249 * This causes map to jump to the given @p lat and @p lon coordinates
21250 * and show it (by scrolling) in the center of the viewport, if it is not
21251 * already centered. This will use animation to do so and take a period
21252 * of time to complete.
21254 * @see elm_map_geo_region_show() for a function to avoid animation.
21255 * @see elm_map_geo_region_get()
21259 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21262 * Show the given coordinates at the center of the map, @b immediately.
21264 * @param obj The map object.
21265 * @param lon Longitude to center at.
21266 * @param lat Latitude to center at.
21268 * This causes map to @b redraw its viewport's contents to the
21269 * region contining the given @p lat and @p lon, that will be moved to the
21270 * center of the map.
21272 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21273 * @see elm_map_geo_region_get()
21277 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21280 * Pause or unpause the map.
21282 * @param obj The map object.
21283 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21286 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21289 * The default is off.
21291 * This will stop zooming using animation, changing zoom levels will
21292 * change instantly. This will stop any existing animations that are running.
21294 * @see elm_map_paused_get()
21298 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21301 * Get a value whether map is paused or not.
21303 * @param obj The map object.
21304 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21305 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21307 * This gets the current paused state for the map object.
21309 * @see elm_map_paused_set() for details.
21313 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21316 * Set to show markers during zoom level changes or not.
21318 * @param obj The map object.
21319 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21322 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21325 * The default is off.
21327 * This will stop zooming using animation, changing zoom levels will
21328 * change instantly. This will stop any existing animations that are running.
21330 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21333 * The default is off.
21335 * Enabling it will force the map to stop displaying the markers during
21336 * zoom level changes. Set to on if you have a large number of markers.
21338 * @see elm_map_paused_markers_get()
21342 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21345 * Get a value whether markers will be displayed on zoom level changes or not
21347 * @param obj The map object.
21348 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21349 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21351 * This gets the current markers paused state for the map object.
21353 * @see elm_map_paused_markers_set() for details.
21357 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21360 * Get the information of downloading status.
21362 * @param obj The map object.
21363 * @param try_num Pointer where to store number of tiles being downloaded.
21364 * @param finish_num Pointer where to store number of tiles successfully
21367 * This gets the current downloading status for the map object, the number
21368 * of tiles being downloaded and the number of tiles already downloaded.
21372 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21375 * Convert a pixel coordinate (x,y) into a geographic coordinate
21376 * (longitude, latitude).
21378 * @param obj The map object.
21379 * @param x the coordinate.
21380 * @param y the coordinate.
21381 * @param size the size in pixels of the map.
21382 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21383 * @param lon Pointer where to store the longitude that correspond to x.
21384 * @param lat Pointer where to store the latitude that correspond to y.
21386 * @note Origin pixel point is the top left corner of the viewport.
21387 * Map zoom and size are taken on account.
21389 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21393 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);
21396 * Convert a geographic coordinate (longitude, latitude) into a pixel
21397 * coordinate (x, y).
21399 * @param obj The map object.
21400 * @param lon the longitude.
21401 * @param lat the latitude.
21402 * @param size the size in pixels of the map. The map is a square
21403 * and generally his size is : pow(2.0, zoom)*256.
21404 * @param x Pointer where to store the horizontal pixel coordinate that
21405 * correspond to the longitude.
21406 * @param y Pointer where to store the vertical pixel coordinate that
21407 * correspond to the latitude.
21409 * @note Origin pixel point is the top left corner of the viewport.
21410 * Map zoom and size are taken on account.
21412 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21416 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);
21419 * Convert a geographic coordinate (longitude, latitude) into a name
21422 * @param obj The map object.
21423 * @param lon the longitude.
21424 * @param lat the latitude.
21425 * @return name A #Elm_Map_Name handle for this coordinate.
21427 * To get the string for this address, elm_map_name_address_get()
21430 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21434 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21437 * Convert a name (address) into a geographic coordinate
21438 * (longitude, latitude).
21440 * @param obj The map object.
21441 * @param name The address.
21442 * @return name A #Elm_Map_Name handle for this address.
21444 * To get the longitude and latitude, elm_map_name_region_get()
21447 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21451 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21454 * Convert a pixel coordinate into a rotated pixel coordinate.
21456 * @param obj The map object.
21457 * @param x horizontal coordinate of the point to rotate.
21458 * @param y vertical coordinate of the point to rotate.
21459 * @param cx rotation's center horizontal position.
21460 * @param cy rotation's center vertical position.
21461 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21462 * @param xx Pointer where to store rotated x.
21463 * @param yy Pointer where to store rotated y.
21467 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);
21470 * Add a new marker to the map object.
21472 * @param obj The map object.
21473 * @param lon The longitude of the marker.
21474 * @param lat The latitude of the marker.
21475 * @param clas The class, to use when marker @b isn't grouped to others.
21476 * @param clas_group The class group, to use when marker is grouped to others
21477 * @param data The data passed to the callbacks.
21479 * @return The created marker or @c NULL upon failure.
21481 * A marker will be created and shown in a specific point of the map, defined
21482 * by @p lon and @p lat.
21484 * It will be displayed using style defined by @p class when this marker
21485 * is displayed alone (not grouped). A new class can be created with
21486 * elm_map_marker_class_new().
21488 * If the marker is grouped to other markers, it will be displayed with
21489 * style defined by @p class_group. Markers with the same group are grouped
21490 * if they are close. A new group class can be created with
21491 * elm_map_marker_group_class_new().
21493 * Markers created with this method can be deleted with
21494 * elm_map_marker_remove().
21496 * A marker can have associated content to be displayed by a bubble,
21497 * when a user click over it, as well as an icon. These objects will
21498 * be fetch using class' callback functions.
21500 * @see elm_map_marker_class_new()
21501 * @see elm_map_marker_group_class_new()
21502 * @see elm_map_marker_remove()
21506 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);
21509 * Set the maximum numbers of markers' content to be displayed in a group.
21511 * @param obj The map object.
21512 * @param max The maximum numbers of items displayed in a bubble.
21514 * A bubble will be displayed when the user clicks over the group,
21515 * and will place the content of markers that belong to this group
21518 * A group can have a long list of markers, consequently the creation
21519 * of the content of the bubble can be very slow.
21521 * In order to avoid this, a maximum number of items is displayed
21524 * By default this number is 30.
21526 * Marker with the same group class are grouped if they are close.
21528 * @see elm_map_marker_add()
21532 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21535 * Remove a marker from the map.
21537 * @param marker The marker to remove.
21539 * @see elm_map_marker_add()
21543 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21546 * Get the current coordinates of the marker.
21548 * @param marker marker.
21549 * @param lat Pointer where to store the marker's latitude.
21550 * @param lon Pointer where to store the marker's longitude.
21552 * These values are set when adding markers, with function
21553 * elm_map_marker_add().
21555 * @see elm_map_marker_add()
21559 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21562 * Animatedly bring in given marker to the center of the map.
21564 * @param marker The marker to center at.
21566 * This causes map to jump to the given @p marker's coordinates
21567 * and show it (by scrolling) in the center of the viewport, if it is not
21568 * already centered. This will use animation to do so and take a period
21569 * of time to complete.
21571 * @see elm_map_marker_show() for a function to avoid animation.
21572 * @see elm_map_marker_region_get()
21576 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21579 * Show the given marker at the center of the map, @b immediately.
21581 * @param marker The marker to center at.
21583 * This causes map to @b redraw its viewport's contents to the
21584 * region contining the given @p marker's coordinates, that will be
21585 * moved to the center of the map.
21587 * @see elm_map_marker_bring_in() for a function to move with animation.
21588 * @see elm_map_markers_list_show() if more than one marker need to be
21590 * @see elm_map_marker_region_get()
21594 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21597 * Move and zoom the map to display a list of markers.
21599 * @param markers A list of #Elm_Map_Marker handles.
21601 * The map will be centered on the center point of the markers in the list.
21602 * Then the map will be zoomed in order to fit the markers using the maximum
21603 * zoom which allows display of all the markers.
21605 * @warning All the markers should belong to the same map object.
21607 * @see elm_map_marker_show() to show a single marker.
21608 * @see elm_map_marker_bring_in()
21612 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21615 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21617 * @param marker The marker wich content should be returned.
21618 * @return Return the evas object if it exists, else @c NULL.
21620 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21621 * elm_map_marker_class_get_cb_set() should be used.
21623 * This content is what will be inside the bubble that will be displayed
21624 * when an user clicks over the marker.
21626 * This returns the actual Evas object used to be placed inside
21627 * the bubble. This may be @c NULL, as it may
21628 * not have been created or may have been deleted, at any time, by
21629 * the map. <b>Do not modify this object</b> (move, resize,
21630 * show, hide, etc.), as the map is controlling it. This
21631 * function is for querying, emitting custom signals or hooking
21632 * lower level callbacks for events on that object. Do not delete
21633 * this object under any circumstances.
21637 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21640 * Update the marker
21642 * @param marker The marker to be updated.
21644 * If a content is set to this marker, it will call function to delete it,
21645 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21646 * #ElmMapMarkerGetFunc.
21648 * These functions are set for the marker class with
21649 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21653 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21656 * Close all the bubbles opened by the user.
21658 * @param obj The map object.
21660 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21661 * when the user clicks on a marker.
21663 * This functions is set for the marker class with
21664 * elm_map_marker_class_get_cb_set().
21668 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21671 * Create a new group class.
21673 * @param obj The map object.
21674 * @return Returns the new group class.
21676 * Each marker must be associated to a group class. Markers in the same
21677 * group are grouped if they are close.
21679 * The group class defines the style of the marker when a marker is grouped
21680 * to others markers. When it is alone, another class will be used.
21682 * A group class will need to be provided when creating a marker with
21683 * elm_map_marker_add().
21685 * Some properties and functions can be set by class, as:
21686 * - style, with elm_map_group_class_style_set()
21687 * - data - to be associated to the group class. It can be set using
21688 * elm_map_group_class_data_set().
21689 * - min zoom to display markers, set with
21690 * elm_map_group_class_zoom_displayed_set().
21691 * - max zoom to group markers, set using
21692 * elm_map_group_class_zoom_grouped_set().
21693 * - visibility - set if markers will be visible or not, set with
21694 * elm_map_group_class_hide_set().
21695 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21696 * It can be set using elm_map_group_class_icon_cb_set().
21698 * @see elm_map_marker_add()
21699 * @see elm_map_group_class_style_set()
21700 * @see elm_map_group_class_data_set()
21701 * @see elm_map_group_class_zoom_displayed_set()
21702 * @see elm_map_group_class_zoom_grouped_set()
21703 * @see elm_map_group_class_hide_set()
21704 * @see elm_map_group_class_icon_cb_set()
21708 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21711 * Set the marker's style of a group class.
21713 * @param clas The group class.
21714 * @param style The style to be used by markers.
21716 * Each marker must be associated to a group class, and will use the style
21717 * defined by such class when grouped to other markers.
21719 * The following styles are provided by default theme:
21720 * @li @c radio - blue circle
21721 * @li @c radio2 - green circle
21724 * @see elm_map_group_class_new() for more details.
21725 * @see elm_map_marker_add()
21729 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21732 * Set the icon callback function of a group class.
21734 * @param clas The group class.
21735 * @param icon_get The callback function that will return the icon.
21737 * Each marker must be associated to a group class, and it can display a
21738 * custom icon. The function @p icon_get must return this icon.
21740 * @see elm_map_group_class_new() for more details.
21741 * @see elm_map_marker_add()
21745 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21748 * Set the data associated to the group class.
21750 * @param clas The group class.
21751 * @param data The new user data.
21753 * This data will be passed for callback functions, like icon get callback,
21754 * that can be set with elm_map_group_class_icon_cb_set().
21756 * If a data was previously set, the object will lose the pointer for it,
21757 * so if needs to be freed, you must do it yourself.
21759 * @see elm_map_group_class_new() for more details.
21760 * @see elm_map_group_class_icon_cb_set()
21761 * @see elm_map_marker_add()
21765 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21768 * Set the minimum zoom from where the markers are displayed.
21770 * @param clas The group class.
21771 * @param zoom The minimum zoom.
21773 * Markers only will be displayed when the map is displayed at @p zoom
21776 * @see elm_map_group_class_new() for more details.
21777 * @see elm_map_marker_add()
21781 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21784 * Set the zoom from where the markers are no more grouped.
21786 * @param clas The group class.
21787 * @param zoom The maximum zoom.
21789 * Markers only will be grouped when the map is displayed at
21790 * less than @p zoom.
21792 * @see elm_map_group_class_new() for more details.
21793 * @see elm_map_marker_add()
21797 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21800 * Set if the markers associated to the group class @clas are hidden or not.
21802 * @param clas The group class.
21803 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21806 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21811 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21814 * Create a new marker class.
21816 * @param obj The map object.
21817 * @return Returns the new group class.
21819 * Each marker must be associated to a class.
21821 * The marker class defines the style of the marker when a marker is
21822 * displayed alone, i.e., not grouped to to others markers. When grouped
21823 * it will use group class style.
21825 * A marker class will need to be provided when creating a marker with
21826 * elm_map_marker_add().
21828 * Some properties and functions can be set by class, as:
21829 * - style, with elm_map_marker_class_style_set()
21830 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21831 * It can be set using elm_map_marker_class_icon_cb_set().
21832 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21833 * Set using elm_map_marker_class_get_cb_set().
21834 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21835 * Set using elm_map_marker_class_del_cb_set().
21837 * @see elm_map_marker_add()
21838 * @see elm_map_marker_class_style_set()
21839 * @see elm_map_marker_class_icon_cb_set()
21840 * @see elm_map_marker_class_get_cb_set()
21841 * @see elm_map_marker_class_del_cb_set()
21845 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21848 * Set the marker's style of a marker class.
21850 * @param clas The marker class.
21851 * @param style The style to be used by markers.
21853 * Each marker must be associated to a marker class, and will use the style
21854 * defined by such class when alone, i.e., @b not grouped to other markers.
21856 * The following styles are provided by default theme:
21861 * @see elm_map_marker_class_new() for more details.
21862 * @see elm_map_marker_add()
21866 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21869 * Set the icon callback function of a marker class.
21871 * @param clas The marker class.
21872 * @param icon_get The callback function that will return the icon.
21874 * Each marker must be associated to a marker class, and it can display a
21875 * custom icon. The function @p icon_get must return this icon.
21877 * @see elm_map_marker_class_new() for more details.
21878 * @see elm_map_marker_add()
21882 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21885 * Set the bubble content callback function of a marker class.
21887 * @param clas The marker class.
21888 * @param get The callback function that will return the content.
21890 * Each marker must be associated to a marker class, and it can display a
21891 * a content on a bubble that opens when the user click over the marker.
21892 * The function @p get must return this content object.
21894 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21897 * @see elm_map_marker_class_new() for more details.
21898 * @see elm_map_marker_class_del_cb_set()
21899 * @see elm_map_marker_add()
21903 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21906 * Set the callback function used to delete bubble content of a marker class.
21908 * @param clas The marker class.
21909 * @param del The callback function that will delete the content.
21911 * Each marker must be associated to a marker class, and it can display a
21912 * a content on a bubble that opens when the user click over the marker.
21913 * The function to return such content can be set with
21914 * elm_map_marker_class_get_cb_set().
21916 * If this content must be freed, a callback function need to be
21917 * set for that task with this function.
21919 * If this callback is defined it will have to delete (or not) the
21920 * object inside, but if the callback is not defined the object will be
21921 * destroyed with evas_object_del().
21923 * @see elm_map_marker_class_new() for more details.
21924 * @see elm_map_marker_class_get_cb_set()
21925 * @see elm_map_marker_add()
21929 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21932 * Get the list of available sources.
21934 * @param obj The map object.
21935 * @return The source names list.
21937 * It will provide a list with all available sources, that can be set as
21938 * current source with elm_map_source_name_set(), or get with
21939 * elm_map_source_name_get().
21941 * Available sources:
21947 * @see elm_map_source_name_set() for more details.
21948 * @see elm_map_source_name_get()
21952 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21955 * Set the source of the map.
21957 * @param obj The map object.
21958 * @param source The source to be used.
21960 * Map widget retrieves images that composes the map from a web service.
21961 * This web service can be set with this method.
21963 * A different service can return a different maps with different
21964 * information and it can use different zoom values.
21966 * The @p source_name need to match one of the names provided by
21967 * elm_map_source_names_get().
21969 * The current source can be get using elm_map_source_name_get().
21971 * @see elm_map_source_names_get()
21972 * @see elm_map_source_name_get()
21977 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21980 * Get the name of currently used source.
21982 * @param obj The map object.
21983 * @return Returns the name of the source in use.
21985 * @see elm_map_source_name_set() for more details.
21989 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21992 * Set the source of the route service to be used by the map.
21994 * @param obj The map object.
21995 * @param source The route service to be used, being it one of
21996 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21997 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21999 * Each one has its own algorithm, so the route retrieved may
22000 * differ depending on the source route. Now, only the default is working.
22002 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22003 * http://www.yournavigation.org/.
22005 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22006 * assumptions. Its routing core is based on Contraction Hierarchies.
22008 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22010 * @see elm_map_route_source_get().
22014 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22017 * Get the current route source.
22019 * @param obj The map object.
22020 * @return The source of the route service used by the map.
22022 * @see elm_map_route_source_set() for details.
22026 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22029 * Set the minimum zoom of the source.
22031 * @param obj The map object.
22032 * @param zoom New minimum zoom value to be used.
22034 * By default, it's 0.
22038 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22041 * Get the minimum zoom of the source.
22043 * @param obj The map object.
22044 * @return Returns the minimum zoom of the source.
22046 * @see elm_map_source_zoom_min_set() for details.
22050 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22053 * Set the maximum zoom of the source.
22055 * @param obj The map object.
22056 * @param zoom New maximum zoom value to be used.
22058 * By default, it's 18.
22062 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22065 * Get the maximum zoom of the source.
22067 * @param obj The map object.
22068 * @return Returns the maximum zoom of the source.
22070 * @see elm_map_source_zoom_min_set() for details.
22074 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22077 * Set the user agent used by the map object to access routing services.
22079 * @param obj The map object.
22080 * @param user_agent The user agent to be used by the map.
22082 * User agent is a client application implementing a network protocol used
22083 * in communications within a client–server distributed computing system
22085 * The @p user_agent identification string will transmitted in a header
22086 * field @c User-Agent.
22088 * @see elm_map_user_agent_get()
22092 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22095 * Get the user agent used by the map object.
22097 * @param obj The map object.
22098 * @return The user agent identification string used by the map.
22100 * @see elm_map_user_agent_set() for details.
22104 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22107 * Add a new route to the map object.
22109 * @param obj The map object.
22110 * @param type The type of transport to be considered when tracing a route.
22111 * @param method The routing method, what should be priorized.
22112 * @param flon The start longitude.
22113 * @param flat The start latitude.
22114 * @param tlon The destination longitude.
22115 * @param tlat The destination latitude.
22117 * @return The created route or @c NULL upon failure.
22119 * A route will be traced by point on coordinates (@p flat, @p flon)
22120 * to point on coordinates (@p tlat, @p tlon), using the route service
22121 * set with elm_map_route_source_set().
22123 * It will take @p type on consideration to define the route,
22124 * depending if the user will be walking or driving, the route may vary.
22125 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22126 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22128 * Another parameter is what the route should priorize, the minor distance
22129 * or the less time to be spend on the route. So @p method should be one
22130 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22132 * Routes created with this method can be deleted with
22133 * elm_map_route_remove(), colored with elm_map_route_color_set(),
22134 * and distance can be get with elm_map_route_distance_get().
22136 * @see elm_map_route_remove()
22137 * @see elm_map_route_color_set()
22138 * @see elm_map_route_distance_get()
22139 * @see elm_map_route_source_set()
22143 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);
22146 * Remove a route from the map.
22148 * @param route The route to remove.
22150 * @see elm_map_route_add()
22154 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22157 * Set the route color.
22159 * @param route The route object.
22160 * @param r Red channel value, from 0 to 255.
22161 * @param g Green channel value, from 0 to 255.
22162 * @param b Blue channel value, from 0 to 255.
22163 * @param a Alpha channel value, from 0 to 255.
22165 * It uses an additive color model, so each color channel represents
22166 * how much of each primary colors must to be used. 0 represents
22167 * ausence of this color, so if all of the three are set to 0,
22168 * the color will be black.
22170 * These component values should be integers in the range 0 to 255,
22171 * (single 8-bit byte).
22173 * This sets the color used for the route. By default, it is set to
22174 * solid red (r = 255, g = 0, b = 0, a = 255).
22176 * For alpha channel, 0 represents completely transparent, and 255, opaque.
22178 * @see elm_map_route_color_get()
22182 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22185 * Get the route color.
22187 * @param route The route object.
22188 * @param r Pointer where to store the red channel value.
22189 * @param g Pointer where to store the green channel value.
22190 * @param b Pointer where to store the blue channel value.
22191 * @param a Pointer where to store the alpha channel value.
22193 * @see elm_map_route_color_set() for details.
22197 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22200 * Get the route distance in kilometers.
22202 * @param route The route object.
22203 * @return The distance of route (unit : km).
22207 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22210 * Get the information of route nodes.
22212 * @param route The route object.
22213 * @return Returns a string with the nodes of route.
22217 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22220 * Get the information of route waypoint.
22222 * @param route the route object.
22223 * @return Returns a string with information about waypoint of route.
22227 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22230 * Get the address of the name.
22232 * @param name The name handle.
22233 * @return Returns the address string of @p name.
22235 * This gets the coordinates of the @p name, created with one of the
22236 * conversion functions.
22238 * @see elm_map_utils_convert_name_into_coord()
22239 * @see elm_map_utils_convert_coord_into_name()
22243 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22246 * Get the current coordinates of the name.
22248 * @param name The name handle.
22249 * @param lat Pointer where to store the latitude.
22250 * @param lon Pointer where to store The longitude.
22252 * This gets the coordinates of the @p name, created with one of the
22253 * conversion functions.
22255 * @see elm_map_utils_convert_name_into_coord()
22256 * @see elm_map_utils_convert_coord_into_name()
22260 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22263 * Remove a name from the map.
22265 * @param name The name to remove.
22267 * Basically the struct handled by @p name will be freed, so convertions
22268 * between address and coordinates will be lost.
22270 * @see elm_map_utils_convert_name_into_coord()
22271 * @see elm_map_utils_convert_coord_into_name()
22275 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22280 * @param obj The map object.
22281 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22282 * @param cx Rotation's center horizontal position.
22283 * @param cy Rotation's center vertical position.
22285 * @see elm_map_rotate_get()
22289 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22292 * Get the rotate degree of the map
22294 * @param obj The map object
22295 * @param degree Pointer where to store degrees from 0.0 to 360.0
22296 * to rotate arount Z axis.
22297 * @param cx Pointer where to store rotation's center horizontal position.
22298 * @param cy Pointer where to store rotation's center vertical position.
22300 * @see elm_map_rotate_set() to set map rotation.
22304 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);
22307 * Enable or disable mouse wheel to be used to zoom in / out the map.
22309 * @param obj The map object.
22310 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22313 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22315 * It's disabled by default.
22317 * @see elm_map_wheel_disabled_get()
22321 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22324 * Get a value whether mouse wheel is enabled or not.
22326 * @param obj The map object.
22327 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22328 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22330 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22332 * @see elm_map_wheel_disabled_set() for details.
22336 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22340 * Add a track on the map
22342 * @param obj The map object.
22343 * @param emap The emap route object.
22344 * @return The route object. This is an elm object of type Route.
22346 * @see elm_route_add() for details.
22350 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22354 * Remove a track from the map
22356 * @param obj The map object.
22357 * @param route The track to remove.
22361 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22368 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22370 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22372 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22373 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22374 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22375 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22379 * @defgroup Panel Panel
22381 * @image html img/widget/panel/preview-00.png
22382 * @image latex img/widget/panel/preview-00.eps
22384 * @brief A panel is a type of animated container that contains subobjects.
22385 * It can be expanded or contracted by clicking the button on it's edge.
22387 * Orientations are as follows:
22388 * @li ELM_PANEL_ORIENT_TOP
22389 * @li ELM_PANEL_ORIENT_LEFT
22390 * @li ELM_PANEL_ORIENT_RIGHT
22392 * @ref tutorial_panel shows one way to use this widget.
22395 typedef enum _Elm_Panel_Orient
22397 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22398 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22399 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22400 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22401 } Elm_Panel_Orient;
22403 * @brief Adds a panel object
22405 * @param parent The parent object
22407 * @return The panel object, or NULL on failure
22409 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22411 * @brief Sets the orientation of the panel
22413 * @param parent The parent object
22414 * @param orient The panel orientation. Can be one of the following:
22415 * @li ELM_PANEL_ORIENT_TOP
22416 * @li ELM_PANEL_ORIENT_LEFT
22417 * @li ELM_PANEL_ORIENT_RIGHT
22419 * Sets from where the panel will (dis)appear.
22421 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22423 * @brief Get the orientation of the panel.
22425 * @param obj The panel object
22426 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22428 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22430 * @brief Set the content of the panel.
22432 * @param obj The panel object
22433 * @param content The panel content
22435 * Once the content object is set, a previously set one will be deleted.
22436 * If you want to keep that old content object, use the
22437 * elm_panel_content_unset() function.
22439 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22441 * @brief Get the content of the panel.
22443 * @param obj The panel object
22444 * @return The content that is being used
22446 * Return the content object which is set for this widget.
22448 * @see elm_panel_content_set()
22450 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22452 * @brief Unset the content of the panel.
22454 * @param obj The panel object
22455 * @return The content that was being used
22457 * Unparent and return the content object which was set for this widget.
22459 * @see elm_panel_content_set()
22461 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22463 * @brief Set the state of the panel.
22465 * @param obj The panel object
22466 * @param hidden If true, the panel will run the animation to contract
22468 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22470 * @brief Get the state of the panel.
22472 * @param obj The panel object
22473 * @param hidden If true, the panel is in the "hide" state
22475 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22477 * @brief Toggle the hidden state of the panel from code
22479 * @param obj The panel object
22481 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22487 * @defgroup Panes Panes
22488 * @ingroup Elementary
22490 * @image html img/widget/panes/preview-00.png
22491 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22493 * @image html img/panes.png
22494 * @image latex img/panes.eps width=\textwidth
22496 * The panes adds a dragable bar between two contents. When dragged
22497 * this bar will resize contents size.
22499 * Panes can be displayed vertically or horizontally, and contents
22500 * size proportion can be customized (homogeneous by default).
22502 * Smart callbacks one can listen to:
22503 * - "press" - The panes has been pressed (button wasn't released yet).
22504 * - "unpressed" - The panes was released after being pressed.
22505 * - "clicked" - The panes has been clicked>
22506 * - "clicked,double" - The panes has been double clicked
22508 * Available styles for it:
22511 * Here is an example on its usage:
22512 * @li @ref panes_example
22516 * @addtogroup Panes
22521 * Add a new panes widget to the given parent Elementary
22522 * (container) object.
22524 * @param parent The parent object.
22525 * @return a new panes widget handle or @c NULL, on errors.
22527 * This function inserts a new panes widget on the canvas.
22531 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22534 * Set the left content of the panes widget.
22536 * @param obj The panes object.
22537 * @param content The new left content object.
22539 * Once the content object is set, a previously set one will be deleted.
22540 * If you want to keep that old content object, use the
22541 * elm_panes_content_left_unset() function.
22543 * If panes is displayed vertically, left content will be displayed at
22546 * @see elm_panes_content_left_get()
22547 * @see elm_panes_content_right_set() to set content on the other side.
22551 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22554 * Set the right content of the panes widget.
22556 * @param obj The panes object.
22557 * @param content The new right content object.
22559 * Once the content object is set, a previously set one will be deleted.
22560 * If you want to keep that old content object, use the
22561 * elm_panes_content_right_unset() function.
22563 * If panes is displayed vertically, left content will be displayed at
22566 * @see elm_panes_content_right_get()
22567 * @see elm_panes_content_left_set() to set content on the other side.
22571 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22574 * Get the left content of the panes.
22576 * @param obj The panes object.
22577 * @return The left content object that is being used.
22579 * Return the left content object which is set for this widget.
22581 * @see elm_panes_content_left_set() for details.
22585 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22588 * Get the right content of the panes.
22590 * @param obj The panes object
22591 * @return The right content object that is being used
22593 * Return the right content object which is set for this widget.
22595 * @see elm_panes_content_right_set() for details.
22599 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22602 * Unset the left content used for the panes.
22604 * @param obj The panes object.
22605 * @return The left content object that was being used.
22607 * Unparent and return the left content object which was set for this widget.
22609 * @see elm_panes_content_left_set() for details.
22610 * @see elm_panes_content_left_get().
22614 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22617 * Unset the right content used for the panes.
22619 * @param obj The panes object.
22620 * @return The right content object that was being used.
22622 * Unparent and return the right content object which was set for this
22625 * @see elm_panes_content_right_set() for details.
22626 * @see elm_panes_content_right_get().
22630 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22633 * Get the size proportion of panes widget's left side.
22635 * @param obj The panes object.
22636 * @return float value between 0.0 and 1.0 representing size proportion
22639 * @see elm_panes_content_left_size_set() for more details.
22643 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22646 * Set the size proportion of panes widget's left side.
22648 * @param obj The panes object.
22649 * @param size Value between 0.0 and 1.0 representing size proportion
22652 * By default it's homogeneous, i.e., both sides have the same size.
22654 * If something different is required, it can be set with this function.
22655 * For example, if the left content should be displayed over
22656 * 75% of the panes size, @p size should be passed as @c 0.75.
22657 * This way, right content will be resized to 25% of panes size.
22659 * If displayed vertically, left content is displayed at top, and
22660 * right content at bottom.
22662 * @note This proportion will change when user drags the panes bar.
22664 * @see elm_panes_content_left_size_get()
22668 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22671 * Set the orientation of a given panes widget.
22673 * @param obj The panes object.
22674 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22675 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22677 * Use this function to change how your panes is to be
22678 * disposed: vertically or horizontally.
22680 * By default it's displayed horizontally.
22682 * @see elm_panes_horizontal_get()
22686 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22689 * Retrieve the orientation of a given panes widget.
22691 * @param obj The panes object.
22692 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22693 * @c EINA_FALSE if it's @b vertical (and on errors).
22695 * @see elm_panes_horizontal_set() for more details.
22699 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22706 * @defgroup Flip Flip
22708 * @image html img/widget/flip/preview-00.png
22709 * @image latex img/widget/flip/preview-00.eps
22711 * This widget holds 2 content objects(Evas_Object): one on the front and one
22712 * on the back. It allows you to flip from front to back and vice-versa using
22713 * various animations.
22715 * If either the front or back contents are not set the flip will treat that
22716 * as transparent. So if you wore to set the front content but not the back,
22717 * and then call elm_flip_go() you would see whatever is below the flip.
22719 * For a list of supported animations see elm_flip_go().
22721 * Signals that you can add callbacks for are:
22722 * "animate,begin" - when a flip animation was started
22723 * "animate,done" - when a flip animation is finished
22725 * @ref tutorial_flip show how to use most of the API.
22729 typedef enum _Elm_Flip_Mode
22731 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22732 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22733 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22734 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22735 ELM_FLIP_CUBE_LEFT,
22736 ELM_FLIP_CUBE_RIGHT,
22738 ELM_FLIP_CUBE_DOWN,
22739 ELM_FLIP_PAGE_LEFT,
22740 ELM_FLIP_PAGE_RIGHT,
22744 typedef enum _Elm_Flip_Interaction
22746 ELM_FLIP_INTERACTION_NONE,
22747 ELM_FLIP_INTERACTION_ROTATE,
22748 ELM_FLIP_INTERACTION_CUBE,
22749 ELM_FLIP_INTERACTION_PAGE
22750 } Elm_Flip_Interaction;
22751 typedef enum _Elm_Flip_Direction
22753 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22754 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22755 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22756 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22757 } Elm_Flip_Direction;
22759 * @brief Add a new flip to the parent
22761 * @param parent The parent object
22762 * @return The new object or NULL if it cannot be created
22764 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22766 * @brief Set the front content of the flip widget.
22768 * @param obj The flip object
22769 * @param content The new front content object
22771 * Once the content object is set, a previously set one will be deleted.
22772 * If you want to keep that old content object, use the
22773 * elm_flip_content_front_unset() function.
22775 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22777 * @brief Set the back content of the flip widget.
22779 * @param obj The flip object
22780 * @param content The new back content object
22782 * Once the content object is set, a previously set one will be deleted.
22783 * If you want to keep that old content object, use the
22784 * elm_flip_content_back_unset() function.
22786 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22788 * @brief Get the front content used for the flip
22790 * @param obj The flip object
22791 * @return The front content object that is being used
22793 * Return the front content object which is set for this widget.
22795 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22797 * @brief Get the back content used for the flip
22799 * @param obj The flip object
22800 * @return The back content object that is being used
22802 * Return the back content object which is set for this widget.
22804 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22806 * @brief Unset the front content used for the flip
22808 * @param obj The flip object
22809 * @return The front content object that was being used
22811 * Unparent and return the front content object which was set for this widget.
22813 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22815 * @brief Unset the back content used for the flip
22817 * @param obj The flip object
22818 * @return The back content object that was being used
22820 * Unparent and return the back content object which was set for this widget.
22822 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22824 * @brief Get flip front visibility state
22826 * @param obj The flip objct
22827 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22830 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22832 * @brief Set flip perspective
22834 * @param obj The flip object
22835 * @param foc The coordinate to set the focus on
22836 * @param x The X coordinate
22837 * @param y The Y coordinate
22839 * @warning This function currently does nothing.
22841 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22843 * @brief Runs the flip animation
22845 * @param obj The flip object
22846 * @param mode The mode type
22848 * Flips the front and back contents using the @p mode animation. This
22849 * efectively hides the currently visible content and shows the hidden one.
22851 * There a number of possible animations to use for the flipping:
22852 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22853 * around a horizontal axis in the middle of its height, the other content
22854 * is shown as the other side of the flip.
22855 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22856 * around a vertical axis in the middle of its width, the other content is
22857 * shown as the other side of the flip.
22858 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22859 * around a diagonal axis in the middle of its width, the other content is
22860 * shown as the other side of the flip.
22861 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22862 * around a diagonal axis in the middle of its height, the other content is
22863 * shown as the other side of the flip.
22864 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22865 * as if the flip was a cube, the other content is show as the right face of
22867 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22868 * right as if the flip was a cube, the other content is show as the left
22869 * face of the cube.
22870 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22871 * flip was a cube, the other content is show as the bottom face of the cube.
22872 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22873 * the flip was a cube, the other content is show as the upper face of the
22875 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22876 * if the flip was a book, the other content is shown as the page below that.
22877 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22878 * as if the flip was a book, the other content is shown as the page below
22880 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22881 * flip was a book, the other content is shown as the page below that.
22882 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22883 * flip was a book, the other content is shown as the page below that.
22885 * @image html elm_flip.png
22886 * @image latex elm_flip.eps width=\textwidth
22888 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22890 * @brief Set the interactive flip mode
22892 * @param obj The flip object
22893 * @param mode The interactive flip mode to use
22895 * This sets if the flip should be interactive (allow user to click and
22896 * drag a side of the flip to reveal the back page and cause it to flip).
22897 * By default a flip is not interactive. You may also need to set which
22898 * sides of the flip are "active" for flipping and how much space they use
22899 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22900 * and elm_flip_interacton_direction_hitsize_set()
22902 * The four avilable mode of interaction are:
22903 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22904 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22905 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22906 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22908 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22909 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22910 * happen, those can only be acheived with elm_flip_go();
22912 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22914 * @brief Get the interactive flip mode
22916 * @param obj The flip object
22917 * @return The interactive flip mode
22919 * Returns the interactive flip mode set by elm_flip_interaction_set()
22921 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22923 * @brief Set which directions of the flip respond to interactive flip
22925 * @param obj The flip object
22926 * @param dir The direction to change
22927 * @param enabled If that direction is enabled or not
22929 * By default all directions are disabled, so you may want to enable the
22930 * desired directions for flipping if you need interactive flipping. You must
22931 * call this function once for each direction that should be enabled.
22933 * @see elm_flip_interaction_set()
22935 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22937 * @brief Get the enabled state of that flip direction
22939 * @param obj The flip object
22940 * @param dir The direction to check
22941 * @return If that direction is enabled or not
22943 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22945 * @see elm_flip_interaction_set()
22947 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22949 * @brief Set the amount of the flip that is sensitive to interactive flip
22951 * @param obj The flip object
22952 * @param dir The direction to modify
22953 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22955 * Set the amount of the flip that is sensitive to interactive flip, with 0
22956 * representing no area in the flip and 1 representing the entire flip. There
22957 * is however a consideration to be made in that the area will never be
22958 * smaller than the finger size set(as set in your Elementary configuration).
22960 * @see elm_flip_interaction_set()
22962 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22964 * @brief Get the amount of the flip that is sensitive to interactive flip
22966 * @param obj The flip object
22967 * @param dir The direction to check
22968 * @return The size set for that direction
22970 * Returns the amount os sensitive area set by
22971 * elm_flip_interacton_direction_hitsize_set().
22973 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22978 /* scrolledentry */
22979 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22980 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22981 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22982 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22983 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22984 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22985 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22986 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22987 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22988 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22989 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22990 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22991 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22992 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22993 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22994 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22995 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22996 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22997 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22998 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22999 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23000 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23001 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23002 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23003 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23004 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23005 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23006 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23007 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23008 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23009 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23010 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23011 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23012 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23013 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23014 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);
23015 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23016 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23017 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);
23018 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23019 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);
23020 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23021 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23022 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23023 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23024 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23025 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23026 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23027 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23028 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);
23029 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);
23030 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);
23031 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);
23032 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);
23033 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);
23034 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23035 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23036 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23037 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23038 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23039 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23040 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23043 * @defgroup Conformant Conformant
23044 * @ingroup Elementary
23046 * @image html img/widget/conformant/preview-00.png
23047 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23049 * @image html img/conformant.png
23050 * @image latex img/conformant.eps width=\textwidth
23052 * The aim is to provide a widget that can be used in elementary apps to
23053 * account for space taken up by the indicator, virtual keypad & softkey
23054 * windows when running the illume2 module of E17.
23056 * So conformant content will be sized and positioned considering the
23057 * space required for such stuff, and when they popup, as a keyboard
23058 * shows when an entry is selected, conformant content won't change.
23060 * Available styles for it:
23063 * See how to use this widget in this example:
23064 * @ref conformant_example
23068 * @addtogroup Conformant
23073 * Add a new conformant widget to the given parent Elementary
23074 * (container) object.
23076 * @param parent The parent object.
23077 * @return A new conformant widget handle or @c NULL, on errors.
23079 * This function inserts a new conformant widget on the canvas.
23081 * @ingroup Conformant
23083 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23086 * Set the content of the conformant widget.
23088 * @param obj The conformant object.
23089 * @param content The content to be displayed by the conformant.
23091 * Content will be sized and positioned considering the space required
23092 * to display a virtual keyboard. So it won't fill all the conformant
23093 * size. This way is possible to be sure that content won't resize
23094 * or be re-positioned after the keyboard is displayed.
23096 * Once the content object is set, a previously set one will be deleted.
23097 * If you want to keep that old content object, use the
23098 * elm_conformat_content_unset() function.
23100 * @see elm_conformant_content_unset()
23101 * @see elm_conformant_content_get()
23103 * @ingroup Conformant
23105 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23108 * Get the content of the conformant widget.
23110 * @param obj The conformant object.
23111 * @return The content that is being used.
23113 * Return the content object which is set for this widget.
23114 * It won't be unparent from conformant. For that, use
23115 * elm_conformant_content_unset().
23117 * @see elm_conformant_content_set() for more details.
23118 * @see elm_conformant_content_unset()
23120 * @ingroup Conformant
23122 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23125 * Unset the content of the conformant widget.
23127 * @param obj The conformant object.
23128 * @return The content that was being used.
23130 * Unparent and return the content object which was set for this widget.
23132 * @see elm_conformant_content_set() for more details.
23134 * @ingroup Conformant
23136 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23139 * Returns the Evas_Object that represents the content area.
23141 * @param obj The conformant object.
23142 * @return The content area of the widget.
23144 * @ingroup Conformant
23146 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23153 * @defgroup Mapbuf Mapbuf
23154 * @ingroup Elementary
23156 * @image html img/widget/mapbuf/preview-00.png
23157 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23159 * This holds one content object and uses an Evas Map of transformation
23160 * points to be later used with this content. So the content will be
23161 * moved, resized, etc as a single image. So it will improve performance
23162 * when you have a complex interafce, with a lot of elements, and will
23163 * need to resize or move it frequently (the content object and its
23166 * See how to use this widget in this example:
23167 * @ref mapbuf_example
23171 * @addtogroup Mapbuf
23176 * Add a new mapbuf widget to the given parent Elementary
23177 * (container) object.
23179 * @param parent The parent object.
23180 * @return A new mapbuf widget handle or @c NULL, on errors.
23182 * This function inserts a new mapbuf widget on the canvas.
23186 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23189 * Set the content of the mapbuf.
23191 * @param obj The mapbuf object.
23192 * @param content The content that will be filled in this mapbuf object.
23194 * Once the content object is set, a previously set one will be deleted.
23195 * If you want to keep that old content object, use the
23196 * elm_mapbuf_content_unset() function.
23198 * To enable map, elm_mapbuf_enabled_set() should be used.
23202 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23205 * Get the content of the mapbuf.
23207 * @param obj The mapbuf object.
23208 * @return The content that is being used.
23210 * Return the content object which is set for this widget.
23212 * @see elm_mapbuf_content_set() for details.
23216 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23219 * Unset the content of the mapbuf.
23221 * @param obj The mapbuf object.
23222 * @return The content that was being used.
23224 * Unparent and return the content object which was set for this widget.
23226 * @see elm_mapbuf_content_set() for details.
23230 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23233 * Enable or disable the map.
23235 * @param obj The mapbuf object.
23236 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23238 * This enables the map that is set or disables it. On enable, the object
23239 * geometry will be saved, and the new geometry will change (position and
23240 * size) to reflect the map geometry set.
23242 * Also, when enabled, alpha and smooth states will be used, so if the
23243 * content isn't solid, alpha should be enabled, for example, otherwise
23244 * a black retangle will fill the content.
23246 * When disabled, the stored map will be freed and geometry prior to
23247 * enabling the map will be restored.
23249 * It's disabled by default.
23251 * @see elm_mapbuf_alpha_set()
23252 * @see elm_mapbuf_smooth_set()
23256 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23259 * Get a value whether map is enabled or not.
23261 * @param obj The mapbuf object.
23262 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23263 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23265 * @see elm_mapbuf_enabled_set() for details.
23269 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23272 * Enable or disable smooth map rendering.
23274 * @param obj The mapbuf object.
23275 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23278 * This sets smoothing for map rendering. If the object is a type that has
23279 * its own smoothing settings, then both the smooth settings for this object
23280 * and the map must be turned off.
23282 * By default smooth maps are enabled.
23286 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23289 * Get a value whether smooth map rendering is enabled or not.
23291 * @param obj The mapbuf object.
23292 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23293 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23295 * @see elm_mapbuf_smooth_set() for details.
23299 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23302 * Set or unset alpha flag for map rendering.
23304 * @param obj The mapbuf object.
23305 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23308 * This sets alpha flag for map rendering. If the object is a type that has
23309 * its own alpha settings, then this will take precedence. Only image objects
23310 * have this currently. It stops alpha blending of the map area, and is
23311 * useful if you know the object and/or all sub-objects is 100% solid.
23313 * Alpha is enabled by default.
23317 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23320 * Get a value whether alpha blending is enabled or not.
23322 * @param obj The mapbuf object.
23323 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23324 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23326 * @see elm_mapbuf_alpha_set() for details.
23330 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23337 * @defgroup Flipselector Flip Selector
23339 * @image html img/widget/flipselector/preview-00.png
23340 * @image latex img/widget/flipselector/preview-00.eps
23342 * A flip selector is a widget to show a set of @b text items, one
23343 * at a time, with the same sheet switching style as the @ref Clock
23344 * "clock" widget, when one changes the current displaying sheet
23345 * (thus, the "flip" in the name).
23347 * User clicks to flip sheets which are @b held for some time will
23348 * make the flip selector to flip continuosly and automatically for
23349 * the user. The interval between flips will keep growing in time,
23350 * so that it helps the user to reach an item which is distant from
23351 * the current selection.
23353 * Smart callbacks one can register to:
23354 * - @c "selected" - when the widget's selected text item is changed
23355 * - @c "overflowed" - when the widget's current selection is changed
23356 * from the first item in its list to the last
23357 * - @c "underflowed" - when the widget's current selection is changed
23358 * from the last item in its list to the first
23360 * Available styles for it:
23363 * Here is an example on its usage:
23364 * @li @ref flipselector_example
23368 * @addtogroup Flipselector
23372 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23375 * Add a new flip selector widget to the given parent Elementary
23376 * (container) widget
23378 * @param parent The parent object
23379 * @return a new flip selector widget handle or @c NULL, on errors
23381 * This function inserts a new flip selector widget on the canvas.
23383 * @ingroup Flipselector
23385 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23388 * Programmatically select the next item of a flip selector widget
23390 * @param obj The flipselector object
23392 * @note The selection will be animated. Also, if it reaches the
23393 * end of its list of member items, it will continue with the first
23396 * @ingroup Flipselector
23398 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23401 * Programmatically select the previous item of a flip selector
23404 * @param obj The flipselector object
23406 * @note The selection will be animated. Also, if it reaches the
23407 * beginning of its list of member items, it will continue with the
23408 * last one backwards.
23410 * @ingroup Flipselector
23412 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23415 * Append a (text) item to a flip selector widget
23417 * @param obj The flipselector object
23418 * @param label The (text) label of the new item
23419 * @param func Convenience callback function to take place when
23421 * @param data Data passed to @p func, above
23422 * @return A handle to the item added or @c NULL, on errors
23424 * The widget's list of labels to show will be appended with the
23425 * given value. If the user wishes so, a callback function pointer
23426 * can be passed, which will get called when this same item is
23429 * @note The current selection @b won't be modified by appending an
23430 * element to the list.
23432 * @note The maximum length of the text label is going to be
23433 * determined <b>by the widget's theme</b>. Strings larger than
23434 * that value are going to be @b truncated.
23436 * @ingroup Flipselector
23438 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23441 * Prepend a (text) item to a flip selector widget
23443 * @param obj The flipselector object
23444 * @param label The (text) label of the new item
23445 * @param func Convenience callback function to take place when
23447 * @param data Data passed to @p func, above
23448 * @return A handle to the item added or @c NULL, on errors
23450 * The widget's list of labels to show will be prepended with the
23451 * given value. If the user wishes so, a callback function pointer
23452 * can be passed, which will get called when this same item is
23455 * @note The current selection @b won't be modified by prepending
23456 * an element to the list.
23458 * @note The maximum length of the text label is going to be
23459 * determined <b>by the widget's theme</b>. Strings larger than
23460 * that value are going to be @b truncated.
23462 * @ingroup Flipselector
23464 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23467 * Get the internal list of items in a given flip selector widget.
23469 * @param obj The flipselector object
23470 * @return The list of items (#Elm_Flipselector_Item as data) or
23471 * @c NULL on errors.
23473 * This list is @b not to be modified in any way and must not be
23474 * freed. Use the list members with functions like
23475 * elm_flipselector_item_label_set(),
23476 * elm_flipselector_item_label_get(),
23477 * elm_flipselector_item_del(),
23478 * elm_flipselector_item_selected_get(),
23479 * elm_flipselector_item_selected_set().
23481 * @warning This list is only valid until @p obj object's internal
23482 * items list is changed. It should be fetched again with another
23483 * call to this function when changes happen.
23485 * @ingroup Flipselector
23487 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23490 * Get the first item in the given flip selector widget's list of
23493 * @param obj The flipselector object
23494 * @return The first item or @c NULL, if it has no items (and on
23497 * @see elm_flipselector_item_append()
23498 * @see elm_flipselector_last_item_get()
23500 * @ingroup Flipselector
23502 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23505 * Get the last item in the given flip selector widget's list of
23508 * @param obj The flipselector object
23509 * @return The last item or @c NULL, if it has no items (and on
23512 * @see elm_flipselector_item_prepend()
23513 * @see elm_flipselector_first_item_get()
23515 * @ingroup Flipselector
23517 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23520 * Get the currently selected item in a flip selector widget.
23522 * @param obj The flipselector object
23523 * @return The selected item or @c NULL, if the widget has no items
23526 * @ingroup Flipselector
23528 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23531 * Set whether a given flip selector widget's item should be the
23532 * currently selected one.
23534 * @param item The flip selector item
23535 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23537 * This sets whether @p item is or not the selected (thus, under
23538 * display) one. If @p item is different than one under display,
23539 * the latter will be unselected. If the @p item is set to be
23540 * unselected, on the other hand, the @b first item in the widget's
23541 * internal members list will be the new selected one.
23543 * @see elm_flipselector_item_selected_get()
23545 * @ingroup Flipselector
23547 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23550 * Get whether a given flip selector widget's item is the currently
23553 * @param item The flip selector item
23554 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23557 * @see elm_flipselector_item_selected_set()
23559 * @ingroup Flipselector
23561 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23564 * Delete a given item from a flip selector widget.
23566 * @param item The item to delete
23568 * @ingroup Flipselector
23570 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23573 * Get the label of a given flip selector widget's item.
23575 * @param item The item to get label from
23576 * @return The text label of @p item or @c NULL, on errors
23578 * @see elm_flipselector_item_label_set()
23580 * @ingroup Flipselector
23582 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23585 * Set the label of a given flip selector widget's item.
23587 * @param item The item to set label on
23588 * @param label The text label string, in UTF-8 encoding
23590 * @see elm_flipselector_item_label_get()
23592 * @ingroup Flipselector
23594 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23597 * Gets the item before @p item in a flip selector widget's
23598 * internal list of items.
23600 * @param item The item to fetch previous from
23601 * @return The item before the @p item, in its parent's list. If
23602 * there is no previous item for @p item or there's an
23603 * error, @c NULL is returned.
23605 * @see elm_flipselector_item_next_get()
23607 * @ingroup Flipselector
23609 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23612 * Gets the item after @p item in a flip selector widget's
23613 * internal list of items.
23615 * @param item The item to fetch next from
23616 * @return The item after the @p item, in its parent's list. If
23617 * there is no next item for @p item or there's an
23618 * error, @c NULL is returned.
23620 * @see elm_flipselector_item_next_get()
23622 * @ingroup Flipselector
23624 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23627 * Set the interval on time updates for an user mouse button hold
23628 * on a flip selector widget.
23630 * @param obj The flip selector object
23631 * @param interval The (first) interval value in seconds
23633 * This interval value is @b decreased while the user holds the
23634 * mouse pointer either flipping up or flipping doww a given flip
23637 * This helps the user to get to a given item distant from the
23638 * current one easier/faster, as it will start to flip quicker and
23639 * quicker on mouse button holds.
23641 * The calculation for the next flip interval value, starting from
23642 * the one set with this call, is the previous interval divided by
23643 * 1.05, so it decreases a little bit.
23645 * The default starting interval value for automatic flips is
23648 * @see elm_flipselector_interval_get()
23650 * @ingroup Flipselector
23652 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23655 * Get the interval on time updates for an user mouse button hold
23656 * on a flip selector widget.
23658 * @param obj The flip selector object
23659 * @return The (first) interval value, in seconds, set on it
23661 * @see elm_flipselector_interval_set() for more details
23663 * @ingroup Flipselector
23665 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23671 * @addtogroup Calendar
23676 * @enum _Elm_Calendar_Mark_Repeat
23677 * @typedef Elm_Calendar_Mark_Repeat
23679 * Event periodicity, used to define if a mark should be repeated
23680 * @b beyond event's day. It's set when a mark is added.
23682 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23683 * there will be marks every week after this date. Marks will be displayed
23684 * at 13th, 20th, 27th, 3rd June ...
23686 * Values don't work as bitmask, only one can be choosen.
23688 * @see elm_calendar_mark_add()
23690 * @ingroup Calendar
23692 typedef enum _Elm_Calendar_Mark_Repeat
23694 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23695 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23696 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23697 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*/
23698 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. */
23699 } Elm_Calendar_Mark_Repeat;
23701 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(). */
23704 * Add a new calendar widget to the given parent Elementary
23705 * (container) object.
23707 * @param parent The parent object.
23708 * @return a new calendar widget handle or @c NULL, on errors.
23710 * This function inserts a new calendar widget on the canvas.
23712 * @ref calendar_example_01
23714 * @ingroup Calendar
23716 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23719 * Get weekdays names displayed by the calendar.
23721 * @param obj The calendar object.
23722 * @return Array of seven strings to be used as weekday names.
23724 * By default, weekdays abbreviations get from system are displayed:
23725 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23726 * The first string is related to Sunday, the second to Monday...
23728 * @see elm_calendar_weekdays_name_set()
23730 * @ref calendar_example_05
23732 * @ingroup Calendar
23734 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23737 * Set weekdays names to be displayed by the calendar.
23739 * @param obj The calendar object.
23740 * @param weekdays Array of seven strings to be used as weekday names.
23741 * @warning It must have 7 elements, or it will access invalid memory.
23742 * @warning The strings must be NULL terminated ('@\0').
23744 * By default, weekdays abbreviations get from system are displayed:
23745 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23747 * The first string should be related to Sunday, the second to Monday...
23749 * The usage should be like this:
23751 * const char *weekdays[] =
23753 * "Sunday", "Monday", "Tuesday", "Wednesday",
23754 * "Thursday", "Friday", "Saturday"
23756 * elm_calendar_weekdays_names_set(calendar, weekdays);
23759 * @see elm_calendar_weekdays_name_get()
23761 * @ref calendar_example_02
23763 * @ingroup Calendar
23765 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23768 * Set the minimum and maximum values for the year
23770 * @param obj The calendar object
23771 * @param min The minimum year, greater than 1901;
23772 * @param max The maximum year;
23774 * Maximum must be greater than minimum, except if you don't wan't to set
23776 * Default values are 1902 and -1.
23778 * If the maximum year is a negative value, it will be limited depending
23779 * on the platform architecture (year 2037 for 32 bits);
23781 * @see elm_calendar_min_max_year_get()
23783 * @ref calendar_example_03
23785 * @ingroup Calendar
23787 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23790 * Get the minimum and maximum values for the year
23792 * @param obj The calendar object.
23793 * @param min The minimum year.
23794 * @param max The maximum year.
23796 * Default values are 1902 and -1.
23798 * @see elm_calendar_min_max_year_get() for more details.
23800 * @ref calendar_example_05
23802 * @ingroup Calendar
23804 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23807 * Enable or disable day selection
23809 * @param obj The calendar object.
23810 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23813 * Enabled by default. If disabled, the user still can select months,
23814 * but not days. Selected days are highlighted on calendar.
23815 * It should be used if you won't need such selection for the widget usage.
23817 * When a day is selected, or month is changed, smart callbacks for
23818 * signal "changed" will be called.
23820 * @see elm_calendar_day_selection_enable_get()
23822 * @ref calendar_example_04
23824 * @ingroup Calendar
23826 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23829 * Get a value whether day selection is enabled or not.
23831 * @see elm_calendar_day_selection_enable_set() for details.
23833 * @param obj The calendar object.
23834 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23835 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23837 * @ref calendar_example_05
23839 * @ingroup Calendar
23841 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23845 * Set selected date to be highlighted on calendar.
23847 * @param obj The calendar object.
23848 * @param selected_time A @b tm struct to represent the selected date.
23850 * Set the selected date, changing the displayed month if needed.
23851 * Selected date changes when the user goes to next/previous month or
23852 * select a day pressing over it on calendar.
23854 * @see elm_calendar_selected_time_get()
23856 * @ref calendar_example_04
23858 * @ingroup Calendar
23860 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23863 * Get selected date.
23865 * @param obj The calendar object
23866 * @param selected_time A @b tm struct to point to selected date
23867 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23870 * Get date selected by the user or set by function
23871 * elm_calendar_selected_time_set().
23872 * Selected date changes when the user goes to next/previous month or
23873 * select a day pressing over it on calendar.
23875 * @see elm_calendar_selected_time_get()
23877 * @ref calendar_example_05
23879 * @ingroup Calendar
23881 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23884 * Set a function to format the string that will be used to display
23887 * @param obj The calendar object
23888 * @param format_function Function to set the month-year string given
23889 * the selected date
23891 * By default it uses strftime with "%B %Y" format string.
23892 * It should allocate the memory that will be used by the string,
23893 * that will be freed by the widget after usage.
23894 * A pointer to the string and a pointer to the time struct will be provided.
23899 * _format_month_year(struct tm *selected_time)
23902 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23903 * return strdup(buf);
23906 * elm_calendar_format_function_set(calendar, _format_month_year);
23909 * @ref calendar_example_02
23911 * @ingroup Calendar
23913 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23916 * Add a new mark to the calendar
23918 * @param obj The calendar object
23919 * @param mark_type A string used to define the type of mark. It will be
23920 * emitted to the theme, that should display a related modification on these
23921 * days representation.
23922 * @param mark_time A time struct to represent the date of inclusion of the
23923 * mark. For marks that repeats it will just be displayed after the inclusion
23924 * date in the calendar.
23925 * @param repeat Repeat the event following this periodicity. Can be a unique
23926 * mark (that don't repeat), daily, weekly, monthly or annually.
23927 * @return The created mark or @p NULL upon failure.
23929 * Add a mark that will be drawn in the calendar respecting the insertion
23930 * time and periodicity. It will emit the type as signal to the widget theme.
23931 * Default theme supports "holiday" and "checked", but it can be extended.
23933 * It won't immediately update the calendar, drawing the marks.
23934 * For this, call elm_calendar_marks_draw(). However, when user selects
23935 * next or previous month calendar forces marks drawn.
23937 * Marks created with this method can be deleted with
23938 * elm_calendar_mark_del().
23942 * struct tm selected_time;
23943 * time_t current_time;
23945 * current_time = time(NULL) + 5 * 84600;
23946 * localtime_r(¤t_time, &selected_time);
23947 * elm_calendar_mark_add(cal, "holiday", selected_time,
23948 * ELM_CALENDAR_ANNUALLY);
23950 * current_time = time(NULL) + 1 * 84600;
23951 * localtime_r(¤t_time, &selected_time);
23952 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23954 * elm_calendar_marks_draw(cal);
23957 * @see elm_calendar_marks_draw()
23958 * @see elm_calendar_mark_del()
23960 * @ref calendar_example_06
23962 * @ingroup Calendar
23964 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);
23967 * Delete mark from the calendar.
23969 * @param mark The mark to be deleted.
23971 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23972 * should be used instead of getting marks list and deleting each one.
23974 * @see elm_calendar_mark_add()
23976 * @ref calendar_example_06
23978 * @ingroup Calendar
23980 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23983 * Remove all calendar's marks
23985 * @param obj The calendar object.
23987 * @see elm_calendar_mark_add()
23988 * @see elm_calendar_mark_del()
23990 * @ingroup Calendar
23992 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23996 * Get a list of all the calendar marks.
23998 * @param obj The calendar object.
23999 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24001 * @see elm_calendar_mark_add()
24002 * @see elm_calendar_mark_del()
24003 * @see elm_calendar_marks_clear()
24005 * @ingroup Calendar
24007 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24010 * Draw calendar marks.
24012 * @param obj The calendar object.
24014 * Should be used after adding, removing or clearing marks.
24015 * It will go through the entire marks list updating the calendar.
24016 * If lots of marks will be added, add all the marks and then call
24019 * When the month is changed, i.e. user selects next or previous month,
24020 * marks will be drawed.
24022 * @see elm_calendar_mark_add()
24023 * @see elm_calendar_mark_del()
24024 * @see elm_calendar_marks_clear()
24026 * @ref calendar_example_06
24028 * @ingroup Calendar
24030 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24033 * Set a day text color to the same that represents Saturdays.
24035 * @param obj The calendar object.
24036 * @param pos The text position. Position is the cell counter, from left
24037 * to right, up to down. It starts on 0 and ends on 41.
24039 * @deprecated use elm_calendar_mark_add() instead like:
24042 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24043 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24046 * @see elm_calendar_mark_add()
24048 * @ingroup Calendar
24050 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24053 * Set a day text color to the same that represents Sundays.
24055 * @param obj The calendar object.
24056 * @param pos The text position. Position is the cell counter, from left
24057 * to right, up to down. It starts on 0 and ends on 41.
24059 * @deprecated use elm_calendar_mark_add() instead like:
24062 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24063 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24066 * @see elm_calendar_mark_add()
24068 * @ingroup Calendar
24070 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24073 * Set a day text color to the same that represents Weekdays.
24075 * @param obj The calendar object
24076 * @param pos The text position. Position is the cell counter, from left
24077 * to right, up to down. It starts on 0 and ends on 41.
24079 * @deprecated use elm_calendar_mark_add() instead like:
24082 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24084 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24085 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24086 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24087 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24088 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24089 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24090 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24091 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24092 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24095 * @see elm_calendar_mark_add()
24097 * @ingroup Calendar
24099 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24102 * Set the interval on time updates for an user mouse button hold
24103 * on calendar widgets' month selection.
24105 * @param obj The calendar object
24106 * @param interval The (first) interval value in seconds
24108 * This interval value is @b decreased while the user holds the
24109 * mouse pointer either selecting next or previous month.
24111 * This helps the user to get to a given month distant from the
24112 * current one easier/faster, as it will start to change quicker and
24113 * quicker on mouse button holds.
24115 * The calculation for the next change interval value, starting from
24116 * the one set with this call, is the previous interval divided by
24117 * 1.05, so it decreases a little bit.
24119 * The default starting interval value for automatic changes is
24122 * @see elm_calendar_interval_get()
24124 * @ingroup Calendar
24126 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24129 * Get the interval on time updates for an user mouse button hold
24130 * on calendar widgets' month selection.
24132 * @param obj The calendar object
24133 * @return The (first) interval value, in seconds, set on it
24135 * @see elm_calendar_interval_set() for more details
24137 * @ingroup Calendar
24139 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24146 * @defgroup Diskselector Diskselector
24147 * @ingroup Elementary
24149 * @image html img/widget/diskselector/preview-00.png
24150 * @image latex img/widget/diskselector/preview-00.eps
24152 * A diskselector is a kind of list widget. It scrolls horizontally,
24153 * and can contain label and icon objects. Three items are displayed
24154 * with the selected one in the middle.
24156 * It can act like a circular list with round mode and labels can be
24157 * reduced for a defined length for side items.
24159 * Smart callbacks one can listen to:
24160 * - "selected" - when item is selected, i.e. scroller stops.
24162 * Available styles for it:
24165 * List of examples:
24166 * @li @ref diskselector_example_01
24167 * @li @ref diskselector_example_02
24171 * @addtogroup Diskselector
24175 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(). */
24178 * Add a new diskselector widget to the given parent Elementary
24179 * (container) object.
24181 * @param parent The parent object.
24182 * @return a new diskselector widget handle or @c NULL, on errors.
24184 * This function inserts a new diskselector widget on the canvas.
24186 * @ingroup Diskselector
24188 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24191 * Enable or disable round mode.
24193 * @param obj The diskselector object.
24194 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24197 * Disabled by default. If round mode is enabled the items list will
24198 * work like a circle list, so when the user reaches the last item,
24199 * the first one will popup.
24201 * @see elm_diskselector_round_get()
24203 * @ingroup Diskselector
24205 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24208 * Get a value whether round mode is enabled or not.
24210 * @see elm_diskselector_round_set() for details.
24212 * @param obj The diskselector object.
24213 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24214 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24216 * @ingroup Diskselector
24218 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24221 * Get the side labels max length.
24223 * @deprecated use elm_diskselector_side_label_length_get() instead:
24225 * @param obj The diskselector object.
24226 * @return The max length defined for side labels, or 0 if not a valid
24229 * @ingroup Diskselector
24231 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24234 * Set the side labels max length.
24236 * @deprecated use elm_diskselector_side_label_length_set() instead:
24238 * @param obj The diskselector object.
24239 * @param len The max length defined for side labels.
24241 * @ingroup Diskselector
24243 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24246 * Get the side labels max length.
24248 * @see elm_diskselector_side_label_length_set() for details.
24250 * @param obj The diskselector object.
24251 * @return The max length defined for side labels, or 0 if not a valid
24254 * @ingroup Diskselector
24256 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24259 * Set the side labels max length.
24261 * @param obj The diskselector object.
24262 * @param len The max length defined for side labels.
24264 * Length is the number of characters of items' label that will be
24265 * visible when it's set on side positions. It will just crop
24266 * the string after defined size. E.g.:
24268 * An item with label "January" would be displayed on side position as
24269 * "Jan" if max length is set to 3, or "Janu", if this property
24272 * When it's selected, the entire label will be displayed, except for
24273 * width restrictions. In this case label will be cropped and "..."
24274 * will be concatenated.
24276 * Default side label max length is 3.
24278 * This property will be applyed over all items, included before or
24279 * later this function call.
24281 * @ingroup Diskselector
24283 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24286 * Set the number of items to be displayed.
24288 * @param obj The diskselector object.
24289 * @param num The number of items the diskselector will display.
24291 * Default value is 3, and also it's the minimun. If @p num is less
24292 * than 3, it will be set to 3.
24294 * Also, it can be set on theme, using data item @c display_item_num
24295 * on group "elm/diskselector/item/X", where X is style set.
24298 * group { name: "elm/diskselector/item/X";
24300 * item: "display_item_num" "5";
24303 * @ingroup Diskselector
24305 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24308 * Get the number of items in the diskselector object.
24310 * @param obj The diskselector object.
24312 * @ingroup Diskselector
24314 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24317 * Set bouncing behaviour when the scrolled content reaches an edge.
24319 * Tell the internal scroller object whether it should bounce or not
24320 * when it reaches the respective edges for each axis.
24322 * @param obj The diskselector object.
24323 * @param h_bounce Whether to bounce or not in the horizontal axis.
24324 * @param v_bounce Whether to bounce or not in the vertical axis.
24326 * @see elm_scroller_bounce_set()
24328 * @ingroup Diskselector
24330 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24333 * Get the bouncing behaviour of the internal scroller.
24335 * Get whether the internal scroller should bounce when the edge of each
24336 * axis is reached scrolling.
24338 * @param obj The diskselector object.
24339 * @param h_bounce Pointer where to store the bounce state of the horizontal
24341 * @param v_bounce Pointer where to store the bounce state of the vertical
24344 * @see elm_scroller_bounce_get()
24345 * @see elm_diskselector_bounce_set()
24347 * @ingroup Diskselector
24349 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24352 * Get the scrollbar policy.
24354 * @see elm_diskselector_scroller_policy_get() for details.
24356 * @param obj The diskselector object.
24357 * @param policy_h Pointer where to store horizontal scrollbar policy.
24358 * @param policy_v Pointer where to store vertical scrollbar policy.
24360 * @ingroup Diskselector
24362 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);
24365 * Set the scrollbar policy.
24367 * @param obj The diskselector object.
24368 * @param policy_h Horizontal scrollbar policy.
24369 * @param policy_v Vertical scrollbar policy.
24371 * This sets the scrollbar visibility policy for the given scroller.
24372 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24373 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24374 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24375 * This applies respectively for the horizontal and vertical scrollbars.
24377 * The both are disabled by default, i.e., are set to
24378 * #ELM_SCROLLER_POLICY_OFF.
24380 * @ingroup Diskselector
24382 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24385 * Remove all diskselector's items.
24387 * @param obj The diskselector object.
24389 * @see elm_diskselector_item_del()
24390 * @see elm_diskselector_item_append()
24392 * @ingroup Diskselector
24394 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24397 * Get a list of all the diskselector items.
24399 * @param obj The diskselector object.
24400 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24401 * or @c NULL on failure.
24403 * @see elm_diskselector_item_append()
24404 * @see elm_diskselector_item_del()
24405 * @see elm_diskselector_clear()
24407 * @ingroup Diskselector
24409 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24412 * Appends a new item to the diskselector object.
24414 * @param obj The diskselector object.
24415 * @param label The label of the diskselector item.
24416 * @param icon The icon object to use at left side of the item. An
24417 * icon can be any Evas object, but usually it is an icon created
24418 * with elm_icon_add().
24419 * @param func The function to call when the item is selected.
24420 * @param data The data to associate with the item for related callbacks.
24422 * @return The created item or @c NULL upon failure.
24424 * A new item will be created and appended to the diskselector, i.e., will
24425 * be set as last item. Also, if there is no selected item, it will
24426 * be selected. This will always happens for the first appended item.
24428 * If no icon is set, label will be centered on item position, otherwise
24429 * the icon will be placed at left of the label, that will be shifted
24432 * Items created with this method can be deleted with
24433 * elm_diskselector_item_del().
24435 * Associated @p data can be properly freed when item is deleted if a
24436 * callback function is set with elm_diskselector_item_del_cb_set().
24438 * If a function is passed as argument, it will be called everytime this item
24439 * is selected, i.e., the user stops the diskselector with this
24440 * item on center position. If such function isn't needed, just passing
24441 * @c NULL as @p func is enough. The same should be done for @p data.
24443 * Simple example (with no function callback or data associated):
24445 * disk = elm_diskselector_add(win);
24446 * ic = elm_icon_add(win);
24447 * elm_icon_file_set(ic, "path/to/image", NULL);
24448 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24449 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24452 * @see elm_diskselector_item_del()
24453 * @see elm_diskselector_item_del_cb_set()
24454 * @see elm_diskselector_clear()
24455 * @see elm_icon_add()
24457 * @ingroup Diskselector
24459 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);
24463 * Delete them item from the diskselector.
24465 * @param it The item of diskselector to be deleted.
24467 * If deleting all diskselector items is required, elm_diskselector_clear()
24468 * should be used instead of getting items list and deleting each one.
24470 * @see elm_diskselector_clear()
24471 * @see elm_diskselector_item_append()
24472 * @see elm_diskselector_item_del_cb_set()
24474 * @ingroup Diskselector
24476 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24479 * Set the function called when a diskselector item is freed.
24481 * @param it The item to set the callback on
24482 * @param func The function called
24484 * If there is a @p func, then it will be called prior item's memory release.
24485 * That will be called with the following arguments:
24487 * @li item's Evas object;
24490 * This way, a data associated to a diskselector item could be properly
24493 * @ingroup Diskselector
24495 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24498 * Get the data associated to the item.
24500 * @param it The diskselector item
24501 * @return The data associated to @p it
24503 * The return value is a pointer to data associated to @p item when it was
24504 * created, with function elm_diskselector_item_append(). If no data
24505 * was passed as argument, it will return @c NULL.
24507 * @see elm_diskselector_item_append()
24509 * @ingroup Diskselector
24511 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24514 * Set the icon associated to the item.
24516 * @param it The diskselector item
24517 * @param icon The icon object to associate with @p it
24519 * The icon object to use at left side of the item. An
24520 * icon can be any Evas object, but usually it is an icon created
24521 * with elm_icon_add().
24523 * Once the icon object is set, a previously set one will be deleted.
24524 * @warning Setting the same icon for two items will cause the icon to
24525 * dissapear from the first item.
24527 * If an icon was passed as argument on item creation, with function
24528 * elm_diskselector_item_append(), it will be already
24529 * associated to the item.
24531 * @see elm_diskselector_item_append()
24532 * @see elm_diskselector_item_icon_get()
24534 * @ingroup Diskselector
24536 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24539 * Get the icon associated to the item.
24541 * @param it The diskselector item
24542 * @return The icon associated to @p it
24544 * The return value is a pointer to the icon associated to @p item when it was
24545 * created, with function elm_diskselector_item_append(), or later
24546 * with function elm_diskselector_item_icon_set. If no icon
24547 * was passed as argument, it will return @c NULL.
24549 * @see elm_diskselector_item_append()
24550 * @see elm_diskselector_item_icon_set()
24552 * @ingroup Diskselector
24554 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24557 * Set the label of item.
24559 * @param it The item of diskselector.
24560 * @param label The label of item.
24562 * The label to be displayed by the item.
24564 * If no icon is set, label will be centered on item position, otherwise
24565 * the icon will be placed at left of the label, that will be shifted
24568 * An item with label "January" would be displayed on side position as
24569 * "Jan" if max length is set to 3 with function
24570 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24573 * When this @p item is selected, the entire label will be displayed,
24574 * except for width restrictions.
24575 * In this case label will be cropped and "..." will be concatenated,
24576 * but only for display purposes. It will keep the entire string, so
24577 * if diskselector is resized the remaining characters will be displayed.
24579 * If a label was passed as argument on item creation, with function
24580 * elm_diskselector_item_append(), it will be already
24581 * displayed by the item.
24583 * @see elm_diskselector_side_label_lenght_set()
24584 * @see elm_diskselector_item_label_get()
24585 * @see elm_diskselector_item_append()
24587 * @ingroup Diskselector
24589 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24592 * Get the label of item.
24594 * @param it The item of diskselector.
24595 * @return The label of item.
24597 * The return value is a pointer to the label associated to @p item when it was
24598 * created, with function elm_diskselector_item_append(), or later
24599 * with function elm_diskselector_item_label_set. If no label
24600 * was passed as argument, it will return @c NULL.
24602 * @see elm_diskselector_item_label_set() for more details.
24603 * @see elm_diskselector_item_append()
24605 * @ingroup Diskselector
24607 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24610 * Get the selected item.
24612 * @param obj The diskselector object.
24613 * @return The selected diskselector item.
24615 * The selected item can be unselected with function
24616 * elm_diskselector_item_selected_set(), and the first item of
24617 * diskselector will be selected.
24619 * The selected item always will be centered on diskselector, with
24620 * full label displayed, i.e., max lenght set to side labels won't
24621 * apply on the selected item. More details on
24622 * elm_diskselector_side_label_length_set().
24624 * @ingroup Diskselector
24626 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24629 * Set the selected state of an item.
24631 * @param it The diskselector item
24632 * @param selected The selected state
24634 * This sets the selected state of the given item @p it.
24635 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24637 * If a new item is selected the previosly selected will be unselected.
24638 * Previoulsy selected item can be get with function
24639 * elm_diskselector_selected_item_get().
24641 * If the item @p it is unselected, the first item of diskselector will
24644 * Selected items will be visible on center position of diskselector.
24645 * So if it was on another position before selected, or was invisible,
24646 * diskselector will animate items until the selected item reaches center
24649 * @see elm_diskselector_item_selected_get()
24650 * @see elm_diskselector_selected_item_get()
24652 * @ingroup Diskselector
24654 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24657 * Get whether the @p item is selected or not.
24659 * @param it The diskselector item.
24660 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24661 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24663 * @see elm_diskselector_selected_item_set() for details.
24664 * @see elm_diskselector_item_selected_get()
24666 * @ingroup Diskselector
24668 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24671 * Get the first item of the diskselector.
24673 * @param obj The diskselector object.
24674 * @return The first item, or @c NULL if none.
24676 * The list of items follows append order. So it will return the first
24677 * item appended to the widget that wasn't deleted.
24679 * @see elm_diskselector_item_append()
24680 * @see elm_diskselector_items_get()
24682 * @ingroup Diskselector
24684 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24687 * Get the last item of the diskselector.
24689 * @param obj The diskselector object.
24690 * @return The last item, or @c NULL if none.
24692 * The list of items follows append order. So it will return last first
24693 * item appended to the widget that wasn't deleted.
24695 * @see elm_diskselector_item_append()
24696 * @see elm_diskselector_items_get()
24698 * @ingroup Diskselector
24700 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24703 * Get the item before @p item in diskselector.
24705 * @param it The diskselector item.
24706 * @return The item before @p item, or @c NULL if none or on failure.
24708 * The list of items follows append order. So it will return item appended
24709 * just before @p item and that wasn't deleted.
24711 * If it is the first item, @c NULL will be returned.
24712 * First item can be get by elm_diskselector_first_item_get().
24714 * @see elm_diskselector_item_append()
24715 * @see elm_diskselector_items_get()
24717 * @ingroup Diskselector
24719 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24722 * Get the item after @p item in diskselector.
24724 * @param it The diskselector item.
24725 * @return The item after @p item, or @c NULL if none or on failure.
24727 * The list of items follows append order. So it will return item appended
24728 * just after @p item and that wasn't deleted.
24730 * If it is the last item, @c NULL will be returned.
24731 * Last item can be get by elm_diskselector_last_item_get().
24733 * @see elm_diskselector_item_append()
24734 * @see elm_diskselector_items_get()
24736 * @ingroup Diskselector
24738 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24741 * Set the text to be shown in the diskselector item.
24743 * @param item Target item
24744 * @param text The text to set in the content
24746 * Setup the text as tooltip to object. The item can have only one tooltip,
24747 * so any previous tooltip data is removed.
24749 * @see elm_object_tooltip_text_set() for more details.
24751 * @ingroup Diskselector
24753 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24756 * Set the content to be shown in the tooltip item.
24758 * Setup the tooltip to item. The item can have only one tooltip,
24759 * so any previous tooltip data is removed. @p func(with @p data) will
24760 * be called every time that need show the tooltip and it should
24761 * return a valid Evas_Object. This object is then managed fully by
24762 * tooltip system and is deleted when the tooltip is gone.
24764 * @param item the diskselector item being attached a tooltip.
24765 * @param func the function used to create the tooltip contents.
24766 * @param data what to provide to @a func as callback data/context.
24767 * @param del_cb called when data is not needed anymore, either when
24768 * another callback replaces @p func, the tooltip is unset with
24769 * elm_diskselector_item_tooltip_unset() or the owner @a item
24770 * dies. This callback receives as the first parameter the
24771 * given @a data, and @c event_info is the item.
24773 * @see elm_object_tooltip_content_cb_set() for more details.
24775 * @ingroup Diskselector
24777 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);
24780 * Unset tooltip from item.
24782 * @param item diskselector item to remove previously set tooltip.
24784 * Remove tooltip from item. The callback provided as del_cb to
24785 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24786 * it is not used anymore.
24788 * @see elm_object_tooltip_unset() for more details.
24789 * @see elm_diskselector_item_tooltip_content_cb_set()
24791 * @ingroup Diskselector
24793 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24797 * Sets a different style for this item tooltip.
24799 * @note before you set a style you should define a tooltip with
24800 * elm_diskselector_item_tooltip_content_cb_set() or
24801 * elm_diskselector_item_tooltip_text_set()
24803 * @param item diskselector item with tooltip already set.
24804 * @param style the theme style to use (default, transparent, ...)
24806 * @see elm_object_tooltip_style_set() for more details.
24808 * @ingroup Diskselector
24810 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24813 * Get the style for this item tooltip.
24815 * @param item diskselector item with tooltip already set.
24816 * @return style the theme style in use, defaults to "default". If the
24817 * object does not have a tooltip set, then NULL is returned.
24819 * @see elm_object_tooltip_style_get() for more details.
24820 * @see elm_diskselector_item_tooltip_style_set()
24822 * @ingroup Diskselector
24824 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24827 * Set the cursor to be shown when mouse is over the diskselector item
24829 * @param item Target item
24830 * @param cursor the cursor name to be used.
24832 * @see elm_object_cursor_set() for more details.
24834 * @ingroup Diskselector
24836 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24839 * Get the cursor to be shown when mouse is over the diskselector item
24841 * @param item diskselector item with cursor already set.
24842 * @return the cursor name.
24844 * @see elm_object_cursor_get() for more details.
24845 * @see elm_diskselector_cursor_set()
24847 * @ingroup Diskselector
24849 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24853 * Unset the cursor to be shown when mouse is over the diskselector item
24855 * @param item Target item
24857 * @see elm_object_cursor_unset() for more details.
24858 * @see elm_diskselector_cursor_set()
24860 * @ingroup Diskselector
24862 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24865 * Sets a different style for this item cursor.
24867 * @note before you set a style you should define a cursor with
24868 * elm_diskselector_item_cursor_set()
24870 * @param item diskselector item with cursor already set.
24871 * @param style the theme style to use (default, transparent, ...)
24873 * @see elm_object_cursor_style_set() for more details.
24875 * @ingroup Diskselector
24877 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24881 * Get the style for this item cursor.
24883 * @param item diskselector item with cursor already set.
24884 * @return style the theme style in use, defaults to "default". If the
24885 * object does not have a cursor set, then @c NULL is returned.
24887 * @see elm_object_cursor_style_get() for more details.
24888 * @see elm_diskselector_item_cursor_style_set()
24890 * @ingroup Diskselector
24892 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24896 * Set if the cursor set should be searched on the theme or should use
24897 * the provided by the engine, only.
24899 * @note before you set if should look on theme you should define a cursor
24900 * with elm_diskselector_item_cursor_set().
24901 * By default it will only look for cursors provided by the engine.
24903 * @param item widget item with cursor already set.
24904 * @param engine_only boolean to define if cursors set with
24905 * elm_diskselector_item_cursor_set() should be searched only
24906 * between cursors provided by the engine or searched on widget's
24909 * @see elm_object_cursor_engine_only_set() for more details.
24911 * @ingroup Diskselector
24913 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24916 * Get the cursor engine only usage for this item cursor.
24918 * @param item widget item with cursor already set.
24919 * @return engine_only boolean to define it cursors should be looked only
24920 * between the provided by the engine or searched on widget's theme as well.
24921 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24923 * @see elm_object_cursor_engine_only_get() for more details.
24924 * @see elm_diskselector_item_cursor_engine_only_set()
24926 * @ingroup Diskselector
24928 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24935 * @defgroup Colorselector Colorselector
24939 * @image html img/widget/colorselector/preview-00.png
24940 * @image latex img/widget/colorselector/preview-00.eps
24942 * @brief Widget for user to select a color.
24944 * Signals that you can add callbacks for are:
24945 * "changed" - When the color value changes(event_info is NULL).
24947 * See @ref tutorial_colorselector.
24950 * @brief Add a new colorselector to the parent
24952 * @param parent The parent object
24953 * @return The new object or NULL if it cannot be created
24955 * @ingroup Colorselector
24957 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24959 * Set a color for the colorselector
24961 * @param obj Colorselector object
24962 * @param r r-value of color
24963 * @param g g-value of color
24964 * @param b b-value of color
24965 * @param a a-value of color
24967 * @ingroup Colorselector
24969 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24971 * Get a color from the colorselector
24973 * @param obj Colorselector object
24974 * @param r integer pointer for r-value of color
24975 * @param g integer pointer for g-value of color
24976 * @param b integer pointer for b-value of color
24977 * @param a integer pointer for a-value of color
24979 * @ingroup Colorselector
24981 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24987 * @defgroup Ctxpopup Ctxpopup
24989 * @image html img/widget/ctxpopup/preview-00.png
24990 * @image latex img/widget/ctxpopup/preview-00.eps
24992 * @brief Context popup widet.
24994 * A ctxpopup is a widget that, when shown, pops up a list of items.
24995 * It automatically chooses an area inside its parent object's view
24996 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24997 * optimally fit into it. In the default theme, it will also point an
24998 * arrow to it's top left position at the time one shows it. Ctxpopup
24999 * items have a label and/or an icon. It is intended for a small
25000 * number of items (hence the use of list, not genlist).
25002 * @note Ctxpopup is a especialization of @ref Hover.
25004 * Signals that you can add callbacks for are:
25005 * "dismissed" - the ctxpopup was dismissed
25007 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25010 typedef enum _Elm_Ctxpopup_Direction
25012 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25014 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25015 the clicked area */
25016 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25017 the clicked area */
25018 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25020 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25021 } Elm_Ctxpopup_Direction;
25024 * @brief Add a new Ctxpopup object to the parent.
25026 * @param parent Parent object
25027 * @return New object or @c NULL, if it cannot be created
25029 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25031 * @brief Set the Ctxpopup's parent
25033 * @param obj The ctxpopup object
25034 * @param area The parent to use
25036 * Set the parent object.
25038 * @note elm_ctxpopup_add() will automatically call this function
25039 * with its @c parent argument.
25041 * @see elm_ctxpopup_add()
25042 * @see elm_hover_parent_set()
25044 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25046 * @brief Get the Ctxpopup's parent
25048 * @param obj The ctxpopup object
25050 * @see elm_ctxpopup_hover_parent_set() for more information
25052 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25054 * @brief Clear all items in the given ctxpopup object.
25056 * @param obj Ctxpopup object
25058 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25060 * @brief Change the ctxpopup's orientation to horizontal or vertical.
25062 * @param obj Ctxpopup object
25063 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25065 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25067 * @brief Get the value of current ctxpopup object's orientation.
25069 * @param obj Ctxpopup object
25070 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25072 * @see elm_ctxpopup_horizontal_set()
25074 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25076 * @brief Add a new item to a ctxpopup object.
25078 * @param obj Ctxpopup object
25079 * @param icon Icon to be set on new item
25080 * @param label The Label of the new item
25081 * @param func Convenience function called when item selected
25082 * @param data Data passed to @p func
25083 * @return A handle to the item added or @c NULL, on errors
25085 * @warning Ctxpopup can't hold both an item list and a content at the same
25086 * time. When an item is added, any previous content will be removed.
25088 * @see elm_ctxpopup_content_set()
25090 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);
25092 * @brief Delete the given item in a ctxpopup object.
25094 * @param it Ctxpopup item to be deleted
25096 * @see elm_ctxpopup_item_append()
25098 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25100 * @brief Set the ctxpopup item's state as disabled or enabled.
25102 * @param it Ctxpopup item to be enabled/disabled
25103 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25105 * When disabled the item is greyed out to indicate it's state.
25107 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25109 * @brief Get the ctxpopup item's disabled/enabled state.
25111 * @param it Ctxpopup item to be enabled/disabled
25112 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25114 * @see elm_ctxpopup_item_disabled_set()
25116 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25118 * @brief Get the icon object for the given ctxpopup item.
25120 * @param it Ctxpopup item
25121 * @return icon object or @c NULL, if the item does not have icon or an error
25124 * @see elm_ctxpopup_item_append()
25125 * @see elm_ctxpopup_item_icon_set()
25127 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25129 * @brief Sets the side icon associated with the ctxpopup item
25131 * @param it Ctxpopup item
25132 * @param icon Icon object to be set
25134 * Once the icon object is set, a previously set one will be deleted.
25135 * @warning Setting the same icon for two items will cause the icon to
25136 * dissapear from the first item.
25138 * @see elm_ctxpopup_item_append()
25140 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25142 * @brief Get the label for the given ctxpopup item.
25144 * @param it Ctxpopup item
25145 * @return label string or @c NULL, if the item does not have label or an
25148 * @see elm_ctxpopup_item_append()
25149 * @see elm_ctxpopup_item_label_set()
25151 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25153 * @brief (Re)set the label on the given ctxpopup item.
25155 * @param it Ctxpopup item
25156 * @param label String to set as label
25158 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25160 * @brief Set an elm widget as the content of the ctxpopup.
25162 * @param obj Ctxpopup object
25163 * @param content Content to be swallowed
25165 * If the content object is already set, a previous one will bedeleted. If
25166 * you want to keep that old content object, use the
25167 * elm_ctxpopup_content_unset() function.
25169 * @deprecated use elm_object_content_set()
25171 * @warning Ctxpopup can't hold both a item list and a content at the same
25172 * time. When a content is set, any previous items will be removed.
25174 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25176 * @brief Unset the ctxpopup content
25178 * @param obj Ctxpopup object
25179 * @return The content that was being used
25181 * Unparent and return the content object which was set for this widget.
25183 * @deprecated use elm_object_content_unset()
25185 * @see elm_ctxpopup_content_set()
25187 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25189 * @brief Set the direction priority of a ctxpopup.
25191 * @param obj Ctxpopup object
25192 * @param first 1st priority of direction
25193 * @param second 2nd priority of direction
25194 * @param third 3th priority of direction
25195 * @param fourth 4th priority of direction
25197 * This functions gives a chance to user to set the priority of ctxpopup
25198 * showing direction. This doesn't guarantee the ctxpopup will appear in the
25199 * requested direction.
25201 * @see Elm_Ctxpopup_Direction
25203 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);
25205 * @brief Get the direction priority of a ctxpopup.
25207 * @param obj Ctxpopup object
25208 * @param first 1st priority of direction to be returned
25209 * @param second 2nd priority of direction to be returned
25210 * @param third 3th priority of direction to be returned
25211 * @param fourth 4th priority of direction to be returned
25213 * @see elm_ctxpopup_direction_priority_set() for more information.
25215 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);
25218 * @brief Get the current direction of a ctxpopup.
25220 * @param obj Ctxpopup object
25221 * @return current direction of a ctxpopup
25223 * @warning Once the ctxpopup showed up, the direction would be determined
25225 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25234 * @defgroup Transit Transit
25235 * @ingroup Elementary
25237 * Transit is designed to apply various animated transition effects to @c
25238 * Evas_Object, such like translation, rotation, etc. For using these
25239 * effects, create an @ref Elm_Transit and add the desired transition effects.
25241 * Once the effects are added into transit, they will be automatically
25242 * managed (their callback will be called until the duration is ended, and
25243 * they will be deleted on completion).
25247 * Elm_Transit *trans = elm_transit_add();
25248 * elm_transit_object_add(trans, obj);
25249 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25250 * elm_transit_duration_set(transit, 1);
25251 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25252 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25253 * elm_transit_repeat_times_set(transit, 3);
25256 * Some transition effects are used to change the properties of objects. They
25258 * @li @ref elm_transit_effect_translation_add
25259 * @li @ref elm_transit_effect_color_add
25260 * @li @ref elm_transit_effect_rotation_add
25261 * @li @ref elm_transit_effect_wipe_add
25262 * @li @ref elm_transit_effect_zoom_add
25263 * @li @ref elm_transit_effect_resizing_add
25265 * Other transition effects are used to make one object disappear and another
25266 * object appear on its old place. These effects are:
25268 * @li @ref elm_transit_effect_flip_add
25269 * @li @ref elm_transit_effect_resizable_flip_add
25270 * @li @ref elm_transit_effect_fade_add
25271 * @li @ref elm_transit_effect_blend_add
25273 * It's also possible to make a transition chain with @ref
25274 * elm_transit_chain_transit_add.
25276 * @warning We strongly recommend to use elm_transit just when edje can not do
25277 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25278 * animations can be manipulated inside the theme.
25280 * List of examples:
25281 * @li @ref transit_example_01_explained
25282 * @li @ref transit_example_02_explained
25283 * @li @ref transit_example_03_c
25284 * @li @ref transit_example_04_c
25290 * @enum Elm_Transit_Tween_Mode
25292 * The type of acceleration used in the transition.
25296 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25297 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25298 over time, then decrease again
25300 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25302 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25304 } Elm_Transit_Tween_Mode;
25307 * @enum Elm_Transit_Effect_Flip_Axis
25309 * The axis where flip effect should be applied.
25313 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25314 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25315 } Elm_Transit_Effect_Flip_Axis;
25317 * @enum Elm_Transit_Effect_Wipe_Dir
25319 * The direction where the wipe effect should occur.
25323 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25324 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25325 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25326 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25327 } Elm_Transit_Effect_Wipe_Dir;
25328 /** @enum Elm_Transit_Effect_Wipe_Type
25330 * Whether the wipe effect should show or hide the object.
25334 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25336 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25338 } Elm_Transit_Effect_Wipe_Type;
25341 * @typedef Elm_Transit
25343 * The Transit created with elm_transit_add(). This type has the information
25344 * about the objects which the transition will be applied, and the
25345 * transition effects that will be used. It also contains info about
25346 * duration, number of repetitions, auto-reverse, etc.
25348 typedef struct _Elm_Transit Elm_Transit;
25349 typedef void Elm_Transit_Effect;
25351 * @typedef Elm_Transit_Effect_Transition_Cb
25353 * Transition callback called for this effect on each transition iteration.
25355 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25357 * Elm_Transit_Effect_End_Cb
25359 * Transition callback called for this effect when the transition is over.
25361 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25364 * Elm_Transit_Del_Cb
25366 * A callback called when the transit is deleted.
25368 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25373 * @note Is not necessary to delete the transit object, it will be deleted at
25374 * the end of its operation.
25375 * @note The transit will start playing when the program enter in the main loop, is not
25376 * necessary to give a start to the transit.
25378 * @return The transit object.
25382 EAPI Elm_Transit *elm_transit_add(void);
25385 * Stops the animation and delete the @p transit object.
25387 * Call this function if you wants to stop the animation before the duration
25388 * time. Make sure the @p transit object is still alive with
25389 * elm_transit_del_cb_set() function.
25390 * All added effects will be deleted, calling its repective data_free_cb
25391 * functions. The function setted by elm_transit_del_cb_set() will be called.
25393 * @see elm_transit_del_cb_set()
25395 * @param transit The transit object to be deleted.
25398 * @warning Just call this function if you are sure the transit is alive.
25400 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25403 * Add a new effect to the transit.
25405 * @note The cb function and the data are the key to the effect. If you try to
25406 * add an already added effect, nothing is done.
25407 * @note After the first addition of an effect in @p transit, if its
25408 * effect list become empty again, the @p transit will be killed by
25409 * elm_transit_del(transit) function.
25413 * Elm_Transit *transit = elm_transit_add();
25414 * elm_transit_effect_add(transit,
25415 * elm_transit_effect_blend_op,
25416 * elm_transit_effect_blend_context_new(),
25417 * elm_transit_effect_blend_context_free);
25420 * @param transit The transit object.
25421 * @param transition_cb The operation function. It is called when the
25422 * animation begins, it is the function that actually performs the animation.
25423 * It is called with the @p data, @p transit and the time progression of the
25424 * animation (a double value between 0.0 and 1.0).
25425 * @param effect The context data of the effect.
25426 * @param end_cb The function to free the context data, it will be called
25427 * at the end of the effect, it must finalize the animation and free the
25431 * @warning The transit free the context data at the and of the transition with
25432 * the data_free_cb function, do not use the context data in another transit.
25434 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);
25437 * Delete an added effect.
25439 * This function will remove the effect from the @p transit, calling the
25440 * data_free_cb to free the @p data.
25442 * @see elm_transit_effect_add()
25444 * @note If the effect is not found, nothing is done.
25445 * @note If the effect list become empty, this function will call
25446 * elm_transit_del(transit), that is, it will kill the @p transit.
25448 * @param transit The transit object.
25449 * @param transition_cb The operation function.
25450 * @param effect The context data of the effect.
25454 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);
25457 * Add new object to apply the effects.
25459 * @note After the first addition of an object in @p transit, if its
25460 * object list become empty again, the @p transit will be killed by
25461 * elm_transit_del(transit) function.
25462 * @note If the @p obj belongs to another transit, the @p obj will be
25463 * removed from it and it will only belong to the @p transit. If the old
25464 * transit stays without objects, it will die.
25465 * @note When you add an object into the @p transit, its state from
25466 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25467 * transit ends, if you change this state whith evas_object_pass_events_set()
25468 * after add the object, this state will change again when @p transit stops to
25471 * @param transit The transit object.
25472 * @param obj Object to be animated.
25475 * @warning It is not allowed to add a new object after transit begins to go.
25477 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25480 * Removes an added object from the transit.
25482 * @note If the @p obj is not in the @p transit, nothing is done.
25483 * @note If the list become empty, this function will call
25484 * elm_transit_del(transit), that is, it will kill the @p transit.
25486 * @param transit The transit object.
25487 * @param obj Object to be removed from @p transit.
25490 * @warning It is not allowed to remove objects after transit begins to go.
25492 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25495 * Get the objects of the transit.
25497 * @param transit The transit object.
25498 * @return a Eina_List with the objects from the transit.
25502 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25505 * Enable/disable keeping up the objects states.
25506 * If it is not kept, the objects states will be reset when transition ends.
25508 * @note @p transit can not be NULL.
25509 * @note One state includes geometry, color, map data.
25511 * @param transit The transit object.
25512 * @param state_keep Keeping or Non Keeping.
25516 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25519 * Get a value whether the objects states will be reset or not.
25521 * @note @p transit can not be NULL
25523 * @see elm_transit_objects_final_state_keep_set()
25525 * @param transit The transit object.
25526 * @return EINA_TRUE means the states of the objects will be reset.
25527 * If @p transit is NULL, EINA_FALSE is returned
25531 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25534 * Set the event enabled when transit is operating.
25536 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25537 * events from mouse and keyboard during the animation.
25538 * @note When you add an object with elm_transit_object_add(), its state from
25539 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25540 * transit ends, if you change this state with evas_object_pass_events_set()
25541 * after adding the object, this state will change again when @p transit stops
25544 * @param transit The transit object.
25545 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25546 * ignored otherwise.
25550 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25553 * Get the value of event enabled status.
25555 * @see elm_transit_event_enabled_set()
25557 * @param transit The Transit object
25558 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25559 * EINA_FALSE is returned
25563 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25566 * Set the user-callback function when the transit is deleted.
25568 * @note Using this function twice will overwrite the first function setted.
25569 * @note the @p transit object will be deleted after call @p cb function.
25571 * @param transit The transit object.
25572 * @param cb Callback function pointer. This function will be called before
25573 * the deletion of the transit.
25574 * @param data Callback funtion user data. It is the @p op parameter.
25578 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25581 * Set reverse effect automatically.
25583 * If auto reverse is setted, after running the effects with the progress
25584 * parameter from 0 to 1, it will call the effecs again with the progress
25585 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25586 * where the duration was setted with the function elm_transit_add and
25587 * the repeat with the function elm_transit_repeat_times_set().
25589 * @param transit The transit object.
25590 * @param reverse EINA_TRUE means the auto_reverse is on.
25594 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25597 * Get if the auto reverse is on.
25599 * @see elm_transit_auto_reverse_set()
25601 * @param transit The transit object.
25602 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25603 * EINA_FALSE is returned
25607 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25610 * Set the transit repeat count. Effect will be repeated by repeat count.
25612 * This function sets the number of repetition the transit will run after
25613 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25614 * If the @p repeat is a negative number, it will repeat infinite times.
25616 * @note If this function is called during the transit execution, the transit
25617 * will run @p repeat times, ignoring the times it already performed.
25619 * @param transit The transit object
25620 * @param repeat Repeat count
25624 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25627 * Get the transit repeat count.
25629 * @see elm_transit_repeat_times_set()
25631 * @param transit The Transit object.
25632 * @return The repeat count. If @p transit is NULL
25637 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25640 * Set the transit animation acceleration type.
25642 * This function sets the tween mode of the transit that can be:
25643 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25644 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25645 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25646 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25648 * @param transit The transit object.
25649 * @param tween_mode The tween type.
25653 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25656 * Get the transit animation acceleration type.
25658 * @note @p transit can not be NULL
25660 * @param transit The transit object.
25661 * @return The tween type. If @p transit is NULL
25662 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25666 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25669 * Set the transit animation time
25671 * @note @p transit can not be NULL
25673 * @param transit The transit object.
25674 * @param duration The animation time.
25678 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25681 * Get the transit animation time
25683 * @note @p transit can not be NULL
25685 * @param transit The transit object.
25687 * @return The transit animation time.
25691 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25694 * Starts the transition.
25695 * Once this API is called, the transit begins to measure the time.
25697 * @note @p transit can not be NULL
25699 * @param transit The transit object.
25703 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25706 * Pause/Resume the transition.
25708 * If you call elm_transit_go again, the transit will be started from the
25709 * beginning, and will be unpaused.
25711 * @note @p transit can not be NULL
25713 * @param transit The transit object.
25714 * @param paused Whether the transition should be paused or not.
25718 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25721 * Get the value of paused status.
25723 * @see elm_transit_paused_set()
25725 * @note @p transit can not be NULL
25727 * @param transit The transit object.
25728 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25729 * EINA_FALSE is returned
25733 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25736 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25738 * The value returned is a fraction (current time / total time). It
25739 * represents the progression position relative to the total.
25741 * @note @p transit can not be NULL
25743 * @param transit The transit object.
25745 * @return The time progression value. If @p transit is NULL
25750 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25753 * Makes the chain relationship between two transits.
25755 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25756 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25758 * @param transit The transit object.
25759 * @param chain_transit The chain transit object. This transit will be operated
25760 * after transit is done.
25762 * This function adds @p chain_transit transition to a chain after the @p
25763 * transit, and will be started as soon as @p transit ends. See @ref
25764 * transit_example_02_explained for a full example.
25768 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25771 * Cut off the chain relationship between two transits.
25773 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25774 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25776 * @param transit The transit object.
25777 * @param chain_transit The chain transit object.
25779 * This function remove the @p chain_transit transition from the @p transit.
25783 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25786 * Get the current chain transit list.
25788 * @note @p transit can not be NULL.
25790 * @param transit The transit object.
25791 * @return chain transit list.
25795 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25798 * Add the Resizing Effect to Elm_Transit.
25800 * @note This API is one of the facades. It creates resizing effect context
25801 * and add it's required APIs to elm_transit_effect_add.
25803 * @see elm_transit_effect_add()
25805 * @param transit Transit object.
25806 * @param from_w Object width size when effect begins.
25807 * @param from_h Object height size when effect begins.
25808 * @param to_w Object width size when effect ends.
25809 * @param to_h Object height size when effect ends.
25810 * @return Resizing effect context data.
25814 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);
25817 * Add the Translation Effect to Elm_Transit.
25819 * @note This API is one of the facades. It creates translation effect context
25820 * and add it's required APIs to elm_transit_effect_add.
25822 * @see elm_transit_effect_add()
25824 * @param transit Transit object.
25825 * @param from_dx X Position variation when effect begins.
25826 * @param from_dy Y Position variation when effect begins.
25827 * @param to_dx X Position variation when effect ends.
25828 * @param to_dy Y Position variation when effect ends.
25829 * @return Translation effect context data.
25832 * @warning It is highly recommended just create a transit with this effect when
25833 * the window that the objects of the transit belongs has already been created.
25834 * This is because this effect needs the geometry information about the objects,
25835 * and if the window was not created yet, it can get a wrong information.
25837 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);
25840 * Add the Zoom Effect to Elm_Transit.
25842 * @note This API is one of the facades. It creates zoom effect context
25843 * and add it's required APIs to elm_transit_effect_add.
25845 * @see elm_transit_effect_add()
25847 * @param transit Transit object.
25848 * @param from_rate Scale rate when effect begins (1 is current rate).
25849 * @param to_rate Scale rate when effect ends.
25850 * @return Zoom effect context data.
25853 * @warning It is highly recommended just create a transit with this effect when
25854 * the window that the objects of the transit belongs has already been created.
25855 * This is because this effect needs the geometry information about the objects,
25856 * and if the window was not created yet, it can get a wrong information.
25858 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25861 * Add the Flip Effect to Elm_Transit.
25863 * @note This API is one of the facades. It creates flip effect context
25864 * and add it's required APIs to elm_transit_effect_add.
25865 * @note This effect is applied to each pair of objects in the order they are listed
25866 * in the transit list of objects. The first object in the pair will be the
25867 * "front" object and the second will be the "back" object.
25869 * @see elm_transit_effect_add()
25871 * @param transit Transit object.
25872 * @param axis Flipping Axis(X or Y).
25873 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25874 * @return Flip effect context data.
25877 * @warning It is highly recommended just create a transit with this effect when
25878 * the window that the objects of the transit belongs has already been created.
25879 * This is because this effect needs the geometry information about the objects,
25880 * and if the window was not created yet, it can get a wrong information.
25882 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25885 * Add the Resizable Flip Effect to Elm_Transit.
25887 * @note This API is one of the facades. It creates resizable flip effect context
25888 * and add it's required APIs to elm_transit_effect_add.
25889 * @note This effect is applied to each pair of objects in the order they are listed
25890 * in the transit list of objects. The first object in the pair will be the
25891 * "front" object and the second will be the "back" object.
25893 * @see elm_transit_effect_add()
25895 * @param transit Transit object.
25896 * @param axis Flipping Axis(X or Y).
25897 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25898 * @return Resizable flip effect context data.
25901 * @warning It is highly recommended just create a transit with this effect when
25902 * the window that the objects of the transit belongs has already been created.
25903 * This is because this effect needs the geometry information about the objects,
25904 * and if the window was not created yet, it can get a wrong information.
25906 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25909 * Add the Wipe Effect to Elm_Transit.
25911 * @note This API is one of the facades. It creates wipe effect context
25912 * and add it's required APIs to elm_transit_effect_add.
25914 * @see elm_transit_effect_add()
25916 * @param transit Transit object.
25917 * @param type Wipe type. Hide or show.
25918 * @param dir Wipe Direction.
25919 * @return Wipe effect context data.
25922 * @warning It is highly recommended just create a transit with this effect when
25923 * the window that the objects of the transit belongs has already been created.
25924 * This is because this effect needs the geometry information about the objects,
25925 * and if the window was not created yet, it can get a wrong information.
25927 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25930 * Add the Color Effect to Elm_Transit.
25932 * @note This API is one of the facades. It creates color effect context
25933 * and add it's required APIs to elm_transit_effect_add.
25935 * @see elm_transit_effect_add()
25937 * @param transit Transit object.
25938 * @param from_r RGB R when effect begins.
25939 * @param from_g RGB G when effect begins.
25940 * @param from_b RGB B when effect begins.
25941 * @param from_a RGB A when effect begins.
25942 * @param to_r RGB R when effect ends.
25943 * @param to_g RGB G when effect ends.
25944 * @param to_b RGB B when effect ends.
25945 * @param to_a RGB A when effect ends.
25946 * @return Color effect context data.
25950 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);
25953 * Add the Fade Effect to Elm_Transit.
25955 * @note This API is one of the facades. It creates fade effect context
25956 * and add it's required APIs to elm_transit_effect_add.
25957 * @note This effect is applied to each pair of objects in the order they are listed
25958 * in the transit list of objects. The first object in the pair will be the
25959 * "before" object and the second will be the "after" object.
25961 * @see elm_transit_effect_add()
25963 * @param transit Transit object.
25964 * @return Fade effect context data.
25967 * @warning It is highly recommended just create a transit with this effect when
25968 * the window that the objects of the transit belongs has already been created.
25969 * This is because this effect needs the color information about the objects,
25970 * and if the window was not created yet, it can get a wrong information.
25972 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25975 * Add the Blend Effect to Elm_Transit.
25977 * @note This API is one of the facades. It creates blend effect context
25978 * and add it's required APIs to elm_transit_effect_add.
25979 * @note This effect is applied to each pair of objects in the order they are listed
25980 * in the transit list of objects. The first object in the pair will be the
25981 * "before" object and the second will be the "after" object.
25983 * @see elm_transit_effect_add()
25985 * @param transit Transit object.
25986 * @return Blend effect context data.
25989 * @warning It is highly recommended just create a transit with this effect when
25990 * the window that the objects of the transit belongs has already been created.
25991 * This is because this effect needs the color information about the objects,
25992 * and if the window was not created yet, it can get a wrong information.
25994 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25997 * Add the Rotation Effect to Elm_Transit.
25999 * @note This API is one of the facades. It creates rotation effect context
26000 * and add it's required APIs to elm_transit_effect_add.
26002 * @see elm_transit_effect_add()
26004 * @param transit Transit object.
26005 * @param from_degree Degree when effect begins.
26006 * @param to_degree Degree when effect is ends.
26007 * @return Rotation effect context data.
26010 * @warning It is highly recommended just create a transit with this effect when
26011 * the window that the objects of the transit belongs has already been created.
26012 * This is because this effect needs the geometry information about the objects,
26013 * and if the window was not created yet, it can get a wrong information.
26015 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26018 * Add the ImageAnimation Effect to Elm_Transit.
26020 * @note This API is one of the facades. It creates image animation effect context
26021 * and add it's required APIs to elm_transit_effect_add.
26022 * The @p images parameter is a list images paths. This list and
26023 * its contents will be deleted at the end of the effect by
26024 * elm_transit_effect_image_animation_context_free() function.
26028 * char buf[PATH_MAX];
26029 * Eina_List *images = NULL;
26030 * Elm_Transit *transi = elm_transit_add();
26032 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26033 * images = eina_list_append(images, eina_stringshare_add(buf));
26035 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26036 * images = eina_list_append(images, eina_stringshare_add(buf));
26037 * elm_transit_effect_image_animation_add(transi, images);
26041 * @see elm_transit_effect_add()
26043 * @param transit Transit object.
26044 * @param images Eina_List of images file paths. This list and
26045 * its contents will be deleted at the end of the effect by
26046 * elm_transit_effect_image_animation_context_free() function.
26047 * @return Image Animation effect context data.
26051 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26056 typedef struct _Elm_Store Elm_Store;
26057 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
26058 typedef struct _Elm_Store_Item Elm_Store_Item;
26059 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
26060 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
26061 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26062 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
26063 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
26064 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
26065 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
26066 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
26068 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26069 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26070 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26071 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26075 ELM_STORE_ITEM_MAPPING_NONE = 0,
26076 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26077 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26078 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26079 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26080 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26081 // can add more here as needed by common apps
26082 ELM_STORE_ITEM_MAPPING_LAST
26083 } Elm_Store_Item_Mapping_Type;
26085 struct _Elm_Store_Item_Mapping_Icon
26087 // FIXME: allow edje file icons
26089 Elm_Icon_Lookup_Order lookup_order;
26090 Eina_Bool standard_name : 1;
26091 Eina_Bool no_scale : 1;
26092 Eina_Bool smooth : 1;
26093 Eina_Bool scale_up : 1;
26094 Eina_Bool scale_down : 1;
26097 struct _Elm_Store_Item_Mapping_Empty
26102 struct _Elm_Store_Item_Mapping_Photo
26107 struct _Elm_Store_Item_Mapping_Custom
26109 Elm_Store_Item_Mapping_Cb func;
26112 struct _Elm_Store_Item_Mapping
26114 Elm_Store_Item_Mapping_Type type;
26119 Elm_Store_Item_Mapping_Empty empty;
26120 Elm_Store_Item_Mapping_Icon icon;
26121 Elm_Store_Item_Mapping_Photo photo;
26122 Elm_Store_Item_Mapping_Custom custom;
26123 // add more types here
26127 struct _Elm_Store_Item_Info
26129 Elm_Genlist_Item_Class *item_class;
26130 const Elm_Store_Item_Mapping *mapping;
26135 struct _Elm_Store_Item_Info_Filesystem
26137 Elm_Store_Item_Info base;
26141 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26142 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26144 EAPI void elm_store_free(Elm_Store *st);
26146 EAPI Elm_Store *elm_store_filesystem_new(void);
26147 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26148 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26149 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26151 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26153 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26154 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26155 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26156 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26157 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26158 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26160 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26161 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26162 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26163 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26164 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26165 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26166 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26169 * @defgroup SegmentControl SegmentControl
26170 * @ingroup Elementary
26172 * @image html img/widget/segment_control/preview-00.png
26173 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26175 * @image html img/segment_control.png
26176 * @image latex img/segment_control.eps width=\textwidth
26178 * Segment control widget is a horizontal control made of multiple segment
26179 * items, each segment item functioning similar to discrete two state button.
26180 * A segment control groups the items together and provides compact
26181 * single button with multiple equal size segments.
26183 * Segment item size is determined by base widget
26184 * size and the number of items added.
26185 * Only one segment item can be at selected state. A segment item can display
26186 * combination of Text and any Evas_Object like Images or other widget.
26188 * Smart callbacks one can listen to:
26189 * - "changed" - When the user clicks on a segment item which is not
26190 * previously selected and get selected. The event_info parameter is the
26191 * segment item index.
26193 * Available styles for it:
26196 * Here is an example on its usage:
26197 * @li @ref segment_control_example
26201 * @addtogroup SegmentControl
26205 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26208 * Add a new segment control widget to the given parent Elementary
26209 * (container) object.
26211 * @param parent The parent object.
26212 * @return a new segment control widget handle or @c NULL, on errors.
26214 * This function inserts a new segment control widget on the canvas.
26216 * @ingroup SegmentControl
26218 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26221 * Append a new item to the segment control object.
26223 * @param obj The segment control object.
26224 * @param icon The icon object to use for the left side of the item. An
26225 * icon can be any Evas object, but usually it is an icon created
26226 * with elm_icon_add().
26227 * @param label The label of the item.
26228 * Note that, NULL is different from empty string "".
26229 * @return The created item or @c NULL upon failure.
26231 * A new item will be created and appended to the segment control, i.e., will
26232 * be set as @b last item.
26234 * If it should be inserted at another position,
26235 * elm_segment_control_item_insert_at() should be used instead.
26237 * Items created with this function can be deleted with function
26238 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26240 * @note @p label set to @c NULL is different from empty string "".
26242 * only has icon, it will be displayed bigger and centered. If it has
26243 * icon and label, even that an empty string, icon will be smaller and
26244 * positioned at left.
26248 * sc = elm_segment_control_add(win);
26249 * ic = elm_icon_add(win);
26250 * elm_icon_file_set(ic, "path/to/image", NULL);
26251 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26252 * elm_segment_control_item_add(sc, ic, "label");
26253 * evas_object_show(sc);
26256 * @see elm_segment_control_item_insert_at()
26257 * @see elm_segment_control_item_del()
26259 * @ingroup SegmentControl
26261 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26264 * Insert a new item to the segment control object at specified position.
26266 * @param obj The segment control object.
26267 * @param icon The icon object to use for the left side of the item. An
26268 * icon can be any Evas object, but usually it is an icon created
26269 * with elm_icon_add().
26270 * @param label The label of the item.
26271 * @param index Item position. Value should be between 0 and items count.
26272 * @return The created item or @c NULL upon failure.
26274 * Index values must be between @c 0, when item will be prepended to
26275 * segment control, and items count, that can be get with
26276 * elm_segment_control_item_count_get(), case when item will be appended
26277 * to segment control, just like elm_segment_control_item_add().
26279 * Items created with this function can be deleted with function
26280 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26282 * @note @p label set to @c NULL is different from empty string "".
26284 * only has icon, it will be displayed bigger and centered. If it has
26285 * icon and label, even that an empty string, icon will be smaller and
26286 * positioned at left.
26288 * @see elm_segment_control_item_add()
26289 * @see elm_segment_control_item_count_get()
26290 * @see elm_segment_control_item_del()
26292 * @ingroup SegmentControl
26294 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);
26297 * Remove a segment control item from its parent, deleting it.
26299 * @param it The item to be removed.
26301 * Items can be added with elm_segment_control_item_add() or
26302 * elm_segment_control_item_insert_at().
26304 * @ingroup SegmentControl
26306 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26309 * Remove a segment control item at given index from its parent,
26312 * @param obj The segment control object.
26313 * @param index The position of the segment control item to be deleted.
26315 * Items can be added with elm_segment_control_item_add() or
26316 * elm_segment_control_item_insert_at().
26318 * @ingroup SegmentControl
26320 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26323 * Get the Segment items count from segment control.
26325 * @param obj The segment control object.
26326 * @return Segment items count.
26328 * It will just return the number of items added to segment control @p obj.
26330 * @ingroup SegmentControl
26332 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26335 * Get the item placed at specified index.
26337 * @param obj The segment control object.
26338 * @param index The index of the segment item.
26339 * @return The segment control item or @c NULL on failure.
26341 * Index is the position of an item in segment control widget. Its
26342 * range is from @c 0 to <tt> count - 1 </tt>.
26343 * Count is the number of items, that can be get with
26344 * elm_segment_control_item_count_get().
26346 * @ingroup SegmentControl
26348 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26351 * Get the label of item.
26353 * @param obj The segment control object.
26354 * @param index The index of the segment item.
26355 * @return The label of the item at @p index.
26357 * The return value is a pointer to the label associated to the item when
26358 * it was created, with function elm_segment_control_item_add(), or later
26359 * with function elm_segment_control_item_label_set. If no label
26360 * was passed as argument, it will return @c NULL.
26362 * @see elm_segment_control_item_label_set() for more details.
26363 * @see elm_segment_control_item_add()
26365 * @ingroup SegmentControl
26367 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26370 * Set the label of item.
26372 * @param it The item of segment control.
26373 * @param text The label of item.
26375 * The label to be displayed by the item.
26376 * Label will be at right of the icon (if set).
26378 * If a label was passed as argument on item creation, with function
26379 * elm_control_segment_item_add(), it will be already
26380 * displayed by the item.
26382 * @see elm_segment_control_item_label_get()
26383 * @see elm_segment_control_item_add()
26385 * @ingroup SegmentControl
26387 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26390 * Get the icon associated to the item.
26392 * @param obj The segment control object.
26393 * @param index The index of the segment item.
26394 * @return The left side icon associated to the item at @p index.
26396 * The return value is a pointer to the icon associated to the item when
26397 * it was created, with function elm_segment_control_item_add(), or later
26398 * with function elm_segment_control_item_icon_set(). If no icon
26399 * was passed as argument, it will return @c NULL.
26401 * @see elm_segment_control_item_add()
26402 * @see elm_segment_control_item_icon_set()
26404 * @ingroup SegmentControl
26406 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26409 * Set the icon associated to the item.
26411 * @param it The segment control item.
26412 * @param icon The icon object to associate with @p it.
26414 * The icon object to use at left side of the item. An
26415 * icon can be any Evas object, but usually it is an icon created
26416 * with elm_icon_add().
26418 * Once the icon object is set, a previously set one will be deleted.
26419 * @warning Setting the same icon for two items will cause the icon to
26420 * dissapear from the first item.
26422 * If an icon was passed as argument on item creation, with function
26423 * elm_segment_control_item_add(), it will be already
26424 * associated to the item.
26426 * @see elm_segment_control_item_add()
26427 * @see elm_segment_control_item_icon_get()
26429 * @ingroup SegmentControl
26431 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26434 * Get the index of an item.
26436 * @param it The segment control item.
26437 * @return The position of item in segment control widget.
26439 * Index is the position of an item in segment control widget. Its
26440 * range is from @c 0 to <tt> count - 1 </tt>.
26441 * Count is the number of items, that can be get with
26442 * elm_segment_control_item_count_get().
26444 * @ingroup SegmentControl
26446 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26449 * Get the base object of the item.
26451 * @param it The segment control item.
26452 * @return The base object associated with @p it.
26454 * Base object is the @c Evas_Object that represents that item.
26456 * @ingroup SegmentControl
26458 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26461 * Get the selected item.
26463 * @param obj The segment control object.
26464 * @return The selected item or @c NULL if none of segment items is
26467 * The selected item can be unselected with function
26468 * elm_segment_control_item_selected_set().
26470 * The selected item always will be highlighted on segment control.
26472 * @ingroup SegmentControl
26474 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26477 * Set the selected state of an item.
26479 * @param it The segment control item
26480 * @param select The selected state
26482 * This sets the selected state of the given item @p it.
26483 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26485 * If a new item is selected the previosly selected will be unselected.
26486 * Previoulsy selected item can be get with function
26487 * elm_segment_control_item_selected_get().
26489 * The selected item always will be highlighted on segment control.
26491 * @see elm_segment_control_item_selected_get()
26493 * @ingroup SegmentControl
26495 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26502 * @defgroup Grid Grid
26504 * The grid is a grid layout widget that lays out a series of children as a
26505 * fixed "grid" of widgets using a given percentage of the grid width and
26506 * height each using the child object.
26508 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26509 * widgets size itself. The default is 100 x 100, so that means the
26510 * position and sizes of children will effectively be percentages (0 to 100)
26511 * of the width or height of the grid widget
26517 * Add a new grid to the parent
26519 * @param parent The parent object
26520 * @return The new object or NULL if it cannot be created
26524 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26527 * Set the virtual size of the grid
26529 * @param obj The grid object
26530 * @param w The virtual width of the grid
26531 * @param h The virtual height of the grid
26535 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26538 * Get the virtual size of the grid
26540 * @param obj The grid object
26541 * @param w Pointer to integer to store the virtual width of the grid
26542 * @param h Pointer to integer to store the virtual height of the grid
26546 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26549 * Pack child at given position and size
26551 * @param obj The grid object
26552 * @param subobj The child to pack
26553 * @param x The virtual x coord at which to pack it
26554 * @param y The virtual y coord at which to pack it
26555 * @param w The virtual width at which to pack it
26556 * @param h The virtual height at which to pack it
26560 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26563 * Unpack a child from a grid object
26565 * @param obj The grid object
26566 * @param subobj The child to unpack
26570 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26573 * Faster way to remove all child objects from a grid object.
26575 * @param obj The grid object
26576 * @param clear If true, it will delete just removed children
26580 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26583 * Set packing of an existing child at to position and size
26585 * @param subobj The child to set packing of
26586 * @param x The virtual x coord at which to pack it
26587 * @param y The virtual y coord at which to pack it
26588 * @param w The virtual width at which to pack it
26589 * @param h The virtual height at which to pack it
26593 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26596 * get packing of a child
26598 * @param subobj The child to query
26599 * @param x Pointer to integer to store the virtual x coord
26600 * @param y Pointer to integer to store the virtual y coord
26601 * @param w Pointer to integer to store the virtual width
26602 * @param h Pointer to integer to store the virtual height
26606 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26612 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26613 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26614 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26615 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26616 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
26617 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
26620 * @defgroup Video Video
26622 * This object display an player that let you control an Elm_Video
26623 * object. It take care of updating it's content according to what is
26624 * going on inside the Emotion object. It does activate the remember
26625 * function on the linked Elm_Video object.
26627 * Signals that you can add callback for are :
26629 * "forward,clicked" - the user clicked the forward button.
26630 * "info,clicked" - the user clicked the info button.
26631 * "next,clicked" - the user clicked the next button.
26632 * "pause,clicked" - the user clicked the pause button.
26633 * "play,clicked" - the user clicked the play button.
26634 * "prev,clicked" - the user clicked the prev button.
26635 * "rewind,clicked" - the user clicked the rewind button.
26636 * "stop,clicked" - the user clicked the stop button.
26638 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26639 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26640 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26641 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26642 EAPI void elm_video_play(Evas_Object *video);
26643 EAPI void elm_video_pause(Evas_Object *video);
26644 EAPI void elm_video_stop(Evas_Object *video);
26645 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26646 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26647 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26648 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26649 EAPI double elm_video_audio_level_get(Evas_Object *video);
26650 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26651 EAPI double elm_video_play_position_get(Evas_Object *video);
26652 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26653 EAPI double elm_video_play_length_get(Evas_Object *video);
26654 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26655 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26656 EAPI const char *elm_video_title_get(Evas_Object *video);
26658 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26659 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26662 * @defgroup Naviframe Naviframe
26664 * @brief Naviframe is a kind of view manager for the applications.
26666 * Naviframe provies functions to switch the different pages with stack
26667 * mechanism. It means if one page(item) needs to be changed to the new one,
26668 * then naviframe would push the new page to it's internal stack. Of course,
26669 * it can be back to the previous page by popping the top page. Naviframe
26670 * provides some transition effect while the pages are switching (such as
26673 * Since the each item could keep the different styles, users could keep the
26674 * same look & feel for the pages or different styles for the items in it's
26677 * Signals that you can add callback for are:
26679 * @li "transition,finished" - When the transition is finished in changing
26681 * @li "title,clicked" - User clicked title area
26683 * Default contents parts for the naviframe items that you can use for are:
26685 * @li "elm.swallow.content" - The main content of the page
26686 * @li "elm.swallow.prev_btn" - The button to go to the previous page
26687 * @li "elm.swallow.next_btn" - The button to go to the next page
26689 * Default text parts for the naviframe items that you can use for are:
26691 * @li "elm.text.title" - The title label in the title area
26693 * @ref tutorial_naviframe gives a good overview of the usage of the API.
26697 * @brief Add a new Naviframe object to the parent.
26699 * @param parent Parent object
26700 * @return New object or @c NULL, if it cannot be created
26702 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26704 * @brief Push a new item to the top of the naviframe stack (and show it).
26706 * @param obj The naviframe object
26707 * @param title_label The label in the title area. The name of the title
26708 * label part is "elm.text.title"
26709 * @param prev_btn The button to go to the previous item. If it is NULL,
26710 * then naviframe will create a back button automatically. The name of
26711 * the prev_btn part is "elm.swallow.prev_btn"
26712 * @param next_btn The button to go to the next item. Or It could be just an
26713 * extra function button. The name of the next_btn part is
26714 * "elm.swallow.next_btn"
26715 * @param content The main content object. The name of content part is
26716 * "elm.swallow.content"
26717 * @param item_style The current item style name. @c NULL would be default.
26718 * @return The created item or @c NULL upon failure.
26720 * The item pushed becomes one page of the naviframe, this item will be
26721 * deleted when it is popped.
26723 * @see also elm_naviframe_item_style_set()
26725 * The following styles are available for this item:
26728 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);
26730 * @brief Pop an item that is on top of the stack
26732 * @param obj The naviframe object
26733 * @return @c NULL or the content object(if the
26734 * elm_naviframe_content_preserve_on_pop_get is true).
26736 * This pops an item that is on the top(visible) of the naviframe, makes it
26737 * disappear, then deletes the item. The item that was underneath it on the
26738 * stack will become visible.
26740 * @see also elm_naviframe_content_preserve_on_pop_get()
26742 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26744 * @brief Pop the items between the top and the above one on the given item.
26746 * @param it The naviframe item
26748 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26750 * @brief preserve the content objects when items are popped.
26752 * @param obj The naviframe object
26753 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
26755 * @see also elm_naviframe_content_preserve_on_pop_get()
26757 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26759 * @brief Get a value whether preserve mode is enabled or not.
26761 * @param obj The naviframe object
26762 * @return If @c EINA_TRUE, preserve mode is enabled
26764 * @see also elm_naviframe_content_preserve_on_pop_set()
26766 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26768 * @brief Get a top item on the naviframe stack
26770 * @param obj The naviframe object
26771 * @return The top item on the naviframe stack or @c NULL, if the stack is
26774 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26776 * @brief Get a bottom item on the naviframe stack
26778 * @param obj The naviframe object
26779 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
26782 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26784 * @brief Set an item style
26786 * @param obj The naviframe item
26787 * @param item_style The current item style name. @c NULL would be default
26789 * The following styles are available for this item:
26792 * @see also elm_naviframe_item_style_get()
26794 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26796 * @brief Get an item style
26798 * @param obj The naviframe item
26799 * @return The current item style name
26801 * @see also elm_naviframe_item_style_set()
26803 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26805 * @brief Show/Hide the title area
26807 * @param it The naviframe item
26808 * @param visible If @c EINA_TRUE, title area will be visible, disable
26811 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
26813 * @see also elm_naviframe_item_title_visible_get()
26815 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26817 * @brief Get a value whether title area is visible or not.
26819 * @param it The naviframe item
26820 * @return If @c EINA_TRUE, title area is visible
26822 * @see also elm_naviframe_item_title_visible_set()
26824 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);