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 *part);
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) elm_object_item_content_part_unset((it), NULL)
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 * Force the box to recalculate its children packing.
5862 * If any children was added or removed, box will not calculate the
5863 * values immediately rather leaving it to the next main loop
5864 * iteration. While this is great as it would save lots of
5865 * recalculation, whenever you need to get the position of a just
5866 * added item you must force recalculate before doing so.
5868 * @param obj The box object.
5870 EAPI void elm_box_recalculate(Evas_Object *obj);
5873 * Set the layout defining function to be used by the box
5875 * Whenever anything changes that requires the box in @p obj to recalculate
5876 * the size and position of its elements, the function @p cb will be called
5877 * to determine what the layout of the children will be.
5879 * Once a custom function is set, everything about the children layout
5880 * is defined by it. The flags set by elm_box_horizontal_set() and
5881 * elm_box_homogeneous_set() no longer have any meaning, and the values
5882 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5883 * layout function to decide if they are used and how. These last two
5884 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5885 * passed to @p cb. The @c Evas_Object the function receives is not the
5886 * Elementary widget, but the internal Evas Box it uses, so none of the
5887 * functions described here can be used on it.
5889 * Any of the layout functions in @c Evas can be used here, as well as the
5890 * special elm_box_layout_transition().
5892 * The final @p data argument received by @p cb is the same @p data passed
5893 * here, and the @p free_data function will be called to free it
5894 * whenever the box is destroyed or another layout function is set.
5896 * Setting @p cb to NULL will revert back to the default layout function.
5898 * @param obj The box object
5899 * @param cb The callback function used for layout
5900 * @param data Data that will be passed to layout function
5901 * @param free_data Function called to free @p data
5903 * @see elm_box_layout_transition()
5905 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);
5907 * Special layout function that animates the transition from one layout to another
5909 * Normally, when switching the layout function for a box, this will be
5910 * reflected immediately on screen on the next render, but it's also
5911 * possible to do this through an animated transition.
5913 * This is done by creating an ::Elm_Box_Transition and setting the box
5914 * layout to this function.
5918 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5919 * evas_object_box_layout_vertical, // start
5920 * NULL, // data for initial layout
5921 * NULL, // free function for initial data
5922 * evas_object_box_layout_horizontal, // end
5923 * NULL, // data for final layout
5924 * NULL, // free function for final data
5925 * anim_end, // will be called when animation ends
5926 * NULL); // data for anim_end function\
5927 * elm_box_layout_set(box, elm_box_layout_transition, t,
5928 * elm_box_transition_free);
5931 * @note This function can only be used with elm_box_layout_set(). Calling
5932 * it directly will not have the expected results.
5934 * @see elm_box_transition_new
5935 * @see elm_box_transition_free
5936 * @see elm_box_layout_set
5938 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5940 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5942 * If you want to animate the change from one layout to another, you need
5943 * to set the layout function of the box to elm_box_layout_transition(),
5944 * passing as user data to it an instance of ::Elm_Box_Transition with the
5945 * necessary information to perform this animation. The free function to
5946 * set for the layout is elm_box_transition_free().
5948 * The parameters to create an ::Elm_Box_Transition sum up to how long
5949 * will it be, in seconds, a layout function to describe the initial point,
5950 * another for the final position of the children and one function to be
5951 * called when the whole animation ends. This last function is useful to
5952 * set the definitive layout for the box, usually the same as the end
5953 * layout for the animation, but could be used to start another transition.
5955 * @param start_layout The layout function that will be used to start the animation
5956 * @param start_layout_data The data to be passed the @p start_layout function
5957 * @param start_layout_free_data Function to free @p start_layout_data
5958 * @param end_layout The layout function that will be used to end the animation
5959 * @param end_layout_free_data The data to be passed the @p end_layout function
5960 * @param end_layout_free_data Function to free @p end_layout_data
5961 * @param transition_end_cb Callback function called when animation ends
5962 * @param transition_end_data Data to be passed to @p transition_end_cb
5963 * @return An instance of ::Elm_Box_Transition
5965 * @see elm_box_transition_new
5966 * @see elm_box_layout_transition
5968 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);
5970 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5972 * This function is mostly useful as the @c free_data parameter in
5973 * elm_box_layout_set() when elm_box_layout_transition().
5975 * @param data The Elm_Box_Transition instance to be freed.
5977 * @see elm_box_transition_new
5978 * @see elm_box_layout_transition
5980 EAPI void elm_box_transition_free(void *data);
5987 * @defgroup Button Button
5989 * @image html img/widget/button/preview-00.png
5990 * @image latex img/widget/button/preview-00.eps
5991 * @image html img/widget/button/preview-01.png
5992 * @image latex img/widget/button/preview-01.eps
5993 * @image html img/widget/button/preview-02.png
5994 * @image latex img/widget/button/preview-02.eps
5996 * This is a push-button. Press it and run some function. It can contain
5997 * a simple label and icon object and it also has an autorepeat feature.
5999 * This widgets emits the following signals:
6000 * @li "clicked": the user clicked the button (press/release).
6001 * @li "repeated": the user pressed the button without releasing it.
6002 * @li "pressed": button was pressed.
6003 * @li "unpressed": button was released after being pressed.
6004 * In all three cases, the @c event parameter of the callback will be
6007 * Also, defined in the default theme, the button has the following styles
6009 * @li default: a normal button.
6010 * @li anchor: Like default, but the button fades away when the mouse is not
6011 * over it, leaving only the text or icon.
6012 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6013 * continuous look across its options.
6014 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6016 * Follow through a complete example @ref button_example_01 "here".
6020 * Add a new button to the parent's canvas
6022 * @param parent The parent object
6023 * @return The new object or NULL if it cannot be created
6025 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6027 * Set the label used in the button
6029 * The passed @p label can be NULL to clean any existing text in it and
6030 * leave the button as an icon only object.
6032 * @param obj The button object
6033 * @param label The text will be written on the button
6034 * @deprecated use elm_object_text_set() instead.
6036 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6038 * Get the label set for the button
6040 * The string returned is an internal pointer and should not be freed or
6041 * altered. It will also become invalid when the button is destroyed.
6042 * The string returned, if not NULL, is a stringshare, so if you need to
6043 * keep it around even after the button is destroyed, you can use
6044 * eina_stringshare_ref().
6046 * @param obj The button object
6047 * @return The text set to the label, or NULL if nothing is set
6048 * @deprecated use elm_object_text_set() instead.
6050 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6052 * Set the icon used for the button
6054 * Setting a new icon will delete any other that was previously set, making
6055 * any reference to them invalid. If you need to maintain the previous
6056 * object alive, unset it first with elm_button_icon_unset().
6058 * @param obj The button object
6059 * @param icon The icon object for the button
6061 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6063 * Get the icon used for the button
6065 * Return the icon object which is set for this widget. If the button is
6066 * destroyed or another icon is set, the returned object will be deleted
6067 * and any reference to it will be invalid.
6069 * @param obj The button object
6070 * @return The icon object that is being used
6072 * @see elm_button_icon_unset()
6074 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6076 * Remove the icon set without deleting it and return the object
6078 * This function drops the reference the button holds of the icon object
6079 * and returns this last object. It is used in case you want to remove any
6080 * icon, or set another one, without deleting the actual object. The button
6081 * will be left without an icon set.
6083 * @param obj The button object
6084 * @return The icon object that was being used
6086 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6088 * Turn on/off the autorepeat event generated when the button is kept pressed
6090 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6091 * signal when they are clicked.
6093 * When on, keeping a button pressed will continuously emit a @c repeated
6094 * signal until the button is released. The time it takes until it starts
6095 * emitting the signal is given by
6096 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6097 * new emission by elm_button_autorepeat_gap_timeout_set().
6099 * @param obj The button object
6100 * @param on A bool to turn on/off the event
6102 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6104 * Get whether the autorepeat feature is enabled
6106 * @param obj The button object
6107 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6109 * @see elm_button_autorepeat_set()
6111 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6113 * Set the initial timeout before the autorepeat event is generated
6115 * Sets the timeout, in seconds, since the button is pressed until the
6116 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6117 * won't be any delay and the even will be fired the moment the button is
6120 * @param obj The button object
6121 * @param t Timeout in seconds
6123 * @see elm_button_autorepeat_set()
6124 * @see elm_button_autorepeat_gap_timeout_set()
6126 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6128 * Get the initial timeout before the autorepeat event is generated
6130 * @param obj The button object
6131 * @return Timeout in seconds
6133 * @see elm_button_autorepeat_initial_timeout_set()
6135 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6137 * Set the interval between each generated autorepeat event
6139 * After the first @c repeated event is fired, all subsequent ones will
6140 * follow after a delay of @p t seconds for each.
6142 * @param obj The button object
6143 * @param t Interval in seconds
6145 * @see elm_button_autorepeat_initial_timeout_set()
6147 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6149 * Get the interval between each generated autorepeat event
6151 * @param obj The button object
6152 * @return Interval in seconds
6154 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6160 * @defgroup File_Selector_Button File Selector Button
6162 * @image html img/widget/fileselector_button/preview-00.png
6163 * @image latex img/widget/fileselector_button/preview-00.eps
6164 * @image html img/widget/fileselector_button/preview-01.png
6165 * @image latex img/widget/fileselector_button/preview-01.eps
6166 * @image html img/widget/fileselector_button/preview-02.png
6167 * @image latex img/widget/fileselector_button/preview-02.eps
6169 * This is a button that, when clicked, creates an Elementary
6170 * window (or inner window) <b> with a @ref Fileselector "file
6171 * selector widget" within</b>. When a file is chosen, the (inner)
6172 * window is closed and the button emits a signal having the
6173 * selected file as it's @c event_info.
6175 * This widget encapsulates operations on its internal file
6176 * selector on its own API. There is less control over its file
6177 * selector than that one would have instatiating one directly.
6179 * The following styles are available for this button:
6182 * @li @c "hoversel_vertical"
6183 * @li @c "hoversel_vertical_entry"
6185 * Smart callbacks one can register to:
6186 * - @c "file,chosen" - the user has selected a path, whose string
6187 * pointer comes as the @c event_info data (a stringshared
6190 * Here is an example on its usage:
6191 * @li @ref fileselector_button_example
6193 * @see @ref File_Selector_Entry for a similar widget.
6198 * Add a new file selector button widget to the given parent
6199 * Elementary (container) object
6201 * @param parent The parent object
6202 * @return a new file selector button widget handle or @c NULL, on
6205 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6208 * Set the label for a given file selector button widget
6210 * @param obj The file selector button widget
6211 * @param label The text label to be displayed on @p obj
6213 * @deprecated use elm_object_text_set() instead.
6215 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6218 * Get the label set for a given file selector button widget
6220 * @param obj The file selector button widget
6221 * @return The button label
6223 * @deprecated use elm_object_text_set() instead.
6225 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6228 * Set the icon on a given file selector button widget
6230 * @param obj The file selector button widget
6231 * @param icon The icon object for the button
6233 * Once the icon object is set, a previously set one will be
6234 * deleted. If you want to keep the latter, use the
6235 * elm_fileselector_button_icon_unset() function.
6237 * @see elm_fileselector_button_icon_get()
6239 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6242 * Get the icon set for a given file selector button widget
6244 * @param obj The file selector button widget
6245 * @return The icon object currently set on @p obj or @c NULL, if
6248 * @see elm_fileselector_button_icon_set()
6250 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6253 * Unset the icon used in a given file selector button widget
6255 * @param obj The file selector button widget
6256 * @return The icon object that was being used on @p obj or @c
6259 * Unparent and return the icon object which was set for this
6262 * @see elm_fileselector_button_icon_set()
6264 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6267 * Set the title for a given file selector button widget's window
6269 * @param obj The file selector button widget
6270 * @param title The title string
6272 * This will change the window's title, when the file selector pops
6273 * out after a click on the button. Those windows have the default
6274 * (unlocalized) value of @c "Select a file" as titles.
6276 * @note It will only take any effect if the file selector
6277 * button widget is @b not under "inwin mode".
6279 * @see elm_fileselector_button_window_title_get()
6281 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6284 * Get the title set for a given file selector button widget's
6287 * @param obj The file selector button widget
6288 * @return Title of the file selector button's window
6290 * @see elm_fileselector_button_window_title_get() for more details
6292 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6295 * Set the size of a given file selector button widget's window,
6296 * holding the file selector itself.
6298 * @param obj The file selector button widget
6299 * @param width The window's width
6300 * @param height The window's height
6302 * @note it will only take any effect if the file selector button
6303 * widget is @b not under "inwin mode". The default size for the
6304 * window (when applicable) is 400x400 pixels.
6306 * @see elm_fileselector_button_window_size_get()
6308 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6311 * Get the size of a given file selector button widget's window,
6312 * holding the file selector itself.
6314 * @param obj The file selector button widget
6315 * @param width Pointer into which to store the width value
6316 * @param height Pointer into which to store the height value
6318 * @note Use @c NULL pointers on the size values you're not
6319 * interested in: they'll be ignored by the function.
6321 * @see elm_fileselector_button_window_size_set(), for more details
6323 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6326 * Set the initial file system path for a given file selector
6329 * @param obj The file selector button widget
6330 * @param path The path string
6332 * It must be a <b>directory</b> path, which will have the contents
6333 * displayed initially in the file selector's view, when invoked
6334 * from @p obj. The default initial path is the @c "HOME"
6335 * environment variable's value.
6337 * @see elm_fileselector_button_path_get()
6339 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6342 * Get the initial file system path set for a given file selector
6345 * @param obj The file selector button widget
6346 * @return path The path string
6348 * @see elm_fileselector_button_path_set() for more details
6350 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6353 * Enable/disable a tree view in the given file selector button
6354 * widget's internal file selector
6356 * @param obj The file selector button widget
6357 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6360 * This has the same effect as elm_fileselector_expandable_set(),
6361 * but now applied to a file selector button's internal file
6364 * @note There's no way to put a file selector button's internal
6365 * file selector in "grid mode", as one may do with "pure" file
6368 * @see elm_fileselector_expandable_get()
6370 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6373 * Get whether tree view is enabled for the given file selector
6374 * button widget's internal file selector
6376 * @param obj The file selector button widget
6377 * @return @c EINA_TRUE if @p obj widget's internal file selector
6378 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6380 * @see elm_fileselector_expandable_set() for more details
6382 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6385 * Set whether a given file selector button widget's internal file
6386 * selector is to display folders only or the directory contents,
6389 * @param obj The file selector button widget
6390 * @param only @c EINA_TRUE to make @p obj widget's internal file
6391 * selector only display directories, @c EINA_FALSE to make files
6392 * to be displayed in it too
6394 * This has the same effect as elm_fileselector_folder_only_set(),
6395 * but now applied to a file selector button's internal file
6398 * @see elm_fileselector_folder_only_get()
6400 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6403 * Get whether a given file selector button widget's internal file
6404 * selector is displaying folders only or the directory contents,
6407 * @param obj The file selector button widget
6408 * @return @c EINA_TRUE if @p obj widget's internal file
6409 * selector is only displaying directories, @c EINA_FALSE if files
6410 * are being displayed in it too (and on errors)
6412 * @see elm_fileselector_button_folder_only_set() for more details
6414 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6417 * Enable/disable the file name entry box where the user can type
6418 * in a name for a file, in a given file selector button widget's
6419 * internal file selector.
6421 * @param obj The file selector button widget
6422 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6423 * file selector a "saving dialog", @c EINA_FALSE otherwise
6425 * This has the same effect as elm_fileselector_is_save_set(),
6426 * but now applied to a file selector button's internal file
6429 * @see elm_fileselector_is_save_get()
6431 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6434 * Get whether the given file selector button widget's internal
6435 * file selector is in "saving dialog" mode
6437 * @param obj The file selector button widget
6438 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6439 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6442 * @see elm_fileselector_button_is_save_set() for more details
6444 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6447 * Set whether a given file selector button widget's internal file
6448 * selector will raise an Elementary "inner window", instead of a
6449 * dedicated Elementary window. By default, it won't.
6451 * @param obj The file selector button widget
6452 * @param value @c EINA_TRUE to make it use an inner window, @c
6453 * EINA_TRUE to make it use a dedicated window
6455 * @see elm_win_inwin_add() for more information on inner windows
6456 * @see elm_fileselector_button_inwin_mode_get()
6458 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6461 * Get whether a given file selector button widget's internal file
6462 * selector will raise an Elementary "inner window", instead of a
6463 * dedicated Elementary window.
6465 * @param obj The file selector button widget
6466 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6467 * if it will use a dedicated window
6469 * @see elm_fileselector_button_inwin_mode_set() for more details
6471 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6478 * @defgroup File_Selector_Entry File Selector Entry
6480 * @image html img/widget/fileselector_entry/preview-00.png
6481 * @image latex img/widget/fileselector_entry/preview-00.eps
6483 * This is an entry made to be filled with or display a <b>file
6484 * system path string</b>. Besides the entry itself, the widget has
6485 * a @ref File_Selector_Button "file selector button" on its side,
6486 * which will raise an internal @ref Fileselector "file selector widget",
6487 * when clicked, for path selection aided by file system
6490 * This file selector may appear in an Elementary window or in an
6491 * inner window. When a file is chosen from it, the (inner) window
6492 * is closed and the selected file's path string is exposed both as
6493 * an smart event and as the new text on the entry.
6495 * This widget encapsulates operations on its internal file
6496 * selector on its own API. There is less control over its file
6497 * selector than that one would have instatiating one directly.
6499 * Smart callbacks one can register to:
6500 * - @c "changed" - The text within the entry was changed
6501 * - @c "activated" - The entry has had editing finished and
6502 * changes are to be "committed"
6503 * - @c "press" - The entry has been clicked
6504 * - @c "longpressed" - The entry has been clicked (and held) for a
6506 * - @c "clicked" - The entry has been clicked
6507 * - @c "clicked,double" - The entry has been double clicked
6508 * - @c "focused" - The entry has received focus
6509 * - @c "unfocused" - The entry has lost focus
6510 * - @c "selection,paste" - A paste action has occurred on the
6512 * - @c "selection,copy" - A copy action has occurred on the entry
6513 * - @c "selection,cut" - A cut action has occurred on the entry
6514 * - @c "unpressed" - The file selector entry's button was released
6515 * after being pressed.
6516 * - @c "file,chosen" - The user has selected a path via the file
6517 * selector entry's internal file selector, whose string pointer
6518 * comes as the @c event_info data (a stringshared string)
6520 * Here is an example on its usage:
6521 * @li @ref fileselector_entry_example
6523 * @see @ref File_Selector_Button for a similar widget.
6528 * Add a new file selector entry widget to the given parent
6529 * Elementary (container) object
6531 * @param parent The parent object
6532 * @return a new file selector entry widget handle or @c NULL, on
6535 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6538 * Set the label for a given file selector entry widget's button
6540 * @param obj The file selector entry widget
6541 * @param label The text label to be displayed on @p obj widget's
6544 * @deprecated use elm_object_text_set() instead.
6546 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6549 * Get the label set for a given file selector entry widget's button
6551 * @param obj The file selector entry widget
6552 * @return The widget button's label
6554 * @deprecated use elm_object_text_set() instead.
6556 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 * Set the icon on a given file selector entry widget's button
6561 * @param obj The file selector entry widget
6562 * @param icon The icon object for the entry's button
6564 * Once the icon object is set, a previously set one will be
6565 * deleted. If you want to keep the latter, use the
6566 * elm_fileselector_entry_button_icon_unset() function.
6568 * @see elm_fileselector_entry_button_icon_get()
6570 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6573 * Get the icon set for a given file selector entry widget's button
6575 * @param obj The file selector entry widget
6576 * @return The icon object currently set on @p obj widget's button
6577 * or @c NULL, if none is
6579 * @see elm_fileselector_entry_button_icon_set()
6581 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6584 * Unset the icon used in a given file selector entry widget's
6587 * @param obj The file selector entry widget
6588 * @return The icon object that was being used on @p obj widget's
6589 * button or @c NULL, on errors
6591 * Unparent and return the icon object which was set for this
6594 * @see elm_fileselector_entry_button_icon_set()
6596 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6599 * Set the title for a given file selector entry widget's window
6601 * @param obj The file selector entry widget
6602 * @param title The title string
6604 * This will change the window's title, when the file selector pops
6605 * out after a click on the entry's button. Those windows have the
6606 * default (unlocalized) value of @c "Select a file" as titles.
6608 * @note It will only take any effect if the file selector
6609 * entry widget is @b not under "inwin mode".
6611 * @see elm_fileselector_entry_window_title_get()
6613 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6616 * Get the title set for a given file selector entry widget's
6619 * @param obj The file selector entry widget
6620 * @return Title of the file selector entry's window
6622 * @see elm_fileselector_entry_window_title_get() for more details
6624 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6627 * Set the size of a given file selector entry widget's window,
6628 * holding the file selector itself.
6630 * @param obj The file selector entry widget
6631 * @param width The window's width
6632 * @param height The window's height
6634 * @note it will only take any effect if the file selector entry
6635 * widget is @b not under "inwin mode". The default size for the
6636 * window (when applicable) is 400x400 pixels.
6638 * @see elm_fileselector_entry_window_size_get()
6640 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6643 * Get the size of a given file selector entry widget's window,
6644 * holding the file selector itself.
6646 * @param obj The file selector entry widget
6647 * @param width Pointer into which to store the width value
6648 * @param height Pointer into which to store the height value
6650 * @note Use @c NULL pointers on the size values you're not
6651 * interested in: they'll be ignored by the function.
6653 * @see elm_fileselector_entry_window_size_set(), for more details
6655 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6658 * Set the initial file system path and the entry's path string for
6659 * a given file selector entry widget
6661 * @param obj The file selector entry widget
6662 * @param path The path string
6664 * It must be a <b>directory</b> path, which will have the contents
6665 * displayed initially in the file selector's view, when invoked
6666 * from @p obj. The default initial path is the @c "HOME"
6667 * environment variable's value.
6669 * @see elm_fileselector_entry_path_get()
6671 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6674 * Get the entry's path string for a given file selector entry
6677 * @param obj The file selector entry widget
6678 * @return path The path string
6680 * @see elm_fileselector_entry_path_set() for more details
6682 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6685 * Enable/disable a tree view in the given file selector entry
6686 * widget's internal file selector
6688 * @param obj The file selector entry widget
6689 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6692 * This has the same effect as elm_fileselector_expandable_set(),
6693 * but now applied to a file selector entry's internal file
6696 * @note There's no way to put a file selector entry's internal
6697 * file selector in "grid mode", as one may do with "pure" file
6700 * @see elm_fileselector_expandable_get()
6702 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6705 * Get whether tree view is enabled for the given file selector
6706 * entry widget's internal file selector
6708 * @param obj The file selector entry widget
6709 * @return @c EINA_TRUE if @p obj widget's internal file selector
6710 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6712 * @see elm_fileselector_expandable_set() for more details
6714 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6717 * Set whether a given file selector entry widget's internal file
6718 * selector is to display folders only or the directory contents,
6721 * @param obj The file selector entry widget
6722 * @param only @c EINA_TRUE to make @p obj widget's internal file
6723 * selector only display directories, @c EINA_FALSE to make files
6724 * to be displayed in it too
6726 * This has the same effect as elm_fileselector_folder_only_set(),
6727 * but now applied to a file selector entry's internal file
6730 * @see elm_fileselector_folder_only_get()
6732 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6735 * Get whether a given file selector entry widget's internal file
6736 * selector is displaying folders only or the directory contents,
6739 * @param obj The file selector entry widget
6740 * @return @c EINA_TRUE if @p obj widget's internal file
6741 * selector is only displaying directories, @c EINA_FALSE if files
6742 * are being displayed in it too (and on errors)
6744 * @see elm_fileselector_entry_folder_only_set() for more details
6746 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6749 * Enable/disable the file name entry box where the user can type
6750 * in a name for a file, in a given file selector entry widget's
6751 * internal file selector.
6753 * @param obj The file selector entry widget
6754 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6755 * file selector a "saving dialog", @c EINA_FALSE otherwise
6757 * This has the same effect as elm_fileselector_is_save_set(),
6758 * but now applied to a file selector entry's internal file
6761 * @see elm_fileselector_is_save_get()
6763 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6766 * Get whether the given file selector entry widget's internal
6767 * file selector is in "saving dialog" mode
6769 * @param obj The file selector entry widget
6770 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6771 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6774 * @see elm_fileselector_entry_is_save_set() for more details
6776 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6779 * Set whether a given file selector entry widget's internal file
6780 * selector will raise an Elementary "inner window", instead of a
6781 * dedicated Elementary window. By default, it won't.
6783 * @param obj The file selector entry widget
6784 * @param value @c EINA_TRUE to make it use an inner window, @c
6785 * EINA_TRUE to make it use a dedicated window
6787 * @see elm_win_inwin_add() for more information on inner windows
6788 * @see elm_fileselector_entry_inwin_mode_get()
6790 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6793 * Get whether a given file selector entry widget's internal file
6794 * selector will raise an Elementary "inner window", instead of a
6795 * dedicated Elementary window.
6797 * @param obj The file selector entry widget
6798 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6799 * if it will use a dedicated window
6801 * @see elm_fileselector_entry_inwin_mode_set() for more details
6803 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6806 * Set the initial file system path for a given file selector entry
6809 * @param obj The file selector entry widget
6810 * @param path The path string
6812 * It must be a <b>directory</b> path, which will have the contents
6813 * displayed initially in the file selector's view, when invoked
6814 * from @p obj. The default initial path is the @c "HOME"
6815 * environment variable's value.
6817 * @see elm_fileselector_entry_path_get()
6819 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6822 * Get the parent directory's path to the latest file selection on
6823 * a given filer selector entry widget
6825 * @param obj The file selector object
6826 * @return The (full) path of the directory of the last selection
6827 * on @p obj widget, a @b stringshared string
6829 * @see elm_fileselector_entry_path_set()
6831 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6838 * @defgroup Scroller Scroller
6840 * A scroller holds a single object and "scrolls it around". This means that
6841 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6842 * region around, allowing to move through a much larger object that is
6843 * contained in the scroller. The scroiller will always have a small minimum
6844 * size by default as it won't be limited by the contents of the scroller.
6846 * Signals that you can add callbacks for are:
6847 * @li "edge,left" - the left edge of the content has been reached
6848 * @li "edge,right" - the right edge of the content has been reached
6849 * @li "edge,top" - the top edge of the content has been reached
6850 * @li "edge,bottom" - the bottom edge of the content has been reached
6851 * @li "scroll" - the content has been scrolled (moved)
6852 * @li "scroll,anim,start" - scrolling animation has started
6853 * @li "scroll,anim,stop" - scrolling animation has stopped
6854 * @li "scroll,drag,start" - dragging the contents around has started
6855 * @li "scroll,drag,stop" - dragging the contents around has stopped
6856 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6859 * @note When Elemementary is in embedded mode the scrollbars will not be
6860 * dragable, they appear merely as indicators of how much has been scrolled.
6861 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6862 * fingerscroll) won't work.
6864 * In @ref tutorial_scroller you'll find an example of how to use most of
6869 * @brief Type that controls when scrollbars should appear.
6871 * @see elm_scroller_policy_set()
6873 typedef enum _Elm_Scroller_Policy
6875 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6876 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6877 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6878 ELM_SCROLLER_POLICY_LAST
6879 } Elm_Scroller_Policy;
6881 * @brief Add a new scroller to the parent
6883 * @param parent The parent object
6884 * @return The new object or NULL if it cannot be created
6886 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6888 * @brief Set the content of the scroller widget (the object to be scrolled around).
6890 * @param obj The scroller object
6891 * @param content The new content object
6893 * Once the content object is set, a previously set one will be deleted.
6894 * If you want to keep that old content object, use the
6895 * elm_scroller_content_unset() function.
6897 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6899 * @brief Get the content of the scroller widget
6901 * @param obj The slider object
6902 * @return The content that is being used
6904 * Return the content object which is set for this widget
6906 * @see elm_scroller_content_set()
6908 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6910 * @brief Unset the content of the scroller widget
6912 * @param obj The slider object
6913 * @return The content that was being used
6915 * Unparent and return the content object which was set for this widget
6917 * @see elm_scroller_content_set()
6919 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6921 * @brief Set custom theme elements for the scroller
6923 * @param obj The scroller object
6924 * @param widget The widget name to use (default is "scroller")
6925 * @param base The base name to use (default is "base")
6927 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6929 * @brief Make the scroller minimum size limited to the minimum size of the content
6931 * @param obj The scroller object
6932 * @param w Enable limiting minimum size horizontally
6933 * @param h Enable limiting minimum size vertically
6935 * By default the scroller will be as small as its design allows,
6936 * irrespective of its content. This will make the scroller minimum size the
6937 * right size horizontally and/or vertically to perfectly fit its content in
6940 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6942 * @brief Show a specific virtual region within the scroller content object
6944 * @param obj The scroller object
6945 * @param x X coordinate of the region
6946 * @param y Y coordinate of the region
6947 * @param w Width of the region
6948 * @param h Height of the region
6950 * This will ensure all (or part if it does not fit) of the designated
6951 * region in the virtual content object (0, 0 starting at the top-left of the
6952 * virtual content object) is shown within the scroller.
6954 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);
6956 * @brief Set the scrollbar visibility policy
6958 * @param obj The scroller object
6959 * @param policy_h Horizontal scrollbar policy
6960 * @param policy_v Vertical scrollbar policy
6962 * This sets the scrollbar visibility policy for the given scroller.
6963 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6964 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6965 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6966 * respectively for the horizontal and vertical scrollbars.
6968 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6970 * @brief Gets scrollbar visibility policy
6972 * @param obj The scroller object
6973 * @param policy_h Horizontal scrollbar policy
6974 * @param policy_v Vertical scrollbar policy
6976 * @see elm_scroller_policy_set()
6978 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6980 * @brief Get the currently visible content region
6982 * @param obj The scroller object
6983 * @param x X coordinate of the region
6984 * @param y Y coordinate of the region
6985 * @param w Width of the region
6986 * @param h Height of the region
6988 * This gets the current region in the content object that is visible through
6989 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6990 * w, @p h values pointed to.
6992 * @note All coordinates are relative to the content.
6994 * @see elm_scroller_region_show()
6996 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);
6998 * @brief Get the size of the content object
7000 * @param obj The scroller object
7001 * @param w Width return
7002 * @param h Height return
7004 * This gets the size of the content object of the scroller.
7006 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7008 * @brief Set bouncing behavior
7010 * @param obj The scroller object
7011 * @param h_bounce Will the scroller bounce horizontally or not
7012 * @param v_bounce Will the scroller bounce vertically or not
7014 * When scrolling, the scroller may "bounce" when reaching an edge of the
7015 * content object. This is a visual way to indicate the end has been reached.
7016 * This is enabled by default for both axis. This will set if it is enabled
7017 * for that axis with the boolean parameters for each axis.
7019 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7021 * @brief Get the bounce mode
7023 * @param obj The Scroller object
7024 * @param h_bounce Allow bounce horizontally
7025 * @param v_bounce Allow bounce vertically
7027 * @see elm_scroller_bounce_set()
7029 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7031 * @brief Set scroll page size relative to viewport size.
7033 * @param obj The scroller object
7034 * @param h_pagerel The horizontal page relative size
7035 * @param v_pagerel The vertical page relative size
7037 * The scroller is capable of limiting scrolling by the user to "pages". That
7038 * is to jump by and only show a "whole page" at a time as if the continuous
7039 * area of the scroller content is split into page sized pieces. This sets
7040 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7041 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7042 * axis. This is mutually exclusive with page size
7043 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7044 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7045 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7048 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7050 * @brief Set scroll page size.
7052 * @param obj The scroller object
7053 * @param h_pagesize The horizontal page size
7054 * @param v_pagesize The vertical page size
7056 * This sets the page size to an absolute fixed value, with 0 turning it off
7059 * @see elm_scroller_page_relative_set()
7061 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7063 * @brief Get scroll current page number.
7065 * @param obj The scroller object
7066 * @param h_pagenumber The horizontal page number
7067 * @param v_pagenumber The vertical page number
7069 * The page number starts from 0. 0 is the first page.
7070 * Current page means the page which meet the top-left of the viewport.
7071 * If there are two or more pages in the viewport, it returns the number of page
7072 * which meet the top-left of the viewport.
7074 * @see elm_scroller_last_page_get()
7075 * @see elm_scroller_page_show()
7076 * @see elm_scroller_page_brint_in()
7078 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7080 * @brief Get scroll last page number.
7082 * @param obj The scroller object
7083 * @param h_pagenumber The horizontal page number
7084 * @param v_pagenumber The vertical page number
7086 * The page number starts from 0. 0 is the first page.
7087 * This returns the last page number among the pages.
7089 * @see elm_scroller_current_page_get()
7090 * @see elm_scroller_page_show()
7091 * @see elm_scroller_page_brint_in()
7093 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7095 * Show a specific virtual region within the scroller content object by page number.
7097 * @param obj The scroller object
7098 * @param h_pagenumber The horizontal page number
7099 * @param v_pagenumber The vertical page number
7101 * 0, 0 of the indicated page is located at the top-left of the viewport.
7102 * This will jump to the page directly without animation.
7107 * sc = elm_scroller_add(win);
7108 * elm_scroller_content_set(sc, content);
7109 * elm_scroller_page_relative_set(sc, 1, 0);
7110 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7111 * elm_scroller_page_show(sc, h_page + 1, v_page);
7114 * @see elm_scroller_page_bring_in()
7116 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7118 * Show a specific virtual region within the scroller content object by page number.
7120 * @param obj The scroller object
7121 * @param h_pagenumber The horizontal page number
7122 * @param v_pagenumber The vertical page number
7124 * 0, 0 of the indicated page is located at the top-left of the viewport.
7125 * This will slide to the page with animation.
7130 * sc = elm_scroller_add(win);
7131 * elm_scroller_content_set(sc, content);
7132 * elm_scroller_page_relative_set(sc, 1, 0);
7133 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7134 * elm_scroller_page_bring_in(sc, h_page, v_page);
7137 * @see elm_scroller_page_show()
7139 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7141 * @brief Show a specific virtual region within the scroller content object.
7143 * @param obj The scroller object
7144 * @param x X coordinate of the region
7145 * @param y Y coordinate of the region
7146 * @param w Width of the region
7147 * @param h Height of the region
7149 * This will ensure all (or part if it does not fit) of the designated
7150 * region in the virtual content object (0, 0 starting at the top-left of the
7151 * virtual content object) is shown within the scroller. Unlike
7152 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7153 * to this location (if configuration in general calls for transitions). It
7154 * may not jump immediately to the new location and make take a while and
7155 * show other content along the way.
7157 * @see elm_scroller_region_show()
7159 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);
7161 * @brief Set event propagation on a scroller
7163 * @param obj The scroller object
7164 * @param propagation If propagation is enabled or not
7166 * This enables or disabled event propagation from the scroller content to
7167 * the scroller and its parent. By default event propagation is disabled.
7169 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7171 * @brief Get event propagation for a scroller
7173 * @param obj The scroller object
7174 * @return The propagation state
7176 * This gets the event propagation for a scroller.
7178 * @see elm_scroller_propagate_events_set()
7180 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7186 * @defgroup Label Label
7188 * @image html img/widget/label/preview-00.png
7189 * @image latex img/widget/label/preview-00.eps
7191 * @brief Widget to display text, with simple html-like markup.
7193 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7194 * text doesn't fit the geometry of the label it will be ellipsized or be
7195 * cut. Elementary provides several themes for this widget:
7196 * @li default - No animation
7197 * @li marker - Centers the text in the label and make it bold by default
7198 * @li slide_long - The entire text appears from the right of the screen and
7199 * slides until it disappears in the left of the screen(reappering on the
7201 * @li slide_short - The text appears in the left of the label and slides to
7202 * the right to show the overflow. When all of the text has been shown the
7203 * position is reset.
7204 * @li slide_bounce - The text appears in the left of the label and slides to
7205 * the right to show the overflow. When all of the text has been shown the
7206 * animation reverses, moving the text to the left.
7208 * Custom themes can of course invent new markup tags and style them any way
7211 * See @ref tutorial_label for a demonstration of how to use a label widget.
7215 * @brief Add a new label to the parent
7217 * @param parent The parent object
7218 * @return The new object or NULL if it cannot be created
7220 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7222 * @brief Set the label on the label object
7224 * @param obj The label object
7225 * @param label The label will be used on the label object
7226 * @deprecated See elm_object_text_set()
7228 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 */
7230 * @brief Get the label used on the label object
7232 * @param obj The label object
7233 * @return The string inside the label
7234 * @deprecated See elm_object_text_get()
7236 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7238 * @brief Set the wrapping behavior of the label
7240 * @param obj The label object
7241 * @param wrap To wrap text or not
7243 * By default no wrapping is done. Possible values for @p wrap are:
7244 * @li ELM_WRAP_NONE - No wrapping
7245 * @li ELM_WRAP_CHAR - wrap between characters
7246 * @li ELM_WRAP_WORD - wrap between words
7247 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7249 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7251 * @brief Get the wrapping behavior of the label
7253 * @param obj The label object
7256 * @see elm_label_line_wrap_set()
7258 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7260 * @brief Set wrap width of the label
7262 * @param obj The label object
7263 * @param w The wrap width in pixels at a minimum where words need to wrap
7265 * This function sets the maximum width size hint of the label.
7267 * @warning This is only relevant if the label is inside a container.
7269 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7271 * @brief Get wrap width of the label
7273 * @param obj The label object
7274 * @return The wrap width in pixels at a minimum where words need to wrap
7276 * @see elm_label_wrap_width_set()
7278 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7280 * @brief Set wrap height of the label
7282 * @param obj The label object
7283 * @param h The wrap height in pixels at a minimum where words need to wrap
7285 * This function sets the maximum height size hint of the label.
7287 * @warning This is only relevant if the label is inside a container.
7289 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7291 * @brief get wrap width of the label
7293 * @param obj The label object
7294 * @return The wrap height in pixels at a minimum where words need to wrap
7296 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7298 * @brief Set the font size on the label object.
7300 * @param obj The label object
7301 * @param size font size
7303 * @warning NEVER use this. It is for hyper-special cases only. use styles
7304 * instead. e.g. "big", "medium", "small" - or better name them by use:
7305 * "title", "footnote", "quote" etc.
7307 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7309 * @brief Set the text color on the label object
7311 * @param obj The label object
7312 * @param r Red property background color of The label object
7313 * @param g Green property background color of The label object
7314 * @param b Blue property background color of The label object
7315 * @param a Alpha property background color of The label object
7317 * @warning NEVER use this. It is for hyper-special cases only. use styles
7318 * instead. e.g. "big", "medium", "small" - or better name them by use:
7319 * "title", "footnote", "quote" etc.
7321 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);
7323 * @brief Set the text align on the label object
7325 * @param obj The label object
7326 * @param align align mode ("left", "center", "right")
7328 * @warning NEVER use this. It is for hyper-special cases only. use styles
7329 * instead. e.g. "big", "medium", "small" - or better name them by use:
7330 * "title", "footnote", "quote" etc.
7332 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7334 * @brief Set background color of the label
7336 * @param obj The label object
7337 * @param r Red property background color of The label object
7338 * @param g Green property background color of The label object
7339 * @param b Blue property background color of The label object
7340 * @param a Alpha property background alpha of The label object
7342 * @warning NEVER use this. It is for hyper-special cases only. use styles
7343 * instead. e.g. "big", "medium", "small" - or better name them by use:
7344 * "title", "footnote", "quote" etc.
7346 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);
7348 * @brief Set the ellipsis behavior of the label
7350 * @param obj The label object
7351 * @param ellipsis To ellipsis text or not
7353 * If set to true and the text doesn't fit in the label an ellipsis("...")
7354 * will be shown at the end of the widget.
7356 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7357 * choosen wrap method was ELM_WRAP_WORD.
7359 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7361 * @brief Set the text slide of the label
7363 * @param obj The label object
7364 * @param slide To start slide or stop
7366 * If set to true the text of the label will slide throught the length of
7369 * @warning This only work with the themes "slide_short", "slide_long" and
7372 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7374 * @brief Get the text slide mode of the label
7376 * @param obj The label object
7377 * @return slide slide mode value
7379 * @see elm_label_slide_set()
7381 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7383 * @brief Set the slide duration(speed) of the label
7385 * @param obj The label object
7386 * @return The duration in seconds in moving text from slide begin position
7387 * to slide end position
7389 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7391 * @brief Get the slide duration(speed) of the label
7393 * @param obj The label object
7394 * @return The duration time in moving text from slide begin position to slide end position
7396 * @see elm_label_slide_duration_set()
7398 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7404 * @defgroup Toggle Toggle
7406 * @image html img/widget/toggle/preview-00.png
7407 * @image latex img/widget/toggle/preview-00.eps
7409 * @brief A toggle is a slider which can be used to toggle between
7410 * two values. It has two states: on and off.
7412 * Signals that you can add callbacks for are:
7413 * @li "changed" - Whenever the toggle value has been changed. Is not called
7414 * until the toggle is released by the cursor (assuming it
7415 * has been triggered by the cursor in the first place).
7417 * @ref tutorial_toggle show how to use a toggle.
7421 * @brief Add a toggle to @p parent.
7423 * @param parent The parent object
7425 * @return The toggle object
7427 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7429 * @brief Sets the label to be displayed with the toggle.
7431 * @param obj The toggle object
7432 * @param label The label to be displayed
7434 * @deprecated use elm_object_text_set() instead.
7436 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7438 * @brief Gets the label of the toggle
7440 * @param obj toggle object
7441 * @return The label of the toggle
7443 * @deprecated use elm_object_text_get() instead.
7445 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7447 * @brief Set the icon used for the toggle
7449 * @param obj The toggle object
7450 * @param icon The icon object for the button
7452 * Once the icon object is set, a previously set one will be deleted
7453 * If you want to keep that old content object, use the
7454 * elm_toggle_icon_unset() function.
7456 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7458 * @brief Get the icon used for the toggle
7460 * @param obj The toggle object
7461 * @return The icon object that is being used
7463 * Return the icon object which is set for this widget.
7465 * @see elm_toggle_icon_set()
7467 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7469 * @brief Unset the icon used for the toggle
7471 * @param obj The toggle object
7472 * @return The icon object that was being used
7474 * Unparent and return the icon object which was set for this widget.
7476 * @see elm_toggle_icon_set()
7478 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7480 * @brief Sets the labels to be associated with the on and off states of the toggle.
7482 * @param obj The toggle object
7483 * @param onlabel The label displayed when the toggle is in the "on" state
7484 * @param offlabel The label displayed when the toggle is in the "off" state
7486 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7488 * @brief Gets the labels associated with the on and off states of the toggle.
7490 * @param obj The toggle object
7491 * @param onlabel A char** to place the onlabel of @p obj into
7492 * @param offlabel A char** to place the offlabel of @p obj into
7494 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7496 * @brief Sets the state of the toggle to @p state.
7498 * @param obj The toggle object
7499 * @param state The state of @p obj
7501 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7503 * @brief Gets the state of the toggle to @p state.
7505 * @param obj The toggle object
7506 * @return The state of @p obj
7508 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7510 * @brief Sets the state pointer of the toggle to @p statep.
7512 * @param obj The toggle object
7513 * @param statep The state pointer of @p obj
7515 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7521 * @defgroup Frame Frame
7523 * @image html img/widget/frame/preview-00.png
7524 * @image latex img/widget/frame/preview-00.eps
7526 * @brief Frame is a widget that holds some content and has a title.
7528 * The default look is a frame with a title, but Frame supports multple
7536 * @li outdent_bottom
7538 * Of all this styles only default shows the title. Frame emits no signals.
7540 * For a detailed example see the @ref tutorial_frame.
7545 * @brief Add a new frame to the parent
7547 * @param parent The parent object
7548 * @return The new object or NULL if it cannot be created
7550 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7552 * @brief Set the frame label
7554 * @param obj The frame object
7555 * @param label The label of this frame object
7557 * @deprecated use elm_object_text_set() instead.
7559 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7561 * @brief Get the frame label
7563 * @param obj The frame object
7565 * @return The label of this frame objet or NULL if unable to get frame
7567 * @deprecated use elm_object_text_get() instead.
7569 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7571 * @brief Set the content of the frame widget
7573 * Once the content object is set, a previously set one will be deleted.
7574 * If you want to keep that old content object, use the
7575 * elm_frame_content_unset() function.
7577 * @param obj The frame object
7578 * @param content The content will be filled in this frame object
7580 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7582 * @brief Get the content of the frame widget
7584 * Return the content object which is set for this widget
7586 * @param obj The frame object
7587 * @return The content that is being used
7589 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7591 * @brief Unset the content of the frame widget
7593 * Unparent and return the content object which was set for this widget
7595 * @param obj The frame object
7596 * @return The content that was being used
7598 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7604 * @defgroup Table Table
7606 * A container widget to arrange other widgets in a table where items can
7607 * also span multiple columns or rows - even overlap (and then be raised or
7608 * lowered accordingly to adjust stacking if they do overlap).
7610 * The followin are examples of how to use a table:
7611 * @li @ref tutorial_table_01
7612 * @li @ref tutorial_table_02
7617 * @brief Add a new table to the parent
7619 * @param parent The parent object
7620 * @return The new object or NULL if it cannot be created
7622 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7624 * @brief Set the homogeneous layout in the table
7626 * @param obj The layout object
7627 * @param homogeneous A boolean to set if the layout is homogeneous in the
7628 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7630 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7632 * @brief Get the current table homogeneous mode.
7634 * @param obj The table object
7635 * @return A boolean to indicating if the layout is homogeneous in the table
7636 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7638 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7640 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7642 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7644 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7646 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7648 * @brief Set padding between cells.
7650 * @param obj The layout object.
7651 * @param horizontal set the horizontal padding.
7652 * @param vertical set the vertical padding.
7654 * Default value is 0.
7656 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7658 * @brief Get padding between cells.
7660 * @param obj The layout object.
7661 * @param horizontal set the horizontal padding.
7662 * @param vertical set the vertical padding.
7664 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7666 * @brief Add a subobject on the table with the coordinates passed
7668 * @param obj The table object
7669 * @param subobj The subobject to be added to the table
7670 * @param x Row number
7671 * @param y Column number
7675 * @note All positioning inside the table is relative to rows and columns, so
7676 * a value of 0 for x and y, means the top left cell of the table, and a
7677 * value of 1 for w and h means @p subobj only takes that 1 cell.
7679 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7681 * @brief Remove child from table.
7683 * @param obj The table object
7684 * @param subobj The subobject
7686 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7688 * @brief Faster way to remove all child objects from a table object.
7690 * @param obj The table object
7691 * @param clear If true, will delete children, else just remove from table.
7693 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7695 * @brief Set the packing location of an existing child of the table
7697 * @param subobj The subobject to be modified in the table
7698 * @param x Row number
7699 * @param y Column number
7703 * Modifies the position of an object already in the table.
7705 * @note All positioning inside the table is relative to rows and columns, so
7706 * a value of 0 for x and y, means the top left cell of the table, and a
7707 * value of 1 for w and h means @p subobj only takes that 1 cell.
7709 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7711 * @brief Get the packing location of an existing child of the table
7713 * @param subobj The subobject to be modified in the table
7714 * @param x Row number
7715 * @param y Column number
7719 * @see elm_table_pack_set()
7721 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7727 * @defgroup Gengrid Gengrid (Generic grid)
7729 * This widget aims to position objects in a grid layout while
7730 * actually creating and rendering only the visible ones, using the
7731 * same idea as the @ref Genlist "genlist": the user defines a @b
7732 * class for each item, specifying functions that will be called at
7733 * object creation, deletion, etc. When those items are selected by
7734 * the user, a callback function is issued. Users may interact with
7735 * a gengrid via the mouse (by clicking on items to select them and
7736 * clicking on the grid's viewport and swiping to pan the whole
7737 * view) or via the keyboard, navigating through item with the
7740 * @section Gengrid_Layouts Gengrid layouts
7742 * Gengrids may layout its items in one of two possible layouts:
7746 * When in "horizontal mode", items will be placed in @b columns,
7747 * from top to bottom and, when the space for a column is filled,
7748 * another one is started on the right, thus expanding the grid
7749 * horizontally, making for horizontal scrolling. When in "vertical
7750 * mode" , though, items will be placed in @b rows, from left to
7751 * right and, when the space for a row is filled, another one is
7752 * started below, thus expanding the grid vertically (and making
7753 * for vertical scrolling).
7755 * @section Gengrid_Items Gengrid items
7757 * An item in a gengrid can have 0 or more text labels (they can be
7758 * regular text or textblock Evas objects - that's up to the style
7759 * to determine), 0 or more icons (which are simply objects
7760 * swallowed into the gengrid item's theming Edje object) and 0 or
7761 * more <b>boolean states</b>, which have the behavior left to the
7762 * user to define. The Edje part names for each of these properties
7763 * will be looked up, in the theme file for the gengrid, under the
7764 * Edje (string) data items named @c "labels", @c "icons" and @c
7765 * "states", respectively. For each of those properties, if more
7766 * than one part is provided, they must have names listed separated
7767 * by spaces in the data fields. For the default gengrid item
7768 * theme, we have @b one label part (@c "elm.text"), @b two icon
7769 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7772 * A gengrid item may be at one of several styles. Elementary
7773 * provides one by default - "default", but this can be extended by
7774 * system or application custom themes/overlays/extensions (see
7775 * @ref Theme "themes" for more details).
7777 * @section Gengrid_Item_Class Gengrid item classes
7779 * In order to have the ability to add and delete items on the fly,
7780 * gengrid implements a class (callback) system where the
7781 * application provides a structure with information about that
7782 * type of item (gengrid may contain multiple different items with
7783 * different classes, states and styles). Gengrid will call the
7784 * functions in this struct (methods) when an item is "realized"
7785 * (i.e., created dynamically, while the user is scrolling the
7786 * grid). All objects will simply be deleted when no longer needed
7787 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7788 * contains the following members:
7789 * - @c item_style - This is a constant string and simply defines
7790 * the name of the item style. It @b must be specified and the
7791 * default should be @c "default".
7792 * - @c func.label_get - This function is called when an item
7793 * object is actually created. The @c data parameter will point to
7794 * the same data passed to elm_gengrid_item_append() and related
7795 * item creation functions. The @c obj parameter is the gengrid
7796 * object itself, while the @c part one is the name string of one
7797 * of the existing text parts in the Edje group implementing the
7798 * item's theme. This function @b must return a strdup'()ed string,
7799 * as the caller will free() it when done. See
7800 * #Elm_Gengrid_Item_Label_Get_Cb.
7801 * - @c func.icon_get - This function is called when an item object
7802 * is actually created. The @c data parameter will point to the
7803 * same data passed to elm_gengrid_item_append() and related item
7804 * creation functions. The @c obj parameter is the gengrid object
7805 * itself, while the @c part one is the name string of one of the
7806 * existing (icon) swallow parts in the Edje group implementing the
7807 * item's theme. It must return @c NULL, when no icon is desired,
7808 * or a valid object handle, otherwise. The object will be deleted
7809 * by the gengrid on its deletion or when the item is "unrealized".
7810 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7811 * - @c func.state_get - This function is called when an item
7812 * object is actually created. The @c data parameter will point to
7813 * the same data passed to elm_gengrid_item_append() and related
7814 * item creation functions. The @c obj parameter is the gengrid
7815 * object itself, while the @c part one is the name string of one
7816 * of the state parts in the Edje group implementing the item's
7817 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7818 * true/on. Gengrids will emit a signal to its theming Edje object
7819 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7820 * "source" arguments, respectively, when the state is true (the
7821 * default is false), where @c XXX is the name of the (state) part.
7822 * See #Elm_Gengrid_Item_State_Get_Cb.
7823 * - @c func.del - This is called when elm_gengrid_item_del() is
7824 * called on an item or elm_gengrid_clear() is called on the
7825 * gengrid. This is intended for use when gengrid items are
7826 * deleted, so any data attached to the item (e.g. its data
7827 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7829 * @section Gengrid_Usage_Hints Usage hints
7831 * If the user wants to have multiple items selected at the same
7832 * time, elm_gengrid_multi_select_set() will permit it. If the
7833 * gengrid is single-selection only (the default), then
7834 * elm_gengrid_select_item_get() will return the selected item or
7835 * @c NULL, if none is selected. If the gengrid is under
7836 * multi-selection, then elm_gengrid_selected_items_get() will
7837 * return a list (that is only valid as long as no items are
7838 * modified (added, deleted, selected or unselected) of child items
7841 * If an item changes (internal (boolean) state, label or icon
7842 * changes), then use elm_gengrid_item_update() to have gengrid
7843 * update the item with the new state. A gengrid will re-"realize"
7844 * the item, thus calling the functions in the
7845 * #Elm_Gengrid_Item_Class set for that item.
7847 * To programmatically (un)select an item, use
7848 * elm_gengrid_item_selected_set(). To get its selected state use
7849 * elm_gengrid_item_selected_get(). To make an item disabled
7850 * (unable to be selected and appear differently) use
7851 * elm_gengrid_item_disabled_set() to set this and
7852 * elm_gengrid_item_disabled_get() to get the disabled state.
7854 * Grid cells will only have their selection smart callbacks called
7855 * when firstly getting selected. Any further clicks will do
7856 * nothing, unless you enable the "always select mode", with
7857 * elm_gengrid_always_select_mode_set(), thus making every click to
7858 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7859 * turn off the ability to select items entirely in the widget and
7860 * they will neither appear selected nor call the selection smart
7863 * Remember that you can create new styles and add your own theme
7864 * augmentation per application with elm_theme_extension_add(). If
7865 * you absolutely must have a specific style that overrides any
7866 * theme the user or system sets up you can use
7867 * elm_theme_overlay_add() to add such a file.
7869 * @section Gengrid_Smart_Events Gengrid smart events
7871 * Smart events that you can add callbacks for are:
7872 * - @c "activated" - The user has double-clicked or pressed
7873 * (enter|return|spacebar) on an item. The @c event_info parameter
7874 * is the gengrid item that was activated.
7875 * - @c "clicked,double" - The user has double-clicked an item.
7876 * The @c event_info parameter is the gengrid item that was double-clicked.
7877 * - @c "longpressed" - This is called when the item is pressed for a certain
7878 * amount of time. By default it's 1 second.
7879 * - @c "selected" - The user has made an item selected. The
7880 * @c event_info parameter is the gengrid item that was selected.
7881 * - @c "unselected" - The user has made an item unselected. The
7882 * @c event_info parameter is the gengrid item that was unselected.
7883 * - @c "realized" - This is called when the item in the gengrid
7884 * has its implementing Evas object instantiated, de facto. @c
7885 * event_info is the gengrid item that was created. The object
7886 * may be deleted at any time, so it is highly advised to the
7887 * caller @b not to use the object pointer returned from
7888 * elm_gengrid_item_object_get(), because it may point to freed
7890 * - @c "unrealized" - This is called when the implementing Evas
7891 * object for this item is deleted. @c event_info is the gengrid
7892 * item that was deleted.
7893 * - @c "changed" - Called when an item is added, removed, resized
7894 * or moved and when the gengrid is resized or gets "horizontal"
7896 * - @c "scroll,anim,start" - This is called when scrolling animation has
7898 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7900 * - @c "drag,start,up" - Called when the item in the gengrid has
7901 * been dragged (not scrolled) up.
7902 * - @c "drag,start,down" - Called when the item in the gengrid has
7903 * been dragged (not scrolled) down.
7904 * - @c "drag,start,left" - Called when the item in the gengrid has
7905 * been dragged (not scrolled) left.
7906 * - @c "drag,start,right" - Called when the item in the gengrid has
7907 * been dragged (not scrolled) right.
7908 * - @c "drag,stop" - Called when the item in the gengrid has
7909 * stopped being dragged.
7910 * - @c "drag" - Called when the item in the gengrid is being
7912 * - @c "scroll" - called when the content has been scrolled
7914 * - @c "scroll,drag,start" - called when dragging the content has
7916 * - @c "scroll,drag,stop" - called when dragging the content has
7918 * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7920 * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7921 * until the bottom edge.
7922 * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7923 * until the left edge.
7924 * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7925 * until the right edge.
7927 * List of gengrid examples:
7928 * @li @ref gengrid_example
7932 * @addtogroup Gengrid
7936 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7937 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7938 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7939 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7940 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. */
7941 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. */
7942 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7944 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7945 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7946 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7947 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7950 * @struct _Elm_Gengrid_Item_Class
7952 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7955 struct _Elm_Gengrid_Item_Class
7957 const char *item_style;
7958 struct _Elm_Gengrid_Item_Class_Func
7960 Elm_Gengrid_Item_Label_Get_Cb label_get;
7961 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7962 Elm_Gengrid_Item_State_Get_Cb state_get;
7963 Elm_Gengrid_Item_Del_Cb del;
7965 }; /**< #Elm_Gengrid_Item_Class member definitions */
7968 * Add a new gengrid widget to the given parent Elementary
7969 * (container) object
7971 * @param parent The parent object
7972 * @return a new gengrid widget handle or @c NULL, on errors
7974 * This function inserts a new gengrid widget on the canvas.
7976 * @see elm_gengrid_item_size_set()
7977 * @see elm_gengrid_group_item_size_set()
7978 * @see elm_gengrid_horizontal_set()
7979 * @see elm_gengrid_item_append()
7980 * @see elm_gengrid_item_del()
7981 * @see elm_gengrid_clear()
7985 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7988 * Set the size for the items of a given gengrid widget
7990 * @param obj The gengrid object.
7991 * @param w The items' width.
7992 * @param h The items' height;
7994 * A gengrid, after creation, has still no information on the size
7995 * to give to each of its cells. So, you most probably will end up
7996 * with squares one @ref Fingers "finger" wide, the default
7997 * size. Use this function to force a custom size for you items,
7998 * making them as big as you wish.
8000 * @see elm_gengrid_item_size_get()
8004 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8007 * Get the size set for the items of a given gengrid widget
8009 * @param obj The gengrid object.
8010 * @param w Pointer to a variable where to store the items' width.
8011 * @param h Pointer to a variable where to store the items' height.
8013 * @note Use @c NULL pointers on the size values you're not
8014 * interested in: they'll be ignored by the function.
8016 * @see elm_gengrid_item_size_get() for more details
8020 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8023 * Set the size for the group items of a given gengrid widget
8025 * @param obj The gengrid object.
8026 * @param w The group items' width.
8027 * @param h The group items' height;
8029 * A gengrid, after creation, has still no information on the size
8030 * to give to each of its cells. So, you most probably will end up
8031 * with squares one @ref Fingers "finger" wide, the default
8032 * size. Use this function to force a custom size for you group items,
8033 * making them as big as you wish.
8035 * @see elm_gengrid_group_item_size_get()
8039 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8042 * Get the size set for the group items of a given gengrid widget
8044 * @param obj The gengrid object.
8045 * @param w Pointer to a variable where to store the group items' width.
8046 * @param h Pointer to a variable where to store the group items' height.
8048 * @note Use @c NULL pointers on the size values you're not
8049 * interested in: they'll be ignored by the function.
8051 * @see elm_gengrid_group_item_size_get() for more details
8055 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8058 * Set the items grid's alignment within a given gengrid widget
8060 * @param obj The gengrid object.
8061 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8062 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8064 * This sets the alignment of the whole grid of items of a gengrid
8065 * within its given viewport. By default, those values are both
8066 * 0.5, meaning that the gengrid will have its items grid placed
8067 * exactly in the middle of its viewport.
8069 * @note If given alignment values are out of the cited ranges,
8070 * they'll be changed to the nearest boundary values on the valid
8073 * @see elm_gengrid_align_get()
8077 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8080 * Get the items grid's alignment values within a given gengrid
8083 * @param obj The gengrid object.
8084 * @param align_x Pointer to a variable where to store the
8085 * horizontal alignment.
8086 * @param align_y Pointer to a variable where to store the vertical
8089 * @note Use @c NULL pointers on the alignment values you're not
8090 * interested in: they'll be ignored by the function.
8092 * @see elm_gengrid_align_set() for more details
8096 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8099 * Set whether a given gengrid widget is or not able have items
8102 * @param obj The gengrid object
8103 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8104 * @c EINA_FALSE to turn it off
8106 * If a gengrid is set to allow reordering, a click held for more
8107 * than 0.5 over a given item will highlight it specially,
8108 * signalling the gengrid has entered the reordering state. From
8109 * that time on, the user will be able to, while still holding the
8110 * mouse button down, move the item freely in the gengrid's
8111 * viewport, replacing to said item to the locations it goes to.
8112 * The replacements will be animated and, whenever the user
8113 * releases the mouse button, the item being replaced gets a new
8114 * definitive place in the grid.
8116 * @see elm_gengrid_reorder_mode_get()
8120 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8123 * Get whether a given gengrid widget is or not able have items
8126 * @param obj The gengrid object
8127 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8130 * @see elm_gengrid_reorder_mode_set() for more details
8134 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8137 * Append a new item in a given gengrid widget.
8139 * @param obj The gengrid object.
8140 * @param gic The item class for the item.
8141 * @param data The item data.
8142 * @param func Convenience function called when the item is
8144 * @param func_data Data to be passed to @p func.
8145 * @return A handle to the item added or @c NULL, on errors.
8147 * This adds an item to the beginning of the gengrid.
8149 * @see elm_gengrid_item_prepend()
8150 * @see elm_gengrid_item_insert_before()
8151 * @see elm_gengrid_item_insert_after()
8152 * @see elm_gengrid_item_del()
8156 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);
8159 * Prepend a new item in a given gengrid widget.
8161 * @param obj The gengrid object.
8162 * @param gic The item class for the item.
8163 * @param data The item data.
8164 * @param func Convenience function called when the item is
8166 * @param func_data Data to be passed to @p func.
8167 * @return A handle to the item added or @c NULL, on errors.
8169 * This adds an item to the end of the gengrid.
8171 * @see elm_gengrid_item_append()
8172 * @see elm_gengrid_item_insert_before()
8173 * @see elm_gengrid_item_insert_after()
8174 * @see elm_gengrid_item_del()
8178 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);
8181 * Insert an item before another in a gengrid widget
8183 * @param obj The gengrid object.
8184 * @param gic The item class for the item.
8185 * @param data The item data.
8186 * @param relative The item to place this new one before.
8187 * @param func Convenience function called when the item is
8189 * @param func_data Data to be passed to @p func.
8190 * @return A handle to the item added or @c NULL, on errors.
8192 * This inserts an item before another in the gengrid.
8194 * @see elm_gengrid_item_append()
8195 * @see elm_gengrid_item_prepend()
8196 * @see elm_gengrid_item_insert_after()
8197 * @see elm_gengrid_item_del()
8201 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);
8204 * Insert an item after another in a gengrid widget
8206 * @param obj The gengrid object.
8207 * @param gic The item class for the item.
8208 * @param data The item data.
8209 * @param relative The item to place this new one after.
8210 * @param func Convenience function called when the item is
8212 * @param func_data Data to be passed to @p func.
8213 * @return A handle to the item added or @c NULL, on errors.
8215 * This inserts an item after another in the gengrid.
8217 * @see elm_gengrid_item_append()
8218 * @see elm_gengrid_item_prepend()
8219 * @see elm_gengrid_item_insert_after()
8220 * @see elm_gengrid_item_del()
8224 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);
8226 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);
8228 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);
8231 * Set whether items on a given gengrid widget are to get their
8232 * selection callbacks issued for @b every subsequent selection
8233 * click on them or just for the first click.
8235 * @param obj The gengrid object
8236 * @param always_select @c EINA_TRUE to make items "always
8237 * selected", @c EINA_FALSE, otherwise
8239 * By default, grid items will only call their selection callback
8240 * function when firstly getting selected, any subsequent further
8241 * clicks will do nothing. With this call, you make those
8242 * subsequent clicks also to issue the selection callbacks.
8244 * @note <b>Double clicks</b> will @b always be reported on items.
8246 * @see elm_gengrid_always_select_mode_get()
8250 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8253 * Get whether items on a given gengrid widget have their selection
8254 * callbacks issued for @b every subsequent selection click on them
8255 * or just for the first click.
8257 * @param obj The gengrid object.
8258 * @return @c EINA_TRUE if the gengrid items are "always selected",
8259 * @c EINA_FALSE, otherwise
8261 * @see elm_gengrid_always_select_mode_set() for more details
8265 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8268 * Set whether items on a given gengrid widget can be selected or not.
8270 * @param obj The gengrid object
8271 * @param no_select @c EINA_TRUE to make items selectable,
8272 * @c EINA_FALSE otherwise
8274 * This will make items in @p obj selectable or not. In the latter
8275 * case, any user interaction on the gengrid items will neither make
8276 * them appear selected nor them call their selection callback
8279 * @see elm_gengrid_no_select_mode_get()
8283 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8286 * Get whether items on a given gengrid widget can be selected or
8289 * @param obj The gengrid object
8290 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8293 * @see elm_gengrid_no_select_mode_set() for more details
8297 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8300 * Enable or disable multi-selection in a given gengrid widget
8302 * @param obj The gengrid object.
8303 * @param multi @c EINA_TRUE, to enable multi-selection,
8304 * @c EINA_FALSE to disable it.
8306 * Multi-selection is the ability for one to have @b more than one
8307 * item selected, on a given gengrid, simultaneously. When it is
8308 * enabled, a sequence of clicks on different items will make them
8309 * all selected, progressively. A click on an already selected item
8310 * will unselect it. If interecting via the keyboard,
8311 * multi-selection is enabled while holding the "Shift" key.
8313 * @note By default, multi-selection is @b disabled on gengrids
8315 * @see elm_gengrid_multi_select_get()
8319 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8322 * Get whether multi-selection is enabled or disabled for a given
8325 * @param obj The gengrid object.
8326 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8327 * EINA_FALSE otherwise
8329 * @see elm_gengrid_multi_select_set() for more details
8333 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8336 * Enable or disable bouncing effect for a given gengrid widget
8338 * @param obj The gengrid object
8339 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8340 * @c EINA_FALSE to disable it
8341 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8342 * @c EINA_FALSE to disable it
8344 * The bouncing effect occurs whenever one reaches the gengrid's
8345 * edge's while panning it -- it will scroll past its limits a
8346 * little bit and return to the edge again, in a animated for,
8349 * @note By default, gengrids have bouncing enabled on both axis
8351 * @see elm_gengrid_bounce_get()
8355 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8358 * Get whether bouncing effects are enabled or disabled, for a
8359 * given gengrid widget, on each axis
8361 * @param obj The gengrid object
8362 * @param h_bounce Pointer to a variable where to store the
8363 * horizontal bouncing flag.
8364 * @param v_bounce Pointer to a variable where to store the
8365 * vertical bouncing flag.
8367 * @see elm_gengrid_bounce_set() for more details
8371 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8374 * Set a given gengrid widget's scrolling page size, relative to
8375 * its viewport size.
8377 * @param obj The gengrid object
8378 * @param h_pagerel The horizontal page (relative) size
8379 * @param v_pagerel The vertical page (relative) size
8381 * The gengrid's scroller is capable of binding scrolling by the
8382 * user to "pages". It means that, while scrolling and, specially
8383 * after releasing the mouse button, the grid will @b snap to the
8384 * nearest displaying page's area. When page sizes are set, the
8385 * grid's continuous content area is split into (equal) page sized
8388 * This function sets the size of a page <b>relatively to the
8389 * viewport dimensions</b> of the gengrid, for each axis. A value
8390 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8391 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8392 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8393 * 1.0. Values beyond those will make it behave behave
8394 * inconsistently. If you only want one axis to snap to pages, use
8395 * the value @c 0.0 for the other one.
8397 * There is a function setting page size values in @b absolute
8398 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8399 * is mutually exclusive to this one.
8401 * @see elm_gengrid_page_relative_get()
8405 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8408 * Get a given gengrid widget's scrolling page size, relative to
8409 * its viewport size.
8411 * @param obj The gengrid object
8412 * @param h_pagerel Pointer to a variable where to store the
8413 * horizontal page (relative) size
8414 * @param v_pagerel Pointer to a variable where to store the
8415 * vertical page (relative) size
8417 * @see elm_gengrid_page_relative_set() for more details
8421 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8424 * Set a given gengrid widget's scrolling page size
8426 * @param obj The gengrid object
8427 * @param h_pagerel The horizontal page size, in pixels
8428 * @param v_pagerel The vertical page size, in pixels
8430 * The gengrid's scroller is capable of binding scrolling by the
8431 * user to "pages". It means that, while scrolling and, specially
8432 * after releasing the mouse button, the grid will @b snap to the
8433 * nearest displaying page's area. When page sizes are set, the
8434 * grid's continuous content area is split into (equal) page sized
8437 * This function sets the size of a page of the gengrid, in pixels,
8438 * for each axis. Sane usable values are, between @c 0 and the
8439 * dimensions of @p obj, for each axis. Values beyond those will
8440 * make it behave behave inconsistently. If you only want one axis
8441 * to snap to pages, use the value @c 0 for the other one.
8443 * There is a function setting page size values in @b relative
8444 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8445 * use is mutually exclusive to this one.
8449 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8452 * @brief Get gengrid current page number.
8454 * @param obj The gengrid object
8455 * @param h_pagenumber The horizontal page number
8456 * @param v_pagenumber The vertical page number
8458 * The page number starts from 0. 0 is the first page.
8459 * Current page means the page which meet the top-left of the viewport.
8460 * If there are two or more pages in the viewport, it returns the number of page
8461 * which meet the top-left of the viewport.
8463 * @see elm_gengrid_last_page_get()
8464 * @see elm_gengrid_page_show()
8465 * @see elm_gengrid_page_brint_in()
8467 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8470 * @brief Get scroll last page number.
8472 * @param obj The gengrid object
8473 * @param h_pagenumber The horizontal page number
8474 * @param v_pagenumber The vertical page number
8476 * The page number starts from 0. 0 is the first page.
8477 * This returns the last page number among the pages.
8479 * @see elm_gengrid_current_page_get()
8480 * @see elm_gengrid_page_show()
8481 * @see elm_gengrid_page_brint_in()
8483 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8486 * Show a specific virtual region within the gengrid content object by page number.
8488 * @param obj The gengrid object
8489 * @param h_pagenumber The horizontal page number
8490 * @param v_pagenumber The vertical page number
8492 * 0, 0 of the indicated page is located at the top-left of the viewport.
8493 * This will jump to the page directly without animation.
8498 * sc = elm_gengrid_add(win);
8499 * elm_gengrid_content_set(sc, content);
8500 * elm_gengrid_page_relative_set(sc, 1, 0);
8501 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8502 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8505 * @see elm_gengrid_page_bring_in()
8507 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8510 * Show a specific virtual region within the gengrid content object by page number.
8512 * @param obj The gengrid object
8513 * @param h_pagenumber The horizontal page number
8514 * @param v_pagenumber The vertical page number
8516 * 0, 0 of the indicated page is located at the top-left of the viewport.
8517 * This will slide to the page with animation.
8522 * sc = elm_gengrid_add(win);
8523 * elm_gengrid_content_set(sc, content);
8524 * elm_gengrid_page_relative_set(sc, 1, 0);
8525 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8526 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8529 * @see elm_gengrid_page_show()
8531 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8534 * Set for what direction a given gengrid widget will expand while
8535 * placing its items.
8537 * @param obj The gengrid object.
8538 * @param setting @c EINA_TRUE to make the gengrid expand
8539 * horizontally, @c EINA_FALSE to expand vertically.
8541 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8542 * in @b columns, from top to bottom and, when the space for a
8543 * column is filled, another one is started on the right, thus
8544 * expanding the grid horizontally. When in "vertical mode"
8545 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8546 * to right and, when the space for a row is filled, another one is
8547 * started below, thus expanding the grid vertically.
8549 * @see elm_gengrid_horizontal_get()
8553 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8556 * Get for what direction a given gengrid widget will expand while
8557 * placing its items.
8559 * @param obj The gengrid object.
8560 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8561 * @c EINA_FALSE if it's set to expand vertically.
8563 * @see elm_gengrid_horizontal_set() for more detais
8567 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8570 * Get the first item in a given gengrid widget
8572 * @param obj The gengrid object
8573 * @return The first item's handle or @c NULL, if there are no
8574 * items in @p obj (and on errors)
8576 * This returns the first item in the @p obj's internal list of
8579 * @see elm_gengrid_last_item_get()
8583 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8586 * Get the last item in a given gengrid widget
8588 * @param obj The gengrid object
8589 * @return The last item's handle or @c NULL, if there are no
8590 * items in @p obj (and on errors)
8592 * This returns the last item in the @p obj's internal list of
8595 * @see elm_gengrid_first_item_get()
8599 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8602 * Get the @b next item in a gengrid widget's internal list of items,
8603 * given a handle to one of those items.
8605 * @param item The gengrid item to fetch next from
8606 * @return The item after @p item, or @c NULL if there's none (and
8609 * This returns the item placed after the @p item, on the container
8612 * @see elm_gengrid_item_prev_get()
8616 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8619 * Get the @b previous item in a gengrid widget's internal list of items,
8620 * given a handle to one of those items.
8622 * @param item The gengrid item to fetch previous from
8623 * @return The item before @p item, or @c NULL if there's none (and
8626 * This returns the item placed before the @p item, on the container
8629 * @see elm_gengrid_item_next_get()
8633 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8636 * Get the gengrid object's handle which contains a given gengrid
8639 * @param item The item to fetch the container from
8640 * @return The gengrid (parent) object
8642 * This returns the gengrid object itself that an item belongs to.
8646 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8649 * Remove a gengrid item from the its parent, deleting it.
8651 * @param item The item to be removed.
8652 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8654 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8659 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8662 * Update the contents of a given gengrid item
8664 * @param item The gengrid item
8666 * This updates an item by calling all the item class functions
8667 * again to get the icons, labels and states. Use this when the
8668 * original item data has changed and you want thta changes to be
8673 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8674 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8675 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8678 * Return the data associated to a given gengrid item
8680 * @param item The gengrid item.
8681 * @return the data associated to this item.
8683 * This returns the @c data value passed on the
8684 * elm_gengrid_item_append() and related item addition calls.
8686 * @see elm_gengrid_item_append()
8687 * @see elm_gengrid_item_data_set()
8691 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8694 * Set the data associated to a given gengrid item
8696 * @param item The gengrid item
8697 * @param data The new data pointer to set on it
8699 * This @b overrides the @c data value passed on the
8700 * elm_gengrid_item_append() and related item addition calls. This
8701 * function @b won't call elm_gengrid_item_update() automatically,
8702 * so you'd issue it afterwards if you want to hove the item
8703 * updated to reflect the that new data.
8705 * @see elm_gengrid_item_data_get()
8709 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8712 * Get a given gengrid item's position, relative to the whole
8713 * gengrid's grid area.
8715 * @param item The Gengrid item.
8716 * @param x Pointer to variable where to store the item's <b>row
8718 * @param y Pointer to variable where to store the item's <b>column
8721 * This returns the "logical" position of the item whithin the
8722 * gengrid. For example, @c (0, 1) would stand for first row,
8727 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8730 * Set whether a given gengrid item is selected or not
8732 * @param item The gengrid item
8733 * @param selected Use @c EINA_TRUE, to make it selected, @c
8734 * EINA_FALSE to make it unselected
8736 * This sets the selected state of an item. If multi selection is
8737 * not enabled on the containing gengrid and @p selected is @c
8738 * EINA_TRUE, any other previously selected items will get
8739 * unselected in favor of this new one.
8741 * @see elm_gengrid_item_selected_get()
8745 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8748 * Get whether a given gengrid item is selected or not
8750 * @param item The gengrid item
8751 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8753 * @see elm_gengrid_item_selected_set() for more details
8757 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8760 * Get the real Evas object created to implement the view of a
8761 * given gengrid item
8763 * @param item The gengrid item.
8764 * @return the Evas object implementing this item's view.
8766 * This returns the actual Evas object used to implement the
8767 * specified gengrid item's view. This may be @c NULL, as it may
8768 * not have been created or may have been deleted, at any time, by
8769 * the gengrid. <b>Do not modify this object</b> (move, resize,
8770 * show, hide, etc.), as the gengrid is controlling it. This
8771 * function is for querying, emitting custom signals or hooking
8772 * lower level callbacks for events on that object. Do not delete
8773 * this object under any circumstances.
8775 * @see elm_gengrid_item_data_get()
8779 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8782 * Show the portion of a gengrid's internal grid containing a given
8783 * item, @b immediately.
8785 * @param item The item to display
8787 * This causes gengrid to @b redraw its viewport's contents to the
8788 * region contining the given @p item item, if it is not fully
8791 * @see elm_gengrid_item_bring_in()
8795 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8798 * Animatedly bring in, to the visible are of a gengrid, a given
8801 * @param item The gengrid item to display
8803 * This causes gengrig to jump to the given @p item item and show
8804 * it (by scrolling), if it is not fully visible. This will use
8805 * animation to do so and take a period of time to complete.
8807 * @see elm_gengrid_item_show()
8811 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8814 * Set whether a given gengrid item is disabled or not.
8816 * @param item The gengrid item
8817 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8818 * to enable it back.
8820 * A disabled item cannot be selected or unselected. It will also
8821 * change its appearance, to signal the user it's disabled.
8823 * @see elm_gengrid_item_disabled_get()
8827 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8830 * Get whether a given gengrid item is disabled or not.
8832 * @param item The gengrid item
8833 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8836 * @see elm_gengrid_item_disabled_set() for more details
8840 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8843 * Set the text to be shown in a given gengrid item's tooltips.
8845 * @param item The gengrid item
8846 * @param text The text to set in the content
8848 * This call will setup the text to be used as tooltip to that item
8849 * (analogous to elm_object_tooltip_text_set(), but being item
8850 * tooltips with higher precedence than object tooltips). It can
8851 * have only one tooltip at a time, so any previous tooltip data
8856 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8859 * Set the content to be shown in a given gengrid item's tooltips
8861 * @param item The gengrid item.
8862 * @param func The function returning the tooltip contents.
8863 * @param data What to provide to @a func as callback data/context.
8864 * @param del_cb Called when data is not needed anymore, either when
8865 * another callback replaces @p func, the tooltip is unset with
8866 * elm_gengrid_item_tooltip_unset() or the owner @p item
8867 * dies. This callback receives as its first parameter the
8868 * given @p data, being @c event_info the item handle.
8870 * This call will setup the tooltip's contents to @p item
8871 * (analogous to elm_object_tooltip_content_cb_set(), but being
8872 * item tooltips with higher precedence than object tooltips). It
8873 * can have only one tooltip at a time, so any previous tooltip
8874 * content will get removed. @p func (with @p data) will be called
8875 * every time Elementary needs to show the tooltip and it should
8876 * return a valid Evas object, which will be fully managed by the
8877 * tooltip system, getting deleted when the tooltip is gone.
8881 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);
8884 * Unset a tooltip from a given gengrid item
8886 * @param item gengrid item to remove a previously set tooltip from.
8888 * This call removes any tooltip set on @p item. The callback
8889 * provided as @c del_cb to
8890 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8891 * notify it is not used anymore (and have resources cleaned, if
8894 * @see elm_gengrid_item_tooltip_content_cb_set()
8898 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8901 * Set a different @b style for a given gengrid item's tooltip.
8903 * @param item gengrid item with tooltip set
8904 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8905 * "default", @c "transparent", etc)
8907 * Tooltips can have <b>alternate styles</b> to be displayed on,
8908 * which are defined by the theme set on Elementary. This function
8909 * works analogously as elm_object_tooltip_style_set(), but here
8910 * applied only to gengrid item objects. The default style for
8911 * tooltips is @c "default".
8913 * @note before you set a style you should define a tooltip with
8914 * elm_gengrid_item_tooltip_content_cb_set() or
8915 * elm_gengrid_item_tooltip_text_set()
8917 * @see elm_gengrid_item_tooltip_style_get()
8921 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8924 * Get the style set a given gengrid item's tooltip.
8926 * @param item gengrid item with tooltip already set on.
8927 * @return style the theme style in use, which defaults to
8928 * "default". If the object does not have a tooltip set,
8929 * then @c NULL is returned.
8931 * @see elm_gengrid_item_tooltip_style_set() for more details
8935 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8937 * @brief Disable size restrictions on an object's tooltip
8938 * @param item The tooltip's anchor object
8939 * @param disable If EINA_TRUE, size restrictions are disabled
8940 * @return EINA_FALSE on failure, EINA_TRUE on success
8942 * This function allows a tooltip to expand beyond its parant window's canvas.
8943 * It will instead be limited only by the size of the display.
8945 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8947 * @brief Retrieve size restriction state of an object's tooltip
8948 * @param item The tooltip's anchor object
8949 * @return If EINA_TRUE, size restrictions are disabled
8951 * This function returns whether a tooltip is allowed to expand beyond
8952 * its parant window's canvas.
8953 * It will instead be limited only by the size of the display.
8955 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8957 * Set the type of mouse pointer/cursor decoration to be shown,
8958 * when the mouse pointer is over the given gengrid widget item
8960 * @param item gengrid item to customize cursor on
8961 * @param cursor the cursor type's name
8963 * This function works analogously as elm_object_cursor_set(), but
8964 * here the cursor's changing area is restricted to the item's
8965 * area, and not the whole widget's. Note that that item cursors
8966 * have precedence over widget cursors, so that a mouse over @p
8967 * item will always show cursor @p type.
8969 * If this function is called twice for an object, a previously set
8970 * cursor will be unset on the second call.
8972 * @see elm_object_cursor_set()
8973 * @see elm_gengrid_item_cursor_get()
8974 * @see elm_gengrid_item_cursor_unset()
8978 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8981 * Get the type of mouse pointer/cursor decoration set to be shown,
8982 * when the mouse pointer is over the given gengrid widget item
8984 * @param item gengrid item with custom cursor set
8985 * @return the cursor type's name or @c NULL, if no custom cursors
8986 * were set to @p item (and on errors)
8988 * @see elm_object_cursor_get()
8989 * @see elm_gengrid_item_cursor_set() for more details
8990 * @see elm_gengrid_item_cursor_unset()
8994 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8997 * Unset any custom mouse pointer/cursor decoration set to be
8998 * shown, when the mouse pointer is over the given gengrid widget
8999 * item, thus making it show the @b default cursor again.
9001 * @param item a gengrid item
9003 * Use this call to undo any custom settings on this item's cursor
9004 * decoration, bringing it back to defaults (no custom style set).
9006 * @see elm_object_cursor_unset()
9007 * @see elm_gengrid_item_cursor_set() for more details
9011 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9014 * Set a different @b style for a given custom cursor set for a
9017 * @param item gengrid item with custom cursor set
9018 * @param style the <b>theme style</b> to use (e.g. @c "default",
9019 * @c "transparent", etc)
9021 * This function only makes sense when one is using custom mouse
9022 * cursor decorations <b>defined in a theme file</b> , which can
9023 * have, given a cursor name/type, <b>alternate styles</b> on
9024 * it. It works analogously as elm_object_cursor_style_set(), but
9025 * here applied only to gengrid item objects.
9027 * @warning Before you set a cursor style you should have defined a
9028 * custom cursor previously on the item, with
9029 * elm_gengrid_item_cursor_set()
9031 * @see elm_gengrid_item_cursor_engine_only_set()
9032 * @see elm_gengrid_item_cursor_style_get()
9036 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9039 * Get the current @b style set for a given gengrid item's custom
9042 * @param item gengrid item with custom cursor set.
9043 * @return style the cursor style in use. If the object does not
9044 * have a cursor set, then @c NULL is returned.
9046 * @see elm_gengrid_item_cursor_style_set() for more details
9050 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9053 * Set if the (custom) cursor for a given gengrid item should be
9054 * searched in its theme, also, or should only rely on the
9057 * @param item item with custom (custom) cursor already set on
9058 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9059 * only on those provided by the rendering engine, @c EINA_FALSE to
9060 * have them searched on the widget's theme, as well.
9062 * @note This call is of use only if you've set a custom cursor
9063 * for gengrid items, with elm_gengrid_item_cursor_set().
9065 * @note By default, cursors will only be looked for between those
9066 * provided by the rendering engine.
9070 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9073 * Get if the (custom) cursor for a given gengrid item is being
9074 * searched in its theme, also, or is only relying on the rendering
9077 * @param item a gengrid item
9078 * @return @c EINA_TRUE, if cursors are being looked for only on
9079 * those provided by the rendering engine, @c EINA_FALSE if they
9080 * are being searched on the widget's theme, as well.
9082 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9086 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9089 * Remove all items from a given gengrid widget
9091 * @param obj The gengrid object.
9093 * This removes (and deletes) all items in @p obj, leaving it
9096 * @see elm_gengrid_item_del(), to remove just one item.
9100 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9103 * Get the selected item in a given gengrid widget
9105 * @param obj The gengrid object.
9106 * @return The selected item's handleor @c NULL, if none is
9107 * selected at the moment (and on errors)
9109 * This returns the selected item in @p obj. If multi selection is
9110 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9111 * the first item in the list is selected, which might not be very
9112 * useful. For that case, see elm_gengrid_selected_items_get().
9116 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9119 * Get <b>a list</b> of selected items in a given gengrid
9121 * @param obj The gengrid object.
9122 * @return The list of selected items or @c NULL, if none is
9123 * selected at the moment (and on errors)
9125 * This returns a list of the selected items, in the order that
9126 * they appear in the grid. This list is only valid as long as no
9127 * more items are selected or unselected (or unselected implictly
9128 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9131 * @see elm_gengrid_selected_item_get()
9135 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9142 * @defgroup Clock Clock
9144 * @image html img/widget/clock/preview-00.png
9145 * @image latex img/widget/clock/preview-00.eps
9147 * This is a @b digital clock widget. In its default theme, it has a
9148 * vintage "flipping numbers clock" appearance, which will animate
9149 * sheets of individual algarisms individually as time goes by.
9151 * A newly created clock will fetch system's time (already
9152 * considering local time adjustments) to start with, and will tick
9153 * accondingly. It may or may not show seconds.
9155 * Clocks have an @b edition mode. When in it, the sheets will
9156 * display extra arrow indications on the top and bottom and the
9157 * user may click on them to raise or lower the time values. After
9158 * it's told to exit edition mode, it will keep ticking with that
9159 * new time set (it keeps the difference from local time).
9161 * Also, when under edition mode, user clicks on the cited arrows
9162 * which are @b held for some time will make the clock to flip the
9163 * sheet, thus editing the time, continuosly and automatically for
9164 * the user. The interval between sheet flips will keep growing in
9165 * time, so that it helps the user to reach a time which is distant
9168 * The time display is, by default, in military mode (24h), but an
9169 * am/pm indicator may be optionally shown, too, when it will
9172 * Smart callbacks one can register to:
9173 * - "changed" - the clock's user changed the time
9175 * Here is an example on its usage:
9176 * @li @ref clock_example
9185 * Identifiers for which clock digits should be editable, when a
9186 * clock widget is in edition mode. Values may be ORed together to
9187 * make a mask, naturally.
9189 * @see elm_clock_edit_set()
9190 * @see elm_clock_digit_edit_set()
9192 typedef enum _Elm_Clock_Digedit
9194 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9195 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9196 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9197 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9198 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9199 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9200 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9201 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9202 } Elm_Clock_Digedit;
9205 * Add a new clock widget to the given parent Elementary
9206 * (container) object
9208 * @param parent The parent object
9209 * @return a new clock widget handle or @c NULL, on errors
9211 * This function inserts a new clock widget on the canvas.
9215 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9218 * Set a clock widget's time, programmatically
9220 * @param obj The clock widget object
9221 * @param hrs The hours to set
9222 * @param min The minutes to set
9223 * @param sec The secondes to set
9225 * This function updates the time that is showed by the clock
9228 * Values @b must be set within the following ranges:
9229 * - 0 - 23, for hours
9230 * - 0 - 59, for minutes
9231 * - 0 - 59, for seconds,
9233 * even if the clock is not in "military" mode.
9235 * @warning The behavior for values set out of those ranges is @b
9240 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9243 * Get a clock widget's time values
9245 * @param obj The clock object
9246 * @param[out] hrs Pointer to the variable to get the hours value
9247 * @param[out] min Pointer to the variable to get the minutes value
9248 * @param[out] sec Pointer to the variable to get the seconds value
9250 * This function gets the time set for @p obj, returning
9251 * it on the variables passed as the arguments to function
9253 * @note Use @c NULL pointers on the time values you're not
9254 * interested in: they'll be ignored by the function.
9258 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9261 * Set whether a given clock widget is under <b>edition mode</b> or
9262 * under (default) displaying-only mode.
9264 * @param obj The clock object
9265 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9266 * put it back to "displaying only" mode
9268 * This function makes a clock's time to be editable or not <b>by
9269 * user interaction</b>. When in edition mode, clocks @b stop
9270 * ticking, until one brings them back to canonical mode. The
9271 * elm_clock_digit_edit_set() function will influence which digits
9272 * of the clock will be editable. By default, all of them will be
9273 * (#ELM_CLOCK_NONE).
9275 * @note am/pm sheets, if being shown, will @b always be editable
9276 * under edition mode.
9278 * @see elm_clock_edit_get()
9282 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9285 * Retrieve whether a given clock widget is under <b>edition
9286 * mode</b> or under (default) displaying-only mode.
9288 * @param obj The clock object
9289 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9292 * This function retrieves whether the clock's time can be edited
9293 * or not by user interaction.
9295 * @see elm_clock_edit_set() for more details
9299 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9302 * Set what digits of the given clock widget should be editable
9303 * when in edition mode.
9305 * @param obj The clock object
9306 * @param digedit Bit mask indicating the digits to be editable
9307 * (values in #Elm_Clock_Digedit).
9309 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9310 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9313 * @see elm_clock_digit_edit_get()
9317 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9320 * Retrieve what digits of the given clock widget should be
9321 * editable when in edition mode.
9323 * @param obj The clock object
9324 * @return Bit mask indicating the digits to be editable
9325 * (values in #Elm_Clock_Digedit).
9327 * @see elm_clock_digit_edit_set() for more details
9331 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9334 * Set if the given clock widget must show hours in military or
9337 * @param obj The clock object
9338 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9341 * This function sets if the clock must show hours in military or
9342 * am/pm mode. In some countries like Brazil the military mode
9343 * (00-24h-format) is used, in opposition to the USA, where the
9344 * am/pm mode is more commonly used.
9346 * @see elm_clock_show_am_pm_get()
9350 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9353 * Get if the given clock widget shows hours in military or am/pm
9356 * @param obj The clock object
9357 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9360 * This function gets if the clock shows hours in military or am/pm
9363 * @see elm_clock_show_am_pm_set() for more details
9367 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9370 * Set if the given clock widget must show time with seconds or not
9372 * @param obj The clock object
9373 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9375 * This function sets if the given clock must show or not elapsed
9376 * seconds. By default, they are @b not shown.
9378 * @see elm_clock_show_seconds_get()
9382 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9385 * Get whether the given clock widget is showing time with seconds
9388 * @param obj The clock object
9389 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9391 * This function gets whether @p obj is showing or not the elapsed
9394 * @see elm_clock_show_seconds_set()
9398 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9401 * Set the interval on time updates for an user mouse button hold
9402 * on clock widgets' time edition.
9404 * @param obj The clock object
9405 * @param interval The (first) interval value in seconds
9407 * This interval value is @b decreased while the user holds the
9408 * mouse pointer either incrementing or decrementing a given the
9409 * clock digit's value.
9411 * This helps the user to get to a given time distant from the
9412 * current one easier/faster, as it will start to flip quicker and
9413 * quicker on mouse button holds.
9415 * The calculation for the next flip interval value, starting from
9416 * the one set with this call, is the previous interval divided by
9417 * 1.05, so it decreases a little bit.
9419 * The default starting interval value for automatic flips is
9422 * @see elm_clock_interval_get()
9426 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9429 * Get the interval on time updates for an user mouse button hold
9430 * on clock widgets' time edition.
9432 * @param obj The clock object
9433 * @return The (first) interval value, in seconds, set on it
9435 * @see elm_clock_interval_set() for more details
9439 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9446 * @defgroup Layout Layout
9448 * @image html img/widget/layout/preview-00.png
9449 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9451 * @image html img/layout-predefined.png
9452 * @image latex img/layout-predefined.eps width=\textwidth
9454 * This is a container widget that takes a standard Edje design file and
9455 * wraps it very thinly in a widget.
9457 * An Edje design (theme) file has a very wide range of possibilities to
9458 * describe the behavior of elements added to the Layout. Check out the Edje
9459 * documentation and the EDC reference to get more information about what can
9460 * be done with Edje.
9462 * Just like @ref List, @ref Box, and other container widgets, any
9463 * object added to the Layout will become its child, meaning that it will be
9464 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9466 * The Layout widget can contain as many Contents, Boxes or Tables as
9467 * described in its theme file. For instance, objects can be added to
9468 * different Tables by specifying the respective Table part names. The same
9469 * is valid for Content and Box.
9471 * The objects added as child of the Layout will behave as described in the
9472 * part description where they were added. There are 3 possible types of
9473 * parts where a child can be added:
9475 * @section secContent Content (SWALLOW part)
9477 * Only one object can be added to the @c SWALLOW part (but you still can
9478 * have many @c SWALLOW parts and one object on each of them). Use the @c
9479 * elm_layout_content_* set of functions to set, retrieve and unset objects
9480 * as content of the @c SWALLOW. After being set to this part, the object
9481 * size, position, visibility, clipping and other description properties
9482 * will be totally controled by the description of the given part (inside
9483 * the Edje theme file).
9485 * One can use @c evas_object_size_hint_* functions on the child to have some
9486 * kind of control over its behavior, but the resulting behavior will still
9487 * depend heavily on the @c SWALLOW part description.
9489 * The Edje theme also can change the part description, based on signals or
9490 * scripts running inside the theme. This change can also be animated. All of
9491 * this will affect the child object set as content accordingly. The object
9492 * size will be changed if the part size is changed, it will animate move if
9493 * the part is moving, and so on.
9495 * The following picture demonstrates a Layout widget with a child object
9496 * added to its @c SWALLOW:
9498 * @image html layout_swallow.png
9499 * @image latex layout_swallow.eps width=\textwidth
9501 * @section secBox Box (BOX part)
9503 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9504 * allows one to add objects to the box and have them distributed along its
9505 * area, accordingly to the specified @a layout property (now by @a layout we
9506 * mean the chosen layouting design of the Box, not the Layout widget
9509 * A similar effect for having a box with its position, size and other things
9510 * controled by the Layout theme would be to create an Elementary @ref Box
9511 * widget and add it as a Content in the @c SWALLOW part.
9513 * The main difference of using the Layout Box is that its behavior, the box
9514 * properties like layouting format, padding, align, etc. will be all
9515 * controled by the theme. This means, for example, that a signal could be
9516 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9517 * handled the signal by changing the box padding, or align, or both. Using
9518 * the Elementary @ref Box widget is not necessarily harder or easier, it
9519 * just depends on the circunstances and requirements.
9521 * The Layout Box can be used through the @c elm_layout_box_* set of
9524 * The following picture demonstrates a Layout widget with many child objects
9525 * added to its @c BOX part:
9527 * @image html layout_box.png
9528 * @image latex layout_box.eps width=\textwidth
9530 * @section secTable Table (TABLE part)
9532 * Just like the @ref secBox, the Layout Table is very similar to the
9533 * Elementary @ref Table widget. It allows one to add objects to the Table
9534 * specifying the row and column where the object should be added, and any
9535 * column or row span if necessary.
9537 * Again, we could have this design by adding a @ref Table widget to the @c
9538 * SWALLOW part using elm_layout_content_set(). The same difference happens
9539 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9540 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9542 * The Layout Table can be used through the @c elm_layout_table_* set of
9545 * The following picture demonstrates a Layout widget with many child objects
9546 * added to its @c TABLE part:
9548 * @image html layout_table.png
9549 * @image latex layout_table.eps width=\textwidth
9551 * @section secPredef Predefined Layouts
9553 * Another interesting thing about the Layout widget is that it offers some
9554 * predefined themes that come with the default Elementary theme. These
9555 * themes can be set by the call elm_layout_theme_set(), and provide some
9556 * basic functionality depending on the theme used.
9558 * Most of them already send some signals, some already provide a toolbar or
9559 * back and next buttons.
9561 * These are available predefined theme layouts. All of them have class = @c
9562 * layout, group = @c application, and style = one of the following options:
9564 * @li @c toolbar-content - application with toolbar and main content area
9565 * @li @c toolbar-content-back - application with toolbar and main content
9566 * area with a back button and title area
9567 * @li @c toolbar-content-back-next - application with toolbar and main
9568 * content area with a back and next buttons and title area
9569 * @li @c content-back - application with a main content area with a back
9570 * button and title area
9571 * @li @c content-back-next - application with a main content area with a
9572 * back and next buttons and title area
9573 * @li @c toolbar-vbox - application with toolbar and main content area as a
9575 * @li @c toolbar-table - application with toolbar and main content area as a
9578 * @section secExamples Examples
9580 * Some examples of the Layout widget can be found here:
9581 * @li @ref layout_example_01
9582 * @li @ref layout_example_02
9583 * @li @ref layout_example_03
9584 * @li @ref layout_example_edc
9589 * Add a new layout to the parent
9591 * @param parent The parent object
9592 * @return The new object or NULL if it cannot be created
9594 * @see elm_layout_file_set()
9595 * @see elm_layout_theme_set()
9599 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9601 * Set the file that will be used as layout
9603 * @param obj The layout object
9604 * @param file The path to file (edj) that will be used as layout
9605 * @param group The group that the layout belongs in edje file
9607 * @return (1 = success, 0 = error)
9611 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9613 * Set the edje group from the elementary theme that will be used as layout
9615 * @param obj The layout object
9616 * @param clas the clas of the group
9617 * @param group the group
9618 * @param style the style to used
9620 * @return (1 = success, 0 = error)
9624 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9626 * Set the layout content.
9628 * @param obj The layout object
9629 * @param swallow The swallow part name in the edje file
9630 * @param content The child that will be added in this layout object
9632 * Once the content object is set, a previously set one will be deleted.
9633 * If you want to keep that old content object, use the
9634 * elm_layout_content_unset() function.
9636 * @note In an Edje theme, the part used as a content container is called @c
9637 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9638 * expected to be a part name just like the second parameter of
9639 * elm_layout_box_append().
9641 * @see elm_layout_box_append()
9642 * @see elm_layout_content_get()
9643 * @see elm_layout_content_unset()
9648 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9650 * Get the child object in the given content part.
9652 * @param obj The layout object
9653 * @param swallow The SWALLOW part to get its content
9655 * @return The swallowed object or NULL if none or an error occurred
9657 * @see elm_layout_content_set()
9661 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9663 * Unset the layout content.
9665 * @param obj The layout object
9666 * @param swallow The swallow part name in the edje file
9667 * @return The content that was being used
9669 * Unparent and return the content object which was set for this part.
9671 * @see elm_layout_content_set()
9675 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9677 * Set the text of the given part
9679 * @param obj The layout object
9680 * @param part The TEXT part where to set the text
9681 * @param text The text to set
9684 * @deprecated use elm_object_text_* instead.
9686 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9688 * Get the text set in the given part
9690 * @param obj The layout object
9691 * @param part The TEXT part to retrieve the text off
9693 * @return The text set in @p part
9696 * @deprecated use elm_object_text_* instead.
9698 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9700 * Append child to layout box part.
9702 * @param obj the layout object
9703 * @param part the box part to which the object will be appended.
9704 * @param child the child object to append to box.
9706 * Once the object is appended, it will become child of the layout. Its
9707 * lifetime will be bound to the layout, whenever the layout dies the child
9708 * will be deleted automatically. One should use elm_layout_box_remove() to
9709 * make this layout forget about the object.
9711 * @see elm_layout_box_prepend()
9712 * @see elm_layout_box_insert_before()
9713 * @see elm_layout_box_insert_at()
9714 * @see elm_layout_box_remove()
9718 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9720 * Prepend child to layout box part.
9722 * @param obj the layout object
9723 * @param part the box part to prepend.
9724 * @param child the child object to prepend to box.
9726 * Once the object is prepended, 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_insert_before()
9733 * @see elm_layout_box_insert_at()
9734 * @see elm_layout_box_remove()
9738 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9740 * Insert child to layout box part before a reference object.
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 reference another reference object to insert before in box.
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_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9761 * Insert child to layout box part at a given position.
9763 * @param obj the layout object
9764 * @param part the box part to insert.
9765 * @param child the child object to insert into box.
9766 * @param pos the numeric position >=0 to insert the child.
9768 * Once the object is inserted, it will become child of the layout. Its
9769 * lifetime will be bound to the layout, whenever the layout dies the child
9770 * will be deleted automatically. One should use elm_layout_box_remove() to
9771 * make this layout forget about the object.
9773 * @see elm_layout_box_append()
9774 * @see elm_layout_box_prepend()
9775 * @see elm_layout_box_insert_before()
9776 * @see elm_layout_box_remove()
9780 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9782 * Remove a child of the given part box.
9784 * @param obj The layout object
9785 * @param part The box part name to remove child.
9786 * @param child The object to remove from box.
9787 * @return The object that was being used, or NULL if not found.
9789 * The object will be removed from the box part and its lifetime will
9790 * not be handled by the layout anymore. This is equivalent to
9791 * elm_layout_content_unset() for box.
9793 * @see elm_layout_box_append()
9794 * @see elm_layout_box_remove_all()
9798 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9800 * Remove all child of the given part box.
9802 * @param obj The layout object
9803 * @param part The box part name to remove child.
9804 * @param clear If EINA_TRUE, then all objects will be deleted as
9805 * well, otherwise they will just be removed and will be
9806 * dangling on the canvas.
9808 * The objects will be removed from the box part and their lifetime will
9809 * not be handled by the layout anymore. This is equivalent to
9810 * elm_layout_box_remove() for all box children.
9812 * @see elm_layout_box_append()
9813 * @see elm_layout_box_remove()
9817 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9819 * Insert child to layout table part.
9821 * @param obj the layout object
9822 * @param part the box part to pack child.
9823 * @param child_obj the child object to pack into table.
9824 * @param col the column to which the child should be added. (>= 0)
9825 * @param row the row to which the child should be added. (>= 0)
9826 * @param colspan how many columns should be used to store this object. (>=
9828 * @param rowspan how many rows should be used to store this object. (>= 1)
9830 * Once the object is inserted, it will become child of the table. Its
9831 * lifetime will be bound to the layout, and whenever the layout dies the
9832 * child will be deleted automatically. One should use
9833 * elm_layout_table_remove() to make this layout forget about the object.
9835 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9836 * more space than a single cell. For instance, the following code:
9838 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9841 * Would result in an object being added like the following picture:
9843 * @image html layout_colspan.png
9844 * @image latex layout_colspan.eps width=\textwidth
9846 * @see elm_layout_table_unpack()
9847 * @see elm_layout_table_clear()
9851 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);
9853 * Unpack (remove) a child of the given part table.
9855 * @param obj The layout object
9856 * @param part The table part name to remove child.
9857 * @param child_obj The object to remove from table.
9858 * @return The object that was being used, or NULL if not found.
9860 * The object will be unpacked from the table part and its lifetime
9861 * will not be handled by the layout anymore. This is equivalent to
9862 * elm_layout_content_unset() for table.
9864 * @see elm_layout_table_pack()
9865 * @see elm_layout_table_clear()
9869 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9871 * Remove all child of the given part table.
9873 * @param obj The layout object
9874 * @param part The table part name to remove child.
9875 * @param clear If EINA_TRUE, then all objects will be deleted as
9876 * well, otherwise they will just be removed and will be
9877 * dangling on the canvas.
9879 * The objects will be removed from the table part and their lifetime will
9880 * not be handled by the layout anymore. This is equivalent to
9881 * elm_layout_table_unpack() for all table children.
9883 * @see elm_layout_table_pack()
9884 * @see elm_layout_table_unpack()
9888 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9890 * Get the edje layout
9892 * @param obj The layout object
9894 * @return A Evas_Object with the edje layout settings loaded
9895 * with function elm_layout_file_set
9897 * This returns the edje object. It is not expected to be used to then
9898 * swallow objects via edje_object_part_swallow() for example. Use
9899 * elm_layout_content_set() instead so child object handling and sizing is
9902 * @note This function should only be used if you really need to call some
9903 * low level Edje function on this edje object. All the common stuff (setting
9904 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9905 * with proper elementary functions.
9907 * @see elm_object_signal_callback_add()
9908 * @see elm_object_signal_emit()
9909 * @see elm_object_text_part_set()
9910 * @see elm_layout_content_set()
9911 * @see elm_layout_box_append()
9912 * @see elm_layout_table_pack()
9913 * @see elm_layout_data_get()
9917 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9919 * Get the edje data from the given layout
9921 * @param obj The layout object
9922 * @param key The data key
9924 * @return The edje data string
9926 * This function fetches data specified inside the edje theme of this layout.
9927 * This function return NULL if data is not found.
9929 * In EDC this comes from a data block within the group block that @p
9930 * obj was loaded from. E.g.
9937 * item: "key1" "value1";
9938 * item: "key2" "value2";
9946 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9950 * @param obj The layout object
9952 * Manually forces a sizing re-evaluation. This is useful when the minimum
9953 * size required by the edje theme of this layout has changed. The change on
9954 * the minimum size required by the edje theme is not immediately reported to
9955 * the elementary layout, so one needs to call this function in order to tell
9956 * the widget (layout) that it needs to reevaluate its own size.
9958 * The minimum size of the theme is calculated based on minimum size of
9959 * parts, the size of elements inside containers like box and table, etc. All
9960 * of this can change due to state changes, and that's when this function
9963 * Also note that a standard signal of "size,eval" "elm" emitted from the
9964 * edje object will cause this to happen too.
9968 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9971 * Sets a specific cursor for an edje part.
9973 * @param obj The layout object.
9974 * @param part_name a part from loaded edje group.
9975 * @param cursor cursor name to use, see Elementary_Cursor.h
9977 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9978 * part not exists or it has "mouse_events: 0".
9982 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9985 * Get the cursor to be shown when mouse is over an edje part
9987 * @param obj The layout object.
9988 * @param part_name a part from loaded edje group.
9989 * @return the cursor name.
9993 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9996 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9998 * @param obj The layout object.
9999 * @param part_name a part from loaded edje group, that had a cursor set
10000 * with elm_layout_part_cursor_set().
10004 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10007 * Sets a specific cursor style for an edje part.
10009 * @param obj The layout object.
10010 * @param part_name a part from loaded edje group.
10011 * @param style the theme style to use (default, transparent, ...)
10013 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10014 * part not exists or it did not had a cursor set.
10018 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10021 * Gets a specific cursor style for an edje part.
10023 * @param obj The layout object.
10024 * @param part_name a part from loaded edje group.
10026 * @return the theme style in use, defaults to "default". If the
10027 * object does not have a cursor set, then NULL is returned.
10031 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10034 * Sets if the cursor set should be searched on the theme or should use
10035 * the provided by the engine, only.
10037 * @note before you set if should look on theme you should define a
10038 * cursor with elm_layout_part_cursor_set(). By default it will only
10039 * look for cursors provided by the engine.
10041 * @param obj The layout object.
10042 * @param part_name a part from loaded edje group.
10043 * @param engine_only if cursors should be just provided by the engine
10044 * or should also search on widget's theme as well
10046 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10047 * part not exists or it did not had a cursor set.
10051 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);
10054 * Gets a specific cursor engine_only for an edje part.
10056 * @param obj The layout object.
10057 * @param part_name a part from loaded edje group.
10059 * @return whenever the cursor is just provided by engine or also from theme.
10063 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10066 * @def elm_layout_icon_set
10067 * Convienience macro to set the icon object in a layout that follows the
10068 * Elementary naming convention for its parts.
10072 #define elm_layout_icon_set(_ly, _obj) \
10075 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10076 if ((_obj)) sig = "elm,state,icon,visible"; \
10077 else sig = "elm,state,icon,hidden"; \
10078 elm_object_signal_emit((_ly), sig, "elm"); \
10082 * @def elm_layout_icon_get
10083 * Convienience macro to get the icon object from a layout that follows the
10084 * Elementary naming convention for its parts.
10088 #define elm_layout_icon_get(_ly) \
10089 elm_layout_content_get((_ly), "elm.swallow.icon")
10092 * @def elm_layout_end_set
10093 * Convienience macro to set the end object in a layout that follows the
10094 * Elementary naming convention for its parts.
10098 #define elm_layout_end_set(_ly, _obj) \
10101 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10102 if ((_obj)) sig = "elm,state,end,visible"; \
10103 else sig = "elm,state,end,hidden"; \
10104 elm_object_signal_emit((_ly), sig, "elm"); \
10108 * @def elm_layout_end_get
10109 * Convienience macro to get the end object in a layout that follows the
10110 * Elementary naming convention for its parts.
10114 #define elm_layout_end_get(_ly) \
10115 elm_layout_content_get((_ly), "elm.swallow.end")
10118 * @def elm_layout_label_set
10119 * Convienience macro to set the label in a layout that follows the
10120 * Elementary naming convention for its parts.
10123 * @deprecated use elm_object_text_* instead.
10125 #define elm_layout_label_set(_ly, _txt) \
10126 elm_layout_text_set((_ly), "elm.text", (_txt))
10129 * @def elm_layout_label_get
10130 * Convienience macro to get the label in a layout that follows the
10131 * Elementary naming convention for its parts.
10134 * @deprecated use elm_object_text_* instead.
10136 #define elm_layout_label_get(_ly) \
10137 elm_layout_text_get((_ly), "elm.text")
10139 /* smart callbacks called:
10140 * "theme,changed" - when elm theme is changed.
10144 * @defgroup Notify Notify
10146 * @image html img/widget/notify/preview-00.png
10147 * @image latex img/widget/notify/preview-00.eps
10149 * Display a container in a particular region of the parent(top, bottom,
10150 * etc. A timeout can be set to automatically hide the notify. This is so
10151 * that, after an evas_object_show() on a notify object, if a timeout was set
10152 * on it, it will @b automatically get hidden after that time.
10154 * Signals that you can add callbacks for are:
10155 * @li "timeout" - when timeout happens on notify and it's hidden
10156 * @li "block,clicked" - when a click outside of the notify happens
10158 * @ref tutorial_notify show usage of the API.
10163 * @brief Possible orient values for notify.
10165 * This values should be used in conjunction to elm_notify_orient_set() to
10166 * set the position in which the notify should appear(relative to its parent)
10167 * and in conjunction with elm_notify_orient_get() to know where the notify
10170 typedef enum _Elm_Notify_Orient
10172 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10173 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10174 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10175 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10176 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10177 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10178 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10179 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10180 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10181 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10182 } Elm_Notify_Orient;
10184 * @brief Add a new notify to the parent
10186 * @param parent The parent object
10187 * @return The new object or NULL if it cannot be created
10189 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10191 * @brief Set the content of the notify widget
10193 * @param obj The notify object
10194 * @param content The content will be filled in this notify object
10196 * Once the content object is set, a previously set one will be deleted. If
10197 * you want to keep that old content object, use the
10198 * elm_notify_content_unset() function.
10200 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10202 * @brief Unset the content of the notify widget
10204 * @param obj The notify object
10205 * @return The content that was being used
10207 * Unparent and return the content object which was set for this widget
10209 * @see elm_notify_content_set()
10211 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10213 * @brief Return the content of the notify widget
10215 * @param obj The notify object
10216 * @return The content that is being used
10218 * @see elm_notify_content_set()
10220 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10222 * @brief Set the notify parent
10224 * @param obj The notify object
10225 * @param content The new parent
10227 * Once the parent object is set, a previously set one will be disconnected
10230 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10232 * @brief Get the notify parent
10234 * @param obj The notify object
10235 * @return The parent
10237 * @see elm_notify_parent_set()
10239 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10241 * @brief Set the orientation
10243 * @param obj The notify object
10244 * @param orient The new orientation
10246 * Sets the position in which the notify will appear in its parent.
10248 * @see @ref Elm_Notify_Orient for possible values.
10250 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10252 * @brief Return the orientation
10253 * @param obj The notify object
10254 * @return The orientation of the notification
10256 * @see elm_notify_orient_set()
10257 * @see Elm_Notify_Orient
10259 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10261 * @brief Set the time interval after which the notify window is going to be
10264 * @param obj The notify object
10265 * @param time The timeout in seconds
10267 * This function sets a timeout and starts the timer controlling when the
10268 * notify is hidden. Since calling evas_object_show() on a notify restarts
10269 * the timer controlling when the notify is hidden, setting this before the
10270 * notify is shown will in effect mean starting the timer when the notify is
10273 * @note Set a value <= 0.0 to disable a running timer.
10275 * @note If the value > 0.0 and the notify is previously visible, the
10276 * timer will be started with this value, canceling any running timer.
10278 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10280 * @brief Return the timeout value (in seconds)
10281 * @param obj the notify object
10283 * @see elm_notify_timeout_set()
10285 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10287 * @brief Sets whether events should be passed to by a click outside
10290 * @param obj The notify object
10291 * @param repeats EINA_TRUE Events are repeats, else no
10293 * When true if the user clicks outside the window the events will be caught
10294 * by the others widgets, else the events are blocked.
10296 * @note The default value is EINA_TRUE.
10298 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10300 * @brief Return true if events are repeat below the notify object
10301 * @param obj the notify object
10303 * @see elm_notify_repeat_events_set()
10305 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10311 * @defgroup Hover Hover
10313 * @image html img/widget/hover/preview-00.png
10314 * @image latex img/widget/hover/preview-00.eps
10316 * A Hover object will hover over its @p parent object at the @p target
10317 * location. Anything in the background will be given a darker coloring to
10318 * indicate that the hover object is on top (at the default theme). When the
10319 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10320 * clicked that @b doesn't cause the hover to be dismissed.
10322 * @note The hover object will take up the entire space of @p target
10325 * Elementary has the following styles for the hover widget:
10329 * @li hoversel_vertical
10331 * The following are the available position for content:
10343 * Signals that you can add callbacks for are:
10344 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10345 * @li "smart,changed" - a content object placed under the "smart"
10346 * policy was replaced to a new slot direction.
10348 * See @ref tutorial_hover for more information.
10352 typedef enum _Elm_Hover_Axis
10354 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10355 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10356 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10357 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10360 * @brief Adds a hover object to @p parent
10362 * @param parent The parent object
10363 * @return The hover object or NULL if one could not be created
10365 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10367 * @brief Sets the target object for the hover.
10369 * @param obj The hover object
10370 * @param target The object to center the hover onto. The hover
10372 * This function will cause the hover to be centered on the target object.
10374 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10376 * @brief Gets the target object for the hover.
10378 * @param obj The hover object
10379 * @param parent The object to locate the hover over.
10381 * @see elm_hover_target_set()
10383 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10385 * @brief Sets the parent object for the hover.
10387 * @param obj The hover object
10388 * @param parent The object to locate the hover over.
10390 * This function will cause the hover to take up the entire space that the
10391 * parent object fills.
10393 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10395 * @brief Gets the parent object for the hover.
10397 * @param obj The hover object
10398 * @return The parent object to locate the hover over.
10400 * @see elm_hover_parent_set()
10402 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10404 * @brief Sets the content of the hover object and the direction in which it
10407 * @param obj The hover object
10408 * @param swallow The direction that the object will be displayed
10409 * at. Accepted values are "left", "top-left", "top", "top-right",
10410 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10412 * @param content The content to place at @p swallow
10414 * Once the content object is set for a given direction, a previously
10415 * set one (on the same direction) will be deleted. If you want to
10416 * keep that old content object, use the elm_hover_content_unset()
10419 * All directions may have contents at the same time, except for
10420 * "smart". This is a special placement hint and its use case
10421 * independs of the calculations coming from
10422 * elm_hover_best_content_location_get(). Its use is for cases when
10423 * one desires only one hover content, but with a dinamic special
10424 * placement within the hover area. The content's geometry, whenever
10425 * it changes, will be used to decide on a best location not
10426 * extrapolating the hover's parent object view to show it in (still
10427 * being the hover's target determinant of its medium part -- move and
10428 * resize it to simulate finger sizes, for example). If one of the
10429 * directions other than "smart" are used, a previously content set
10430 * using it will be deleted, and vice-versa.
10432 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10434 * @brief Get the content of the hover object, in a given direction.
10436 * Return the content object which was set for this widget in the
10437 * @p swallow direction.
10439 * @param obj The hover object
10440 * @param swallow The direction that the object was display at.
10441 * @return The content that was being used
10443 * @see elm_hover_content_set()
10445 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10447 * @brief Unset the content of the hover object, in a given direction.
10449 * Unparent and return the content object set at @p swallow direction.
10451 * @param obj The hover object
10452 * @param swallow The direction that the object was display at.
10453 * @return The content that was being used.
10455 * @see elm_hover_content_set()
10457 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10459 * @brief Returns the best swallow location for content in the hover.
10461 * @param obj The hover object
10462 * @param pref_axis The preferred orientation axis for the hover object to use
10463 * @return The edje location to place content into the hover or @c
10466 * Best is defined here as the location at which there is the most available
10469 * @p pref_axis may be one of
10470 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10471 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10472 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10473 * - @c ELM_HOVER_AXIS_BOTH -- both
10475 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10476 * nescessarily be along the horizontal axis("left" or "right"). If
10477 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10478 * be along the vertical axis("top" or "bottom"). Chossing
10479 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10480 * returned position may be in either axis.
10482 * @see elm_hover_content_set()
10484 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10491 * @defgroup Entry Entry
10493 * @image html img/widget/entry/preview-00.png
10494 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10495 * @image html img/widget/entry/preview-01.png
10496 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10497 * @image html img/widget/entry/preview-02.png
10498 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10499 * @image html img/widget/entry/preview-03.png
10500 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10502 * An entry is a convenience widget which shows a box that the user can
10503 * enter text into. Entries by default don't scroll, so they grow to
10504 * accomodate the entire text, resizing the parent window as needed. This
10505 * can be changed with the elm_entry_scrollable_set() function.
10507 * They can also be single line or multi line (the default) and when set
10508 * to multi line mode they support text wrapping in any of the modes
10509 * indicated by #Elm_Wrap_Type.
10511 * Other features include password mode, filtering of inserted text with
10512 * elm_entry_text_filter_append() and related functions, inline "items" and
10513 * formatted markup text.
10515 * @section entry-markup Formatted text
10517 * The markup tags supported by the Entry are defined by the theme, but
10518 * even when writing new themes or extensions it's a good idea to stick to
10519 * a sane default, to maintain coherency and avoid application breakages.
10520 * Currently defined by the default theme are the following tags:
10521 * @li \<br\>: Inserts a line break.
10522 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10524 * @li \<tab\>: Inserts a tab.
10525 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10527 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10528 * @li \<link\>...\</link\>: Underlines the enclosed text.
10529 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10531 * @section entry-special Special markups
10533 * Besides those used to format text, entries support two special markup
10534 * tags used to insert clickable portions of text or items inlined within
10537 * @subsection entry-anchors Anchors
10539 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10540 * \</a\> tags and an event will be generated when this text is clicked,
10544 * This text is outside <a href=anc-01>but this one is an anchor</a>
10547 * The @c href attribute in the opening tag gives the name that will be
10548 * used to identify the anchor and it can be any valid utf8 string.
10550 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10551 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10552 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10553 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10556 * @subsection entry-items Items
10558 * Inlined in the text, any other @c Evas_Object can be inserted by using
10559 * \<item\> tags this way:
10562 * <item size=16x16 vsize=full href=emoticon/haha></item>
10565 * Just like with anchors, the @c href identifies each item, but these need,
10566 * in addition, to indicate their size, which is done using any one of
10567 * @c size, @c absize or @c relsize attributes. These attributes take their
10568 * value in the WxH format, where W is the width and H the height of the
10571 * @li absize: Absolute pixel size for the item. Whatever value is set will
10572 * be the item's size regardless of any scale value the object may have
10573 * been set to. The final line height will be adjusted to fit larger items.
10574 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10576 * @li relsize: Size is adjusted for the item to fit within the current
10579 * Besides their size, items are specificed a @c vsize value that affects
10580 * how their final size and position are calculated. The possible values
10582 * @li ascent: Item will be placed within the line's baseline and its
10583 * ascent. That is, the height between the line where all characters are
10584 * positioned and the highest point in the line. For @c size and @c absize
10585 * items, the descent value will be added to the total line height to make
10586 * them fit. @c relsize items will be adjusted to fit within this space.
10587 * @li full: Items will be placed between the descent and ascent, or the
10588 * lowest point in the line and its highest.
10590 * The next image shows different configurations of items and how they
10591 * are the previously mentioned options affect their sizes. In all cases,
10592 * the green line indicates the ascent, blue for the baseline and red for
10595 * @image html entry_item.png
10596 * @image latex entry_item.eps width=\textwidth
10598 * And another one to show how size differs from absize. In the first one,
10599 * the scale value is set to 1.0, while the second one is using one of 2.0.
10601 * @image html entry_item_scale.png
10602 * @image latex entry_item_scale.eps width=\textwidth
10604 * After the size for an item is calculated, the entry will request an
10605 * object to place in its space. For this, the functions set with
10606 * elm_entry_item_provider_append() and related functions will be called
10607 * in order until one of them returns a @c non-NULL value. If no providers
10608 * are available, or all of them return @c NULL, then the entry falls back
10609 * to one of the internal defaults, provided the name matches with one of
10612 * All of the following are currently supported:
10615 * - emoticon/angry-shout
10616 * - emoticon/crazy-laugh
10617 * - emoticon/evil-laugh
10619 * - emoticon/goggle-smile
10620 * - emoticon/grumpy
10621 * - emoticon/grumpy-smile
10622 * - emoticon/guilty
10623 * - emoticon/guilty-smile
10625 * - emoticon/half-smile
10626 * - emoticon/happy-panting
10628 * - emoticon/indifferent
10630 * - emoticon/knowing-grin
10632 * - emoticon/little-bit-sorry
10633 * - emoticon/love-lots
10635 * - emoticon/minimal-smile
10636 * - emoticon/not-happy
10637 * - emoticon/not-impressed
10639 * - emoticon/opensmile
10642 * - emoticon/squint-laugh
10643 * - emoticon/surprised
10644 * - emoticon/suspicious
10645 * - emoticon/tongue-dangling
10646 * - emoticon/tongue-poke
10648 * - emoticon/unhappy
10649 * - emoticon/very-sorry
10652 * - emoticon/worried
10655 * Alternatively, an item may reference an image by its path, using
10656 * the URI form @c file:///path/to/an/image.png and the entry will then
10657 * use that image for the item.
10659 * @section entry-files Loading and saving files
10661 * Entries have convinience functions to load text from a file and save
10662 * changes back to it after a short delay. The automatic saving is enabled
10663 * by default, but can be disabled with elm_entry_autosave_set() and files
10664 * can be loaded directly as plain text or have any markup in them
10665 * recognized. See elm_entry_file_set() for more details.
10667 * @section entry-signals Emitted signals
10669 * This widget emits the following signals:
10671 * @li "changed": The text within the entry was changed.
10672 * @li "changed,user": The text within the entry was changed because of user interaction.
10673 * @li "activated": The enter key was pressed on a single line entry.
10674 * @li "press": A mouse button has been pressed on the entry.
10675 * @li "longpressed": A mouse button has been pressed and held for a couple
10677 * @li "clicked": The entry has been clicked (mouse press and release).
10678 * @li "clicked,double": The entry has been double clicked.
10679 * @li "clicked,triple": The entry has been triple clicked.
10680 * @li "focused": The entry has received focus.
10681 * @li "unfocused": The entry has lost focus.
10682 * @li "selection,paste": A paste of the clipboard contents was requested.
10683 * @li "selection,copy": A copy of the selected text into the clipboard was
10685 * @li "selection,cut": A cut of the selected text into the clipboard was
10687 * @li "selection,start": A selection has begun and no previous selection
10689 * @li "selection,changed": The current selection has changed.
10690 * @li "selection,cleared": The current selection has been cleared.
10691 * @li "cursor,changed": The cursor has changed position.
10692 * @li "anchor,clicked": An anchor has been clicked. The event_info
10693 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10694 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10695 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10696 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10697 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10698 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10699 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10700 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10701 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10702 * @li "preedit,changed": The preedit string has changed.
10704 * @section entry-examples
10706 * An overview of the Entry API can be seen in @ref entry_example_01
10711 * @typedef Elm_Entry_Anchor_Info
10713 * The info sent in the callback for the "anchor,clicked" signals emitted
10716 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10718 * @struct _Elm_Entry_Anchor_Info
10720 * The info sent in the callback for the "anchor,clicked" signals emitted
10723 struct _Elm_Entry_Anchor_Info
10725 const char *name; /**< The name of the anchor, as stated in its href */
10726 int button; /**< The mouse button used to click on it */
10727 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10728 y, /**< Anchor geometry, relative to canvas */
10729 w, /**< Anchor geometry, relative to canvas */
10730 h; /**< Anchor geometry, relative to canvas */
10733 * @typedef Elm_Entry_Filter_Cb
10734 * This callback type is used by entry filters to modify text.
10735 * @param data The data specified as the last param when adding the filter
10736 * @param entry The entry object
10737 * @param text A pointer to the location of the text being filtered. This data can be modified,
10738 * but any additional allocations must be managed by the user.
10739 * @see elm_entry_text_filter_append
10740 * @see elm_entry_text_filter_prepend
10742 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10745 * This adds an entry to @p parent object.
10747 * By default, entries are:
10751 * @li autosave is enabled
10753 * @param parent The parent object
10754 * @return The new object or NULL if it cannot be created
10756 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10758 * Sets the entry to single line mode.
10760 * In single line mode, entries don't ever wrap when the text reaches the
10761 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10762 * key will generate an @c "activate" event instead of adding a new line.
10764 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10765 * and pressing enter will break the text into a different line
10766 * without generating any events.
10768 * @param obj The entry object
10769 * @param single_line If true, the text in the entry
10770 * will be on a single line.
10772 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10774 * Gets whether the entry is set to be single line.
10776 * @param obj The entry object
10777 * @return single_line If true, the text in the entry is set to display
10778 * on a single line.
10780 * @see elm_entry_single_line_set()
10782 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10784 * Sets the entry to password mode.
10786 * In password mode, entries are implicitly single line and the display of
10787 * any text in them is replaced with asterisks (*).
10789 * @param obj The entry object
10790 * @param password If true, password mode is enabled.
10792 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10794 * Gets whether the entry is set to password mode.
10796 * @param obj The entry object
10797 * @return If true, the entry is set to display all characters
10798 * as asterisks (*).
10800 * @see elm_entry_password_set()
10802 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10804 * This sets the text displayed within the entry to @p entry.
10806 * @param obj The entry object
10807 * @param entry The text to be displayed
10809 * @deprecated Use elm_object_text_set() instead.
10811 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10813 * This returns the text currently shown in object @p entry.
10814 * See also elm_entry_entry_set().
10816 * @param obj The entry object
10817 * @return The currently displayed text or NULL on failure
10819 * @deprecated Use elm_object_text_get() instead.
10821 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10823 * Appends @p entry to the text of the entry.
10825 * Adds the text in @p entry to the end of any text already present in the
10828 * The appended text is subject to any filters set for the widget.
10830 * @param obj The entry object
10831 * @param entry The text to be displayed
10833 * @see elm_entry_text_filter_append()
10835 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10837 * Gets whether the entry is empty.
10839 * Empty means no text at all. If there are any markup tags, like an item
10840 * tag for which no provider finds anything, and no text is displayed, this
10841 * function still returns EINA_FALSE.
10843 * @param obj The entry object
10844 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10846 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10848 * Gets any selected text within the entry.
10850 * If there's any selected text in the entry, this function returns it as
10851 * a string in markup format. NULL is returned if no selection exists or
10852 * if an error occurred.
10854 * The returned value points to an internal string and should not be freed
10855 * or modified in any way. If the @p entry object is deleted or its
10856 * contents are changed, the returned pointer should be considered invalid.
10858 * @param obj The entry object
10859 * @return The selected text within the entry or NULL on failure
10861 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10863 * Inserts the given text into the entry at the current cursor position.
10865 * This inserts text at the cursor position as if it was typed
10866 * by the user (note that this also allows markup which a user
10867 * can't just "type" as it would be converted to escaped text, so this
10868 * call can be used to insert things like emoticon items or bold push/pop
10869 * tags, other font and color change tags etc.)
10871 * If any selection exists, it will be replaced by the inserted text.
10873 * The inserted text is subject to any filters set for the widget.
10875 * @param obj The entry object
10876 * @param entry The text to insert
10878 * @see elm_entry_text_filter_append()
10880 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10882 * Set the line wrap type to use on multi-line entries.
10884 * Sets the wrap type used by the entry to any of the specified in
10885 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10886 * line (without inserting a line break or paragraph separator) when it
10887 * reaches the far edge of the widget.
10889 * Note that this only makes sense for multi-line entries. A widget set
10890 * to be single line will never wrap.
10892 * @param obj The entry object
10893 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10895 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10897 * Gets the wrap mode the entry was set to use.
10899 * @param obj The entry object
10900 * @return Wrap type
10902 * @see also elm_entry_line_wrap_set()
10904 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10906 * Sets if the entry is to be editable or not.
10908 * By default, entries are editable and when focused, any text input by the
10909 * user will be inserted at the current cursor position. But calling this
10910 * function with @p editable as EINA_FALSE will prevent the user from
10911 * inputting text into the entry.
10913 * The only way to change the text of a non-editable entry is to use
10914 * elm_object_text_set(), elm_entry_entry_insert() and other related
10917 * @param obj The entry object
10918 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10919 * if not, the entry is read-only and no user input is allowed.
10921 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10923 * Gets whether the entry is editable or not.
10925 * @param obj The entry object
10926 * @return If true, the entry is editable by the user.
10927 * If false, it is not editable by the user
10929 * @see elm_entry_editable_set()
10931 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10933 * This drops any existing text selection within the entry.
10935 * @param obj The entry object
10937 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10939 * This selects all text within the entry.
10941 * @param obj The entry object
10943 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10945 * This moves the cursor one place to the right 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_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10952 * This moves the cursor one place to the left within the entry.
10954 * @param obj The entry object
10955 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10957 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10959 * This moves the cursor one line up within the entry.
10961 * @param obj The entry object
10962 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10964 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10966 * This moves the cursor one line down within the entry.
10968 * @param obj The entry object
10969 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10971 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10973 * This moves the cursor to the beginning of the entry.
10975 * @param obj The entry object
10977 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10979 * This moves the cursor to the end of the entry.
10981 * @param obj The entry object
10983 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10985 * This moves the cursor to the beginning of the current line.
10987 * @param obj The entry object
10989 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10991 * This moves the cursor to the end of the current line.
10993 * @param obj The entry object
10995 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10997 * This begins a selection within the entry as though
10998 * the user were holding down the mouse button to make a selection.
11000 * @param obj The entry object
11002 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11004 * This ends a selection within the entry as though
11005 * the user had just released the mouse button while making a selection.
11007 * @param obj The entry object
11009 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11011 * Gets whether a format node exists at the current cursor position.
11013 * A format node is anything that defines how the text is rendered. It can
11014 * be a visible format node, such as a line break or a paragraph separator,
11015 * or an invisible one, such as bold begin or end tag.
11016 * This function returns whether any format node exists at the current
11019 * @param obj The entry object
11020 * @return EINA_TRUE if the current cursor position contains a format node,
11021 * EINA_FALSE otherwise.
11023 * @see elm_entry_cursor_is_visible_format_get()
11025 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11027 * Gets if the current cursor position holds a visible format node.
11029 * @param obj The entry object
11030 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11031 * if it's an invisible one or no format exists.
11033 * @see elm_entry_cursor_is_format_get()
11035 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11037 * Gets the character pointed by the cursor at its current position.
11039 * This function returns a string with the utf8 character stored at the
11040 * current cursor position.
11041 * Only the text is returned, any format that may exist will not be part
11042 * of the return value.
11044 * @param obj The entry object
11045 * @return The text pointed by the cursors.
11047 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11049 * This function returns the geometry of the cursor.
11051 * It's useful if you want to draw something on the cursor (or where it is),
11052 * or for example in the case of scrolled entry where you want to show the
11055 * @param obj The entry object
11056 * @param x returned geometry
11057 * @param y returned geometry
11058 * @param w returned geometry
11059 * @param h returned geometry
11060 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11062 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);
11064 * Sets the cursor position in the entry to the given value
11066 * The value in @p pos is the index of the character position within the
11067 * contents of the string as returned by elm_entry_cursor_pos_get().
11069 * @param obj The entry object
11070 * @param pos The position of the cursor
11072 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11074 * Retrieves the current position of the cursor in the entry
11076 * @param obj The entry object
11077 * @return The cursor position
11079 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11081 * This executes a "cut" action on the selected text in the entry.
11083 * @param obj The entry object
11085 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11087 * This executes a "copy" action on the selected text in the entry.
11089 * @param obj The entry object
11091 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11093 * This executes a "paste" action in the entry.
11095 * @param obj The entry object
11097 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11099 * This clears and frees the items in a entry's contextual (longpress)
11102 * @param obj The entry object
11104 * @see elm_entry_context_menu_item_add()
11106 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11108 * This adds an item to the entry's contextual menu.
11110 * A longpress on an entry will make the contextual menu show up, if this
11111 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11112 * By default, this menu provides a few options like enabling selection mode,
11113 * which is useful on embedded devices that need to be explicit about it,
11114 * and when a selection exists it also shows the copy and cut actions.
11116 * With this function, developers can add other options to this menu to
11117 * perform any action they deem necessary.
11119 * @param obj The entry object
11120 * @param label The item's text label
11121 * @param icon_file The item's icon file
11122 * @param icon_type The item's icon type
11123 * @param func The callback to execute when the item is clicked
11124 * @param data The data to associate with the item for related functions
11126 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);
11128 * This disables the entry's contextual (longpress) menu.
11130 * @param obj The entry object
11131 * @param disabled If true, the menu is disabled
11133 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11135 * This returns whether the entry's contextual (longpress) menu is
11138 * @param obj The entry object
11139 * @return If true, the menu is disabled
11141 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11143 * This appends a custom item provider to the list for that entry
11145 * This appends the given callback. The list is walked from beginning to end
11146 * with each function called given the item href string in the text. If the
11147 * function returns an object handle other than NULL (it should create an
11148 * object to do this), then this object is used to replace that item. If
11149 * not the next provider is called until one provides an item object, or the
11150 * default provider in entry does.
11152 * @param obj The entry object
11153 * @param func The function called to provide the item object
11154 * @param data The data passed to @p func
11156 * @see @ref entry-items
11158 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);
11160 * This prepends a custom item provider to the list for that entry
11162 * This prepends the given callback. See elm_entry_item_provider_append() for
11165 * @param obj The entry object
11166 * @param func The function called to provide the item object
11167 * @param data The data passed to @p func
11169 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);
11171 * This removes a custom item provider to the list for that entry
11173 * This removes the given callback. See elm_entry_item_provider_append() for
11176 * @param obj The entry object
11177 * @param func The function called to provide the item object
11178 * @param data The data passed to @p func
11180 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);
11182 * Append a filter function for text inserted in the entry
11184 * Append the given callback to the list. This functions will be called
11185 * whenever any text is inserted into the entry, with the text to be inserted
11186 * as a parameter. The callback function is free to alter the text in any way
11187 * it wants, but it must remember to free the given pointer and update it.
11188 * If the new text is to be discarded, the function can free it and set its
11189 * text parameter to NULL. This will also prevent any following filters from
11192 * @param obj The entry object
11193 * @param func The function to use as text filter
11194 * @param data User data to pass to @p func
11196 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11198 * Prepend a filter function for text insdrted in the entry
11200 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11201 * for more information
11203 * @param obj The entry object
11204 * @param func The function to use as text filter
11205 * @param data User data to pass to @p func
11207 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11209 * Remove a filter from the list
11211 * Removes the given callback from the filter list. See
11212 * elm_entry_text_filter_append() for more information.
11214 * @param obj The entry object
11215 * @param func The filter function to remove
11216 * @param data The user data passed when adding the function
11218 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11220 * This converts a markup (HTML-like) string into UTF-8.
11222 * The returned string is a malloc'ed buffer and it should be freed when
11223 * not needed anymore.
11225 * @param s The string (in markup) to be converted
11226 * @return The converted string (in UTF-8). It should be freed.
11228 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11230 * This converts a UTF-8 string into markup (HTML-like).
11232 * The returned string is a malloc'ed buffer and it should be freed when
11233 * not needed anymore.
11235 * @param s The string (in UTF-8) to be converted
11236 * @return The converted string (in markup). It should be freed.
11238 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11240 * This sets the file (and implicitly loads it) for the text to display and
11241 * then edit. All changes are written back to the file after a short delay if
11242 * the entry object is set to autosave (which is the default).
11244 * If the entry had any other file set previously, any changes made to it
11245 * will be saved if the autosave feature is enabled, otherwise, the file
11246 * will be silently discarded and any non-saved changes will be lost.
11248 * @param obj The entry object
11249 * @param file The path to the file to load and save
11250 * @param format The file format
11252 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11254 * Gets the file being edited by the entry.
11256 * This function can be used to retrieve any file set on the entry for
11257 * edition, along with the format used to load and save it.
11259 * @param obj The entry object
11260 * @param file The path to the file to load and save
11261 * @param format The file format
11263 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11265 * This function writes any changes made to the file set with
11266 * elm_entry_file_set()
11268 * @param obj The entry object
11270 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11272 * This sets the entry object to 'autosave' the loaded text file or not.
11274 * @param obj The entry object
11275 * @param autosave Autosave the loaded file or not
11277 * @see elm_entry_file_set()
11279 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11281 * This gets the entry object's 'autosave' status.
11283 * @param obj The entry object
11284 * @return Autosave the loaded file or not
11286 * @see elm_entry_file_set()
11288 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11290 * Control pasting of text and images for the widget.
11292 * Normally the entry allows both text and images to be pasted. By setting
11293 * textonly to be true, this prevents images from being pasted.
11295 * Note this only changes the behaviour of text.
11297 * @param obj The entry object
11298 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11299 * text+image+other.
11301 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11303 * Getting elm_entry text paste/drop mode.
11305 * In textonly mode, only text may be pasted or dropped into the widget.
11307 * @param obj The entry object
11308 * @return If the widget only accepts text from pastes.
11310 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11312 * Enable or disable scrolling in entry
11314 * Normally the entry is not scrollable unless you enable it with this call.
11316 * @param obj The entry object
11317 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11319 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11321 * Get the scrollable state of the entry
11323 * Normally the entry is not scrollable. This gets the scrollable state
11324 * of the entry. See elm_entry_scrollable_set() for more information.
11326 * @param obj The entry object
11327 * @return The scrollable state
11329 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11331 * This sets a widget to be displayed to the left of a scrolled entry.
11333 * @param obj The scrolled entry object
11334 * @param icon The widget to display on the left side of the scrolled
11337 * @note A previously set widget will be destroyed.
11338 * @note If the object being set does not have minimum size hints set,
11339 * it won't get properly displayed.
11341 * @see elm_entry_end_set()
11343 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11345 * Gets the leftmost widget of the scrolled entry. This object is
11346 * owned by the scrolled entry and should not be modified.
11348 * @param obj The scrolled entry object
11349 * @return the left widget inside the scroller
11351 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11353 * Unset the leftmost widget of the scrolled entry, unparenting and
11356 * @param obj The scrolled entry object
11357 * @return the previously set icon sub-object of this entry, on
11360 * @see elm_entry_icon_set()
11362 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11364 * Sets the visibility of the left-side widget of the scrolled entry,
11365 * set by elm_entry_icon_set().
11367 * @param obj The scrolled entry object
11368 * @param setting EINA_TRUE if the object should be displayed,
11369 * EINA_FALSE if not.
11371 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11373 * This sets a widget to be displayed to the end of a scrolled entry.
11375 * @param obj The scrolled entry object
11376 * @param end The widget to display on the right side of the scrolled
11379 * @note A previously set widget will be destroyed.
11380 * @note If the object being set does not have minimum size hints set,
11381 * it won't get properly displayed.
11383 * @see elm_entry_icon_set
11385 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11387 * Gets the endmost widget of the scrolled entry. This object is owned
11388 * by the scrolled entry and should not be modified.
11390 * @param obj The scrolled entry object
11391 * @return the right widget inside the scroller
11393 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11395 * Unset the endmost widget of the scrolled entry, unparenting and
11398 * @param obj The scrolled entry object
11399 * @return the previously set icon sub-object of this entry, on
11402 * @see elm_entry_icon_set()
11404 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11406 * Sets the visibility of the end widget of the scrolled entry, set by
11407 * elm_entry_end_set().
11409 * @param obj The scrolled entry object
11410 * @param setting EINA_TRUE if the object should be displayed,
11411 * EINA_FALSE if not.
11413 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11415 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11418 * Setting an entry to single-line mode with elm_entry_single_line_set()
11419 * will automatically disable the display of scrollbars when the entry
11420 * moves inside its scroller.
11422 * @param obj The scrolled entry object
11423 * @param h The horizontal scrollbar policy to apply
11424 * @param v The vertical scrollbar policy to apply
11426 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11428 * This enables/disables bouncing within the entry.
11430 * This function sets whether the entry will bounce when scrolling reaches
11431 * the end of the contained entry.
11433 * @param obj The scrolled entry object
11434 * @param h The horizontal bounce state
11435 * @param v The vertical bounce state
11437 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11439 * Get the bounce mode
11441 * @param obj The Entry object
11442 * @param h_bounce Allow bounce horizontally
11443 * @param v_bounce Allow bounce vertically
11445 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11447 /* pre-made filters for entries */
11449 * @typedef Elm_Entry_Filter_Limit_Size
11451 * Data for the elm_entry_filter_limit_size() entry filter.
11453 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11455 * @struct _Elm_Entry_Filter_Limit_Size
11457 * Data for the elm_entry_filter_limit_size() entry filter.
11459 struct _Elm_Entry_Filter_Limit_Size
11461 int max_char_count; /**< The maximum number of characters allowed. */
11462 int max_byte_count; /**< The maximum number of bytes allowed*/
11465 * Filter inserted text based on user defined character and byte limits
11467 * Add this filter to an entry to limit the characters that it will accept
11468 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11469 * The funtion works on the UTF-8 representation of the string, converting
11470 * it from the set markup, thus not accounting for any format in it.
11472 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11473 * it as data when setting the filter. In it, it's possible to set limits
11474 * by character count or bytes (any of them is disabled if 0), and both can
11475 * be set at the same time. In that case, it first checks for characters,
11478 * The function will cut the inserted text in order to allow only the first
11479 * number of characters that are still allowed. The cut is made in
11480 * characters, even when limiting by bytes, in order to always contain
11481 * valid ones and avoid half unicode characters making it in.
11483 * This filter, like any others, does not apply when setting the entry text
11484 * directly with elm_object_text_set() (or the deprecated
11485 * elm_entry_entry_set()).
11487 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11489 * @typedef Elm_Entry_Filter_Accept_Set
11491 * Data for the elm_entry_filter_accept_set() entry filter.
11493 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11495 * @struct _Elm_Entry_Filter_Accept_Set
11497 * Data for the elm_entry_filter_accept_set() entry filter.
11499 struct _Elm_Entry_Filter_Accept_Set
11501 const char *accepted; /**< Set of characters accepted in the entry. */
11502 const char *rejected; /**< Set of characters rejected from the entry. */
11505 * Filter inserted text based on accepted or rejected sets of characters
11507 * Add this filter to an entry to restrict the set of accepted characters
11508 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11509 * This structure contains both accepted and rejected sets, but they are
11510 * mutually exclusive.
11512 * The @c accepted set takes preference, so if it is set, the filter will
11513 * only work based on the accepted characters, ignoring anything in the
11514 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11516 * In both cases, the function filters by matching utf8 characters to the
11517 * raw markup text, so it can be used to remove formatting tags.
11519 * This filter, like any others, does not apply when setting the entry text
11520 * directly with elm_object_text_set() (or the deprecated
11521 * elm_entry_entry_set()).
11523 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11525 * Set the input panel layout of the entry
11527 * @param obj The entry object
11528 * @param layout layout type
11530 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11532 * Get the input panel layout of the entry
11534 * @param obj The entry object
11535 * @return layout type
11537 * @see elm_entry_input_panel_layout_set
11539 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11544 /* composite widgets - these basically put together basic widgets above
11545 * in convenient packages that do more than basic stuff */
11549 * @defgroup Anchorview Anchorview
11551 * @image html img/widget/anchorview/preview-00.png
11552 * @image latex img/widget/anchorview/preview-00.eps
11554 * Anchorview is for displaying text that contains markup with anchors
11555 * like <c>\<a href=1234\>something\</\></c> in it.
11557 * Besides being styled differently, the anchorview widget provides the
11558 * necessary functionality so that clicking on these anchors brings up a
11559 * popup with user defined content such as "call", "add to contacts" or
11560 * "open web page". This popup is provided using the @ref Hover widget.
11562 * This widget is very similar to @ref Anchorblock, so refer to that
11563 * widget for an example. The only difference Anchorview has is that the
11564 * widget is already provided with scrolling functionality, so if the
11565 * text set to it is too large to fit in the given space, it will scroll,
11566 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11567 * text can be displayed.
11569 * This widget emits the following signals:
11570 * @li "anchor,clicked": will be called when an anchor is clicked. The
11571 * @p event_info parameter on the callback will be a pointer of type
11572 * ::Elm_Entry_Anchorview_Info.
11574 * See @ref Anchorblock for an example on how to use both of them.
11583 * @typedef Elm_Entry_Anchorview_Info
11585 * The info sent in the callback for "anchor,clicked" signals emitted by
11586 * the Anchorview widget.
11588 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11590 * @struct _Elm_Entry_Anchorview_Info
11592 * The info sent in the callback for "anchor,clicked" signals emitted by
11593 * the Anchorview widget.
11595 struct _Elm_Entry_Anchorview_Info
11597 const char *name; /**< Name of the anchor, as indicated in its href
11599 int button; /**< The mouse button used to click on it */
11600 Evas_Object *hover; /**< The hover object to use for the popup */
11602 Evas_Coord x, y, w, h;
11603 } anchor, /**< Geometry selection of text used as anchor */
11604 hover_parent; /**< Geometry of the object used as parent by the
11606 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11607 for content on the left side of
11608 the hover. Before calling the
11609 callback, the widget will make the
11610 necessary calculations to check
11611 which sides are fit to be set with
11612 content, based on the position the
11613 hover is activated and its distance
11614 to the edges of its parent object
11616 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11617 the right side of the hover.
11618 See @ref hover_left */
11619 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11620 of the hover. See @ref hover_left */
11621 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11622 below the hover. See @ref
11626 * Add a new Anchorview object
11628 * @param parent The parent object
11629 * @return The new object or NULL if it cannot be created
11631 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11633 * Set the text to show in the anchorview
11635 * Sets the text of the anchorview to @p text. This text can include markup
11636 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11637 * text that will be specially styled and react to click events, ended with
11638 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11639 * "anchor,clicked" signal that you can attach a callback to with
11640 * evas_object_smart_callback_add(). The name of the anchor given in the
11641 * event info struct will be the one set in the href attribute, in this
11642 * case, anchorname.
11644 * Other markup can be used to style the text in different ways, but it's
11645 * up to the style defined in the theme which tags do what.
11646 * @deprecated use elm_object_text_set() instead.
11648 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11650 * Get the markup text set for the anchorview
11652 * Retrieves the text set on the anchorview, with markup tags included.
11654 * @param obj The anchorview object
11655 * @return The markup text set or @c NULL if nothing was set or an error
11657 * @deprecated use elm_object_text_set() instead.
11659 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11661 * Set the parent of the hover popup
11663 * Sets the parent object to use by the hover created by the anchorview
11664 * when an anchor is clicked. See @ref Hover for more details on this.
11665 * If no parent is set, the same anchorview object will be used.
11667 * @param obj The anchorview object
11668 * @param parent The object to use as parent for the hover
11670 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11672 * Get the parent of the hover popup
11674 * Get the object used as parent for the hover created by the anchorview
11675 * widget. See @ref Hover for more details on this.
11677 * @param obj The anchorview object
11678 * @return The object used as parent for the hover, NULL if none is set.
11680 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11682 * Set the style that the hover should use
11684 * When creating the popup hover, anchorview will request that it's
11685 * themed according to @p style.
11687 * @param obj The anchorview object
11688 * @param style The style to use for the underlying hover
11690 * @see elm_object_style_set()
11692 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11694 * Get the style that the hover should use
11696 * Get the style the hover created by anchorview will use.
11698 * @param obj The anchorview object
11699 * @return The style to use by the hover. NULL means the default is used.
11701 * @see elm_object_style_set()
11703 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11705 * Ends the hover popup in the anchorview
11707 * When an anchor is clicked, the anchorview widget will create a hover
11708 * object to use as a popup with user provided content. This function
11709 * terminates this popup, returning the anchorview to its normal state.
11711 * @param obj The anchorview object
11713 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11715 * Set bouncing behaviour when the scrolled content reaches an edge
11717 * Tell the internal scroller object whether it should bounce or not
11718 * when it reaches the respective edges for each axis.
11720 * @param obj The anchorview object
11721 * @param h_bounce Whether to bounce or not in the horizontal axis
11722 * @param v_bounce Whether to bounce or not in the vertical axis
11724 * @see elm_scroller_bounce_set()
11726 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11728 * Get the set bouncing behaviour of the internal scroller
11730 * Get whether the internal scroller should bounce when the edge of each
11731 * axis is reached scrolling.
11733 * @param obj The anchorview object
11734 * @param h_bounce Pointer where to store the bounce state of the horizontal
11736 * @param v_bounce Pointer where to store the bounce state of the vertical
11739 * @see elm_scroller_bounce_get()
11741 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11743 * Appends a custom item provider to the given anchorview
11745 * Appends the given function to the list of items providers. This list is
11746 * called, one function at a time, with the given @p data pointer, the
11747 * anchorview object and, in the @p item parameter, the item name as
11748 * referenced in its href string. Following functions in the list will be
11749 * called in order until one of them returns something different to NULL,
11750 * which should be an Evas_Object which will be used in place of the item
11753 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11754 * href=item/name\>\</item\>
11756 * @param obj The anchorview object
11757 * @param func The function to add to the list of providers
11758 * @param data User data that will be passed to the callback function
11760 * @see elm_entry_item_provider_append()
11762 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);
11764 * Prepend a custom item provider to the given anchorview
11766 * Like elm_anchorview_item_provider_append(), but it adds the function
11767 * @p func to the beginning of the list, instead of the end.
11769 * @param obj The anchorview object
11770 * @param func The function to add to the list of providers
11771 * @param data User data that will be passed to the callback function
11773 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);
11775 * Remove a custom item provider from the list of the given anchorview
11777 * Removes the function and data pairing that matches @p func and @p data.
11778 * That is, unless the same function and same user data are given, the
11779 * function will not be removed from the list. This allows us to add the
11780 * same callback several times, with different @p data pointers and be
11781 * able to remove them later without conflicts.
11783 * @param obj The anchorview object
11784 * @param func The function to remove from the list
11785 * @param data The data matching the function to remove from the list
11787 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);
11794 * @defgroup Anchorblock Anchorblock
11796 * @image html img/widget/anchorblock/preview-00.png
11797 * @image latex img/widget/anchorblock/preview-00.eps
11799 * Anchorblock is for displaying text that contains markup with anchors
11800 * like <c>\<a href=1234\>something\</\></c> in it.
11802 * Besides being styled differently, the anchorblock widget provides the
11803 * necessary functionality so that clicking on these anchors brings up a
11804 * popup with user defined content such as "call", "add to contacts" or
11805 * "open web page". This popup is provided using the @ref Hover widget.
11807 * This widget emits the following signals:
11808 * @li "anchor,clicked": will be called when an anchor is clicked. The
11809 * @p event_info parameter on the callback will be a pointer of type
11810 * ::Elm_Entry_Anchorblock_Info.
11816 * Since examples are usually better than plain words, we might as well
11817 * try @ref tutorial_anchorblock_example "one".
11820 * @addtogroup Anchorblock
11824 * @typedef Elm_Entry_Anchorblock_Info
11826 * The info sent in the callback for "anchor,clicked" signals emitted by
11827 * the Anchorblock widget.
11829 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11831 * @struct _Elm_Entry_Anchorblock_Info
11833 * The info sent in the callback for "anchor,clicked" signals emitted by
11834 * the Anchorblock widget.
11836 struct _Elm_Entry_Anchorblock_Info
11838 const char *name; /**< Name of the anchor, as indicated in its href
11840 int button; /**< The mouse button used to click on it */
11841 Evas_Object *hover; /**< The hover object to use for the popup */
11843 Evas_Coord x, y, w, h;
11844 } anchor, /**< Geometry selection of text used as anchor */
11845 hover_parent; /**< Geometry of the object used as parent by the
11847 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11848 for content on the left side of
11849 the hover. Before calling the
11850 callback, the widget will make the
11851 necessary calculations to check
11852 which sides are fit to be set with
11853 content, based on the position the
11854 hover is activated and its distance
11855 to the edges of its parent object
11857 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11858 the right side of the hover.
11859 See @ref hover_left */
11860 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11861 of the hover. See @ref hover_left */
11862 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11863 below the hover. See @ref
11867 * Add a new Anchorblock object
11869 * @param parent The parent object
11870 * @return The new object or NULL if it cannot be created
11872 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11874 * Set the text to show in the anchorblock
11876 * Sets the text of the anchorblock to @p text. This text can include markup
11877 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11878 * of text that will be specially styled and react to click events, ended
11879 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11880 * "anchor,clicked" signal that you can attach a callback to with
11881 * evas_object_smart_callback_add(). The name of the anchor given in the
11882 * event info struct will be the one set in the href attribute, in this
11883 * case, anchorname.
11885 * Other markup can be used to style the text in different ways, but it's
11886 * up to the style defined in the theme which tags do what.
11887 * @deprecated use elm_object_text_set() instead.
11889 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11891 * Get the markup text set for the anchorblock
11893 * Retrieves the text set on the anchorblock, with markup tags included.
11895 * @param obj The anchorblock object
11896 * @return The markup text set or @c NULL if nothing was set or an error
11898 * @deprecated use elm_object_text_set() instead.
11900 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11902 * Set the parent of the hover popup
11904 * Sets the parent object to use by the hover created by the anchorblock
11905 * when an anchor is clicked. See @ref Hover for more details on this.
11907 * @param obj The anchorblock object
11908 * @param parent The object to use as parent for the hover
11910 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11912 * Get the parent of the hover popup
11914 * Get the object used as parent for the hover created by the anchorblock
11915 * widget. See @ref Hover for more details on this.
11916 * If no parent is set, the same anchorblock object will be used.
11918 * @param obj The anchorblock object
11919 * @return The object used as parent for the hover, NULL if none is set.
11921 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11923 * Set the style that the hover should use
11925 * When creating the popup hover, anchorblock will request that it's
11926 * themed according to @p style.
11928 * @param obj The anchorblock object
11929 * @param style The style to use for the underlying hover
11931 * @see elm_object_style_set()
11933 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11935 * Get the style that the hover should use
11937 * Get the style the hover created by anchorblock will use.
11939 * @param obj The anchorblock object
11940 * @return The style to use by the hover. NULL means the default is used.
11942 * @see elm_object_style_set()
11944 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11946 * Ends the hover popup in the anchorblock
11948 * When an anchor is clicked, the anchorblock widget will create a hover
11949 * object to use as a popup with user provided content. This function
11950 * terminates this popup, returning the anchorblock to its normal state.
11952 * @param obj The anchorblock object
11954 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11956 * Appends a custom item provider to the given anchorblock
11958 * Appends the given function to the list of items providers. This list is
11959 * called, one function at a time, with the given @p data pointer, the
11960 * anchorblock object and, in the @p item parameter, the item name as
11961 * referenced in its href string. Following functions in the list will be
11962 * called in order until one of them returns something different to NULL,
11963 * which should be an Evas_Object which will be used in place of the item
11966 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11967 * href=item/name\>\</item\>
11969 * @param obj The anchorblock object
11970 * @param func The function to add to the list of providers
11971 * @param data User data that will be passed to the callback function
11973 * @see elm_entry_item_provider_append()
11975 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);
11977 * Prepend a custom item provider to the given anchorblock
11979 * Like elm_anchorblock_item_provider_append(), but it adds the function
11980 * @p func to the beginning of the list, instead of the end.
11982 * @param obj The anchorblock object
11983 * @param func The function to add to the list of providers
11984 * @param data User data that will be passed to the callback function
11986 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);
11988 * Remove a custom item provider from the list of the given anchorblock
11990 * Removes the function and data pairing that matches @p func and @p data.
11991 * That is, unless the same function and same user data are given, the
11992 * function will not be removed from the list. This allows us to add the
11993 * same callback several times, with different @p data pointers and be
11994 * able to remove them later without conflicts.
11996 * @param obj The anchorblock object
11997 * @param func The function to remove from the list
11998 * @param data The data matching the function to remove from the list
12000 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);
12006 * @defgroup Bubble Bubble
12008 * @image html img/widget/bubble/preview-00.png
12009 * @image latex img/widget/bubble/preview-00.eps
12010 * @image html img/widget/bubble/preview-01.png
12011 * @image latex img/widget/bubble/preview-01.eps
12012 * @image html img/widget/bubble/preview-02.png
12013 * @image latex img/widget/bubble/preview-02.eps
12015 * @brief The Bubble is a widget to show text similarly to how speech is
12016 * represented in comics.
12018 * The bubble widget contains 5 important visual elements:
12019 * @li The frame is a rectangle with rounded rectangles and an "arrow".
12020 * @li The @p icon is an image to which the frame's arrow points to.
12021 * @li The @p label is a text which appears to the right of the icon if the
12022 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12024 * @li The @p info is a text which appears to the right of the label. Info's
12025 * font is of a ligther color than label.
12026 * @li The @p content is an evas object that is shown inside the frame.
12028 * The position of the arrow, icon, label and info depends on which corner is
12029 * selected. The four available corners are:
12030 * @li "top_left" - Default
12032 * @li "bottom_left"
12033 * @li "bottom_right"
12035 * Signals that you can add callbacks for are:
12036 * @li "clicked" - This is called when a user has clicked the bubble.
12038 * For an example of using a buble see @ref bubble_01_example_page "this".
12043 * Add a new bubble to the parent
12045 * @param parent The parent object
12046 * @return The new object or NULL if it cannot be created
12048 * This function adds a text bubble to the given parent evas object.
12050 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12052 * Set the label of the bubble
12054 * @param obj The bubble object
12055 * @param label The string to set in the label
12057 * This function sets the title of the bubble. Where this appears depends on
12058 * the selected corner.
12059 * @deprecated use elm_object_text_set() instead.
12061 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12063 * Get the label of the bubble
12065 * @param obj The bubble object
12066 * @return The string of set in the label
12068 * This function gets the title of the bubble.
12069 * @deprecated use elm_object_text_get() instead.
12071 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12073 * Set the info of the bubble
12075 * @param obj The bubble object
12076 * @param info The given info about the bubble
12078 * This function sets the info of the bubble. Where this appears depends on
12079 * the selected corner.
12080 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12082 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12084 * Get the info of the bubble
12086 * @param obj The bubble object
12088 * @return The "info" string of the bubble
12090 * This function gets the info text.
12091 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12093 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12095 * Set the content to be shown in the bubble
12097 * Once the content object is set, a previously set one will be deleted.
12098 * If you want to keep the old content object, use the
12099 * elm_bubble_content_unset() function.
12101 * @param obj The bubble object
12102 * @param content The given content of the bubble
12104 * This function sets the content shown on the middle of the bubble.
12106 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12108 * Get the content shown in the bubble
12110 * Return the content object which is set for this widget.
12112 * @param obj The bubble object
12113 * @return The content that is being used
12115 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12117 * Unset the content shown in the bubble
12119 * Unparent and return the content object which was set for this widget.
12121 * @param obj The bubble object
12122 * @return The content that was being used
12124 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12126 * Set the icon of the bubble
12128 * Once the icon object is set, a previously set one will be deleted.
12129 * If you want to keep the old content object, use the
12130 * elm_icon_content_unset() function.
12132 * @param obj The bubble object
12133 * @param icon The given icon for the bubble
12135 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12137 * Get the icon of the bubble
12139 * @param obj The bubble object
12140 * @return The icon for the bubble
12142 * This function gets the icon shown on the top left of bubble.
12144 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12146 * Unset the icon of the bubble
12148 * Unparent and return the icon object which was set for this widget.
12150 * @param obj The bubble object
12151 * @return The icon that was being used
12153 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12155 * Set the corner of the bubble
12157 * @param obj The bubble object.
12158 * @param corner The given corner for the bubble.
12160 * This function sets the corner of the bubble. The corner will be used to
12161 * determine where the arrow in the frame points to and where label, icon and
12164 * Possible values for corner are:
12165 * @li "top_left" - Default
12167 * @li "bottom_left"
12168 * @li "bottom_right"
12170 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12172 * Get the corner of the bubble
12174 * @param obj The bubble object.
12175 * @return The given corner for the bubble.
12177 * This function gets the selected corner of the bubble.
12179 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12185 * @defgroup Photo Photo
12187 * For displaying the photo of a person (contact). Simple yet
12188 * with a very specific purpose.
12190 * Signals that you can add callbacks for are:
12192 * "clicked" - This is called when a user has clicked the photo
12193 * "drag,start" - Someone started dragging the image out of the object
12194 * "drag,end" - Dragged item was dropped (somewhere)
12200 * Add a new photo to the parent
12202 * @param parent The parent object
12203 * @return The new object or NULL if it cannot be created
12207 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12210 * Set the file that will be used as photo
12212 * @param obj The photo object
12213 * @param file The path to file that will be used as photo
12215 * @return (1 = success, 0 = error)
12219 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12222 * Set the file that will be used as thumbnail in the photo.
12224 * @param obj The photo object.
12225 * @param file The path to file that will be used as thumb.
12226 * @param group The key used in case of an EET file.
12230 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12233 * Set the size that will be used on the photo
12235 * @param obj The photo object
12236 * @param size The size that the photo will be
12240 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12243 * Set if the photo should be completely visible or not.
12245 * @param obj The photo object
12246 * @param fill if true the photo will be completely visible
12250 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12253 * Set editability of the photo.
12255 * An editable photo can be dragged to or from, and can be cut or
12256 * pasted too. Note that pasting an image or dropping an item on
12257 * the image will delete the existing content.
12259 * @param obj The photo object.
12260 * @param set To set of clear editablity.
12262 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12268 /* gesture layer */
12270 * @defgroup Elm_Gesture_Layer Gesture Layer
12271 * Gesture Layer Usage:
12273 * Use Gesture Layer to detect gestures.
12274 * The advantage is that you don't have to implement
12275 * gesture detection, just set callbacks of gesture state.
12276 * By using gesture layer we make standard interface.
12278 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12279 * with a parent object parameter.
12280 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12281 * call. Usually with same object as target (2nd parameter).
12283 * Now you need to tell gesture layer what gestures you follow.
12284 * This is done with @ref elm_gesture_layer_cb_set call.
12285 * By setting the callback you actually saying to gesture layer:
12286 * I would like to know when the gesture @ref Elm_Gesture_Types
12287 * switches to state @ref Elm_Gesture_State.
12289 * Next, you need to implement the actual action that follows the input
12290 * in your callback.
12292 * Note that if you like to stop being reported about a gesture, just set
12293 * all callbacks referring this gesture to NULL.
12294 * (again with @ref elm_gesture_layer_cb_set)
12296 * The information reported by gesture layer to your callback is depending
12297 * on @ref Elm_Gesture_Types:
12298 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12299 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12300 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12302 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12303 * @ref ELM_GESTURE_MOMENTUM.
12305 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12306 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12307 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12308 * Note that we consider a flick as a line-gesture that should be completed
12309 * in flick-time-limit as defined in @ref Config.
12311 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12313 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12316 * Gesture Layer Tweaks:
12318 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12319 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12321 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12322 * so gesture starts when user touches (a *DOWN event) touch-surface
12323 * and ends when no fingers touches surface (a *UP event).
12327 * @enum _Elm_Gesture_Types
12328 * Enum of supported gesture types.
12329 * @ingroup Elm_Gesture_Layer
12331 enum _Elm_Gesture_Types
12333 ELM_GESTURE_FIRST = 0,
12335 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12336 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12337 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12338 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12340 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12342 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12343 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12345 ELM_GESTURE_ZOOM, /**< Zoom */
12346 ELM_GESTURE_ROTATE, /**< Rotate */
12352 * @typedef Elm_Gesture_Types
12353 * gesture types enum
12354 * @ingroup Elm_Gesture_Layer
12356 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12359 * @enum _Elm_Gesture_State
12360 * Enum of gesture states.
12361 * @ingroup Elm_Gesture_Layer
12363 enum _Elm_Gesture_State
12365 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12366 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12367 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12368 ELM_GESTURE_STATE_END, /**< Gesture completed */
12369 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12373 * @typedef Elm_Gesture_State
12374 * gesture states enum
12375 * @ingroup Elm_Gesture_Layer
12377 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12380 * @struct _Elm_Gesture_Taps_Info
12381 * Struct holds taps info for user
12382 * @ingroup Elm_Gesture_Layer
12384 struct _Elm_Gesture_Taps_Info
12386 Evas_Coord x, y; /**< Holds center point between fingers */
12387 unsigned int n; /**< Number of fingers tapped */
12388 unsigned int timestamp; /**< event timestamp */
12392 * @typedef Elm_Gesture_Taps_Info
12393 * holds taps info for user
12394 * @ingroup Elm_Gesture_Layer
12396 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12399 * @struct _Elm_Gesture_Momentum_Info
12400 * Struct holds momentum info for user
12401 * x1 and y1 are not necessarily in sync
12402 * x1 holds x value of x direction starting point
12403 * and same holds for y1.
12404 * This is noticeable when doing V-shape movement
12405 * @ingroup Elm_Gesture_Layer
12407 struct _Elm_Gesture_Momentum_Info
12408 { /* Report line ends, timestamps, and momentum computed */
12409 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12410 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12411 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12412 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12414 unsigned int tx; /**< Timestamp of start of final x-swipe */
12415 unsigned int ty; /**< Timestamp of start of final y-swipe */
12417 Evas_Coord mx; /**< Momentum on X */
12418 Evas_Coord my; /**< Momentum on Y */
12422 * @typedef Elm_Gesture_Momentum_Info
12423 * holds momentum info for user
12424 * @ingroup Elm_Gesture_Layer
12426 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12429 * @struct _Elm_Gesture_Line_Info
12430 * Struct holds line info for user
12431 * @ingroup Elm_Gesture_Layer
12433 struct _Elm_Gesture_Line_Info
12434 { /* Report line ends, timestamps, and momentum computed */
12435 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12436 unsigned int n; /**< Number of fingers (lines) */
12437 /* FIXME should be radians, bot degrees */
12438 double angle; /**< Angle (direction) of lines */
12442 * @typedef Elm_Gesture_Line_Info
12443 * Holds line info for user
12444 * @ingroup Elm_Gesture_Layer
12446 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12449 * @struct _Elm_Gesture_Zoom_Info
12450 * Struct holds zoom info for user
12451 * @ingroup Elm_Gesture_Layer
12453 struct _Elm_Gesture_Zoom_Info
12455 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12456 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12457 double zoom; /**< Zoom value: 1.0 means no zoom */
12458 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12462 * @typedef Elm_Gesture_Zoom_Info
12463 * Holds zoom info for user
12464 * @ingroup Elm_Gesture_Layer
12466 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12469 * @struct _Elm_Gesture_Rotate_Info
12470 * Struct holds rotation info for user
12471 * @ingroup Elm_Gesture_Layer
12473 struct _Elm_Gesture_Rotate_Info
12475 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12476 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12477 double base_angle; /**< Holds start-angle */
12478 double angle; /**< Rotation value: 0.0 means no rotation */
12479 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12483 * @typedef Elm_Gesture_Rotate_Info
12484 * Holds rotation info for user
12485 * @ingroup Elm_Gesture_Layer
12487 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12490 * @typedef Elm_Gesture_Event_Cb
12491 * User callback used to stream gesture info from gesture layer
12492 * @param data user data
12493 * @param event_info gesture report info
12494 * Returns a flag field to be applied on the causing event.
12495 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12496 * upon the event, in an irreversible way.
12498 * @ingroup Elm_Gesture_Layer
12500 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12503 * Use function to set callbacks to be notified about
12504 * change of state of gesture.
12505 * When a user registers a callback with this function
12506 * this means this gesture has to be tested.
12508 * When ALL callbacks for a gesture are set to NULL
12509 * it means user isn't interested in gesture-state
12510 * and it will not be tested.
12512 * @param obj Pointer to gesture-layer.
12513 * @param idx The gesture you would like to track its state.
12514 * @param cb callback function pointer.
12515 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12516 * @param data user info to be sent to callback (usually, Smart Data)
12518 * @ingroup Elm_Gesture_Layer
12520 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);
12523 * Call this function to get repeat-events settings.
12525 * @param obj Pointer to gesture-layer.
12527 * @return repeat events settings.
12528 * @see elm_gesture_layer_hold_events_set()
12529 * @ingroup Elm_Gesture_Layer
12531 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12534 * This function called in order to make gesture-layer repeat events.
12535 * Set this of you like to get the raw events only if gestures were not detected.
12536 * Clear this if you like gesture layer to fwd events as testing gestures.
12538 * @param obj Pointer to gesture-layer.
12539 * @param r Repeat: TRUE/FALSE
12541 * @ingroup Elm_Gesture_Layer
12543 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12546 * This function sets step-value for zoom action.
12547 * Set step to any positive value.
12548 * Cancel step setting by setting to 0.0
12550 * @param obj Pointer to gesture-layer.
12551 * @param s new zoom step value.
12553 * @ingroup Elm_Gesture_Layer
12555 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12558 * This function sets step-value for rotate action.
12559 * Set step to any positive value.
12560 * Cancel step setting by setting to 0.0
12562 * @param obj Pointer to gesture-layer.
12563 * @param s new roatate step value.
12565 * @ingroup Elm_Gesture_Layer
12567 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12570 * This function called to attach gesture-layer to an Evas_Object.
12571 * @param obj Pointer to gesture-layer.
12572 * @param t Pointer to underlying object (AKA Target)
12574 * @return TRUE, FALSE on success, failure.
12576 * @ingroup Elm_Gesture_Layer
12578 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12581 * Call this function to construct a new gesture-layer object.
12582 * This does not activate the gesture layer. You have to
12583 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12585 * @param parent the parent object.
12587 * @return Pointer to new gesture-layer object.
12589 * @ingroup Elm_Gesture_Layer
12591 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12594 * @defgroup Thumb Thumb
12596 * @image html img/widget/thumb/preview-00.png
12597 * @image latex img/widget/thumb/preview-00.eps
12599 * A thumb object is used for displaying the thumbnail of an image or video.
12600 * You must have compiled Elementary with Ethumb_Client support and the DBus
12601 * service must be present and auto-activated in order to have thumbnails to
12604 * Once the thumbnail object becomes visible, it will check if there is a
12605 * previously generated thumbnail image for the file set on it. If not, it
12606 * will start generating this thumbnail.
12608 * Different config settings will cause different thumbnails to be generated
12609 * even on the same file.
12611 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12612 * Ethumb documentation to change this path, and to see other configuration
12615 * Signals that you can add callbacks for are:
12617 * - "clicked" - This is called when a user has clicked the thumb without dragging
12619 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12620 * - "press" - This is called when a user has pressed down the thumb.
12621 * - "generate,start" - The thumbnail generation started.
12622 * - "generate,stop" - The generation process stopped.
12623 * - "generate,error" - The generation failed.
12624 * - "load,error" - The thumbnail image loading failed.
12626 * available styles:
12630 * An example of use of thumbnail:
12632 * - @ref thumb_example_01
12636 * @addtogroup Thumb
12641 * @enum _Elm_Thumb_Animation_Setting
12642 * @typedef Elm_Thumb_Animation_Setting
12644 * Used to set if a video thumbnail is animating or not.
12648 typedef enum _Elm_Thumb_Animation_Setting
12650 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12651 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12652 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12653 ELM_THUMB_ANIMATION_LAST
12654 } Elm_Thumb_Animation_Setting;
12657 * Add a new thumb object to the parent.
12659 * @param parent The parent object.
12660 * @return The new object or NULL if it cannot be created.
12662 * @see elm_thumb_file_set()
12663 * @see elm_thumb_ethumb_client_get()
12667 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12669 * Reload thumbnail if it was generated before.
12671 * @param obj The thumb object to reload
12673 * This is useful if the ethumb client configuration changed, like its
12674 * size, aspect or any other property one set in the handle returned
12675 * by elm_thumb_ethumb_client_get().
12677 * If the options didn't change, the thumbnail won't be generated again, but
12678 * the old one will still be used.
12680 * @see elm_thumb_file_set()
12684 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12686 * Set the file that will be used as thumbnail.
12688 * @param obj The thumb object.
12689 * @param file The path to file that will be used as thumb.
12690 * @param key The key used in case of an EET file.
12692 * The file can be an image or a video (in that case, acceptable extensions are:
12693 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12694 * function elm_thumb_animate().
12696 * @see elm_thumb_file_get()
12697 * @see elm_thumb_reload()
12698 * @see elm_thumb_animate()
12702 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12704 * Get the image or video path and key used to generate the thumbnail.
12706 * @param obj The thumb object.
12707 * @param file Pointer to filename.
12708 * @param key Pointer to key.
12710 * @see elm_thumb_file_set()
12711 * @see elm_thumb_path_get()
12715 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12717 * Get the path and key to the image or video generated by ethumb.
12719 * One just need to make sure that the thumbnail was generated before getting
12720 * its path; otherwise, the path will be NULL. One way to do that is by asking
12721 * for the path when/after the "generate,stop" smart callback is called.
12723 * @param obj The thumb object.
12724 * @param file Pointer to thumb path.
12725 * @param key Pointer to thumb key.
12727 * @see elm_thumb_file_get()
12731 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12733 * Set the animation state for the thumb object. If its content is an animated
12734 * video, you may start/stop the animation or tell it to play continuously and
12737 * @param obj The thumb object.
12738 * @param setting The animation setting.
12740 * @see elm_thumb_file_set()
12744 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12746 * Get the animation state for the thumb object.
12748 * @param obj The thumb object.
12749 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12752 * @see elm_thumb_animate_set()
12756 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12758 * Get the ethumb_client handle so custom configuration can be made.
12760 * @return Ethumb_Client instance or NULL.
12762 * This must be called before the objects are created to be sure no object is
12763 * visible and no generation started.
12765 * Example of usage:
12768 * #include <Elementary.h>
12769 * #ifndef ELM_LIB_QUICKLAUNCH
12771 * elm_main(int argc, char **argv)
12773 * Ethumb_Client *client;
12775 * elm_need_ethumb();
12779 * client = elm_thumb_ethumb_client_get();
12782 * ERR("could not get ethumb_client");
12785 * ethumb_client_size_set(client, 100, 100);
12786 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12789 * // Create elm_thumb objects here
12799 * @note There's only one client handle for Ethumb, so once a configuration
12800 * change is done to it, any other request for thumbnails (for any thumbnail
12801 * object) will use that configuration. Thus, this configuration is global.
12805 EAPI void *elm_thumb_ethumb_client_get(void);
12807 * Get the ethumb_client connection state.
12809 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12812 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12814 * Make the thumbnail 'editable'.
12816 * @param obj Thumb object.
12817 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12819 * This means the thumbnail is a valid drag target for drag and drop, and can be
12820 * cut or pasted too.
12822 * @see elm_thumb_editable_get()
12826 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12828 * Make the thumbnail 'editable'.
12830 * @param obj Thumb object.
12831 * @return Editability.
12833 * This means the thumbnail is a valid drag target for drag and drop, and can be
12834 * cut or pasted too.
12836 * @see elm_thumb_editable_set()
12840 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12847 * @defgroup Hoversel Hoversel
12849 * @image html img/widget/hoversel/preview-00.png
12850 * @image latex img/widget/hoversel/preview-00.eps
12852 * A hoversel is a button that pops up a list of items (automatically
12853 * choosing the direction to display) that have a label and, optionally, an
12854 * icon to select from. It is a convenience widget to avoid the need to do
12855 * all the piecing together yourself. It is intended for a small number of
12856 * items in the hoversel menu (no more than 8), though is capable of many
12859 * Signals that you can add callbacks for are:
12860 * "clicked" - the user clicked the hoversel button and popped up the sel
12861 * "selected" - an item in the hoversel list is selected. event_info is the item
12862 * "dismissed" - the hover is dismissed
12864 * See @ref tutorial_hoversel for an example.
12867 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12869 * @brief Add a new Hoversel object
12871 * @param parent The parent object
12872 * @return The new object or NULL if it cannot be created
12874 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12876 * @brief This sets the hoversel to expand horizontally.
12878 * @param obj The hoversel object
12879 * @param horizontal If true, the hover will expand horizontally to the
12882 * @note The initial button will display horizontally regardless of this
12885 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12887 * @brief This returns whether the hoversel is set to expand horizontally.
12889 * @param obj The hoversel object
12890 * @return If true, the hover will expand horizontally to the right.
12892 * @see elm_hoversel_horizontal_set()
12894 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12896 * @brief Set the Hover parent
12898 * @param obj The hoversel object
12899 * @param parent The parent to use
12901 * Sets the hover parent object, the area that will be darkened when the
12902 * hoversel is clicked. Should probably be the window that the hoversel is
12903 * in. See @ref Hover objects for more information.
12905 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12907 * @brief Get the Hover parent
12909 * @param obj The hoversel object
12910 * @return The used parent
12912 * Gets the hover parent object.
12914 * @see elm_hoversel_hover_parent_set()
12916 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12918 * @brief Set the hoversel button label
12920 * @param obj The hoversel object
12921 * @param label The label text.
12923 * This sets the label of the button that is always visible (before it is
12924 * clicked and expanded).
12926 * @deprecated elm_object_text_set()
12928 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12930 * @brief Get the hoversel button label
12932 * @param obj The hoversel object
12933 * @return The label text.
12935 * @deprecated elm_object_text_get()
12937 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12939 * @brief Set the icon of the hoversel button
12941 * @param obj The hoversel object
12942 * @param icon The icon object
12944 * Sets the icon of the button that is always visible (before it is clicked
12945 * and expanded). Once the icon object is set, a previously set one will be
12946 * deleted, if you want to keep that old content object, use the
12947 * elm_hoversel_icon_unset() function.
12949 * @see elm_button_icon_set()
12951 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12953 * @brief Get the icon of the hoversel button
12955 * @param obj The hoversel object
12956 * @return The icon object
12958 * Get the icon of the button that is always visible (before it is clicked
12959 * and expanded). Also see elm_button_icon_get().
12961 * @see elm_hoversel_icon_set()
12963 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12965 * @brief Get and unparent the icon of the hoversel button
12967 * @param obj The hoversel object
12968 * @return The icon object that was being used
12970 * Unparent and return the icon of the button that is always visible
12971 * (before it is clicked and expanded).
12973 * @see elm_hoversel_icon_set()
12974 * @see elm_button_icon_unset()
12976 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12978 * @brief This triggers the hoversel popup from code, the same as if the user
12979 * had clicked the button.
12981 * @param obj The hoversel object
12983 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12985 * @brief This dismisses the hoversel popup as if the user had clicked
12986 * outside the hover.
12988 * @param obj The hoversel object
12990 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12992 * @brief Returns whether the hoversel is expanded.
12994 * @param obj The hoversel object
12995 * @return This will return EINA_TRUE if the hoversel is expanded or
12996 * EINA_FALSE if it is not expanded.
12998 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13000 * @brief This will remove all the children items from the hoversel.
13002 * @param obj The hoversel object
13004 * @warning Should @b not be called while the hoversel is active; use
13005 * elm_hoversel_expanded_get() to check first.
13007 * @see elm_hoversel_item_del_cb_set()
13008 * @see elm_hoversel_item_del()
13010 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13012 * @brief Get the list of items within the given hoversel.
13014 * @param obj The hoversel object
13015 * @return Returns a list of Elm_Hoversel_Item*
13017 * @see elm_hoversel_item_add()
13019 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13021 * @brief Add an item to the hoversel button
13023 * @param obj The hoversel object
13024 * @param label The text label to use for the item (NULL if not desired)
13025 * @param icon_file An image file path on disk to use for the icon or standard
13026 * icon name (NULL if not desired)
13027 * @param icon_type The icon type if relevant
13028 * @param func Convenience function to call when this item is selected
13029 * @param data Data to pass to item-related functions
13030 * @return A handle to the item added.
13032 * This adds an item to the hoversel to show when it is clicked. Note: if you
13033 * need to use an icon from an edje file then use
13034 * elm_hoversel_item_icon_set() right after the this function, and set
13035 * icon_file to NULL here.
13037 * For more information on what @p icon_file and @p icon_type are see the
13038 * @ref Icon "icon documentation".
13040 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);
13042 * @brief Delete an item from the hoversel
13044 * @param item The item to delete
13046 * This deletes the item from the hoversel (should not be called while the
13047 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13049 * @see elm_hoversel_item_add()
13050 * @see elm_hoversel_item_del_cb_set()
13052 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13054 * @brief Set the function to be called when an item from the hoversel is
13057 * @param item The item to set the callback on
13058 * @param func The function called
13060 * That function will receive these parameters:
13061 * @li void *item_data
13062 * @li Evas_Object *the_item_object
13063 * @li Elm_Hoversel_Item *the_object_struct
13065 * @see elm_hoversel_item_add()
13067 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13069 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13070 * that will be passed to associated function callbacks.
13072 * @param item The item to get the data from
13073 * @return The data pointer set with elm_hoversel_item_add()
13075 * @see elm_hoversel_item_add()
13077 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13079 * @brief This returns the label text of the given hoversel item.
13081 * @param item The item to get the label
13082 * @return The label text of the hoversel item
13084 * @see elm_hoversel_item_add()
13086 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13088 * @brief This sets the icon for the given hoversel item.
13090 * @param item The item to set the icon
13091 * @param icon_file An image file path on disk to use for the icon or standard
13093 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13094 * to NULL if the icon is not an edje file
13095 * @param icon_type The icon type
13097 * The icon can be loaded from the standard set, from an image file, or from
13100 * @see elm_hoversel_item_add()
13102 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);
13104 * @brief Get the icon object of the hoversel item
13106 * @param item The item to get the icon from
13107 * @param icon_file The image file path on disk used for the icon or standard
13109 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13110 * if the icon is not an edje file
13111 * @param icon_type The icon type
13113 * @see elm_hoversel_item_icon_set()
13114 * @see elm_hoversel_item_add()
13116 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);
13122 * @defgroup Toolbar Toolbar
13123 * @ingroup Elementary
13125 * @image html img/widget/toolbar/preview-00.png
13126 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13128 * @image html img/toolbar.png
13129 * @image latex img/toolbar.eps width=\textwidth
13131 * A toolbar is a widget that displays a list of items inside
13132 * a box. It can be scrollable, show a menu with items that don't fit
13133 * to toolbar size or even crop them.
13135 * Only one item can be selected at a time.
13137 * Items can have multiple states, or show menus when selected by the user.
13139 * Smart callbacks one can listen to:
13140 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13142 * Available styles for it:
13144 * - @c "transparent" - no background or shadow, just show the content
13146 * List of examples:
13147 * @li @ref toolbar_example_01
13148 * @li @ref toolbar_example_02
13149 * @li @ref toolbar_example_03
13153 * @addtogroup Toolbar
13158 * @enum _Elm_Toolbar_Shrink_Mode
13159 * @typedef Elm_Toolbar_Shrink_Mode
13161 * Set toolbar's items display behavior, it can be scrollabel,
13162 * show a menu with exceeding items, or simply hide them.
13164 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13167 * Values <b> don't </b> work as bitmask, only one can be choosen.
13169 * @see elm_toolbar_mode_shrink_set()
13170 * @see elm_toolbar_mode_shrink_get()
13174 typedef enum _Elm_Toolbar_Shrink_Mode
13176 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
13177 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
13178 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13179 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
13180 } Elm_Toolbar_Shrink_Mode;
13182 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(). */
13184 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(). */
13187 * Add a new toolbar widget to the given parent Elementary
13188 * (container) object.
13190 * @param parent The parent object.
13191 * @return a new toolbar widget handle or @c NULL, on errors.
13193 * This function inserts a new toolbar widget on the canvas.
13197 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13200 * Set the icon size, in pixels, to be used by toolbar items.
13202 * @param obj The toolbar object
13203 * @param icon_size The icon size in pixels
13205 * @note Default value is @c 32. It reads value from elm config.
13207 * @see elm_toolbar_icon_size_get()
13211 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13214 * Get the icon size, in pixels, to be used by toolbar items.
13216 * @param obj The toolbar object.
13217 * @return The icon size in pixels.
13219 * @see elm_toolbar_icon_size_set() for details.
13223 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13226 * Sets icon lookup order, for toolbar items' icons.
13228 * @param obj The toolbar object.
13229 * @param order The icon lookup order.
13231 * Icons added before calling this function will not be affected.
13232 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13234 * @see elm_toolbar_icon_order_lookup_get()
13238 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13241 * Gets the icon lookup order.
13243 * @param obj The toolbar object.
13244 * @return The icon lookup order.
13246 * @see elm_toolbar_icon_order_lookup_set() for details.
13250 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13253 * Set whether the toolbar items' should be selected by the user or not.
13255 * @param obj The toolbar object.
13256 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13259 * This will turn off the ability to select items entirely and they will
13260 * neither appear selected nor emit selected signals. The clicked
13261 * callback function will still be called.
13263 * Selection is enabled by default.
13265 * @see elm_toolbar_no_select_mode_get().
13269 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13272 * Set whether the toolbar items' should be selected by the user or not.
13274 * @param obj The toolbar object.
13275 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13276 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13278 * @see elm_toolbar_no_select_mode_set() for details.
13282 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13285 * Append item to the toolbar.
13287 * @param obj The toolbar object.
13288 * @param icon A string with icon name or the absolute path of an image file.
13289 * @param label The label of the item.
13290 * @param func The function to call when the item is clicked.
13291 * @param data The data to associate with the item for related callbacks.
13292 * @return The created item or @c NULL upon failure.
13294 * A new item will be created and appended to the toolbar, i.e., will
13295 * be set as @b last item.
13297 * Items created with this method can be deleted with
13298 * elm_toolbar_item_del().
13300 * Associated @p data can be properly freed when item is deleted if a
13301 * callback function is set with elm_toolbar_item_del_cb_set().
13303 * If a function is passed as argument, it will be called everytime this item
13304 * is selected, i.e., the user clicks over an unselected item.
13305 * If such function isn't needed, just passing
13306 * @c NULL as @p func is enough. The same should be done for @p data.
13308 * Toolbar will load icon image from fdo or current theme.
13309 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13310 * If an absolute path is provided it will load it direct from a file.
13312 * @see elm_toolbar_item_icon_set()
13313 * @see elm_toolbar_item_del()
13314 * @see elm_toolbar_item_del_cb_set()
13318 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);
13321 * Prepend item to the toolbar.
13323 * @param obj The toolbar object.
13324 * @param icon A string with icon name or the absolute path of an image file.
13325 * @param label The label of the item.
13326 * @param func The function to call when the item is clicked.
13327 * @param data The data to associate with the item for related callbacks.
13328 * @return The created item or @c NULL upon failure.
13330 * A new item will be created and prepended to the toolbar, i.e., will
13331 * be set as @b first item.
13333 * Items created with this method can be deleted with
13334 * elm_toolbar_item_del().
13336 * Associated @p data can be properly freed when item is deleted if a
13337 * callback function is set with elm_toolbar_item_del_cb_set().
13339 * If a function is passed as argument, it will be called everytime this item
13340 * is selected, i.e., the user clicks over an unselected item.
13341 * If such function isn't needed, just passing
13342 * @c NULL as @p func is enough. The same should be done for @p data.
13344 * Toolbar will load icon image from fdo or current theme.
13345 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13346 * If an absolute path is provided it will load it direct from a file.
13348 * @see elm_toolbar_item_icon_set()
13349 * @see elm_toolbar_item_del()
13350 * @see elm_toolbar_item_del_cb_set()
13354 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);
13357 * Insert a new item into the toolbar object before item @p before.
13359 * @param obj The toolbar object.
13360 * @param before The toolbar item to insert before.
13361 * @param icon A string with icon name or the absolute path of an image file.
13362 * @param label The label of the item.
13363 * @param func The function to call when the item is clicked.
13364 * @param data The data to associate with the item for related callbacks.
13365 * @return The created item or @c NULL upon failure.
13367 * A new item will be created and added to the toolbar. Its position in
13368 * this toolbar will be just before item @p before.
13370 * Items created with this method can be deleted with
13371 * elm_toolbar_item_del().
13373 * Associated @p data can be properly freed when item is deleted if a
13374 * callback function is set with elm_toolbar_item_del_cb_set().
13376 * If a function is passed as argument, it will be called everytime this item
13377 * is selected, i.e., the user clicks over an unselected item.
13378 * If such function isn't needed, just passing
13379 * @c NULL as @p func is enough. The same should be done for @p data.
13381 * Toolbar will load icon image from fdo or current theme.
13382 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13383 * If an absolute path is provided it will load it direct from a file.
13385 * @see elm_toolbar_item_icon_set()
13386 * @see elm_toolbar_item_del()
13387 * @see elm_toolbar_item_del_cb_set()
13391 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);
13394 * Insert a new item into the toolbar object after item @p after.
13396 * @param obj The toolbar object.
13397 * @param before The toolbar item to insert before.
13398 * @param icon A string with icon name or the absolute path of an image file.
13399 * @param label The label of the item.
13400 * @param func The function to call when the item is clicked.
13401 * @param data The data to associate with the item for related callbacks.
13402 * @return The created item or @c NULL upon failure.
13404 * A new item will be created and added to the toolbar. Its position in
13405 * this toolbar will be just after item @p after.
13407 * Items created with this method can be deleted with
13408 * elm_toolbar_item_del().
13410 * Associated @p data can be properly freed when item is deleted if a
13411 * callback function is set with elm_toolbar_item_del_cb_set().
13413 * If a function is passed as argument, it will be called everytime this item
13414 * is selected, i.e., the user clicks over an unselected item.
13415 * If such function isn't needed, just passing
13416 * @c NULL as @p func is enough. The same should be done for @p data.
13418 * Toolbar will load icon image from fdo or current theme.
13419 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13420 * If an absolute path is provided it will load it direct from a file.
13422 * @see elm_toolbar_item_icon_set()
13423 * @see elm_toolbar_item_del()
13424 * @see elm_toolbar_item_del_cb_set()
13428 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);
13431 * Get the first item in the given toolbar widget's list of
13434 * @param obj The toolbar object
13435 * @return The first item or @c NULL, if it has no items (and on
13438 * @see elm_toolbar_item_append()
13439 * @see elm_toolbar_last_item_get()
13443 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13446 * Get the last item in the given toolbar widget's list of
13449 * @param obj The toolbar object
13450 * @return The last item or @c NULL, if it has no items (and on
13453 * @see elm_toolbar_item_prepend()
13454 * @see elm_toolbar_first_item_get()
13458 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13461 * Get the item after @p item in toolbar.
13463 * @param item The toolbar item.
13464 * @return The item after @p item, or @c NULL if none or on failure.
13466 * @note If it is the last item, @c NULL will be returned.
13468 * @see elm_toolbar_item_append()
13472 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13475 * Get the item before @p item in toolbar.
13477 * @param item The toolbar item.
13478 * @return The item before @p item, or @c NULL if none or on failure.
13480 * @note If it is the first item, @c NULL will be returned.
13482 * @see elm_toolbar_item_prepend()
13486 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13489 * Get the toolbar object from an item.
13491 * @param item The item.
13492 * @return The toolbar object.
13494 * This returns the toolbar object itself that an item belongs to.
13498 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13501 * Set the priority of a toolbar item.
13503 * @param item The toolbar item.
13504 * @param priority The item priority. The default is zero.
13506 * This is used only when the toolbar shrink mode is set to
13507 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13508 * When space is less than required, items with low priority
13509 * will be removed from the toolbar and added to a dynamically-created menu,
13510 * while items with higher priority will remain on the toolbar,
13511 * with the same order they were added.
13513 * @see elm_toolbar_item_priority_get()
13517 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13520 * Get the priority of a toolbar item.
13522 * @param item The toolbar item.
13523 * @return The @p item priority, or @c 0 on failure.
13525 * @see elm_toolbar_item_priority_set() for details.
13529 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13532 * Get the label of item.
13534 * @param item The item of toolbar.
13535 * @return The label of item.
13537 * The return value is a pointer to the label associated to @p item when
13538 * it was created, with function elm_toolbar_item_append() or similar,
13540 * with function elm_toolbar_item_label_set. If no label
13541 * was passed as argument, it will return @c NULL.
13543 * @see elm_toolbar_item_label_set() for more details.
13544 * @see elm_toolbar_item_append()
13548 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13551 * Set the label of item.
13553 * @param item The item of toolbar.
13554 * @param text The label of item.
13556 * The label to be displayed by the item.
13557 * Label will be placed at icons bottom (if set).
13559 * If a label was passed as argument on item creation, with function
13560 * elm_toolbar_item_append() or similar, it will be already
13561 * displayed by the item.
13563 * @see elm_toolbar_item_label_get()
13564 * @see elm_toolbar_item_append()
13568 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13571 * Return the data associated with a given toolbar widget item.
13573 * @param item The toolbar widget item handle.
13574 * @return The data associated with @p item.
13576 * @see elm_toolbar_item_data_set()
13580 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13583 * Set the data associated with a given toolbar widget item.
13585 * @param item The toolbar widget item handle.
13586 * @param data The new data pointer to set to @p item.
13588 * This sets new item data on @p item.
13590 * @warning The old data pointer won't be touched by this function, so
13591 * the user had better to free that old data himself/herself.
13595 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13598 * Returns a pointer to a toolbar item by its label.
13600 * @param obj The toolbar object.
13601 * @param label The label of the item to find.
13603 * @return The pointer to the toolbar item matching @p label or @c NULL
13608 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13611 * Get whether the @p item is selected or not.
13613 * @param item The toolbar item.
13614 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13615 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13617 * @see elm_toolbar_selected_item_set() for details.
13618 * @see elm_toolbar_item_selected_get()
13622 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13625 * Set the selected state of an item.
13627 * @param item The toolbar item
13628 * @param selected The selected state
13630 * This sets the selected state of the given item @p it.
13631 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13633 * If a new item is selected the previosly selected will be unselected.
13634 * Previoulsy selected item can be get with function
13635 * elm_toolbar_selected_item_get().
13637 * Selected items will be highlighted.
13639 * @see elm_toolbar_item_selected_get()
13640 * @see elm_toolbar_selected_item_get()
13644 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13647 * Get the selected item.
13649 * @param obj The toolbar object.
13650 * @return The selected toolbar item.
13652 * The selected item can be unselected with function
13653 * elm_toolbar_item_selected_set().
13655 * The selected item always will be highlighted on toolbar.
13657 * @see elm_toolbar_selected_items_get()
13661 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13664 * Set the icon associated with @p item.
13666 * @param obj The parent of this item.
13667 * @param item The toolbar item.
13668 * @param icon A string with icon name or the absolute path of an image file.
13670 * Toolbar will load icon image from fdo or current theme.
13671 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13672 * If an absolute path is provided it will load it direct from a file.
13674 * @see elm_toolbar_icon_order_lookup_set()
13675 * @see elm_toolbar_icon_order_lookup_get()
13679 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13682 * Get the string used to set the icon of @p item.
13684 * @param item The toolbar item.
13685 * @return The string associated with the icon object.
13687 * @see elm_toolbar_item_icon_set() for details.
13691 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13694 * Set the icon associated with @p item to an image in a binary buffer.
13696 * @param item The toolbar item.
13697 * @param img The binary data that will be used as an image
13698 * @param size The size of binary data @p img
13699 * @param format Optional format of @p img to pass to the image loader
13700 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
13702 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
13704 * @note The icon image set by this function can be changed by
13705 * elm_toolbar_item_icon_set().
13709 EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
13712 * Delete them item from the toolbar.
13714 * @param item The item of toolbar to be deleted.
13716 * @see elm_toolbar_item_append()
13717 * @see elm_toolbar_item_del_cb_set()
13721 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13724 * Set the function called when a toolbar item is freed.
13726 * @param item The item to set the callback on.
13727 * @param func The function called.
13729 * If there is a @p func, then it will be called prior item's memory release.
13730 * That will be called with the following arguments:
13732 * @li item's Evas object;
13735 * This way, a data associated to a toolbar item could be properly freed.
13739 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13742 * Get a value whether toolbar item is disabled or not.
13744 * @param item The item.
13745 * @return The disabled state.
13747 * @see elm_toolbar_item_disabled_set() for more details.
13751 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13754 * Sets the disabled/enabled state of a toolbar item.
13756 * @param item The item.
13757 * @param disabled The disabled state.
13759 * A disabled item cannot be selected or unselected. It will also
13760 * change its appearance (generally greyed out). This sets the
13761 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13766 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13769 * Set or unset item as a separator.
13771 * @param item The toolbar item.
13772 * @param setting @c EINA_TRUE to set item @p item as separator or
13773 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13775 * Items aren't set as separator by default.
13777 * If set as separator it will display separator theme, so won't display
13780 * @see elm_toolbar_item_separator_get()
13784 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13787 * Get a value whether item is a separator or not.
13789 * @param item The toolbar item.
13790 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13791 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13793 * @see elm_toolbar_item_separator_set() for details.
13797 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13800 * Set the shrink state of toolbar @p obj.
13802 * @param obj The toolbar object.
13803 * @param shrink_mode Toolbar's items display behavior.
13805 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13806 * but will enforce a minimun size so all the items will fit, won't scroll
13807 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13808 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13809 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13813 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13816 * Get the shrink mode of toolbar @p obj.
13818 * @param obj The toolbar object.
13819 * @return Toolbar's items display behavior.
13821 * @see elm_toolbar_mode_shrink_set() for details.
13825 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13828 * Enable/disable homogenous mode.
13830 * @param obj The toolbar object
13831 * @param homogeneous Assume the items within the toolbar are of the
13832 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13834 * This will enable the homogeneous mode where items are of the same size.
13835 * @see elm_toolbar_homogeneous_get()
13839 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13842 * Get whether the homogenous mode is enabled.
13844 * @param obj The toolbar object.
13845 * @return Assume the items within the toolbar are of the same height
13846 * and width (EINA_TRUE = on, EINA_FALSE = off).
13848 * @see elm_toolbar_homogeneous_set()
13852 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13855 * Enable/disable homogenous mode.
13857 * @param obj The toolbar object
13858 * @param homogeneous Assume the items within the toolbar are of the
13859 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13861 * This will enable the homogeneous mode where items are of the same size.
13862 * @see elm_toolbar_homogeneous_get()
13864 * @deprecated use elm_toolbar_homogeneous_set() instead.
13868 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13871 * Get whether the homogenous mode is enabled.
13873 * @param obj The toolbar object.
13874 * @return Assume the items within the toolbar are of the same height
13875 * and width (EINA_TRUE = on, EINA_FALSE = off).
13877 * @see elm_toolbar_homogeneous_set()
13878 * @deprecated use elm_toolbar_homogeneous_get() instead.
13882 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13885 * Set the parent object of the toolbar items' menus.
13887 * @param obj The toolbar object.
13888 * @param parent The parent of the menu objects.
13890 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13892 * For more details about setting the parent for toolbar menus, see
13893 * elm_menu_parent_set().
13895 * @see elm_menu_parent_set() for details.
13896 * @see elm_toolbar_item_menu_set() for details.
13900 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13903 * Get the parent object of the toolbar items' menus.
13905 * @param obj The toolbar object.
13906 * @return The parent of the menu objects.
13908 * @see elm_toolbar_menu_parent_set() for details.
13912 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13915 * Set the alignment of the items.
13917 * @param obj The toolbar object.
13918 * @param align The new alignment, a float between <tt> 0.0 </tt>
13919 * and <tt> 1.0 </tt>.
13921 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13922 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13925 * Centered items by default.
13927 * @see elm_toolbar_align_get()
13931 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13934 * Get the alignment of the items.
13936 * @param obj The toolbar object.
13937 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13940 * @see elm_toolbar_align_set() for details.
13944 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13947 * Set whether the toolbar item opens a menu.
13949 * @param item The toolbar item.
13950 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13952 * A toolbar item can be set to be a menu, using this function.
13954 * Once it is set to be a menu, it can be manipulated through the
13955 * menu-like function elm_toolbar_menu_parent_set() and the other
13956 * elm_menu functions, using the Evas_Object @c menu returned by
13957 * elm_toolbar_item_menu_get().
13959 * So, items to be displayed in this item's menu should be added with
13960 * elm_menu_item_add().
13962 * The following code exemplifies the most basic usage:
13964 * tb = elm_toolbar_add(win)
13965 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13966 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13967 * elm_toolbar_menu_parent_set(tb, win);
13968 * menu = elm_toolbar_item_menu_get(item);
13969 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13970 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13974 * @see elm_toolbar_item_menu_get()
13978 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13981 * Get toolbar item's menu.
13983 * @param item The toolbar item.
13984 * @return Item's menu object or @c NULL on failure.
13986 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13987 * this function will set it.
13989 * @see elm_toolbar_item_menu_set() for details.
13993 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13996 * Add a new state to @p item.
13998 * @param item The item.
13999 * @param icon A string with icon name or the absolute path of an image file.
14000 * @param label The label of the new state.
14001 * @param func The function to call when the item is clicked when this
14002 * state is selected.
14003 * @param data The data to associate with the state.
14004 * @return The toolbar item state, or @c NULL upon failure.
14006 * Toolbar will load icon image from fdo or current theme.
14007 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14008 * If an absolute path is provided it will load it direct from a file.
14010 * States created with this function can be removed with
14011 * elm_toolbar_item_state_del().
14013 * @see elm_toolbar_item_state_del()
14014 * @see elm_toolbar_item_state_sel()
14015 * @see elm_toolbar_item_state_get()
14019 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);
14022 * Delete a previoulsy added state to @p item.
14024 * @param item The toolbar item.
14025 * @param state The state to be deleted.
14026 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14028 * @see elm_toolbar_item_state_add()
14030 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14033 * Set @p state as the current state of @p it.
14035 * @param it The item.
14036 * @param state The state to use.
14037 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14039 * If @p state is @c NULL, it won't select any state and the default item's
14040 * icon and label will be used. It's the same behaviour than
14041 * elm_toolbar_item_state_unser().
14043 * @see elm_toolbar_item_state_unset()
14047 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14050 * Unset the state of @p it.
14052 * @param it The item.
14054 * The default icon and label from this item will be displayed.
14056 * @see elm_toolbar_item_state_set() for more details.
14060 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14063 * Get the current state of @p it.
14065 * @param item The item.
14066 * @return The selected state or @c NULL if none is selected or on failure.
14068 * @see elm_toolbar_item_state_set() for details.
14069 * @see elm_toolbar_item_state_unset()
14070 * @see elm_toolbar_item_state_add()
14074 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14077 * Get the state after selected state in toolbar's @p item.
14079 * @param it The toolbar item to change state.
14080 * @return The state after current state, or @c NULL on failure.
14082 * If last state is selected, this function will return first state.
14084 * @see elm_toolbar_item_state_set()
14085 * @see elm_toolbar_item_state_add()
14089 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14092 * Get the state before selected state in toolbar's @p item.
14094 * @param it The toolbar item to change state.
14095 * @return The state before current state, or @c NULL on failure.
14097 * If first state is selected, this function will return last state.
14099 * @see elm_toolbar_item_state_set()
14100 * @see elm_toolbar_item_state_add()
14104 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14107 * Set the text to be shown in a given toolbar item's tooltips.
14109 * @param item Target item.
14110 * @param text The text to set in the content.
14112 * Setup the text as tooltip to object. The item can have only one tooltip,
14113 * so any previous tooltip data - set with this function or
14114 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14116 * @see elm_object_tooltip_text_set() for more details.
14120 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14123 * Set the content to be shown in the tooltip item.
14125 * Setup the tooltip to item. The item can have only one tooltip,
14126 * so any previous tooltip data is removed. @p func(with @p data) will
14127 * be called every time that need show the tooltip and it should
14128 * return a valid Evas_Object. This object is then managed fully by
14129 * tooltip system and is deleted when the tooltip is gone.
14131 * @param item the toolbar item being attached a tooltip.
14132 * @param func the function used to create the tooltip contents.
14133 * @param data what to provide to @a func as callback data/context.
14134 * @param del_cb called when data is not needed anymore, either when
14135 * another callback replaces @a func, the tooltip is unset with
14136 * elm_toolbar_item_tooltip_unset() or the owner @a item
14137 * dies. This callback receives as the first parameter the
14138 * given @a data, and @c event_info is the item.
14140 * @see elm_object_tooltip_content_cb_set() for more details.
14144 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);
14147 * Unset tooltip from item.
14149 * @param item toolbar item to remove previously set tooltip.
14151 * Remove tooltip from item. The callback provided as del_cb to
14152 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14153 * it is not used anymore.
14155 * @see elm_object_tooltip_unset() for more details.
14156 * @see elm_toolbar_item_tooltip_content_cb_set()
14160 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14163 * Sets a different style for this item tooltip.
14165 * @note before you set a style you should define a tooltip with
14166 * elm_toolbar_item_tooltip_content_cb_set() or
14167 * elm_toolbar_item_tooltip_text_set()
14169 * @param item toolbar item with tooltip already set.
14170 * @param style the theme style to use (default, transparent, ...)
14172 * @see elm_object_tooltip_style_set() for more details.
14176 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14179 * Get the style for this item tooltip.
14181 * @param item toolbar item with tooltip already set.
14182 * @return style the theme style in use, defaults to "default". If the
14183 * object does not have a tooltip set, then NULL is returned.
14185 * @see elm_object_tooltip_style_get() for more details.
14186 * @see elm_toolbar_item_tooltip_style_set()
14190 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14193 * Set the type of mouse pointer/cursor decoration to be shown,
14194 * when the mouse pointer is over the given toolbar widget item
14196 * @param item toolbar item to customize cursor on
14197 * @param cursor the cursor type's name
14199 * This function works analogously as elm_object_cursor_set(), but
14200 * here the cursor's changing area is restricted to the item's
14201 * area, and not the whole widget's. Note that that item cursors
14202 * have precedence over widget cursors, so that a mouse over an
14203 * item with custom cursor set will always show @b that cursor.
14205 * If this function is called twice for an object, a previously set
14206 * cursor will be unset on the second call.
14208 * @see elm_object_cursor_set()
14209 * @see elm_toolbar_item_cursor_get()
14210 * @see elm_toolbar_item_cursor_unset()
14214 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14217 * Get the type of mouse pointer/cursor decoration set to be shown,
14218 * when the mouse pointer is over the given toolbar widget item
14220 * @param item toolbar item with custom cursor set
14221 * @return the cursor type's name or @c NULL, if no custom cursors
14222 * were set to @p item (and on errors)
14224 * @see elm_object_cursor_get()
14225 * @see elm_toolbar_item_cursor_set()
14226 * @see elm_toolbar_item_cursor_unset()
14230 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14233 * Unset any custom mouse pointer/cursor decoration set to be
14234 * shown, when the mouse pointer is over the given toolbar widget
14235 * item, thus making it show the @b default cursor again.
14237 * @param item a toolbar item
14239 * Use this call to undo any custom settings on this item's cursor
14240 * decoration, bringing it back to defaults (no custom style set).
14242 * @see elm_object_cursor_unset()
14243 * @see elm_toolbar_item_cursor_set()
14247 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14250 * Set a different @b style for a given custom cursor set for a
14253 * @param item toolbar item with custom cursor set
14254 * @param style the <b>theme style</b> to use (e.g. @c "default",
14255 * @c "transparent", etc)
14257 * This function only makes sense when one is using custom mouse
14258 * cursor decorations <b>defined in a theme file</b>, which can have,
14259 * given a cursor name/type, <b>alternate styles</b> on it. It
14260 * works analogously as elm_object_cursor_style_set(), but here
14261 * applyed only to toolbar item objects.
14263 * @warning Before you set a cursor style you should have definen a
14264 * custom cursor previously on the item, with
14265 * elm_toolbar_item_cursor_set()
14267 * @see elm_toolbar_item_cursor_engine_only_set()
14268 * @see elm_toolbar_item_cursor_style_get()
14272 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14275 * Get the current @b style set for a given toolbar item's custom
14278 * @param item toolbar item with custom cursor set.
14279 * @return style the cursor style in use. If the object does not
14280 * have a cursor set, then @c NULL is returned.
14282 * @see elm_toolbar_item_cursor_style_set() for more details
14286 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14289 * Set if the (custom)cursor for a given toolbar item should be
14290 * searched in its theme, also, or should only rely on the
14291 * rendering engine.
14293 * @param item item with custom (custom) cursor already set on
14294 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14295 * only on those provided by the rendering engine, @c EINA_FALSE to
14296 * have them searched on the widget's theme, as well.
14298 * @note This call is of use only if you've set a custom cursor
14299 * for toolbar items, with elm_toolbar_item_cursor_set().
14301 * @note By default, cursors will only be looked for between those
14302 * provided by the rendering engine.
14306 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14309 * Get if the (custom) cursor for a given toolbar item is being
14310 * searched in its theme, also, or is only relying on the rendering
14313 * @param item a toolbar item
14314 * @return @c EINA_TRUE, if cursors are being looked for only on
14315 * those provided by the rendering engine, @c EINA_FALSE if they
14316 * are being searched on the widget's theme, as well.
14318 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14322 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14325 * Change a toolbar's orientation
14326 * @param obj The toolbar object
14327 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14328 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14331 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14334 * Get a toolbar's orientation
14335 * @param obj The toolbar object
14336 * @return If @c EINA_TRUE, the toolbar is vertical
14337 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14340 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14347 * @defgroup Tooltips Tooltips
14349 * The Tooltip is an (internal, for now) smart object used to show a
14350 * content in a frame on mouse hover of objects(or widgets), with
14351 * tips/information about them.
14356 EAPI double elm_tooltip_delay_get(void);
14357 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14358 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14359 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14360 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14361 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);
14362 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14363 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14364 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14365 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14366 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14373 * @defgroup Cursors Cursors
14375 * The Elementary cursor is an internal smart object used to
14376 * customize the mouse cursor displayed over objects (or
14377 * widgets). In the most common scenario, the cursor decoration
14378 * comes from the graphical @b engine Elementary is running
14379 * on. Those engines may provide different decorations for cursors,
14380 * and Elementary provides functions to choose them (think of X11
14381 * cursors, as an example).
14383 * There's also the possibility of, besides using engine provided
14384 * cursors, also use ones coming from Edje theming files. Both
14385 * globally and per widget, Elementary makes it possible for one to
14386 * make the cursors lookup to be held on engines only or on
14387 * Elementary's theme file, too.
14393 * Set the cursor to be shown when mouse is over the object
14395 * Set the cursor that will be displayed when mouse is over the
14396 * object. The object can have only one cursor set to it, so if
14397 * this function is called twice for an object, the previous set
14399 * If using X cursors, a definition of all the valid cursor names
14400 * is listed on Elementary_Cursors.h. If an invalid name is set
14401 * the default cursor will be used.
14403 * @param obj the object being set a cursor.
14404 * @param cursor the cursor name to be used.
14408 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14411 * Get the cursor to be shown when mouse is over the object
14413 * @param obj an object with cursor already set.
14414 * @return the cursor name.
14418 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14421 * Unset cursor for object
14423 * Unset cursor for object, and set the cursor to default if the mouse
14424 * was over this object.
14426 * @param obj Target object
14427 * @see elm_object_cursor_set()
14431 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14434 * Sets a different style for this object cursor.
14436 * @note before you set a style you should define a cursor with
14437 * elm_object_cursor_set()
14439 * @param obj an object with cursor already set.
14440 * @param style the theme style to use (default, transparent, ...)
14444 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14447 * Get the style for this object cursor.
14449 * @param obj an object with cursor already set.
14450 * @return style the theme style in use, defaults to "default". If the
14451 * object does not have a cursor set, then NULL is returned.
14455 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14458 * Set if the cursor set should be searched on the theme or should use
14459 * the provided by the engine, only.
14461 * @note before you set if should look on theme you should define a cursor
14462 * with elm_object_cursor_set(). By default it will only look for cursors
14463 * provided by the engine.
14465 * @param obj an object with cursor already set.
14466 * @param engine_only boolean to define it cursors should be looked only
14467 * between the provided by the engine or searched on widget's theme as well.
14471 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14474 * Get the cursor engine only usage for this object cursor.
14476 * @param obj an object with cursor already set.
14477 * @return engine_only boolean to define it cursors should be
14478 * looked only between the provided by the engine or searched on
14479 * widget's theme as well. If the object does not have a cursor
14480 * set, then EINA_FALSE is returned.
14484 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14487 * Get the configured cursor engine only usage
14489 * This gets the globally configured exclusive usage of engine cursors.
14491 * @return 1 if only engine cursors should be used
14494 EAPI int elm_cursor_engine_only_get(void);
14497 * Set the configured cursor engine only usage
14499 * This sets the globally configured exclusive usage of engine cursors.
14500 * It won't affect cursors set before changing this value.
14502 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14503 * look for them on theme before.
14504 * @return EINA_TRUE if value is valid and setted (0 or 1)
14507 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14514 * @defgroup Menu Menu
14516 * @image html img/widget/menu/preview-00.png
14517 * @image latex img/widget/menu/preview-00.eps
14519 * A menu is a list of items displayed above its parent. When the menu is
14520 * showing its parent is darkened. Each item can have a sub-menu. The menu
14521 * object can be used to display a menu on a right click event, in a toolbar,
14524 * Signals that you can add callbacks for are:
14525 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14526 * event_info is NULL.
14528 * @see @ref tutorial_menu
14531 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14533 * @brief Add a new menu to the parent
14535 * @param parent The parent object.
14536 * @return The new object or NULL if it cannot be created.
14538 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14540 * @brief Set the parent for the given menu widget
14542 * @param obj The menu object.
14543 * @param parent The new parent.
14545 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14547 * @brief Get the parent for the given menu widget
14549 * @param obj The menu object.
14550 * @return The parent.
14552 * @see elm_menu_parent_set()
14554 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14556 * @brief Move the menu to a new position
14558 * @param obj The menu object.
14559 * @param x The new position.
14560 * @param y The new position.
14562 * Sets the top-left position of the menu to (@p x,@p y).
14564 * @note @p x and @p y coordinates are relative to parent.
14566 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14568 * @brief Close a opened menu
14570 * @param obj the menu object
14573 * Hides the menu and all it's sub-menus.
14575 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14577 * @brief Returns a list of @p item's items.
14579 * @param obj The menu object
14580 * @return An Eina_List* of @p item's items
14582 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14584 * @brief Get the Evas_Object of an Elm_Menu_Item
14586 * @param item The menu item object.
14587 * @return The edje object containing the swallowed content
14589 * @warning Don't manipulate this object!
14591 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14593 * @brief Add an item at the end of the given menu widget
14595 * @param obj The menu object.
14596 * @param parent The parent menu item (optional)
14597 * @param icon A icon display on the item. The icon will be destryed by the menu.
14598 * @param label The label of the item.
14599 * @param func Function called when the user select the item.
14600 * @param data Data sent by the callback.
14601 * @return Returns the new item.
14603 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);
14605 * @brief Add an object swallowed in an item at the end of the given menu
14608 * @param obj The menu object.
14609 * @param parent The parent menu item (optional)
14610 * @param subobj The object to swallow
14611 * @param func Function called when the user select the item.
14612 * @param data Data sent by the callback.
14613 * @return Returns the new item.
14615 * Add an evas object as an item to the menu.
14617 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);
14619 * @brief Set the label of a menu item
14621 * @param item The menu item object.
14622 * @param label The label to set for @p item
14624 * @warning Don't use this funcion on items created with
14625 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14627 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14629 * @brief Get the label of a menu item
14631 * @param item The menu item object.
14632 * @return The label of @p item
14634 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14636 * @brief Set the icon of a menu item to the standard icon with name @p icon
14638 * @param item The menu item object.
14639 * @param icon The icon object to set for the content of @p item
14641 * Once this icon is set, any previously set icon will be deleted.
14643 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14645 * @brief Get the string representation from the icon of a menu item
14647 * @param item The menu item object.
14648 * @return The string representation of @p item's icon or NULL
14650 * @see elm_menu_item_object_icon_name_set()
14652 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14654 * @brief Set the content object of a menu item
14656 * @param item The menu item object
14657 * @param The content object or NULL
14658 * @return EINA_TRUE on success, else EINA_FALSE
14660 * Use this function to change the object swallowed by a menu item, deleting
14661 * any previously swallowed object.
14663 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14665 * @brief Get the content object of a menu item
14667 * @param item The menu item object
14668 * @return The content object or NULL
14669 * @note If @p item was added with elm_menu_item_add_object, this
14670 * function will return the object passed, else it will return the
14673 * @see elm_menu_item_object_content_set()
14675 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14677 * @brief Set the selected state of @p item.
14679 * @param item The menu item object.
14680 * @param selected The selected/unselected state of the item
14682 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14684 * @brief Get the selected state of @p item.
14686 * @param item The menu item object.
14687 * @return The selected/unselected state of the item
14689 * @see elm_menu_item_selected_set()
14691 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14693 * @brief Set the disabled state of @p item.
14695 * @param item The menu item object.
14696 * @param disabled The enabled/disabled state of the item
14698 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14700 * @brief Get the disabled state of @p item.
14702 * @param item The menu item object.
14703 * @return The enabled/disabled state of the item
14705 * @see elm_menu_item_disabled_set()
14707 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14709 * @brief Add a separator item to menu @p obj under @p parent.
14711 * @param obj The menu object
14712 * @param parent The item to add the separator under
14713 * @return The created item or NULL on failure
14715 * This is item is a @ref Separator.
14717 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14719 * @brief Returns whether @p item is a separator.
14721 * @param item The item to check
14722 * @return If true, @p item is a separator
14724 * @see elm_menu_item_separator_add()
14726 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14728 * @brief Deletes an item from the menu.
14730 * @param item The item to delete.
14732 * @see elm_menu_item_add()
14734 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14736 * @brief Set the function called when a menu item is deleted.
14738 * @param item The item to set the callback on
14739 * @param func The function called
14741 * @see elm_menu_item_add()
14742 * @see elm_menu_item_del()
14744 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14746 * @brief Returns the data associated with menu item @p item.
14748 * @param item The item
14749 * @return The data associated with @p item or NULL if none was set.
14751 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14753 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14755 * @brief Sets the data to be associated with menu item @p item.
14757 * @param item The item
14758 * @param data The data to be associated with @p item
14760 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14762 * @brief Returns a list of @p item's subitems.
14764 * @param item The item
14765 * @return An Eina_List* of @p item's subitems
14767 * @see elm_menu_add()
14769 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14771 * @brief Get the position of a menu item
14773 * @param item The menu item
14774 * @return The item's index
14776 * This function returns the index position of a menu item in a menu.
14777 * For a sub-menu, this number is relative to the first item in the sub-menu.
14779 * @note Index values begin with 0
14781 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14783 * @brief @brief Return a menu item's owner menu
14785 * @param item The menu item
14786 * @return The menu object owning @p item, or NULL on failure
14788 * Use this function to get the menu object owning an item.
14790 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14792 * @brief Get the selected item in the menu
14794 * @param obj The menu object
14795 * @return The selected item, or NULL if none
14797 * @see elm_menu_item_selected_get()
14798 * @see elm_menu_item_selected_set()
14800 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14802 * @brief Get the last item in the menu
14804 * @param obj The menu object
14805 * @return The last item, or NULL if none
14807 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14809 * @brief Get the first item in the menu
14811 * @param obj The menu object
14812 * @return The first item, or NULL if none
14814 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14816 * @brief Get the next item in the menu.
14818 * @param item The menu item object.
14819 * @return The item after it, or NULL if none
14821 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14823 * @brief Get the previous item in the menu.
14825 * @param item The menu item object.
14826 * @return The item before it, or NULL if none
14828 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14834 * @defgroup List List
14835 * @ingroup Elementary
14837 * @image html img/widget/list/preview-00.png
14838 * @image latex img/widget/list/preview-00.eps width=\textwidth
14840 * @image html img/list.png
14841 * @image latex img/list.eps width=\textwidth
14843 * A list widget is a container whose children are displayed vertically or
14844 * horizontally, in order, and can be selected.
14845 * The list can accept only one or multiple items selection. Also has many
14846 * modes of items displaying.
14848 * A list is a very simple type of list widget. For more robust
14849 * lists, @ref Genlist should probably be used.
14851 * Smart callbacks one can listen to:
14852 * - @c "activated" - The user has double-clicked or pressed
14853 * (enter|return|spacebar) on an item. The @c event_info parameter
14854 * is the item that was activated.
14855 * - @c "clicked,double" - The user has double-clicked an item.
14856 * The @c event_info parameter is the item that was double-clicked.
14857 * - "selected" - when the user selected an item
14858 * - "unselected" - when the user unselected an item
14859 * - "longpressed" - an item in the list is long-pressed
14860 * - "scroll,edge,top" - the list is scrolled until the top edge
14861 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14862 * - "scroll,edge,left" - the list is scrolled until the left edge
14863 * - "scroll,edge,right" - the list is scrolled until the right edge
14865 * Available styles for it:
14868 * List of examples:
14869 * @li @ref list_example_01
14870 * @li @ref list_example_02
14871 * @li @ref list_example_03
14880 * @enum _Elm_List_Mode
14881 * @typedef Elm_List_Mode
14883 * Set list's resize behavior, transverse axis scroll and
14884 * items cropping. See each mode's description for more details.
14886 * @note Default value is #ELM_LIST_SCROLL.
14888 * Values <b> don't </b> work as bitmask, only one can be choosen.
14890 * @see elm_list_mode_set()
14891 * @see elm_list_mode_get()
14895 typedef enum _Elm_List_Mode
14897 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. */
14898 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). */
14899 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. */
14900 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. */
14901 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14904 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(). */
14907 * Add a new list widget to the given parent Elementary
14908 * (container) object.
14910 * @param parent The parent object.
14911 * @return a new list widget handle or @c NULL, on errors.
14913 * This function inserts a new list widget on the canvas.
14917 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14922 * @param obj The list object
14924 * @note Call before running show() on the list object.
14925 * @warning If not called, it won't display the list properly.
14928 * li = elm_list_add(win);
14929 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14930 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14932 * evas_object_show(li);
14937 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14940 * Enable or disable multiple items selection on the list object.
14942 * @param obj The list object
14943 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14946 * Disabled by default. If disabled, the user can select a single item of
14947 * the list each time. Selected items are highlighted on list.
14948 * If enabled, many items can be selected.
14950 * If a selected item is selected again, it will be unselected.
14952 * @see elm_list_multi_select_get()
14956 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14959 * Get a value whether multiple items selection is enabled or not.
14961 * @see elm_list_multi_select_set() for details.
14963 * @param obj The list object.
14964 * @return @c EINA_TRUE means multiple items selection is enabled.
14965 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14966 * @c EINA_FALSE is returned.
14970 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14973 * Set which mode to use for the list object.
14975 * @param obj The list object
14976 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14977 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14979 * Set list's resize behavior, transverse axis scroll and
14980 * items cropping. See each mode's description for more details.
14982 * @note Default value is #ELM_LIST_SCROLL.
14984 * Only one can be set, if a previous one was set, it will be changed
14985 * by the new mode set. Bitmask won't work as well.
14987 * @see elm_list_mode_get()
14991 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14994 * Get the mode the list is at.
14996 * @param obj The list object
14997 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14998 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15000 * @note see elm_list_mode_set() for more information.
15004 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15007 * Enable or disable horizontal mode on the list object.
15009 * @param obj The list object.
15010 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15011 * disable it, i.e., to enable vertical mode.
15013 * @note Vertical mode is set by default.
15015 * On horizontal mode items are displayed on list from left to right,
15016 * instead of from top to bottom. Also, the list will scroll horizontally.
15017 * Each item will presents left icon on top and right icon, or end, at
15020 * @see elm_list_horizontal_get()
15024 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15027 * Get a value whether horizontal mode is enabled or not.
15029 * @param obj The list object.
15030 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15031 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15032 * @c EINA_FALSE is returned.
15034 * @see elm_list_horizontal_set() for details.
15038 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15041 * Enable or disable always select mode on the list object.
15043 * @param obj The list object
15044 * @param always_select @c EINA_TRUE to enable always select mode or
15045 * @c EINA_FALSE to disable it.
15047 * @note Always select mode is disabled by default.
15049 * Default behavior of list items is to only call its callback function
15050 * the first time it's pressed, i.e., when it is selected. If a selected
15051 * item is pressed again, and multi-select is disabled, it won't call
15052 * this function (if multi-select is enabled it will unselect the item).
15054 * If always select is enabled, it will call the callback function
15055 * everytime a item is pressed, so it will call when the item is selected,
15056 * and again when a selected item is pressed.
15058 * @see elm_list_always_select_mode_get()
15059 * @see elm_list_multi_select_set()
15063 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15066 * Get a value whether always select mode is enabled or not, meaning that
15067 * an item will always call its callback function, even if already selected.
15069 * @param obj The list object
15070 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15071 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15072 * @c EINA_FALSE is returned.
15074 * @see elm_list_always_select_mode_set() for details.
15078 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15081 * Set bouncing behaviour when the scrolled content reaches an edge.
15083 * Tell the internal scroller object whether it should bounce or not
15084 * when it reaches the respective edges for each axis.
15086 * @param obj The list object
15087 * @param h_bounce Whether to bounce or not in the horizontal axis.
15088 * @param v_bounce Whether to bounce or not in the vertical axis.
15090 * @see elm_scroller_bounce_set()
15094 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15097 * Get the bouncing behaviour of the internal scroller.
15099 * Get whether the internal scroller should bounce when the edge of each
15100 * axis is reached scrolling.
15102 * @param obj The list object.
15103 * @param h_bounce Pointer where to store the bounce state of the horizontal
15105 * @param v_bounce Pointer where to store the bounce state of the vertical
15108 * @see elm_scroller_bounce_get()
15109 * @see elm_list_bounce_set()
15113 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15116 * Set the scrollbar policy.
15118 * @param obj The list object
15119 * @param policy_h Horizontal scrollbar policy.
15120 * @param policy_v Vertical scrollbar policy.
15122 * This sets the scrollbar visibility policy for the given scroller.
15123 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15124 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15125 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15126 * This applies respectively for the horizontal and vertical scrollbars.
15128 * The both are disabled by default, i.e., are set to
15129 * #ELM_SCROLLER_POLICY_OFF.
15133 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15136 * Get the scrollbar policy.
15138 * @see elm_list_scroller_policy_get() for details.
15140 * @param obj The list object.
15141 * @param policy_h Pointer where to store horizontal scrollbar policy.
15142 * @param policy_v Pointer where to store vertical scrollbar policy.
15146 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);
15149 * Append a new item to the list object.
15151 * @param obj The list object.
15152 * @param label The label of the list item.
15153 * @param icon The icon object to use for the left side of the item. An
15154 * icon can be any Evas object, but usually it is an icon created
15155 * with elm_icon_add().
15156 * @param end The icon object to use for the right side of the item. An
15157 * icon can be any Evas object.
15158 * @param func The function to call when the item is clicked.
15159 * @param data The data to associate with the item for related callbacks.
15161 * @return The created item or @c NULL upon failure.
15163 * A new item will be created and appended to the list, i.e., will
15164 * be set as @b last item.
15166 * Items created with this method can be deleted with
15167 * elm_list_item_del().
15169 * Associated @p data can be properly freed when item is deleted if a
15170 * callback function is set with elm_list_item_del_cb_set().
15172 * If a function is passed as argument, it will be called everytime this item
15173 * is selected, i.e., the user clicks over an unselected item.
15174 * If always select is enabled it will call this function every time
15175 * user clicks over an item (already selected or not).
15176 * If such function isn't needed, just passing
15177 * @c NULL as @p func is enough. The same should be done for @p data.
15179 * Simple example (with no function callback or data associated):
15181 * li = elm_list_add(win);
15182 * ic = elm_icon_add(win);
15183 * elm_icon_file_set(ic, "path/to/image", NULL);
15184 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15185 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15187 * evas_object_show(li);
15190 * @see elm_list_always_select_mode_set()
15191 * @see elm_list_item_del()
15192 * @see elm_list_item_del_cb_set()
15193 * @see elm_list_clear()
15194 * @see elm_icon_add()
15198 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);
15201 * Prepend a new item to the list object.
15203 * @param obj The list object.
15204 * @param label The label of the list item.
15205 * @param icon The icon object to use for the left side of the item. An
15206 * icon can be any Evas object, but usually it is an icon created
15207 * with elm_icon_add().
15208 * @param end The icon object to use for the right side of the item. An
15209 * icon can be any Evas object.
15210 * @param func The function to call when the item is clicked.
15211 * @param data The data to associate with the item for related callbacks.
15213 * @return The created item or @c NULL upon failure.
15215 * A new item will be created and prepended to the list, i.e., will
15216 * be set as @b first item.
15218 * Items created with this method can be deleted with
15219 * elm_list_item_del().
15221 * Associated @p data can be properly freed when item is deleted if a
15222 * callback function is set with elm_list_item_del_cb_set().
15224 * If a function is passed as argument, it will be called everytime this item
15225 * is selected, i.e., the user clicks over an unselected item.
15226 * If always select is enabled it will call this function every time
15227 * user clicks over an item (already selected or not).
15228 * If such function isn't needed, just passing
15229 * @c NULL as @p func is enough. The same should be done for @p data.
15231 * @see elm_list_item_append() for a simple code example.
15232 * @see elm_list_always_select_mode_set()
15233 * @see elm_list_item_del()
15234 * @see elm_list_item_del_cb_set()
15235 * @see elm_list_clear()
15236 * @see elm_icon_add()
15240 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);
15243 * Insert a new item into the list object before item @p before.
15245 * @param obj The list object.
15246 * @param before The list item to insert before.
15247 * @param label The label of the list item.
15248 * @param icon The icon object to use for the left side of the item. An
15249 * icon can be any Evas object, but usually it is an icon created
15250 * with elm_icon_add().
15251 * @param end The icon object to use for the right side of the item. An
15252 * icon can be any Evas object.
15253 * @param func The function to call when the item is clicked.
15254 * @param data The data to associate with the item for related callbacks.
15256 * @return The created item or @c NULL upon failure.
15258 * A new item will be created and added to the list. Its position in
15259 * this list will be just before item @p before.
15261 * Items created with this method can be deleted with
15262 * elm_list_item_del().
15264 * Associated @p data can be properly freed when item is deleted if a
15265 * callback function is set with elm_list_item_del_cb_set().
15267 * If a function is passed as argument, it will be called everytime this item
15268 * is selected, i.e., the user clicks over an unselected item.
15269 * If always select is enabled it will call this function every time
15270 * user clicks over an item (already selected or not).
15271 * If such function isn't needed, just passing
15272 * @c NULL as @p func is enough. The same should be done for @p data.
15274 * @see elm_list_item_append() for a simple code example.
15275 * @see elm_list_always_select_mode_set()
15276 * @see elm_list_item_del()
15277 * @see elm_list_item_del_cb_set()
15278 * @see elm_list_clear()
15279 * @see elm_icon_add()
15283 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);
15286 * Insert a new item into the list object after item @p after.
15288 * @param obj The list object.
15289 * @param after The list item to insert after.
15290 * @param label The label of the list item.
15291 * @param icon The icon object to use for the left side of the item. An
15292 * icon can be any Evas object, but usually it is an icon created
15293 * with elm_icon_add().
15294 * @param end The icon object to use for the right side of the item. An
15295 * icon can be any Evas object.
15296 * @param func The function to call when the item is clicked.
15297 * @param data The data to associate with the item for related callbacks.
15299 * @return The created item or @c NULL upon failure.
15301 * A new item will be created and added to the list. Its position in
15302 * this list will be just after item @p after.
15304 * Items created with this method can be deleted with
15305 * elm_list_item_del().
15307 * Associated @p data can be properly freed when item is deleted if a
15308 * callback function is set with elm_list_item_del_cb_set().
15310 * If a function is passed as argument, it will be called everytime this item
15311 * is selected, i.e., the user clicks over an unselected item.
15312 * If always select is enabled it will call this function every time
15313 * user clicks over an item (already selected or not).
15314 * If such function isn't needed, just passing
15315 * @c NULL as @p func is enough. The same should be done for @p data.
15317 * @see elm_list_item_append() for a simple code example.
15318 * @see elm_list_always_select_mode_set()
15319 * @see elm_list_item_del()
15320 * @see elm_list_item_del_cb_set()
15321 * @see elm_list_clear()
15322 * @see elm_icon_add()
15326 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);
15329 * Insert a new item into the sorted list object.
15331 * @param obj The list object.
15332 * @param label The label of the list item.
15333 * @param icon The icon object to use for the left side of the item. An
15334 * icon can be any Evas object, but usually it is an icon created
15335 * with elm_icon_add().
15336 * @param end The icon object to use for the right side of the item. An
15337 * icon can be any Evas object.
15338 * @param func The function to call when the item is clicked.
15339 * @param data The data to associate with the item for related callbacks.
15340 * @param cmp_func The comparing function to be used to sort list
15341 * items <b>by #Elm_List_Item item handles</b>. This function will
15342 * receive two items and compare them, returning a non-negative integer
15343 * if the second item should be place after the first, or negative value
15344 * if should be placed before.
15346 * @return The created item or @c NULL upon failure.
15348 * @note This function inserts values into a list object assuming it was
15349 * sorted and the result will be sorted.
15351 * A new item will be created and added to the list. Its position in
15352 * this list will be found comparing the new item with previously inserted
15353 * items using function @p cmp_func.
15355 * Items created with this method can be deleted with
15356 * elm_list_item_del().
15358 * Associated @p data can be properly freed when item is deleted if a
15359 * callback function is set with elm_list_item_del_cb_set().
15361 * If a function is passed as argument, it will be called everytime this item
15362 * is selected, i.e., the user clicks over an unselected item.
15363 * If always select is enabled it will call this function every time
15364 * user clicks over an item (already selected or not).
15365 * If such function isn't needed, just passing
15366 * @c NULL as @p func is enough. The same should be done for @p data.
15368 * @see elm_list_item_append() for a simple code example.
15369 * @see elm_list_always_select_mode_set()
15370 * @see elm_list_item_del()
15371 * @see elm_list_item_del_cb_set()
15372 * @see elm_list_clear()
15373 * @see elm_icon_add()
15377 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);
15380 * Remove all list's items.
15382 * @param obj The list object
15384 * @see elm_list_item_del()
15385 * @see elm_list_item_append()
15389 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15392 * Get a list of all the list items.
15394 * @param obj The list object
15395 * @return An @c Eina_List of list items, #Elm_List_Item,
15396 * or @c NULL on failure.
15398 * @see elm_list_item_append()
15399 * @see elm_list_item_del()
15400 * @see elm_list_clear()
15404 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15407 * Get the selected item.
15409 * @param obj The list object.
15410 * @return The selected list item.
15412 * The selected item can be unselected with function
15413 * elm_list_item_selected_set().
15415 * The selected item always will be highlighted on list.
15417 * @see elm_list_selected_items_get()
15421 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15424 * Return a list of the currently selected list items.
15426 * @param obj The list object.
15427 * @return An @c Eina_List of list items, #Elm_List_Item,
15428 * or @c NULL on failure.
15430 * Multiple items can be selected if multi select is enabled. It can be
15431 * done with elm_list_multi_select_set().
15433 * @see elm_list_selected_item_get()
15434 * @see elm_list_multi_select_set()
15438 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15441 * Set the selected state of an item.
15443 * @param item The list item
15444 * @param selected The selected state
15446 * This sets the selected state of the given item @p it.
15447 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15449 * If a new item is selected the previosly selected will be unselected,
15450 * unless multiple selection is enabled with elm_list_multi_select_set().
15451 * Previoulsy selected item can be get with function
15452 * elm_list_selected_item_get().
15454 * Selected items will be highlighted.
15456 * @see elm_list_item_selected_get()
15457 * @see elm_list_selected_item_get()
15458 * @see elm_list_multi_select_set()
15462 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15465 * Get whether the @p item is selected or not.
15467 * @param item The list item.
15468 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15469 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15471 * @see elm_list_selected_item_set() for details.
15472 * @see elm_list_item_selected_get()
15476 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15479 * Set or unset item as a separator.
15481 * @param it The list item.
15482 * @param setting @c EINA_TRUE to set item @p it as separator or
15483 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15485 * Items aren't set as separator by default.
15487 * If set as separator it will display separator theme, so won't display
15490 * @see elm_list_item_separator_get()
15494 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15497 * Get a value whether item is a separator or not.
15499 * @see elm_list_item_separator_set() for details.
15501 * @param it The list item.
15502 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15503 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15507 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15510 * Show @p item in the list view.
15512 * @param item The list item to be shown.
15514 * It won't animate list until item is visible. If such behavior is wanted,
15515 * use elm_list_bring_in() intead.
15519 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15522 * Bring in the given item to list view.
15524 * @param item The item.
15526 * This causes list to jump to the given item @p item and show it
15527 * (by scrolling), if it is not fully visible.
15529 * This may use animation to do so and take a period of time.
15531 * If animation isn't wanted, elm_list_item_show() can be used.
15535 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15538 * Delete them item from the list.
15540 * @param item The item of list to be deleted.
15542 * If deleting all list items is required, elm_list_clear()
15543 * should be used instead of getting items list and deleting each one.
15545 * @see elm_list_clear()
15546 * @see elm_list_item_append()
15547 * @see elm_list_item_del_cb_set()
15551 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15554 * Set the function called when a list item is freed.
15556 * @param item The item to set the callback on
15557 * @param func The function called
15559 * If there is a @p func, then it will be called prior item's memory release.
15560 * That will be called with the following arguments:
15562 * @li item's Evas object;
15565 * This way, a data associated to a list item could be properly freed.
15569 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15572 * Get the data associated to the item.
15574 * @param item The list item
15575 * @return The data associated to @p item
15577 * The return value is a pointer to data associated to @p item when it was
15578 * created, with function elm_list_item_append() or similar. If no data
15579 * was passed as argument, it will return @c NULL.
15581 * @see elm_list_item_append()
15585 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15588 * Get the left side icon associated to the item.
15590 * @param item The list item
15591 * @return The left side icon associated to @p item
15593 * The return value is a pointer to the icon associated to @p item when
15595 * created, with function elm_list_item_append() or similar, or later
15596 * with function elm_list_item_icon_set(). If no icon
15597 * was passed as argument, it will return @c NULL.
15599 * @see elm_list_item_append()
15600 * @see elm_list_item_icon_set()
15604 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15607 * Set the left side icon associated to the item.
15609 * @param item The list item
15610 * @param icon The left side icon object to associate with @p item
15612 * The icon object to use at left side of the item. An
15613 * icon can be any Evas object, but usually it is an icon created
15614 * with elm_icon_add().
15616 * Once the icon object is set, a previously set one will be deleted.
15617 * @warning Setting the same icon for two items will cause the icon to
15618 * dissapear from the first item.
15620 * If an icon was passed as argument on item creation, with function
15621 * elm_list_item_append() or similar, it will be already
15622 * associated to the item.
15624 * @see elm_list_item_append()
15625 * @see elm_list_item_icon_get()
15629 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15632 * Get the right side icon associated to the item.
15634 * @param item The list item
15635 * @return The right side icon associated to @p item
15637 * The return value is a pointer to the icon associated to @p item when
15639 * created, with function elm_list_item_append() or similar, or later
15640 * with function elm_list_item_icon_set(). If no icon
15641 * was passed as argument, it will return @c NULL.
15643 * @see elm_list_item_append()
15644 * @see elm_list_item_icon_set()
15648 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15651 * Set the right side icon associated to the item.
15653 * @param item The list item
15654 * @param end The right side icon object to associate with @p item
15656 * The icon object to use at right side of the item. An
15657 * icon can be any Evas object, but usually it is an icon created
15658 * with elm_icon_add().
15660 * Once the icon object is set, a previously set one will be deleted.
15661 * @warning Setting the same icon for two items will cause the icon to
15662 * dissapear from the first item.
15664 * If an icon was passed as argument on item creation, with function
15665 * elm_list_item_append() or similar, it will be already
15666 * associated to the item.
15668 * @see elm_list_item_append()
15669 * @see elm_list_item_end_get()
15673 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15676 * Gets the base object of the item.
15678 * @param item The list item
15679 * @return The base object associated with @p item
15681 * Base object is the @c Evas_Object that represents that item.
15685 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15686 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15689 * Get the label of item.
15691 * @param item The item of list.
15692 * @return The label of item.
15694 * The return value is a pointer to the label associated to @p item when
15695 * it was created, with function elm_list_item_append(), or later
15696 * with function elm_list_item_label_set. If no label
15697 * was passed as argument, it will return @c NULL.
15699 * @see elm_list_item_label_set() for more details.
15700 * @see elm_list_item_append()
15704 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15707 * Set the label of item.
15709 * @param item The item of list.
15710 * @param text The label of item.
15712 * The label to be displayed by the item.
15713 * Label will be placed between left and right side icons (if set).
15715 * If a label was passed as argument on item creation, with function
15716 * elm_list_item_append() or similar, it will be already
15717 * displayed by the item.
15719 * @see elm_list_item_label_get()
15720 * @see elm_list_item_append()
15724 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15728 * Get the item before @p it in list.
15730 * @param it The list item.
15731 * @return The item before @p it, or @c NULL if none or on failure.
15733 * @note If it is the first item, @c NULL will be returned.
15735 * @see elm_list_item_append()
15736 * @see elm_list_items_get()
15740 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15743 * Get the item after @p it in list.
15745 * @param it The list item.
15746 * @return The item after @p it, or @c NULL if none or on failure.
15748 * @note If it is the last item, @c NULL will be returned.
15750 * @see elm_list_item_append()
15751 * @see elm_list_items_get()
15755 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15758 * Sets the disabled/enabled state of a list item.
15760 * @param it The item.
15761 * @param disabled The disabled state.
15763 * A disabled item cannot be selected or unselected. It will also
15764 * change its appearance (generally greyed out). This sets the
15765 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15770 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15773 * Get a value whether list item is disabled or not.
15775 * @param it The item.
15776 * @return The disabled state.
15778 * @see elm_list_item_disabled_set() for more details.
15782 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15785 * Set the text to be shown in a given list item's tooltips.
15787 * @param item Target item.
15788 * @param text The text to set in the content.
15790 * Setup the text as tooltip to object. The item can have only one tooltip,
15791 * so any previous tooltip data - set with this function or
15792 * elm_list_item_tooltip_content_cb_set() - is removed.
15794 * @see elm_object_tooltip_text_set() for more details.
15798 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15802 * @brief Disable size restrictions on an object's tooltip
15803 * @param item The tooltip's anchor object
15804 * @param disable If EINA_TRUE, size restrictions are disabled
15805 * @return EINA_FALSE on failure, EINA_TRUE on success
15807 * This function allows a tooltip to expand beyond its parant window's canvas.
15808 * It will instead be limited only by the size of the display.
15810 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15812 * @brief Retrieve size restriction state of an object's tooltip
15813 * @param obj The tooltip's anchor object
15814 * @return If EINA_TRUE, size restrictions are disabled
15816 * This function returns whether a tooltip is allowed to expand beyond
15817 * its parant window's canvas.
15818 * It will instead be limited only by the size of the display.
15820 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15823 * Set the content to be shown in the tooltip item.
15825 * Setup the tooltip to item. The item can have only one tooltip,
15826 * so any previous tooltip data is removed. @p func(with @p data) will
15827 * be called every time that need show the tooltip and it should
15828 * return a valid Evas_Object. This object is then managed fully by
15829 * tooltip system and is deleted when the tooltip is gone.
15831 * @param item the list item being attached a tooltip.
15832 * @param func the function used to create the tooltip contents.
15833 * @param data what to provide to @a func as callback data/context.
15834 * @param del_cb called when data is not needed anymore, either when
15835 * another callback replaces @a func, the tooltip is unset with
15836 * elm_list_item_tooltip_unset() or the owner @a item
15837 * dies. This callback receives as the first parameter the
15838 * given @a data, and @c event_info is the item.
15840 * @see elm_object_tooltip_content_cb_set() for more details.
15844 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);
15847 * Unset tooltip from item.
15849 * @param item list item to remove previously set tooltip.
15851 * Remove tooltip from item. The callback provided as del_cb to
15852 * elm_list_item_tooltip_content_cb_set() will be called to notify
15853 * it is not used anymore.
15855 * @see elm_object_tooltip_unset() for more details.
15856 * @see elm_list_item_tooltip_content_cb_set()
15860 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15863 * Sets a different style for this item tooltip.
15865 * @note before you set a style you should define a tooltip with
15866 * elm_list_item_tooltip_content_cb_set() or
15867 * elm_list_item_tooltip_text_set()
15869 * @param item list item with tooltip already set.
15870 * @param style the theme style to use (default, transparent, ...)
15872 * @see elm_object_tooltip_style_set() for more details.
15876 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15879 * Get the style for this item tooltip.
15881 * @param item list item with tooltip already set.
15882 * @return style the theme style in use, defaults to "default". If the
15883 * object does not have a tooltip set, then NULL is returned.
15885 * @see elm_object_tooltip_style_get() for more details.
15886 * @see elm_list_item_tooltip_style_set()
15890 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15893 * Set the type of mouse pointer/cursor decoration to be shown,
15894 * when the mouse pointer is over the given list widget item
15896 * @param item list item to customize cursor on
15897 * @param cursor the cursor type's name
15899 * This function works analogously as elm_object_cursor_set(), but
15900 * here the cursor's changing area is restricted to the item's
15901 * area, and not the whole widget's. Note that that item cursors
15902 * have precedence over widget cursors, so that a mouse over an
15903 * item with custom cursor set will always show @b that cursor.
15905 * If this function is called twice for an object, a previously set
15906 * cursor will be unset on the second call.
15908 * @see elm_object_cursor_set()
15909 * @see elm_list_item_cursor_get()
15910 * @see elm_list_item_cursor_unset()
15914 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15917 * Get the type of mouse pointer/cursor decoration set to be shown,
15918 * when the mouse pointer is over the given list widget item
15920 * @param item list item with custom cursor set
15921 * @return the cursor type's name or @c NULL, if no custom cursors
15922 * were set to @p item (and on errors)
15924 * @see elm_object_cursor_get()
15925 * @see elm_list_item_cursor_set()
15926 * @see elm_list_item_cursor_unset()
15930 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15933 * Unset any custom mouse pointer/cursor decoration set to be
15934 * shown, when the mouse pointer is over the given list widget
15935 * item, thus making it show the @b default cursor again.
15937 * @param item a list item
15939 * Use this call to undo any custom settings on this item's cursor
15940 * decoration, bringing it back to defaults (no custom style set).
15942 * @see elm_object_cursor_unset()
15943 * @see elm_list_item_cursor_set()
15947 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15950 * Set a different @b style for a given custom cursor set for a
15953 * @param item list item with custom cursor set
15954 * @param style the <b>theme style</b> to use (e.g. @c "default",
15955 * @c "transparent", etc)
15957 * This function only makes sense when one is using custom mouse
15958 * cursor decorations <b>defined in a theme file</b>, which can have,
15959 * given a cursor name/type, <b>alternate styles</b> on it. It
15960 * works analogously as elm_object_cursor_style_set(), but here
15961 * applyed only to list item objects.
15963 * @warning Before you set a cursor style you should have definen a
15964 * custom cursor previously on the item, with
15965 * elm_list_item_cursor_set()
15967 * @see elm_list_item_cursor_engine_only_set()
15968 * @see elm_list_item_cursor_style_get()
15972 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15975 * Get the current @b style set for a given list item's custom
15978 * @param item list item with custom cursor set.
15979 * @return style the cursor style in use. If the object does not
15980 * have a cursor set, then @c NULL is returned.
15982 * @see elm_list_item_cursor_style_set() for more details
15986 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15989 * Set if the (custom)cursor for a given list item should be
15990 * searched in its theme, also, or should only rely on the
15991 * rendering engine.
15993 * @param item item with custom (custom) cursor already set on
15994 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15995 * only on those provided by the rendering engine, @c EINA_FALSE to
15996 * have them searched on the widget's theme, as well.
15998 * @note This call is of use only if you've set a custom cursor
15999 * for list items, with elm_list_item_cursor_set().
16001 * @note By default, cursors will only be looked for between those
16002 * provided by the rendering engine.
16006 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16009 * Get if the (custom) cursor for a given list item is being
16010 * searched in its theme, also, or is only relying on the rendering
16013 * @param item a list item
16014 * @return @c EINA_TRUE, if cursors are being looked for only on
16015 * those provided by the rendering engine, @c EINA_FALSE if they
16016 * are being searched on the widget's theme, as well.
16018 * @see elm_list_item_cursor_engine_only_set(), for more details
16022 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16029 * @defgroup Slider Slider
16030 * @ingroup Elementary
16032 * @image html img/widget/slider/preview-00.png
16033 * @image latex img/widget/slider/preview-00.eps width=\textwidth
16035 * The slider adds a dragable “slider” widget for selecting the value of
16036 * something within a range.
16038 * A slider can be horizontal or vertical. It can contain an Icon and has a
16039 * primary label as well as a units label (that is formatted with floating
16040 * point values and thus accepts a printf-style format string, like
16041 * “%1.2f units”. There is also an indicator string that may be somewhere
16042 * else (like on the slider itself) that also accepts a format string like
16043 * units. Label, Icon Unit and Indicator strings/objects are optional.
16045 * A slider may be inverted which means values invert, with high vales being
16046 * on the left or top and low values on the right or bottom (as opposed to
16047 * normally being low on the left or top and high on the bottom and right).
16049 * The slider should have its minimum and maximum values set by the
16050 * application with elm_slider_min_max_set() and value should also be set by
16051 * the application before use with elm_slider_value_set(). The span of the
16052 * slider is its length (horizontally or vertically). This will be scaled by
16053 * the object or applications scaling factor. At any point code can query the
16054 * slider for its value with elm_slider_value_get().
16056 * Smart callbacks one can listen to:
16057 * - "changed" - Whenever the slider value is changed by the user.
16058 * - "slider,drag,start" - dragging the slider indicator around has started.
16059 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16060 * - "delay,changed" - A short time after the value is changed by the user.
16061 * This will be called only when the user stops dragging for
16062 * a very short period or when they release their
16063 * finger/mouse, so it avoids possibly expensive reactions to
16064 * the value change.
16066 * Available styles for it:
16069 * Here is an example on its usage:
16070 * @li @ref slider_example
16074 * @addtogroup Slider
16079 * Add a new slider widget to the given parent Elementary
16080 * (container) object.
16082 * @param parent The parent object.
16083 * @return a new slider widget handle or @c NULL, on errors.
16085 * This function inserts a new slider widget on the canvas.
16089 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16092 * Set the label of a given slider widget
16094 * @param obj The progress bar object
16095 * @param label The text label string, in UTF-8
16098 * @deprecated use elm_object_text_set() instead.
16100 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16103 * Get the label of a given slider widget
16105 * @param obj The progressbar object
16106 * @return The text label string, in UTF-8
16109 * @deprecated use elm_object_text_get() instead.
16111 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16114 * Set the icon object of the slider object.
16116 * @param obj The slider object.
16117 * @param icon The icon object.
16119 * On horizontal mode, icon is placed at left, and on vertical mode,
16122 * @note Once the icon object is set, a previously set one will be deleted.
16123 * If you want to keep that old content object, use the
16124 * elm_slider_icon_unset() function.
16126 * @warning If the object being set does not have minimum size hints set,
16127 * it won't get properly displayed.
16131 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16134 * Unset an icon set on a given slider widget.
16136 * @param obj The slider object.
16137 * @return The icon object that was being used, if any was set, or
16138 * @c NULL, otherwise (and on errors).
16140 * On horizontal mode, icon is placed at left, and on vertical mode,
16143 * This call will unparent and return the icon object which was set
16144 * for this widget, previously, on success.
16146 * @see elm_slider_icon_set() for more details
16147 * @see elm_slider_icon_get()
16151 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16154 * Retrieve the icon object set for a given slider widget.
16156 * @param obj The slider object.
16157 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16158 * otherwise (and on errors).
16160 * On horizontal mode, icon is placed at left, and on vertical mode,
16163 * @see elm_slider_icon_set() for more details
16164 * @see elm_slider_icon_unset()
16168 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16171 * Set the end object of the slider object.
16173 * @param obj The slider object.
16174 * @param end The end object.
16176 * On horizontal mode, end is placed at left, and on vertical mode,
16177 * placed at bottom.
16179 * @note Once the icon object is set, a previously set one will be deleted.
16180 * If you want to keep that old content object, use the
16181 * elm_slider_end_unset() function.
16183 * @warning If the object being set does not have minimum size hints set,
16184 * it won't get properly displayed.
16188 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16191 * Unset an end object set on a given slider widget.
16193 * @param obj The slider object.
16194 * @return The end object that was being used, if any was set, or
16195 * @c NULL, otherwise (and on errors).
16197 * On horizontal mode, end is placed at left, and on vertical mode,
16198 * placed at bottom.
16200 * This call will unparent and return the icon object which was set
16201 * for this widget, previously, on success.
16203 * @see elm_slider_end_set() for more details.
16204 * @see elm_slider_end_get()
16208 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16211 * Retrieve the end object set for a given slider widget.
16213 * @param obj The slider object.
16214 * @return The end object's handle, if @p obj had one set, or @c NULL,
16215 * otherwise (and on errors).
16217 * On horizontal mode, icon is placed at right, and on vertical mode,
16218 * placed at bottom.
16220 * @see elm_slider_end_set() for more details.
16221 * @see elm_slider_end_unset()
16225 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16228 * Set the (exact) length of the bar region of a given slider widget.
16230 * @param obj The slider object.
16231 * @param size The length of the slider's bar region.
16233 * This sets the minimum width (when in horizontal mode) or height
16234 * (when in vertical mode) of the actual bar area of the slider
16235 * @p obj. This in turn affects the object's minimum size. Use
16236 * this when you're not setting other size hints expanding on the
16237 * given direction (like weight and alignment hints) and you would
16238 * like it to have a specific size.
16240 * @note Icon, end, label, indicator and unit text around @p obj
16241 * will require their
16242 * own space, which will make @p obj to require more the @p size,
16245 * @see elm_slider_span_size_get()
16249 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16252 * Get the length set for the bar region of a given slider widget
16254 * @param obj The slider object.
16255 * @return The length of the slider's bar region.
16257 * If that size was not set previously, with
16258 * elm_slider_span_size_set(), this call will return @c 0.
16262 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16265 * Set the format string for the unit label.
16267 * @param obj The slider object.
16268 * @param format The format string for the unit display.
16270 * Unit label is displayed all the time, if set, after slider's bar.
16271 * In horizontal mode, at right and in vertical mode, at bottom.
16273 * If @c NULL, unit label won't be visible. If not it sets the format
16274 * string for the label text. To the label text is provided a floating point
16275 * value, so the label text can display up to 1 floating point value.
16276 * Note that this is optional.
16278 * Use a format string such as "%1.2f meters" for example, and it will
16279 * display values like: "3.14 meters" for a value equal to 3.14159.
16281 * Default is unit label disabled.
16283 * @see elm_slider_indicator_format_get()
16287 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16290 * Get the unit label format of the slider.
16292 * @param obj The slider object.
16293 * @return The unit label format string in UTF-8.
16295 * Unit label is displayed all the time, if set, after slider's bar.
16296 * In horizontal mode, at right and in vertical mode, at bottom.
16298 * @see elm_slider_unit_format_set() for more
16299 * information on how this works.
16303 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16306 * Set the format string for the indicator label.
16308 * @param obj The slider object.
16309 * @param indicator The format string for the indicator display.
16311 * The slider may display its value somewhere else then unit label,
16312 * for example, above the slider knob that is dragged around. This function
16313 * sets the format string used for this.
16315 * If @c NULL, indicator label won't be visible. If not it sets the format
16316 * string for the label text. To the label text is provided a floating point
16317 * value, so the label text can display up to 1 floating point value.
16318 * Note that this is optional.
16320 * Use a format string such as "%1.2f meters" for example, and it will
16321 * display values like: "3.14 meters" for a value equal to 3.14159.
16323 * Default is indicator label disabled.
16325 * @see elm_slider_indicator_format_get()
16329 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16332 * Get the indicator label format of the slider.
16334 * @param obj The slider object.
16335 * @return The indicator label format string in UTF-8.
16337 * The slider may display its value somewhere else then unit label,
16338 * for example, above the slider knob that is dragged around. This function
16339 * gets the format string used for this.
16341 * @see elm_slider_indicator_format_set() for more
16342 * information on how this works.
16346 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16349 * Set the format function pointer for the indicator label
16351 * @param obj The slider object.
16352 * @param func The indicator format function.
16353 * @param free_func The freeing function for the format string.
16355 * Set the callback function to format the indicator string.
16357 * @see elm_slider_indicator_format_set() for more info on how this works.
16361 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);
16364 * Set the format function pointer for the units label
16366 * @param obj The slider object.
16367 * @param func The units format function.
16368 * @param free_func The freeing function for the format string.
16370 * Set the callback function to format the indicator string.
16372 * @see elm_slider_units_format_set() for more info on how this works.
16376 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);
16379 * Set the orientation of a given slider widget.
16381 * @param obj The slider object.
16382 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16383 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16385 * Use this function to change how your slider is to be
16386 * disposed: vertically or horizontally.
16388 * By default it's displayed horizontally.
16390 * @see elm_slider_horizontal_get()
16394 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16397 * Retrieve the orientation of a given slider widget
16399 * @param obj The slider object.
16400 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16401 * @c EINA_FALSE if it's @b vertical (and on errors).
16403 * @see elm_slider_horizontal_set() for more details.
16407 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16410 * Set the minimum and maximum values for the slider.
16412 * @param obj The slider object.
16413 * @param min The minimum value.
16414 * @param max The maximum value.
16416 * Define the allowed range of values to be selected by the user.
16418 * If actual value is less than @p min, it will be updated to @p min. If it
16419 * is bigger then @p max, will be updated to @p max. Actual value can be
16420 * get with elm_slider_value_get().
16422 * By default, min is equal to 0.0, and max is equal to 1.0.
16424 * @warning Maximum must be greater than minimum, otherwise behavior
16427 * @see elm_slider_min_max_get()
16431 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16434 * Get the minimum and maximum values of the slider.
16436 * @param obj The slider object.
16437 * @param min Pointer where to store the minimum value.
16438 * @param max Pointer where to store the maximum value.
16440 * @note If only one value is needed, the other pointer can be passed
16443 * @see elm_slider_min_max_set() for details.
16447 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16450 * Set the value the slider displays.
16452 * @param obj The slider object.
16453 * @param val The value to be displayed.
16455 * Value will be presented on the unit label following format specified with
16456 * elm_slider_unit_format_set() and on indicator with
16457 * elm_slider_indicator_format_set().
16459 * @warning The value must to be between min and max values. This values
16460 * are set by elm_slider_min_max_set().
16462 * @see elm_slider_value_get()
16463 * @see elm_slider_unit_format_set()
16464 * @see elm_slider_indicator_format_set()
16465 * @see elm_slider_min_max_set()
16469 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16472 * Get the value displayed by the spinner.
16474 * @param obj The spinner object.
16475 * @return The value displayed.
16477 * @see elm_spinner_value_set() for details.
16481 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16484 * Invert a given slider widget's displaying values order
16486 * @param obj The slider object.
16487 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16488 * @c EINA_FALSE to bring it back to default, non-inverted values.
16490 * A slider may be @b inverted, in which state it gets its
16491 * values inverted, with high vales being on the left or top and
16492 * low values on the right or bottom, as opposed to normally have
16493 * the low values on the former and high values on the latter,
16494 * respectively, for horizontal and vertical modes.
16496 * @see elm_slider_inverted_get()
16500 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16503 * Get whether a given slider widget's displaying values are
16506 * @param obj The slider object.
16507 * @return @c EINA_TRUE, if @p obj has inverted values,
16508 * @c EINA_FALSE otherwise (and on errors).
16510 * @see elm_slider_inverted_set() for more details.
16514 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16517 * Set whether to enlarge slider indicator (augmented knob) or not.
16519 * @param obj The slider object.
16520 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16521 * let the knob always at default size.
16523 * By default, indicator will be bigger while dragged by the user.
16525 * @warning It won't display values set with
16526 * elm_slider_indicator_format_set() if you disable indicator.
16530 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16533 * Get whether a given slider widget's enlarging indicator or not.
16535 * @param obj The slider object.
16536 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16537 * @c EINA_FALSE otherwise (and on errors).
16539 * @see elm_slider_indicator_show_set() for details.
16543 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16550 * @addtogroup Actionslider Actionslider
16552 * @image html img/widget/actionslider/preview-00.png
16553 * @image latex img/widget/actionslider/preview-00.eps
16555 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16556 * properties. The indicator is the element the user drags to choose a label.
16557 * When the position is set with magnet, when released the indicator will be
16558 * moved to it if it's nearest the magnetized position.
16560 * @note By default all positions are set as enabled.
16562 * Signals that you can add callbacks for are:
16564 * "selected" - when user selects an enabled position (the label is passed
16567 * "pos_changed" - when the indicator reaches any of the positions("left",
16568 * "right" or "center").
16570 * See an example of actionslider usage @ref actionslider_example_page "here"
16573 typedef enum _Elm_Actionslider_Pos
16575 ELM_ACTIONSLIDER_NONE = 0,
16576 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16577 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16578 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16579 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16580 } Elm_Actionslider_Pos;
16583 * Add a new actionslider to the parent.
16585 * @param parent The parent object
16586 * @return The new actionslider object or NULL if it cannot be created
16588 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16590 * Set actionslider labels.
16592 * @param obj The actionslider object
16593 * @param left_label The label to be set on the left.
16594 * @param center_label The label to be set on the center.
16595 * @param right_label The label to be set on the right.
16596 * @deprecated use elm_object_text_set() instead.
16598 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);
16600 * Get actionslider labels.
16602 * @param obj The actionslider object
16603 * @param left_label A char** to place the left_label of @p obj into.
16604 * @param center_label A char** to place the center_label of @p obj into.
16605 * @param right_label A char** to place the right_label of @p obj into.
16606 * @deprecated use elm_object_text_set() instead.
16608 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);
16610 * Get actionslider selected label.
16612 * @param obj The actionslider object
16613 * @return The selected label
16615 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16617 * Set actionslider indicator position.
16619 * @param obj The actionslider object.
16620 * @param pos The position of the indicator.
16622 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16624 * Get actionslider indicator position.
16626 * @param obj The actionslider object.
16627 * @return The position of the indicator.
16629 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16631 * Set actionslider magnet position. To make multiple positions magnets @c or
16632 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16634 * @param obj The actionslider object.
16635 * @param pos Bit mask indicating the magnet positions.
16637 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16639 * Get actionslider magnet position.
16641 * @param obj The actionslider object.
16642 * @return The positions with magnet property.
16644 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16646 * Set actionslider enabled position. To set multiple positions as enabled @c or
16647 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16649 * @note All the positions are enabled by default.
16651 * @param obj The actionslider object.
16652 * @param pos Bit mask indicating the enabled positions.
16654 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16656 * Get actionslider enabled position.
16658 * @param obj The actionslider object.
16659 * @return The enabled positions.
16661 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16663 * Set the label used on the indicator.
16665 * @param obj The actionslider object
16666 * @param label The label to be set on the indicator.
16667 * @deprecated use elm_object_text_set() instead.
16669 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16671 * Get the label used on the indicator object.
16673 * @param obj The actionslider object
16674 * @return The indicator label
16675 * @deprecated use elm_object_text_get() instead.
16677 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16683 * @defgroup Genlist Genlist
16685 * @image html img/widget/genlist/preview-00.png
16686 * @image latex img/widget/genlist/preview-00.eps
16687 * @image html img/genlist.png
16688 * @image latex img/genlist.eps
16690 * This widget aims to have more expansive list than the simple list in
16691 * Elementary that could have more flexible items and allow many more entries
16692 * while still being fast and low on memory usage. At the same time it was
16693 * also made to be able to do tree structures. But the price to pay is more
16694 * complexity when it comes to usage. If all you want is a simple list with
16695 * icons and a single label, use the normal @ref List object.
16697 * Genlist has a fairly large API, mostly because it's relatively complex,
16698 * trying to be both expansive, powerful and efficient. First we will begin
16699 * an overview on the theory behind genlist.
16701 * @section Genlist_Item_Class Genlist item classes - creating items
16703 * In order to have the ability to add and delete items on the fly, genlist
16704 * implements a class (callback) system where the application provides a
16705 * structure with information about that type of item (genlist may contain
16706 * multiple different items with different classes, states and styles).
16707 * Genlist will call the functions in this struct (methods) when an item is
16708 * "realized" (i.e., created dynamically, while the user is scrolling the
16709 * grid). All objects will simply be deleted when no longer needed with
16710 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16711 * following members:
16712 * - @c item_style - This is a constant string and simply defines the name
16713 * of the item style. It @b must be specified and the default should be @c
16715 * - @c mode_item_style - This is a constant string and simply defines the
16716 * name of the style that will be used for mode animations. It can be left
16717 * as @c NULL if you don't plan to use Genlist mode. See
16718 * elm_genlist_item_mode_set() for more info.
16720 * - @c func - A struct with pointers to functions that will be called when
16721 * an item is going to be actually created. All of them receive a @c data
16722 * parameter that will point to the same data passed to
16723 * elm_genlist_item_append() and related item creation functions, and a @c
16724 * obj parameter that points to the genlist object itself.
16726 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16727 * state_get and @c del. The 3 first functions also receive a @c part
16728 * parameter described below. A brief description of these functions follows:
16730 * - @c label_get - The @c part parameter is the name string of one of the
16731 * existing text parts in the Edje group implementing the item's theme.
16732 * This function @b must return a strdup'()ed string, as the caller will
16733 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16734 * - @c icon_get - The @c part parameter is the name string of one of the
16735 * existing (icon) swallow parts in the Edje group implementing the item's
16736 * theme. It must return @c NULL, when no icon is desired, or a valid
16737 * object handle, otherwise. The object will be deleted by the genlist on
16738 * its deletion or when the item is "unrealized". See
16739 * #Elm_Genlist_Item_Icon_Get_Cb.
16740 * - @c func.state_get - The @c part parameter is the name string of one of
16741 * the state parts in the Edje group implementing the item's theme. Return
16742 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16743 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16744 * and @c "elm" as "emission" and "source" arguments, respectively, when
16745 * the state is true (the default is false), where @c XXX is the name of
16746 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16747 * - @c func.del - This is intended for use when genlist items are deleted,
16748 * so any data attached to the item (e.g. its data parameter on creation)
16749 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16751 * available item styles:
16753 * - default_style - The text part is a textblock
16755 * @image html img/widget/genlist/preview-04.png
16756 * @image latex img/widget/genlist/preview-04.eps
16760 * @image html img/widget/genlist/preview-01.png
16761 * @image latex img/widget/genlist/preview-01.eps
16763 * - icon_top_text_bottom
16765 * @image html img/widget/genlist/preview-02.png
16766 * @image latex img/widget/genlist/preview-02.eps
16770 * @image html img/widget/genlist/preview-03.png
16771 * @image latex img/widget/genlist/preview-03.eps
16773 * @section Genlist_Items Structure of items
16775 * An item in a genlist can have 0 or more text labels (they can be regular
16776 * text or textblock Evas objects - that's up to the style to determine), 0
16777 * or more icons (which are simply objects swallowed into the genlist item's
16778 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16779 * behavior left to the user to define. The Edje part names for each of
16780 * these properties will be looked up, in the theme file for the genlist,
16781 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16782 * "states", respectively. For each of those properties, if more than one
16783 * part is provided, they must have names listed separated by spaces in the
16784 * data fields. For the default genlist item theme, we have @b one label
16785 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16786 * "elm.swallow.end") and @b no state parts.
16788 * A genlist item may be at one of several styles. Elementary provides one
16789 * by default - "default", but this can be extended by system or application
16790 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16793 * @section Genlist_Manipulation Editing and Navigating
16795 * Items can be added by several calls. All of them return a @ref
16796 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16797 * They all take a data parameter that is meant to be used for a handle to
16798 * the applications internal data (eg the struct with the original item
16799 * data). The parent parameter is the parent genlist item this belongs to if
16800 * it is a tree or an indexed group, and NULL if there is no parent. The
16801 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16802 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16803 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16804 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16805 * is set then this item is group index item that is displayed at the top
16806 * until the next group comes. The func parameter is a convenience callback
16807 * that is called when the item is selected and the data parameter will be
16808 * the func_data parameter, obj be the genlist object and event_info will be
16809 * the genlist item.
16811 * elm_genlist_item_append() adds an item to the end of the list, or if
16812 * there is a parent, to the end of all the child items of the parent.
16813 * elm_genlist_item_prepend() is the same but adds to the beginning of
16814 * the list or children list. elm_genlist_item_insert_before() inserts at
16815 * item before another item and elm_genlist_item_insert_after() inserts after
16816 * the indicated item.
16818 * The application can clear the list with elm_genlist_clear() which deletes
16819 * all the items in the list and elm_genlist_item_del() will delete a specific
16820 * item. elm_genlist_item_subitems_clear() will clear all items that are
16821 * children of the indicated parent item.
16823 * To help inspect list items you can jump to the item at the top of the list
16824 * with elm_genlist_first_item_get() which will return the item pointer, and
16825 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16826 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16827 * and previous items respectively relative to the indicated item. Using
16828 * these calls you can walk the entire item list/tree. Note that as a tree
16829 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16830 * let you know which item is the parent (and thus know how to skip them if
16833 * @section Genlist_Muti_Selection Multi-selection
16835 * If the application wants multiple items to be able to be selected,
16836 * elm_genlist_multi_select_set() can enable this. If the list is
16837 * single-selection only (the default), then elm_genlist_selected_item_get()
16838 * will return the selected item, if any, or NULL I none is selected. If the
16839 * list is multi-select then elm_genlist_selected_items_get() will return a
16840 * list (that is only valid as long as no items are modified (added, deleted,
16841 * selected or unselected)).
16843 * @section Genlist_Usage_Hints Usage hints
16845 * There are also convenience functions. elm_genlist_item_genlist_get() will
16846 * return the genlist object the item belongs to. elm_genlist_item_show()
16847 * will make the scroller scroll to show that specific item so its visible.
16848 * elm_genlist_item_data_get() returns the data pointer set by the item
16849 * creation functions.
16851 * If an item changes (state of boolean changes, label or icons change),
16852 * then use elm_genlist_item_update() to have genlist update the item with
16853 * the new state. Genlist will re-realize the item thus call the functions
16854 * in the _Elm_Genlist_Item_Class for that item.
16856 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16857 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16858 * to expand/contract an item and get its expanded state, use
16859 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16860 * again to make an item disabled (unable to be selected and appear
16861 * differently) use elm_genlist_item_disabled_set() to set this and
16862 * elm_genlist_item_disabled_get() to get the disabled state.
16864 * In general to indicate how the genlist should expand items horizontally to
16865 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16866 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16867 * mode means that if items are too wide to fit, the scroller will scroll
16868 * horizontally. Otherwise items are expanded to fill the width of the
16869 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16870 * to the viewport width and limited to that size. This can be combined with
16871 * a different style that uses edjes' ellipsis feature (cutting text off like
16874 * Items will only call their selection func and callback when first becoming
16875 * selected. Any further clicks will do nothing, unless you enable always
16876 * select with elm_genlist_always_select_mode_set(). This means even if
16877 * selected, every click will make the selected callbacks be called.
16878 * elm_genlist_no_select_mode_set() will turn off the ability to select
16879 * items entirely and they will neither appear selected nor call selected
16880 * callback functions.
16882 * Remember that you can create new styles and add your own theme augmentation
16883 * per application with elm_theme_extension_add(). If you absolutely must
16884 * have a specific style that overrides any theme the user or system sets up
16885 * you can use elm_theme_overlay_add() to add such a file.
16887 * @section Genlist_Implementation Implementation
16889 * Evas tracks every object you create. Every time it processes an event
16890 * (mouse move, down, up etc.) it needs to walk through objects and find out
16891 * what event that affects. Even worse every time it renders display updates,
16892 * in order to just calculate what to re-draw, it needs to walk through many
16893 * many many objects. Thus, the more objects you keep active, the more
16894 * overhead Evas has in just doing its work. It is advisable to keep your
16895 * active objects to the minimum working set you need. Also remember that
16896 * object creation and deletion carries an overhead, so there is a
16897 * middle-ground, which is not easily determined. But don't keep massive lists
16898 * of objects you can't see or use. Genlist does this with list objects. It
16899 * creates and destroys them dynamically as you scroll around. It groups them
16900 * into blocks so it can determine the visibility etc. of a whole block at
16901 * once as opposed to having to walk the whole list. This 2-level list allows
16902 * for very large numbers of items to be in the list (tests have used up to
16903 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16904 * may be different sizes, every item added needs to be calculated as to its
16905 * size and thus this presents a lot of overhead on populating the list, this
16906 * genlist employs a queue. Any item added is queued and spooled off over
16907 * time, actually appearing some time later, so if your list has many members
16908 * you may find it takes a while for them to all appear, with your process
16909 * consuming a lot of CPU while it is busy spooling.
16911 * Genlist also implements a tree structure, but it does so with callbacks to
16912 * the application, with the application filling in tree structures when
16913 * requested (allowing for efficient building of a very deep tree that could
16914 * even be used for file-management). See the above smart signal callbacks for
16917 * @section Genlist_Smart_Events Genlist smart events
16919 * Signals that you can add callbacks for are:
16920 * - @c "activated" - The user has double-clicked or pressed
16921 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16922 * item that was activated.
16923 * - @c "clicked,double" - The user has double-clicked an item. The @c
16924 * event_info parameter is the item that was double-clicked.
16925 * - @c "selected" - This is called when a user has made an item selected.
16926 * The event_info parameter is the genlist item that was selected.
16927 * - @c "unselected" - This is called when a user has made an item
16928 * unselected. The event_info parameter is the genlist item that was
16930 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16931 * called and the item is now meant to be expanded. The event_info
16932 * parameter is the genlist item that was indicated to expand. It is the
16933 * job of this callback to then fill in the child items.
16934 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16935 * called and the item is now meant to be contracted. The event_info
16936 * parameter is the genlist item that was indicated to contract. It is the
16937 * job of this callback to then delete the child items.
16938 * - @c "expand,request" - This is called when a user has indicated they want
16939 * to expand a tree branch item. The callback should decide if the item can
16940 * expand (has any children) and then call elm_genlist_item_expanded_set()
16941 * appropriately to set the state. The event_info parameter is the genlist
16942 * item that was indicated to expand.
16943 * - @c "contract,request" - This is called when a user has indicated they
16944 * want to contract a tree branch item. The callback should decide if the
16945 * item can contract (has any children) and then call
16946 * elm_genlist_item_expanded_set() appropriately to set the state. The
16947 * event_info parameter is the genlist item that was indicated to contract.
16948 * - @c "realized" - This is called when the item in the list is created as a
16949 * real evas object. event_info parameter is the genlist item that was
16950 * created. The object may be deleted at any time, so it is up to the
16951 * caller to not use the object pointer from elm_genlist_item_object_get()
16952 * in a way where it may point to freed objects.
16953 * - @c "unrealized" - This is called just before an item is unrealized.
16954 * After this call icon objects provided will be deleted and the item
16955 * object itself delete or be put into a floating cache.
16956 * - @c "drag,start,up" - This is called when the item in the list has been
16957 * dragged (not scrolled) up.
16958 * - @c "drag,start,down" - This is called when the item in the list has been
16959 * dragged (not scrolled) down.
16960 * - @c "drag,start,left" - This is called when the item in the list has been
16961 * dragged (not scrolled) left.
16962 * - @c "drag,start,right" - This is called when the item in the list has
16963 * been dragged (not scrolled) right.
16964 * - @c "drag,stop" - This is called when the item in the list has stopped
16966 * - @c "drag" - This is called when the item in the list is being dragged.
16967 * - @c "longpressed" - This is called when the item is pressed for a certain
16968 * amount of time. By default it's 1 second.
16969 * - @c "scroll,anim,start" - This is called when scrolling animation has
16971 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16973 * - @c "scroll,drag,start" - This is called when dragging the content has
16975 * - @c "scroll,drag,stop" - This is called when dragging the content has
16977 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16979 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16980 * until the bottom edge.
16981 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16982 * until the left edge.
16983 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16984 * until the right edge.
16985 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16987 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16989 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16991 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16993 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16994 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16995 * multi-touch pinched in.
16996 * - @c "swipe" - This is called when the genlist is swiped.
16998 * @section Genlist_Examples Examples
17000 * Here is a list of examples that use the genlist, trying to show some of
17001 * its capabilities:
17002 * - @ref genlist_example_01
17003 * - @ref genlist_example_02
17004 * - @ref genlist_example_03
17005 * - @ref genlist_example_04
17006 * - @ref genlist_example_05
17010 * @addtogroup Genlist
17015 * @enum _Elm_Genlist_Item_Flags
17016 * @typedef Elm_Genlist_Item_Flags
17018 * Defines if the item is of any special type (has subitems or it's the
17019 * index of a group), or is just a simple item.
17023 typedef enum _Elm_Genlist_Item_Flags
17025 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
17026 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
17027 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
17028 } Elm_Genlist_Item_Flags;
17029 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
17030 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17031 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17032 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17033 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. */
17034 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. */
17035 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17036 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17038 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17039 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17040 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17041 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17044 * @struct _Elm_Genlist_Item_Class
17046 * Genlist item class definition structs.
17048 * This struct contains the style and fetching functions that will define the
17049 * contents of each item.
17051 * @see @ref Genlist_Item_Class
17053 struct _Elm_Genlist_Item_Class
17055 const char *item_style; /**< style of this class. */
17058 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
17059 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
17060 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
17061 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
17062 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
17064 const char *mode_item_style;
17068 * Add a new genlist widget to the given parent Elementary
17069 * (container) object
17071 * @param parent The parent object
17072 * @return a new genlist widget handle or @c NULL, on errors
17074 * This function inserts a new genlist widget on the canvas.
17076 * @see elm_genlist_item_append()
17077 * @see elm_genlist_item_del()
17078 * @see elm_genlist_clear()
17082 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17084 * Remove all items from a given genlist widget.
17086 * @param obj The genlist object
17088 * This removes (and deletes) all items in @p obj, leaving it empty.
17090 * @see elm_genlist_item_del(), to remove just one item.
17094 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17096 * Enable or disable multi-selection in the genlist
17098 * @param obj The genlist object
17099 * @param multi Multi-select enable/disable. Default is disabled.
17101 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17102 * the list. This allows more than 1 item to be selected. To retrieve the list
17103 * of selected items, use elm_genlist_selected_items_get().
17105 * @see elm_genlist_selected_items_get()
17106 * @see elm_genlist_multi_select_get()
17110 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17112 * Gets if multi-selection in genlist is enabled or disabled.
17114 * @param obj The genlist object
17115 * @return Multi-select enabled/disabled
17116 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17118 * @see elm_genlist_multi_select_set()
17122 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17124 * This sets the horizontal stretching mode.
17126 * @param obj The genlist object
17127 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17129 * This sets the mode used for sizing items horizontally. Valid modes
17130 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17131 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17132 * the scroller will scroll horizontally. Otherwise items are expanded
17133 * to fill the width of the viewport of the scroller. If it is
17134 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17135 * limited to that size.
17137 * @see elm_genlist_horizontal_get()
17141 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17142 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17144 * Gets the horizontal stretching mode.
17146 * @param obj The genlist object
17147 * @return The mode to use
17148 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17150 * @see elm_genlist_horizontal_set()
17154 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17155 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17157 * Set the always select mode.
17159 * @param obj The genlist object
17160 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17161 * EINA_FALSE = off). Default is @c EINA_FALSE.
17163 * Items will only call their selection func and callback when first
17164 * becoming selected. Any further clicks will do nothing, unless you
17165 * enable always select with elm_genlist_always_select_mode_set().
17166 * This means that, even if selected, every click will make the selected
17167 * callbacks be called.
17169 * @see elm_genlist_always_select_mode_get()
17173 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17175 * Get the always select mode.
17177 * @param obj The genlist object
17178 * @return The always select mode
17179 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17181 * @see elm_genlist_always_select_mode_set()
17185 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17187 * Enable/disable the no select mode.
17189 * @param obj The genlist object
17190 * @param no_select The no select mode
17191 * (EINA_TRUE = on, EINA_FALSE = off)
17193 * This will turn off the ability to select items entirely and they
17194 * will neither appear selected nor call selected callback functions.
17196 * @see elm_genlist_no_select_mode_get()
17200 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17202 * Gets whether the no select mode is enabled.
17204 * @param obj The genlist object
17205 * @return The no select mode
17206 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17208 * @see elm_genlist_no_select_mode_set()
17212 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17214 * Enable/disable compress mode.
17216 * @param obj The genlist object
17217 * @param compress The compress mode
17218 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17220 * This will enable the compress mode where items are "compressed"
17221 * horizontally to fit the genlist scrollable viewport width. This is
17222 * special for genlist. Do not rely on
17223 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17224 * work as genlist needs to handle it specially.
17226 * @see elm_genlist_compress_mode_get()
17230 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17232 * Get whether the compress mode is enabled.
17234 * @param obj The genlist object
17235 * @return The compress mode
17236 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17238 * @see elm_genlist_compress_mode_set()
17242 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17244 * Enable/disable height-for-width mode.
17246 * @param obj The genlist object
17247 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17248 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17250 * With height-for-width mode the item width will be fixed (restricted
17251 * to a minimum of) to the list width when calculating its size in
17252 * order to allow the height to be calculated based on it. This allows,
17253 * for instance, text block to wrap lines if the Edje part is
17254 * configured with "text.min: 0 1".
17256 * @note This mode will make list resize slower as it will have to
17257 * recalculate every item height again whenever the list width
17260 * @note When height-for-width mode is enabled, it also enables
17261 * compress mode (see elm_genlist_compress_mode_set()) and
17262 * disables homogeneous (see elm_genlist_homogeneous_set()).
17266 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17268 * Get whether the height-for-width mode is enabled.
17270 * @param obj The genlist object
17271 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17276 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17278 * Enable/disable horizontal and vertical bouncing effect.
17280 * @param obj The genlist object
17281 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17282 * EINA_FALSE = off). Default is @c EINA_FALSE.
17283 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17284 * EINA_FALSE = off). Default is @c EINA_TRUE.
17286 * This will enable or disable the scroller bouncing effect for the
17287 * genlist. See elm_scroller_bounce_set() for details.
17289 * @see elm_scroller_bounce_set()
17290 * @see elm_genlist_bounce_get()
17294 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17296 * Get whether the horizontal and vertical bouncing effect is enabled.
17298 * @param obj The genlist object
17299 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17301 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17304 * @see elm_genlist_bounce_set()
17308 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17310 * Enable/disable homogenous mode.
17312 * @param obj The genlist object
17313 * @param homogeneous Assume the items within the genlist are of the
17314 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17317 * This will enable the homogeneous mode where items are of the same
17318 * height and width so that genlist may do the lazy-loading at its
17319 * maximum (which increases the performance for scrolling the list). This
17320 * implies 'compressed' mode.
17322 * @see elm_genlist_compress_mode_set()
17323 * @see elm_genlist_homogeneous_get()
17327 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17329 * Get whether the homogenous mode is enabled.
17331 * @param obj The genlist object
17332 * @return Assume the items within the genlist are of the same height
17333 * and width (EINA_TRUE = on, EINA_FALSE = off)
17335 * @see elm_genlist_homogeneous_set()
17339 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17341 * Set the maximum number of items within an item block
17343 * @param obj The genlist object
17344 * @param n Maximum number of items within an item block. Default is 32.
17346 * This will configure the block count to tune to the target with
17347 * particular performance matrix.
17349 * A block of objects will be used to reduce the number of operations due to
17350 * many objects in the screen. It can determine the visibility, or if the
17351 * object has changed, it theme needs to be updated, etc. doing this kind of
17352 * calculation to the entire block, instead of per object.
17354 * The default value for the block count is enough for most lists, so unless
17355 * you know you will have a lot of objects visible in the screen at the same
17356 * time, don't try to change this.
17358 * @see elm_genlist_block_count_get()
17359 * @see @ref Genlist_Implementation
17363 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17365 * Get the maximum number of items within an item block
17367 * @param obj The genlist object
17368 * @return Maximum number of items within an item block
17370 * @see elm_genlist_block_count_set()
17374 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17376 * Set the timeout in seconds for the longpress event.
17378 * @param obj The genlist object
17379 * @param timeout timeout in seconds. Default is 1.
17381 * This option will change how long it takes to send an event "longpressed"
17382 * after the mouse down signal is sent to the list. If this event occurs, no
17383 * "clicked" event will be sent.
17385 * @see elm_genlist_longpress_timeout_set()
17389 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17391 * Get the timeout in seconds for the longpress event.
17393 * @param obj The genlist object
17394 * @return timeout in seconds
17396 * @see elm_genlist_longpress_timeout_get()
17400 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17402 * Append a new item in a given genlist widget.
17404 * @param obj The genlist object
17405 * @param itc The item class for the item
17406 * @param data The item data
17407 * @param parent The parent item, or NULL if none
17408 * @param flags Item flags
17409 * @param func Convenience function called when the item is selected
17410 * @param func_data Data passed to @p func above.
17411 * @return A handle to the item added or @c NULL if not possible
17413 * This adds the given item to the end of the list or the end of
17414 * the children list if the @p parent is given.
17416 * @see elm_genlist_item_prepend()
17417 * @see elm_genlist_item_insert_before()
17418 * @see elm_genlist_item_insert_after()
17419 * @see elm_genlist_item_del()
17423 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);
17425 * Prepend a new item in a given genlist widget.
17427 * @param obj The genlist object
17428 * @param itc The item class for the item
17429 * @param data The item data
17430 * @param parent The parent item, or NULL if none
17431 * @param flags Item flags
17432 * @param func Convenience function called when the item is selected
17433 * @param func_data Data passed to @p func above.
17434 * @return A handle to the item added or NULL if not possible
17436 * This adds an item to the beginning of the list or beginning of the
17437 * children of the parent if given.
17439 * @see elm_genlist_item_append()
17440 * @see elm_genlist_item_insert_before()
17441 * @see elm_genlist_item_insert_after()
17442 * @see elm_genlist_item_del()
17446 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);
17448 * Insert an item before another in a genlist widget
17450 * @param obj The genlist object
17451 * @param itc The item class for the item
17452 * @param data The item data
17453 * @param before The item to place this new one before.
17454 * @param flags Item flags
17455 * @param func Convenience function called when the item is selected
17456 * @param func_data Data passed to @p func above.
17457 * @return A handle to the item added or @c NULL if not possible
17459 * This inserts an item before another in the list. It will be in the
17460 * same tree level or group as the item it is inserted before.
17462 * @see elm_genlist_item_append()
17463 * @see elm_genlist_item_prepend()
17464 * @see elm_genlist_item_insert_after()
17465 * @see elm_genlist_item_del()
17469 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);
17471 * Insert an item after another in a genlist widget
17473 * @param obj The genlist object
17474 * @param itc The item class for the item
17475 * @param data The item data
17476 * @param after The item to place this new one after.
17477 * @param flags Item flags
17478 * @param func Convenience function called when the item is selected
17479 * @param func_data Data passed to @p func above.
17480 * @return A handle to the item added or @c NULL if not possible
17482 * This inserts an item after another in the list. It will be in the
17483 * same tree level or group as the item it is inserted after.
17485 * @see elm_genlist_item_append()
17486 * @see elm_genlist_item_prepend()
17487 * @see elm_genlist_item_insert_before()
17488 * @see elm_genlist_item_del()
17492 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);
17494 * Insert a new item into the sorted genlist object
17496 * @param obj The genlist object
17497 * @param itc The item class for the item
17498 * @param data The item data
17499 * @param parent The parent item, or NULL if none
17500 * @param flags Item flags
17501 * @param comp The function called for the sort
17502 * @param func Convenience function called when item selected
17503 * @param func_data Data passed to @p func above.
17504 * @return A handle to the item added or NULL if not possible
17508 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);
17509 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);
17510 /* operations to retrieve existing items */
17512 * Get the selectd item in the genlist.
17514 * @param obj The genlist object
17515 * @return The selected item, or NULL if none is selected.
17517 * This gets the selected item in the list (if multi-selection is enabled, only
17518 * the item that was first selected in the list is returned - which is not very
17519 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17522 * If no item is selected, NULL is returned.
17524 * @see elm_genlist_selected_items_get()
17528 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17530 * Get a list of selected items in the genlist.
17532 * @param obj The genlist object
17533 * @return The list of selected items, or NULL if none are selected.
17535 * It returns a list of the selected items. This list pointer is only valid so
17536 * long as the selection doesn't change (no items are selected or unselected, or
17537 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17538 * pointers. The order of the items in this list is the order which they were
17539 * selected, i.e. the first item in this list is the first item that was
17540 * selected, and so on.
17542 * @note If not in multi-select mode, consider using function
17543 * elm_genlist_selected_item_get() instead.
17545 * @see elm_genlist_multi_select_set()
17546 * @see elm_genlist_selected_item_get()
17550 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17552 * Get a list of realized items in genlist
17554 * @param obj The genlist object
17555 * @return The list of realized items, nor NULL if none are realized.
17557 * This returns a list of the realized items in the genlist. The list
17558 * contains Elm_Genlist_Item pointers. The list must be freed by the
17559 * caller when done with eina_list_free(). The item pointers in the
17560 * list are only valid so long as those items are not deleted or the
17561 * genlist is not deleted.
17563 * @see elm_genlist_realized_items_update()
17567 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17569 * Get the item that is at the x, y canvas coords.
17571 * @param obj The gelinst object.
17572 * @param x The input x coordinate
17573 * @param y The input y coordinate
17574 * @param posret The position relative to the item returned here
17575 * @return The item at the coordinates or NULL if none
17577 * This returns the item at the given coordinates (which are canvas
17578 * relative, not object-relative). If an item is at that coordinate,
17579 * that item handle is returned, and if @p posret is not NULL, the
17580 * integer pointed to is set to a value of -1, 0 or 1, depending if
17581 * the coordinate is on the upper portion of that item (-1), on the
17582 * middle section (0) or on the lower part (1). If NULL is returned as
17583 * an item (no item found there), then posret may indicate -1 or 1
17584 * based if the coordinate is above or below all items respectively in
17589 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);
17591 * Get the first item in the genlist
17593 * This returns the first item in the list.
17595 * @param obj The genlist object
17596 * @return The first item, or NULL if none
17600 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17602 * Get the last item in the genlist
17604 * This returns the last item in the list.
17606 * @return The last item, or NULL if none
17610 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17612 * Set the scrollbar policy
17614 * @param obj The genlist object
17615 * @param policy_h Horizontal scrollbar policy.
17616 * @param policy_v Vertical scrollbar policy.
17618 * This sets the scrollbar visibility policy for the given genlist
17619 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17620 * made visible if it is needed, and otherwise kept hidden.
17621 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17622 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17623 * respectively for the horizontal and vertical scrollbars. Default is
17624 * #ELM_SMART_SCROLLER_POLICY_AUTO
17626 * @see elm_genlist_scroller_policy_get()
17630 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17632 * Get the scrollbar policy
17634 * @param obj The genlist object
17635 * @param policy_h Pointer to store the horizontal scrollbar policy.
17636 * @param policy_v Pointer to store the vertical scrollbar policy.
17638 * @see elm_genlist_scroller_policy_set()
17642 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);
17644 * Get the @b next item in a genlist widget's internal list of items,
17645 * given a handle to one of those items.
17647 * @param item The genlist item to fetch next from
17648 * @return The item after @p item, or @c NULL if there's none (and
17651 * This returns the item placed after the @p item, on the container
17654 * @see elm_genlist_item_prev_get()
17658 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17660 * Get the @b previous item in a genlist widget's internal list of items,
17661 * given a handle to one of those items.
17663 * @param item The genlist item to fetch previous from
17664 * @return The item before @p item, or @c NULL if there's none (and
17667 * This returns the item placed before the @p item, on the container
17670 * @see elm_genlist_item_next_get()
17674 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17676 * Get the genlist object's handle which contains a given genlist
17679 * @param item The item to fetch the container from
17680 * @return The genlist (parent) object
17682 * This returns the genlist object itself that an item belongs to.
17686 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17688 * Get the parent item of the given item
17690 * @param it The item
17691 * @return The parent of the item or @c NULL if it has no parent.
17693 * This returns the item that was specified as parent of the item @p it on
17694 * elm_genlist_item_append() and insertion related functions.
17698 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17700 * Remove all sub-items (children) of the given item
17702 * @param it The item
17704 * This removes all items that are children (and their descendants) of the
17705 * given item @p it.
17707 * @see elm_genlist_clear()
17708 * @see elm_genlist_item_del()
17712 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17714 * Set whether a given genlist item is selected or not
17716 * @param it The item
17717 * @param selected Use @c EINA_TRUE, to make it selected, @c
17718 * EINA_FALSE to make it unselected
17720 * This sets the selected state of an item. If multi selection is
17721 * not enabled on the containing genlist and @p selected is @c
17722 * EINA_TRUE, any other previously selected items will get
17723 * unselected in favor of this new one.
17725 * @see elm_genlist_item_selected_get()
17729 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17731 * Get whether a given genlist item is selected or not
17733 * @param it The item
17734 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17736 * @see elm_genlist_item_selected_set() for more details
17740 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17742 * Sets the expanded state of an item.
17744 * @param it The item
17745 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17747 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17750 * The theme will respond to this change visually, and a signal "expanded" or
17751 * "contracted" will be sent from the genlist with a pointer to the item that
17752 * has been expanded/contracted.
17754 * Calling this function won't show or hide any child of this item (if it is
17755 * a parent). You must manually delete and create them on the callbacks fo
17756 * the "expanded" or "contracted" signals.
17758 * @see elm_genlist_item_expanded_get()
17762 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17764 * Get the expanded state of an item
17766 * @param it The item
17767 * @return The expanded state
17769 * This gets the expanded state of an item.
17771 * @see elm_genlist_item_expanded_set()
17775 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17777 * Get the depth of expanded item
17779 * @param it The genlist item object
17780 * @return The depth of expanded item
17784 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17786 * Set whether a given genlist item is disabled or not.
17788 * @param it The item
17789 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17790 * to enable it back.
17792 * A disabled item cannot be selected or unselected. It will also
17793 * change its appearance, to signal the user it's disabled.
17795 * @see elm_genlist_item_disabled_get()
17799 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17801 * Get whether a given genlist item is disabled or not.
17803 * @param it The item
17804 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17807 * @see elm_genlist_item_disabled_set() for more details
17811 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17813 * Sets the display only state of an item.
17815 * @param it The item
17816 * @param display_only @c EINA_TRUE if the item is display only, @c
17817 * EINA_FALSE otherwise.
17819 * A display only item cannot be selected or unselected. It is for
17820 * display only and not selecting or otherwise clicking, dragging
17821 * etc. by the user, thus finger size rules will not be applied to
17824 * It's good to set group index items to display only state.
17826 * @see elm_genlist_item_display_only_get()
17830 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17832 * Get the display only state of an item
17834 * @param it The item
17835 * @return @c EINA_TRUE if the item is display only, @c
17836 * EINA_FALSE otherwise.
17838 * @see elm_genlist_item_display_only_set()
17842 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17844 * Show the portion of a genlist's internal list containing a given
17845 * item, immediately.
17847 * @param it The item to display
17849 * This causes genlist to jump to the given item @p it and show it (by
17850 * immediately scrolling to that position), if it is not fully visible.
17852 * @see elm_genlist_item_bring_in()
17853 * @see elm_genlist_item_top_show()
17854 * @see elm_genlist_item_middle_show()
17858 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17860 * Animatedly bring in, to the visible are of a genlist, a given
17863 * @param it The item to display
17865 * This causes genlist to jump to the given item @p it and show it (by
17866 * animatedly scrolling), if it is not fully visible. This may use animation
17867 * to do so and take a period of time
17869 * @see elm_genlist_item_show()
17870 * @see elm_genlist_item_top_bring_in()
17871 * @see elm_genlist_item_middle_bring_in()
17875 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17877 * Show the portion of a genlist's internal list containing a given
17878 * item, immediately.
17880 * @param it The item to display
17882 * This causes genlist to jump to the given item @p it and show it (by
17883 * immediately scrolling to that position), if it is not fully visible.
17885 * The item will be positioned at the top of the genlist viewport.
17887 * @see elm_genlist_item_show()
17888 * @see elm_genlist_item_top_bring_in()
17892 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17894 * Animatedly bring in, to the visible are of a genlist, a given
17897 * @param it The item
17899 * This causes genlist to jump to the given item @p it and show it (by
17900 * animatedly scrolling), if it is not fully visible. This may use animation
17901 * to do so and take a period of time
17903 * The item will be positioned at the top of the genlist viewport.
17905 * @see elm_genlist_item_bring_in()
17906 * @see elm_genlist_item_top_show()
17910 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17912 * Show the portion of a genlist's internal list containing a given
17913 * item, immediately.
17915 * @param it The item to display
17917 * This causes genlist to jump to the given item @p it and show it (by
17918 * immediately scrolling to that position), if it is not fully visible.
17920 * The item will be positioned at the middle of the genlist viewport.
17922 * @see elm_genlist_item_show()
17923 * @see elm_genlist_item_middle_bring_in()
17927 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17929 * Animatedly bring in, to the visible are of a genlist, a given
17932 * @param it The item
17934 * This causes genlist to jump to the given item @p it and show it (by
17935 * animatedly scrolling), if it is not fully visible. This may use animation
17936 * to do so and take a period of time
17938 * The item will be positioned at the middle of the genlist viewport.
17940 * @see elm_genlist_item_bring_in()
17941 * @see elm_genlist_item_middle_show()
17945 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17947 * Remove a genlist item from the its parent, deleting it.
17949 * @param item The item to be removed.
17950 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17952 * @see elm_genlist_clear(), to remove all items in a genlist at
17957 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17959 * Return the data associated to a given genlist item
17961 * @param item The genlist item.
17962 * @return the data associated to this item.
17964 * This returns the @c data value passed on the
17965 * elm_genlist_item_append() and related item addition calls.
17967 * @see elm_genlist_item_append()
17968 * @see elm_genlist_item_data_set()
17972 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17974 * Set the data associated to a given genlist item
17976 * @param item The genlist item
17977 * @param data The new data pointer to set on it
17979 * This @b overrides the @c data value passed on the
17980 * elm_genlist_item_append() and related item addition calls. This
17981 * function @b won't call elm_genlist_item_update() automatically,
17982 * so you'd issue it afterwards if you want to hove the item
17983 * updated to reflect the that new data.
17985 * @see elm_genlist_item_data_get()
17989 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17991 * Tells genlist to "orphan" icons fetchs by the item class
17993 * @param it The item
17995 * This instructs genlist to release references to icons in the item,
17996 * meaning that they will no longer be managed by genlist and are
17997 * floating "orphans" that can be re-used elsewhere if the user wants
18002 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18004 * Get the real Evas object created to implement the view of a
18005 * given genlist item
18007 * @param item The genlist item.
18008 * @return the Evas object implementing this item's view.
18010 * This returns the actual Evas object used to implement the
18011 * specified genlist item's view. This may be @c NULL, as it may
18012 * not have been created or may have been deleted, at any time, by
18013 * the genlist. <b>Do not modify this object</b> (move, resize,
18014 * show, hide, etc.), as the genlist is controlling it. This
18015 * function is for querying, emitting custom signals or hooking
18016 * lower level callbacks for events on that object. Do not delete
18017 * this object under any circumstances.
18019 * @see elm_genlist_item_data_get()
18023 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18025 * Update the contents of an item
18027 * @param it The item
18029 * This updates an item by calling all the item class functions again
18030 * to get the icons, labels and states. Use this when the original
18031 * item data has changed and the changes are desired to be reflected.
18033 * Use elm_genlist_realized_items_update() to update all already realized
18036 * @see elm_genlist_realized_items_update()
18040 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18042 * Update the item class of an item
18044 * @param it The item
18045 * @param itc The item class for the item
18047 * This sets another class fo the item, changing the way that it is
18048 * displayed. After changing the item class, elm_genlist_item_update() is
18049 * called on the item @p it.
18053 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18054 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18056 * Set the text to be shown in a given genlist item's tooltips.
18058 * @param item The genlist item
18059 * @param text The text to set in the content
18061 * This call will setup the text to be used as tooltip to that item
18062 * (analogous to elm_object_tooltip_text_set(), but being item
18063 * tooltips with higher precedence than object tooltips). It can
18064 * have only one tooltip at a time, so any previous tooltip data
18065 * will get removed.
18067 * In order to set an icon or something else as a tooltip, look at
18068 * elm_genlist_item_tooltip_content_cb_set().
18072 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18074 * Set the content to be shown in a given genlist item's tooltips
18076 * @param item The genlist item.
18077 * @param func The function returning the tooltip contents.
18078 * @param data What to provide to @a func as callback data/context.
18079 * @param del_cb Called when data is not needed anymore, either when
18080 * another callback replaces @p func, the tooltip is unset with
18081 * elm_genlist_item_tooltip_unset() or the owner @p item
18082 * dies. This callback receives as its first parameter the
18083 * given @p data, being @c event_info the item handle.
18085 * This call will setup the tooltip's contents to @p item
18086 * (analogous to elm_object_tooltip_content_cb_set(), but being
18087 * item tooltips with higher precedence than object tooltips). It
18088 * can have only one tooltip at a time, so any previous tooltip
18089 * content will get removed. @p func (with @p data) will be called
18090 * every time Elementary needs to show the tooltip and it should
18091 * return a valid Evas object, which will be fully managed by the
18092 * tooltip system, getting deleted when the tooltip is gone.
18094 * In order to set just a text as a tooltip, look at
18095 * elm_genlist_item_tooltip_text_set().
18099 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);
18101 * Unset a tooltip from a given genlist item
18103 * @param item genlist item to remove a previously set tooltip from.
18105 * This call removes any tooltip set on @p item. The callback
18106 * provided as @c del_cb to
18107 * elm_genlist_item_tooltip_content_cb_set() will be called to
18108 * notify it is not used anymore (and have resources cleaned, if
18111 * @see elm_genlist_item_tooltip_content_cb_set()
18115 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18117 * Set a different @b style for a given genlist item's tooltip.
18119 * @param item genlist item with tooltip set
18120 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18121 * "default", @c "transparent", etc)
18123 * Tooltips can have <b>alternate styles</b> to be displayed on,
18124 * which are defined by the theme set on Elementary. This function
18125 * works analogously as elm_object_tooltip_style_set(), but here
18126 * applied only to genlist item objects. The default style for
18127 * tooltips is @c "default".
18129 * @note before you set a style you should define a tooltip with
18130 * elm_genlist_item_tooltip_content_cb_set() or
18131 * elm_genlist_item_tooltip_text_set()
18133 * @see elm_genlist_item_tooltip_style_get()
18137 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18139 * Get the style set a given genlist item's tooltip.
18141 * @param item genlist item with tooltip already set on.
18142 * @return style the theme style in use, which defaults to
18143 * "default". If the object does not have a tooltip set,
18144 * then @c NULL is returned.
18146 * @see elm_genlist_item_tooltip_style_set() for more details
18150 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18152 * @brief Disable size restrictions on an object's tooltip
18153 * @param item The tooltip's anchor object
18154 * @param disable If EINA_TRUE, size restrictions are disabled
18155 * @return EINA_FALSE on failure, EINA_TRUE on success
18157 * This function allows a tooltip to expand beyond its parant window's canvas.
18158 * It will instead be limited only by the size of the display.
18160 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18162 * @brief Retrieve size restriction state of an object's tooltip
18163 * @param item The tooltip's anchor object
18164 * @return If EINA_TRUE, size restrictions are disabled
18166 * This function returns whether a tooltip is allowed to expand beyond
18167 * its parant window's canvas.
18168 * It will instead be limited only by the size of the display.
18170 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18172 * Set the type of mouse pointer/cursor decoration to be shown,
18173 * when the mouse pointer is over the given genlist widget item
18175 * @param item genlist item to customize cursor on
18176 * @param cursor the cursor type's name
18178 * This function works analogously as elm_object_cursor_set(), but
18179 * here the cursor's changing area is restricted to the item's
18180 * area, and not the whole widget's. Note that that item cursors
18181 * have precedence over widget cursors, so that a mouse over @p
18182 * item will always show cursor @p type.
18184 * If this function is called twice for an object, a previously set
18185 * cursor will be unset on the second call.
18187 * @see elm_object_cursor_set()
18188 * @see elm_genlist_item_cursor_get()
18189 * @see elm_genlist_item_cursor_unset()
18193 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18195 * Get the type of mouse pointer/cursor decoration set to be shown,
18196 * when the mouse pointer is over the given genlist widget item
18198 * @param item genlist item with custom cursor set
18199 * @return the cursor type's name or @c NULL, if no custom cursors
18200 * were set to @p item (and on errors)
18202 * @see elm_object_cursor_get()
18203 * @see elm_genlist_item_cursor_set() for more details
18204 * @see elm_genlist_item_cursor_unset()
18208 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18210 * Unset any custom mouse pointer/cursor decoration set to be
18211 * shown, when the mouse pointer is over the given genlist widget
18212 * item, thus making it show the @b default cursor again.
18214 * @param item a genlist item
18216 * Use this call to undo any custom settings on this item's cursor
18217 * decoration, bringing it back to defaults (no custom style set).
18219 * @see elm_object_cursor_unset()
18220 * @see elm_genlist_item_cursor_set() for more details
18224 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18226 * Set a different @b style for a given custom cursor set for a
18229 * @param item genlist item with custom cursor set
18230 * @param style the <b>theme style</b> to use (e.g. @c "default",
18231 * @c "transparent", etc)
18233 * This function only makes sense when one is using custom mouse
18234 * cursor decorations <b>defined in a theme file</b> , which can
18235 * have, given a cursor name/type, <b>alternate styles</b> on
18236 * it. It works analogously as elm_object_cursor_style_set(), but
18237 * here applied only to genlist item objects.
18239 * @warning Before you set a cursor style you should have defined a
18240 * custom cursor previously on the item, with
18241 * elm_genlist_item_cursor_set()
18243 * @see elm_genlist_item_cursor_engine_only_set()
18244 * @see elm_genlist_item_cursor_style_get()
18248 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18250 * Get the current @b style set for a given genlist item's custom
18253 * @param item genlist item with custom cursor set.
18254 * @return style the cursor style in use. If the object does not
18255 * have a cursor set, then @c NULL is returned.
18257 * @see elm_genlist_item_cursor_style_set() for more details
18261 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18263 * Set if the (custom) cursor for a given genlist item should be
18264 * searched in its theme, also, or should only rely on the
18265 * rendering engine.
18267 * @param item item with custom (custom) cursor already set on
18268 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18269 * only on those provided by the rendering engine, @c EINA_FALSE to
18270 * have them searched on the widget's theme, as well.
18272 * @note This call is of use only if you've set a custom cursor
18273 * for genlist items, with elm_genlist_item_cursor_set().
18275 * @note By default, cursors will only be looked for between those
18276 * provided by the rendering engine.
18280 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18282 * Get if the (custom) cursor for a given genlist item is being
18283 * searched in its theme, also, or is only relying on the rendering
18286 * @param item a genlist item
18287 * @return @c EINA_TRUE, if cursors are being looked for only on
18288 * those provided by the rendering engine, @c EINA_FALSE if they
18289 * are being searched on the widget's theme, as well.
18291 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18295 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18297 * Update the contents of all realized items.
18299 * @param obj The genlist object.
18301 * This updates all realized items by calling all the item class functions again
18302 * to get the icons, labels and states. Use this when the original
18303 * item data has changed and the changes are desired to be reflected.
18305 * To update just one item, use elm_genlist_item_update().
18307 * @see elm_genlist_realized_items_get()
18308 * @see elm_genlist_item_update()
18312 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18314 * Activate a genlist mode on an item
18316 * @param item The genlist item
18317 * @param mode Mode name
18318 * @param mode_set Boolean to define set or unset mode.
18320 * A genlist mode is a different way of selecting an item. Once a mode is
18321 * activated on an item, any other selected item is immediately unselected.
18322 * This feature provides an easy way of implementing a new kind of animation
18323 * for selecting an item, without having to entirely rewrite the item style
18324 * theme. However, the elm_genlist_selected_* API can't be used to get what
18325 * item is activate for a mode.
18327 * The current item style will still be used, but applying a genlist mode to
18328 * an item will select it using a different kind of animation.
18330 * The current active item for a mode can be found by
18331 * elm_genlist_mode_item_get().
18333 * The characteristics of genlist mode are:
18334 * - Only one mode can be active at any time, and for only one item.
18335 * - Genlist handles deactivating other items when one item is activated.
18336 * - A mode is defined in the genlist theme (edc), and more modes can easily
18338 * - A mode style and the genlist item style are different things. They
18339 * can be combined to provide a default style to the item, with some kind
18340 * of animation for that item when the mode is activated.
18342 * When a mode is activated on an item, a new view for that item is created.
18343 * The theme of this mode defines the animation that will be used to transit
18344 * the item from the old view to the new view. This second (new) view will be
18345 * active for that item while the mode is active on the item, and will be
18346 * destroyed after the mode is totally deactivated from that item.
18348 * @see elm_genlist_mode_get()
18349 * @see elm_genlist_mode_item_get()
18353 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18355 * Get the last (or current) genlist mode used.
18357 * @param obj The genlist object
18359 * This function just returns the name of the last used genlist mode. It will
18360 * be the current mode if it's still active.
18362 * @see elm_genlist_item_mode_set()
18363 * @see elm_genlist_mode_item_get()
18367 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18369 * Get active genlist mode item
18371 * @param obj The genlist object
18372 * @return The active item for that current mode. Or @c NULL if no item is
18373 * activated with any mode.
18375 * This function returns the item that was activated with a mode, by the
18376 * function elm_genlist_item_mode_set().
18378 * @see elm_genlist_item_mode_set()
18379 * @see elm_genlist_mode_get()
18383 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18388 * @param obj The genlist object
18389 * @param reorder_mode The reorder mode
18390 * (EINA_TRUE = on, EINA_FALSE = off)
18394 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18397 * Get the reorder mode
18399 * @param obj The genlist object
18400 * @return The reorder mode
18401 * (EINA_TRUE = on, EINA_FALSE = off)
18405 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18412 * @defgroup Check Check
18414 * @image html img/widget/check/preview-00.png
18415 * @image latex img/widget/check/preview-00.eps
18416 * @image html img/widget/check/preview-01.png
18417 * @image latex img/widget/check/preview-01.eps
18418 * @image html img/widget/check/preview-02.png
18419 * @image latex img/widget/check/preview-02.eps
18421 * @brief The check widget allows for toggling a value between true and
18424 * Check objects are a lot like radio objects in layout and functionality
18425 * except they do not work as a group, but independently and only toggle the
18426 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18427 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18428 * returns the current state. For convenience, like the radio objects, you
18429 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18430 * for it to modify.
18432 * Signals that you can add callbacks for are:
18433 * "changed" - This is called whenever the user changes the state of one of
18434 * the check object(event_info is NULL).
18436 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18440 * @brief Add a new Check object
18442 * @param parent The parent object
18443 * @return The new object or NULL if it cannot be created
18445 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18447 * @brief Set the text label of the check object
18449 * @param obj The check object
18450 * @param label The text label string in UTF-8
18452 * @deprecated use elm_object_text_set() instead.
18454 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18456 * @brief Get the text label of the check object
18458 * @param obj The check object
18459 * @return The text label string in UTF-8
18461 * @deprecated use elm_object_text_get() instead.
18463 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18465 * @brief Set the icon object of the check object
18467 * @param obj The check object
18468 * @param icon The icon object
18470 * Once the icon object is set, a previously set one will be deleted.
18471 * If you want to keep that old content object, use the
18472 * elm_check_icon_unset() function.
18474 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18476 * @brief Get the icon object of the check object
18478 * @param obj The check object
18479 * @return The icon object
18481 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18483 * @brief Unset the icon used for the check object
18485 * @param obj The check object
18486 * @return The icon object that was being used
18488 * Unparent and return the icon object which was set for this widget.
18490 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18492 * @brief Set the on/off state of the check object
18494 * @param obj The check object
18495 * @param state The state to use (1 == on, 0 == off)
18497 * This sets the state of the check. If set
18498 * with elm_check_state_pointer_set() the state of that variable is also
18499 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18501 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18503 * @brief Get the state of the check object
18505 * @param obj The check object
18506 * @return The boolean state
18508 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18510 * @brief Set a convenience pointer to a boolean to change
18512 * @param obj The check object
18513 * @param statep Pointer to the boolean to modify
18515 * This sets a pointer to a boolean, that, in addition to the check objects
18516 * state will also be modified directly. To stop setting the object pointed
18517 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18518 * then when this is called, the check objects state will also be modified to
18519 * reflect the value of the boolean @p statep points to, just like calling
18520 * elm_check_state_set().
18522 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18528 * @defgroup Radio Radio
18530 * @image html img/widget/radio/preview-00.png
18531 * @image latex img/widget/radio/preview-00.eps
18533 * @brief Radio is a widget that allows for 1 or more options to be displayed
18534 * and have the user choose only 1 of them.
18536 * A radio object contains an indicator, an optional Label and an optional
18537 * icon object. While it's possible to have a group of only one radio they,
18538 * are normally used in groups of 2 or more. To add a radio to a group use
18539 * elm_radio_group_add(). The radio object(s) will select from one of a set
18540 * of integer values, so any value they are configuring needs to be mapped to
18541 * a set of integers. To configure what value that radio object represents,
18542 * use elm_radio_state_value_set() to set the integer it represents. To set
18543 * the value the whole group(which one is currently selected) is to indicate
18544 * use elm_radio_value_set() on any group member, and to get the groups value
18545 * use elm_radio_value_get(). For convenience the radio objects are also able
18546 * to directly set an integer(int) to the value that is selected. To specify
18547 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18548 * The radio objects will modify this directly. That implies the pointer must
18549 * point to valid memory for as long as the radio objects exist.
18551 * Signals that you can add callbacks for are:
18552 * @li changed - This is called whenever the user changes the state of one of
18553 * the radio objects within the group of radio objects that work together.
18555 * @ref tutorial_radio show most of this API in action.
18559 * @brief Add a new radio to the parent
18561 * @param parent The parent object
18562 * @return The new object or NULL if it cannot be created
18564 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18566 * @brief Set the text label of the radio object
18568 * @param obj The radio object
18569 * @param label The text label string in UTF-8
18571 * @deprecated use elm_object_text_set() instead.
18573 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18575 * @brief Get the text label of the radio object
18577 * @param obj The radio object
18578 * @return The text label string in UTF-8
18580 * @deprecated use elm_object_text_set() instead.
18582 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18584 * @brief Set the icon object of the radio object
18586 * @param obj The radio object
18587 * @param icon The icon object
18589 * Once the icon object is set, a previously set one will be deleted. If you
18590 * want to keep that old content object, use the elm_radio_icon_unset()
18593 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18595 * @brief Get the icon object of the radio object
18597 * @param obj The radio object
18598 * @return The icon object
18600 * @see elm_radio_icon_set()
18602 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18604 * @brief Unset the icon used for the radio object
18606 * @param obj The radio object
18607 * @return The icon object that was being used
18609 * Unparent and return the icon object which was set for this widget.
18611 * @see elm_radio_icon_set()
18613 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18615 * @brief Add this radio to a group of other radio objects
18617 * @param obj The radio object
18618 * @param group Any object whose group the @p obj is to join.
18620 * Radio objects work in groups. Each member should have a different integer
18621 * value assigned. In order to have them work as a group, they need to know
18622 * about each other. This adds the given radio object to the group of which
18623 * the group object indicated is a member.
18625 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18627 * @brief Set the integer value that this radio object represents
18629 * @param obj The radio object
18630 * @param value The value to use if this radio object is selected
18632 * This sets the value of the radio.
18634 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18636 * @brief Get the integer value that this radio object represents
18638 * @param obj The radio object
18639 * @return The value used if this radio object is selected
18641 * This gets the value of the radio.
18643 * @see elm_radio_value_set()
18645 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18647 * @brief Set the value of the radio.
18649 * @param obj The radio object
18650 * @param value The value to use for the group
18652 * This sets the value of the radio group and will also set the value if
18653 * pointed to, to the value supplied, but will not call any callbacks.
18655 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18657 * @brief Get the state of the radio object
18659 * @param obj The radio object
18660 * @return The integer state
18662 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18664 * @brief Set a convenience pointer to a integer to change
18666 * @param obj The radio object
18667 * @param valuep Pointer to the integer to modify
18669 * This sets a pointer to a integer, that, in addition to the radio objects
18670 * state will also be modified directly. To stop setting the object pointed
18671 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18672 * when this is called, the radio objects state will also be modified to
18673 * reflect the value of the integer valuep points to, just like calling
18674 * elm_radio_value_set().
18676 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18682 * @defgroup Pager Pager
18684 * @image html img/widget/pager/preview-00.png
18685 * @image latex img/widget/pager/preview-00.eps
18687 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18689 * The flipping between “pages” of objects is animated. All content in pager
18690 * is kept in a stack, the last content to be added will be on the top of the
18691 * stack(be visible).
18693 * Objects can be pushed or popped from the stack or deleted as normal.
18694 * Pushes and pops will animate (and a pop will delete the object once the
18695 * animation is finished). Any object already in the pager can be promoted to
18696 * the top(from its current stacking position) through the use of
18697 * elm_pager_content_promote(). Objects are pushed to the top with
18698 * elm_pager_content_push() and when the top item is no longer wanted, simply
18699 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18700 * object is no longer needed and is not the top item, just delete it as
18701 * normal. You can query which objects are the top and bottom with
18702 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18704 * Signals that you can add callbacks for are:
18705 * "hide,finished" - when the previous page is hided
18707 * This widget has the following styles available:
18710 * @li fade_translucide
18711 * @li fade_invisible
18712 * @note This styles affect only the flipping animations, the appearance when
18713 * not animating is unaffected by styles.
18715 * @ref tutorial_pager gives a good overview of the usage of the API.
18719 * Add a new pager to the parent
18721 * @param parent The parent object
18722 * @return The new object or NULL if it cannot be created
18726 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18728 * @brief Push an object to the top of the pager stack (and show it).
18730 * @param obj The pager object
18731 * @param content The object to push
18733 * The object pushed becomes a child of the pager, it will be controlled and
18734 * deleted when the pager is deleted.
18736 * @note If the content is already in the stack use
18737 * elm_pager_content_promote().
18738 * @warning Using this function on @p content already in the stack results in
18739 * undefined behavior.
18741 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18743 * @brief Pop the object that is on top of the stack
18745 * @param obj The pager object
18747 * This pops the object that is on the top(visible) of the pager, makes it
18748 * disappear, then deletes the object. The object that was underneath it on
18749 * the stack will become visible.
18751 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18753 * @brief Moves an object already in the pager stack to the top of the stack.
18755 * @param obj The pager object
18756 * @param content The object to promote
18758 * This will take the @p content and move it to the top of the stack as
18759 * if it had been pushed there.
18761 * @note If the content isn't already in the stack use
18762 * elm_pager_content_push().
18763 * @warning Using this function on @p content not already in the stack
18764 * results in undefined behavior.
18766 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18768 * @brief Return the object at the bottom of the pager stack
18770 * @param obj The pager object
18771 * @return The bottom object or NULL if none
18773 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18775 * @brief Return the object at the top of the pager stack
18777 * @param obj The pager object
18778 * @return The top object or NULL if none
18780 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18786 * @defgroup Slideshow Slideshow
18788 * @image html img/widget/slideshow/preview-00.png
18789 * @image latex img/widget/slideshow/preview-00.eps
18791 * This widget, as the name indicates, is a pre-made image
18792 * slideshow panel, with API functions acting on (child) image
18793 * items presentation. Between those actions, are:
18794 * - advance to next/previous image
18795 * - select the style of image transition animation
18796 * - set the exhibition time for each image
18797 * - start/stop the slideshow
18799 * The transition animations are defined in the widget's theme,
18800 * consequently new animations can be added without having to
18801 * update the widget's code.
18803 * @section Slideshow_Items Slideshow items
18805 * For slideshow items, just like for @ref Genlist "genlist" ones,
18806 * the user defines a @b classes, specifying functions that will be
18807 * called on the item's creation and deletion times.
18809 * The #Elm_Slideshow_Item_Class structure contains the following
18812 * - @c func.get - When an item is displayed, this function is
18813 * called, and it's where one should create the item object, de
18814 * facto. For example, the object can be a pure Evas image object
18815 * or an Elementary @ref Photocam "photocam" widget. See
18816 * #SlideshowItemGetFunc.
18817 * - @c func.del - When an item is no more displayed, this function
18818 * is called, where the user must delete any data associated to
18819 * the item. See #SlideshowItemDelFunc.
18821 * @section Slideshow_Caching Slideshow caching
18823 * The slideshow provides facilities to have items adjacent to the
18824 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18825 * you, so that the system does not have to decode image data
18826 * anymore at the time it has to actually switch images on its
18827 * viewport. The user is able to set the numbers of items to be
18828 * cached @b before and @b after the current item, in the widget's
18831 * Smart events one can add callbacks for are:
18833 * - @c "changed" - when the slideshow switches its view to a new
18836 * List of examples for the slideshow widget:
18837 * @li @ref slideshow_example
18841 * @addtogroup Slideshow
18845 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18846 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18847 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18848 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18849 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18852 * @struct _Elm_Slideshow_Item_Class
18854 * Slideshow item class definition. See @ref Slideshow_Items for
18857 struct _Elm_Slideshow_Item_Class
18859 struct _Elm_Slideshow_Item_Class_Func
18861 SlideshowItemGetFunc get;
18862 SlideshowItemDelFunc del;
18864 }; /**< #Elm_Slideshow_Item_Class member definitions */
18867 * Add a new slideshow widget to the given parent Elementary
18868 * (container) object
18870 * @param parent The parent object
18871 * @return A new slideshow widget handle or @c NULL, on errors
18873 * This function inserts a new slideshow widget on the canvas.
18875 * @ingroup Slideshow
18877 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18880 * Add (append) a new item in a given slideshow widget.
18882 * @param obj The slideshow object
18883 * @param itc The item class for the item
18884 * @param data The item's data
18885 * @return A handle to the item added or @c NULL, on errors
18887 * Add a new item to @p obj's internal list of items, appending it.
18888 * The item's class must contain the function really fetching the
18889 * image object to show for this item, which could be an Evas image
18890 * object or an Elementary photo, for example. The @p data
18891 * parameter is going to be passed to both class functions of the
18894 * @see #Elm_Slideshow_Item_Class
18895 * @see elm_slideshow_item_sorted_insert()
18897 * @ingroup Slideshow
18899 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18902 * Insert a new item into the given slideshow widget, using the @p func
18903 * function to sort items (by item handles).
18905 * @param obj The slideshow object
18906 * @param itc The item class for the item
18907 * @param data The item's data
18908 * @param func The comparing function to be used to sort slideshow
18909 * items <b>by #Elm_Slideshow_Item item handles</b>
18910 * @return Returns The slideshow item handle, on success, or
18911 * @c NULL, on errors
18913 * Add a new item to @p obj's internal list of items, in a position
18914 * determined by the @p func comparing function. The item's class
18915 * must contain the function really fetching the image object to
18916 * show for this item, which could be an Evas image object or an
18917 * Elementary photo, for example. The @p data parameter is going to
18918 * be passed to both class functions of the item.
18920 * @see #Elm_Slideshow_Item_Class
18921 * @see elm_slideshow_item_add()
18923 * @ingroup Slideshow
18925 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);
18928 * Display a given slideshow widget's item, programmatically.
18930 * @param obj The slideshow object
18931 * @param item The item to display on @p obj's viewport
18933 * The change between the current item and @p item will use the
18934 * transition @p obj is set to use (@see
18935 * elm_slideshow_transition_set()).
18937 * @ingroup Slideshow
18939 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18942 * Slide to the @b next item, in a given slideshow widget
18944 * @param obj The slideshow object
18946 * The sliding animation @p obj is set to use will be the
18947 * transition effect used, after this call is issued.
18949 * @note If the end of the slideshow's internal list of items is
18950 * reached, it'll wrap around to the list's beginning, again.
18952 * @ingroup Slideshow
18954 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18957 * Slide to the @b previous item, in a given slideshow widget
18959 * @param obj The slideshow object
18961 * The sliding animation @p obj is set to use will be the
18962 * transition effect used, after this call is issued.
18964 * @note If the beginning of the slideshow's internal list of items
18965 * is reached, it'll wrap around to the list's end, again.
18967 * @ingroup Slideshow
18969 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18972 * Returns the list of sliding transition/effect names available, for a
18973 * given slideshow widget.
18975 * @param obj The slideshow object
18976 * @return The list of transitions (list of @b stringshared strings
18979 * The transitions, which come from @p obj's theme, must be an EDC
18980 * data item named @c "transitions" on the theme file, with (prefix)
18981 * names of EDC programs actually implementing them.
18983 * The available transitions for slideshows on the default theme are:
18984 * - @c "fade" - the current item fades out, while the new one
18985 * fades in to the slideshow's viewport.
18986 * - @c "black_fade" - the current item fades to black, and just
18987 * then, the new item will fade in.
18988 * - @c "horizontal" - the current item slides horizontally, until
18989 * it gets out of the slideshow's viewport, while the new item
18990 * comes from the left to take its place.
18991 * - @c "vertical" - the current item slides vertically, until it
18992 * gets out of the slideshow's viewport, while the new item comes
18993 * from the bottom to take its place.
18994 * - @c "square" - the new item starts to appear from the middle of
18995 * the current one, but with a tiny size, growing until its
18996 * target (full) size and covering the old one.
18998 * @warning The stringshared strings get no new references
18999 * exclusive to the user grabbing the list, here, so if you'd like
19000 * to use them out of this call's context, you'd better @c
19001 * eina_stringshare_ref() them.
19003 * @see elm_slideshow_transition_set()
19005 * @ingroup Slideshow
19007 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19010 * Set the current slide transition/effect in use for a given
19013 * @param obj The slideshow object
19014 * @param transition The new transition's name string
19016 * If @p transition is implemented in @p obj's theme (i.e., is
19017 * contained in the list returned by
19018 * elm_slideshow_transitions_get()), this new sliding effect will
19019 * be used on the widget.
19021 * @see elm_slideshow_transitions_get() for more details
19023 * @ingroup Slideshow
19025 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
19028 * Get the current slide transition/effect in use for a given
19031 * @param obj The slideshow object
19032 * @return The current transition's name
19034 * @see elm_slideshow_transition_set() for more details
19036 * @ingroup Slideshow
19038 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19041 * Set the interval between each image transition on a given
19042 * slideshow widget, <b>and start the slideshow, itself</b>
19044 * @param obj The slideshow object
19045 * @param timeout The new displaying timeout for images
19047 * After this call, the slideshow widget will start cycling its
19048 * view, sequentially and automatically, with the images of the
19049 * items it has. The time between each new image displayed is going
19050 * to be @p timeout, in @b seconds. If a different timeout was set
19051 * previously and an slideshow was in progress, it will continue
19052 * with the new time between transitions, after this call.
19054 * @note A value less than or equal to 0 on @p timeout will disable
19055 * the widget's internal timer, thus halting any slideshow which
19056 * could be happening on @p obj.
19058 * @see elm_slideshow_timeout_get()
19060 * @ingroup Slideshow
19062 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19065 * Get the interval set for image transitions on a given slideshow
19068 * @param obj The slideshow object
19069 * @return Returns the timeout set on it
19071 * @see elm_slideshow_timeout_set() for more details
19073 * @ingroup Slideshow
19075 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19078 * Set if, after a slideshow is started, for a given slideshow
19079 * widget, its items should be displayed cyclically or not.
19081 * @param obj The slideshow object
19082 * @param loop Use @c EINA_TRUE to make it cycle through items or
19083 * @c EINA_FALSE for it to stop at the end of @p obj's internal
19086 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19087 * ignore what is set by this functions, i.e., they'll @b always
19088 * cycle through items. This affects only the "automatic"
19089 * slideshow, as set by elm_slideshow_timeout_set().
19091 * @see elm_slideshow_loop_get()
19093 * @ingroup Slideshow
19095 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19098 * Get if, after a slideshow is started, for a given slideshow
19099 * widget, its items are to be displayed cyclically or not.
19101 * @param obj The slideshow object
19102 * @return @c EINA_TRUE, if the items in @p obj will be cycled
19103 * through or @c EINA_FALSE, otherwise
19105 * @see elm_slideshow_loop_set() for more details
19107 * @ingroup Slideshow
19109 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19112 * Remove all items from a given slideshow widget
19114 * @param obj The slideshow object
19116 * This removes (and deletes) all items in @p obj, leaving it
19119 * @see elm_slideshow_item_del(), to remove just one item.
19121 * @ingroup Slideshow
19123 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19126 * Get the internal list of items in a given slideshow widget.
19128 * @param obj The slideshow object
19129 * @return The list of items (#Elm_Slideshow_Item as data) or
19130 * @c NULL on errors.
19132 * This list is @b not to be modified in any way and must not be
19133 * freed. Use the list members with functions like
19134 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19136 * @warning This list is only valid until @p obj object's internal
19137 * items list is changed. It should be fetched again with another
19138 * call to this function when changes happen.
19140 * @ingroup Slideshow
19142 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19145 * Delete a given item from a slideshow widget.
19147 * @param item The slideshow item
19149 * @ingroup Slideshow
19151 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19154 * Return the data associated with a given slideshow item
19156 * @param item The slideshow item
19157 * @return Returns the data associated to this item
19159 * @ingroup Slideshow
19161 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19164 * Returns the currently displayed item, in a given slideshow widget
19166 * @param obj The slideshow object
19167 * @return A handle to the item being displayed in @p obj or
19168 * @c NULL, if none is (and on errors)
19170 * @ingroup Slideshow
19172 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19175 * Get the real Evas object created to implement the view of a
19176 * given slideshow item
19178 * @param item The slideshow item.
19179 * @return the Evas object implementing this item's view.
19181 * This returns the actual Evas object used to implement the
19182 * specified slideshow item's view. This may be @c NULL, as it may
19183 * not have been created or may have been deleted, at any time, by
19184 * the slideshow. <b>Do not modify this object</b> (move, resize,
19185 * show, hide, etc.), as the slideshow is controlling it. This
19186 * function is for querying, emitting custom signals or hooking
19187 * lower level callbacks for events on that object. Do not delete
19188 * this object under any circumstances.
19190 * @see elm_slideshow_item_data_get()
19192 * @ingroup Slideshow
19194 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19197 * Get the the item, in a given slideshow widget, placed at
19198 * position @p nth, in its internal items list
19200 * @param obj The slideshow object
19201 * @param nth The number of the item to grab a handle to (0 being
19203 * @return The item stored in @p obj at position @p nth or @c NULL,
19204 * if there's no item with that index (and on errors)
19206 * @ingroup Slideshow
19208 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19211 * Set the current slide layout in use for a given slideshow widget
19213 * @param obj The slideshow object
19214 * @param layout The new layout's name string
19216 * If @p layout is implemented in @p obj's theme (i.e., is contained
19217 * in the list returned by elm_slideshow_layouts_get()), this new
19218 * images layout will be used on the widget.
19220 * @see elm_slideshow_layouts_get() for more details
19222 * @ingroup Slideshow
19224 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19227 * Get the current slide layout in use for a given slideshow widget
19229 * @param obj The slideshow object
19230 * @return The current layout's name
19232 * @see elm_slideshow_layout_set() for more details
19234 * @ingroup Slideshow
19236 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19239 * Returns the list of @b layout names available, for a given
19240 * slideshow widget.
19242 * @param obj The slideshow object
19243 * @return The list of layouts (list of @b stringshared strings
19246 * Slideshow layouts will change how the widget is to dispose each
19247 * image item in its viewport, with regard to cropping, scaling,
19250 * The layouts, which come from @p obj's theme, must be an EDC
19251 * data item name @c "layouts" on the theme file, with (prefix)
19252 * names of EDC programs actually implementing them.
19254 * The available layouts for slideshows on the default theme are:
19255 * - @c "fullscreen" - item images with original aspect, scaled to
19256 * touch top and down slideshow borders or, if the image's heigh
19257 * is not enough, left and right slideshow borders.
19258 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19259 * one, but always leaving 10% of the slideshow's dimensions of
19260 * distance between the item image's borders and the slideshow
19261 * borders, for each axis.
19263 * @warning The stringshared strings get no new references
19264 * exclusive to the user grabbing the list, here, so if you'd like
19265 * to use them out of this call's context, you'd better @c
19266 * eina_stringshare_ref() them.
19268 * @see elm_slideshow_layout_set()
19270 * @ingroup Slideshow
19272 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19275 * Set the number of items to cache, on a given slideshow widget,
19276 * <b>before the current item</b>
19278 * @param obj The slideshow object
19279 * @param count Number of items to cache before the current one
19281 * The default value for this property is @c 2. See
19282 * @ref Slideshow_Caching "slideshow caching" for more details.
19284 * @see elm_slideshow_cache_before_get()
19286 * @ingroup Slideshow
19288 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19291 * Retrieve the number of items to cache, on a given slideshow widget,
19292 * <b>before the current item</b>
19294 * @param obj The slideshow object
19295 * @return The number of items set to be cached before the current one
19297 * @see elm_slideshow_cache_before_set() for more details
19299 * @ingroup Slideshow
19301 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19304 * Set the number of items to cache, on a given slideshow widget,
19305 * <b>after the current item</b>
19307 * @param obj The slideshow object
19308 * @param count Number of items to cache after the current one
19310 * The default value for this property is @c 2. See
19311 * @ref Slideshow_Caching "slideshow caching" for more details.
19313 * @see elm_slideshow_cache_after_get()
19315 * @ingroup Slideshow
19317 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19320 * Retrieve the number of items to cache, on a given slideshow widget,
19321 * <b>after the current item</b>
19323 * @param obj The slideshow object
19324 * @return The number of items set to be cached after the current one
19326 * @see elm_slideshow_cache_after_set() for more details
19328 * @ingroup Slideshow
19330 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19333 * Get the number of items stored in a given slideshow widget
19335 * @param obj The slideshow object
19336 * @return The number of items on @p obj, at the moment of this call
19338 * @ingroup Slideshow
19340 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19347 * @defgroup Fileselector File Selector
19349 * @image html img/widget/fileselector/preview-00.png
19350 * @image latex img/widget/fileselector/preview-00.eps
19352 * A file selector is a widget that allows a user to navigate
19353 * through a file system, reporting file selections back via its
19356 * It contains shortcut buttons for home directory (@c ~) and to
19357 * jump one directory upwards (..), as well as cancel/ok buttons to
19358 * confirm/cancel a given selection. After either one of those two
19359 * former actions, the file selector will issue its @c "done" smart
19362 * There's a text entry on it, too, showing the name of the current
19363 * selection. There's the possibility of making it editable, so it
19364 * is useful on file saving dialogs on applications, where one
19365 * gives a file name to save contents to, in a given directory in
19366 * the system. This custom file name will be reported on the @c
19367 * "done" smart callback (explained in sequence).
19369 * Finally, it has a view to display file system items into in two
19374 * If Elementary is built with support of the Ethumb thumbnailing
19375 * library, the second form of view will display preview thumbnails
19376 * of files which it supports.
19378 * Smart callbacks one can register to:
19380 * - @c "selected" - the user has clicked on a file (when not in
19381 * folders-only mode) or directory (when in folders-only mode)
19382 * - @c "directory,open" - the list has been populated with new
19383 * content (@c event_info is a pointer to the directory's
19384 * path, a @b stringshared string)
19385 * - @c "done" - the user has clicked on the "ok" or "cancel"
19386 * buttons (@c event_info is a pointer to the selection's
19387 * path, a @b stringshared string)
19389 * Here is an example on its usage:
19390 * @li @ref fileselector_example
19394 * @addtogroup Fileselector
19399 * Defines how a file selector widget is to layout its contents
19400 * (file system entries).
19402 typedef enum _Elm_Fileselector_Mode
19404 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19405 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19406 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19407 } Elm_Fileselector_Mode;
19410 * Add a new file selector widget to the given parent Elementary
19411 * (container) object
19413 * @param parent The parent object
19414 * @return a new file selector widget handle or @c NULL, on errors
19416 * This function inserts a new file selector widget on the canvas.
19418 * @ingroup Fileselector
19420 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19423 * Enable/disable the file name entry box where the user can type
19424 * in a name for a file, in a given file selector widget
19426 * @param obj The file selector object
19427 * @param is_save @c EINA_TRUE to make the file selector a "saving
19428 * dialog", @c EINA_FALSE otherwise
19430 * Having the entry editable is useful on file saving dialogs on
19431 * applications, where one gives a file name to save contents to,
19432 * in a given directory in the system. This custom file name will
19433 * be reported on the @c "done" smart callback.
19435 * @see elm_fileselector_is_save_get()
19437 * @ingroup Fileselector
19439 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19442 * Get whether the given file selector is in "saving dialog" mode
19444 * @param obj The file selector object
19445 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19446 * mode, @c EINA_FALSE otherwise (and on errors)
19448 * @see elm_fileselector_is_save_set() for more details
19450 * @ingroup Fileselector
19452 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19455 * Enable/disable folder-only view for a given file selector widget
19457 * @param obj The file selector object
19458 * @param only @c EINA_TRUE to make @p obj only display
19459 * directories, @c EINA_FALSE to make files to be displayed in it
19462 * If enabled, the widget's view will only display folder items,
19465 * @see elm_fileselector_folder_only_get()
19467 * @ingroup Fileselector
19469 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19472 * Get whether folder-only view is set for a given file selector
19475 * @param obj The file selector object
19476 * @return only @c EINA_TRUE if @p obj is only displaying
19477 * directories, @c EINA_FALSE if files are being displayed in it
19478 * too (and on errors)
19480 * @see elm_fileselector_folder_only_get()
19482 * @ingroup Fileselector
19484 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19487 * Enable/disable the "ok" and "cancel" buttons on a given file
19490 * @param obj The file selector object
19491 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19493 * @note A file selector without those buttons will never emit the
19494 * @c "done" smart event, and is only usable if one is just hooking
19495 * to the other two events.
19497 * @see elm_fileselector_buttons_ok_cancel_get()
19499 * @ingroup Fileselector
19501 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19504 * Get whether the "ok" and "cancel" buttons on a given file
19505 * selector widget are being shown.
19507 * @param obj The file selector object
19508 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19509 * otherwise (and on errors)
19511 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19513 * @ingroup Fileselector
19515 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19518 * Enable/disable a tree view in the given file selector widget,
19519 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19521 * @param obj The file selector object
19522 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19525 * In a tree view, arrows are created on the sides of directories,
19526 * allowing them to expand in place.
19528 * @note If it's in other mode, the changes made by this function
19529 * will only be visible when one switches back to "list" mode.
19531 * @see elm_fileselector_expandable_get()
19533 * @ingroup Fileselector
19535 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19538 * Get whether tree view is enabled for the given file selector
19541 * @param obj The file selector object
19542 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19543 * otherwise (and or errors)
19545 * @see elm_fileselector_expandable_set() for more details
19547 * @ingroup Fileselector
19549 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19552 * Set, programmatically, the @b directory that a given file
19553 * selector widget will display contents from
19555 * @param obj The file selector object
19556 * @param path The path to display in @p obj
19558 * This will change the @b directory that @p obj is displaying. It
19559 * will also clear the text entry area on the @p obj object, which
19560 * displays select files' names.
19562 * @see elm_fileselector_path_get()
19564 * @ingroup Fileselector
19566 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19569 * Get the parent directory's path that a given file selector
19570 * widget is displaying
19572 * @param obj The file selector object
19573 * @return The (full) path of the directory the file selector is
19574 * displaying, a @b stringshared string
19576 * @see elm_fileselector_path_set()
19578 * @ingroup Fileselector
19580 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19583 * Set, programmatically, the currently selected file/directory in
19584 * the given file selector widget
19586 * @param obj The file selector object
19587 * @param path The (full) path to a file or directory
19588 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19589 * latter case occurs if the directory or file pointed to do not
19592 * @see elm_fileselector_selected_get()
19594 * @ingroup Fileselector
19596 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19599 * Get the currently selected item's (full) path, in the given file
19602 * @param obj The file selector object
19603 * @return The absolute path of the selected item, a @b
19604 * stringshared string
19606 * @note Custom editions on @p obj object's text entry, if made,
19607 * will appear on the return string of this function, naturally.
19609 * @see elm_fileselector_selected_set() for more details
19611 * @ingroup Fileselector
19613 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19616 * Set the mode in which a given file selector widget will display
19617 * (layout) file system entries in its view
19619 * @param obj The file selector object
19620 * @param mode The mode of the fileselector, being it one of
19621 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19622 * first one, naturally, will display the files in a list. The
19623 * latter will make the widget to display its entries in a grid
19626 * @note By using elm_fileselector_expandable_set(), the user may
19627 * trigger a tree view for that list.
19629 * @note If Elementary is built with support of the Ethumb
19630 * thumbnailing library, the second form of view will display
19631 * preview thumbnails of files which it supports. You must have
19632 * elm_need_ethumb() called in your Elementary for thumbnailing to
19635 * @see elm_fileselector_expandable_set().
19636 * @see elm_fileselector_mode_get().
19638 * @ingroup Fileselector
19640 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19643 * Get the mode in which a given file selector widget is displaying
19644 * (layouting) file system entries in its view
19646 * @param obj The fileselector object
19647 * @return The mode in which the fileselector is at
19649 * @see elm_fileselector_mode_set() for more details
19651 * @ingroup Fileselector
19653 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19660 * @defgroup Progressbar Progress bar
19662 * The progress bar is a widget for visually representing the
19663 * progress status of a given job/task.
19665 * A progress bar may be horizontal or vertical. It may display an
19666 * icon besides it, as well as primary and @b units labels. The
19667 * former is meant to label the widget as a whole, while the
19668 * latter, which is formatted with floating point values (and thus
19669 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19670 * units"</c>), is meant to label the widget's <b>progress
19671 * value</b>. Label, icon and unit strings/objects are @b optional
19672 * for progress bars.
19674 * A progress bar may be @b inverted, in which state it gets its
19675 * values inverted, with high values being on the left or top and
19676 * low values on the right or bottom, as opposed to normally have
19677 * the low values on the former and high values on the latter,
19678 * respectively, for horizontal and vertical modes.
19680 * The @b span of the progress, as set by
19681 * elm_progressbar_span_size_set(), is its length (horizontally or
19682 * vertically), unless one puts size hints on the widget to expand
19683 * on desired directions, by any container. That length will be
19684 * scaled by the object or applications scaling factor. At any
19685 * point code can query the progress bar for its value with
19686 * elm_progressbar_value_get().
19688 * Available widget styles for progress bars:
19690 * - @c "wheel" (simple style, no text, no progression, only
19691 * "pulse" effect is available)
19693 * Here is an example on its usage:
19694 * @li @ref progressbar_example
19698 * Add a new progress bar widget to the given parent Elementary
19699 * (container) object
19701 * @param parent The parent object
19702 * @return a new progress bar widget handle or @c NULL, on errors
19704 * This function inserts a new progress bar widget on the canvas.
19706 * @ingroup Progressbar
19708 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19711 * Set whether a given progress bar widget is at "pulsing mode" or
19714 * @param obj The progress bar object
19715 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19716 * @c EINA_FALSE to put it back to its default one
19718 * By default, progress bars will display values from the low to
19719 * high value boundaries. There are, though, contexts in which the
19720 * state of progression of a given task is @b unknown. For those,
19721 * one can set a progress bar widget to a "pulsing state", to give
19722 * the user an idea that some computation is being held, but
19723 * without exact progress values. In the default theme it will
19724 * animate its bar with the contents filling in constantly and back
19725 * to non-filled, in a loop. To start and stop this pulsing
19726 * animation, one has to explicitly call elm_progressbar_pulse().
19728 * @see elm_progressbar_pulse_get()
19729 * @see elm_progressbar_pulse()
19731 * @ingroup Progressbar
19733 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19736 * Get whether a given progress bar widget is at "pulsing mode" or
19739 * @param obj The progress bar object
19740 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19741 * if it's in the default one (and on errors)
19743 * @ingroup Progressbar
19745 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19748 * Start/stop a given progress bar "pulsing" animation, if its
19751 * @param obj The progress bar object
19752 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19753 * @c EINA_FALSE to @b stop it
19755 * @note This call won't do anything if @p obj is not under "pulsing mode".
19757 * @see elm_progressbar_pulse_set() for more details.
19759 * @ingroup Progressbar
19761 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19764 * Set the progress value (in percentage) on a given progress bar
19767 * @param obj The progress bar object
19768 * @param val The progress value (@b must be between @c 0.0 and @c
19771 * Use this call to set progress bar levels.
19773 * @note If you passes a value out of the specified range for @p
19774 * val, it will be interpreted as the @b closest of the @b boundary
19775 * values in the range.
19777 * @ingroup Progressbar
19779 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19782 * Get the progress value (in percentage) on a given progress bar
19785 * @param obj The progress bar object
19786 * @return The value of the progressbar
19788 * @see elm_progressbar_value_set() for more details
19790 * @ingroup Progressbar
19792 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19795 * Set the label of a given progress bar widget
19797 * @param obj The progress bar object
19798 * @param label The text label string, in UTF-8
19800 * @ingroup Progressbar
19801 * @deprecated use elm_object_text_set() instead.
19803 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19806 * Get the label of a given progress bar widget
19808 * @param obj The progressbar object
19809 * @return The text label string, in UTF-8
19811 * @ingroup Progressbar
19812 * @deprecated use elm_object_text_set() instead.
19814 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19817 * Set the icon object of a given progress bar widget
19819 * @param obj The progress bar object
19820 * @param icon The icon object
19822 * Use this call to decorate @p obj with an icon next to it.
19824 * @note Once the icon object is set, a previously set one will be
19825 * deleted. If you want to keep that old content object, use the
19826 * elm_progressbar_icon_unset() function.
19828 * @see elm_progressbar_icon_get()
19830 * @ingroup Progressbar
19832 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19835 * Retrieve the icon object set for a given progress bar widget
19837 * @param obj The progress bar object
19838 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19839 * otherwise (and on errors)
19841 * @see elm_progressbar_icon_set() for more details
19843 * @ingroup Progressbar
19845 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19848 * Unset an icon set on a given progress bar widget
19850 * @param obj The progress bar object
19851 * @return The icon object that was being used, if any was set, or
19852 * @c NULL, otherwise (and on errors)
19854 * This call will unparent and return the icon object which was set
19855 * for this widget, previously, on success.
19857 * @see elm_progressbar_icon_set() for more details
19859 * @ingroup Progressbar
19861 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19864 * Set the (exact) length of the bar region of a given progress bar
19867 * @param obj The progress bar object
19868 * @param size The length of the progress bar's bar region
19870 * This sets the minimum width (when in horizontal mode) or height
19871 * (when in vertical mode) of the actual bar area of the progress
19872 * bar @p obj. This in turn affects the object's minimum size. Use
19873 * this when you're not setting other size hints expanding on the
19874 * given direction (like weight and alignment hints) and you would
19875 * like it to have a specific size.
19877 * @note Icon, label and unit text around @p obj will require their
19878 * own space, which will make @p obj to require more the @p size,
19881 * @see elm_progressbar_span_size_get()
19883 * @ingroup Progressbar
19885 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19888 * Get the length set for the bar region of a given progress bar
19891 * @param obj The progress bar object
19892 * @return The length of the progress bar's bar region
19894 * If that size was not set previously, with
19895 * elm_progressbar_span_size_set(), this call will return @c 0.
19897 * @ingroup Progressbar
19899 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19902 * Set the format string for a given progress bar widget's units
19905 * @param obj The progress bar object
19906 * @param format The format string for @p obj's units label
19908 * If @c NULL is passed on @p format, it will make @p obj's units
19909 * area to be hidden completely. If not, it'll set the <b>format
19910 * string</b> for the units label's @b text. The units label is
19911 * provided a floating point value, so the units text is up display
19912 * at most one floating point falue. Note that the units label is
19913 * optional. Use a format string such as "%1.2f meters" for
19916 * @note The default format string for a progress bar is an integer
19917 * percentage, as in @c "%.0f %%".
19919 * @see elm_progressbar_unit_format_get()
19921 * @ingroup Progressbar
19923 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19926 * Retrieve the format string set for a given progress bar widget's
19929 * @param obj The progress bar object
19930 * @return The format set string for @p obj's units label or
19931 * @c NULL, if none was set (and on errors)
19933 * @see elm_progressbar_unit_format_set() for more details
19935 * @ingroup Progressbar
19937 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19940 * Set the orientation of a given progress bar widget
19942 * @param obj The progress bar object
19943 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19944 * @b horizontal, @c EINA_FALSE to make it @b vertical
19946 * Use this function to change how your progress bar is to be
19947 * disposed: vertically or horizontally.
19949 * @see elm_progressbar_horizontal_get()
19951 * @ingroup Progressbar
19953 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19956 * Retrieve the orientation of a given progress bar widget
19958 * @param obj The progress bar object
19959 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19960 * @c EINA_FALSE if it's @b vertical (and on errors)
19962 * @see elm_progressbar_horizontal_set() for more details
19964 * @ingroup Progressbar
19966 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19969 * Invert a given progress bar widget's displaying values order
19971 * @param obj The progress bar object
19972 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19973 * @c EINA_FALSE to bring it back to default, non-inverted values.
19975 * A progress bar may be @b inverted, in which state it gets its
19976 * values inverted, with high values being on the left or top and
19977 * low values on the right or bottom, as opposed to normally have
19978 * the low values on the former and high values on the latter,
19979 * respectively, for horizontal and vertical modes.
19981 * @see elm_progressbar_inverted_get()
19983 * @ingroup Progressbar
19985 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19988 * Get whether a given progress bar widget's displaying values are
19991 * @param obj The progress bar object
19992 * @return @c EINA_TRUE, if @p obj has inverted values,
19993 * @c EINA_FALSE otherwise (and on errors)
19995 * @see elm_progressbar_inverted_set() for more details
19997 * @ingroup Progressbar
19999 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20002 * @defgroup Separator Separator
20004 * @brief Separator is a very thin object used to separate other objects.
20006 * A separator can be vertical or horizontal.
20008 * @ref tutorial_separator is a good example of how to use a separator.
20012 * @brief Add a separator object to @p parent
20014 * @param parent The parent object
20016 * @return The separator object, or NULL upon failure
20018 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20020 * @brief Set the horizontal mode of a separator object
20022 * @param obj The separator object
20023 * @param horizontal If true, the separator is horizontal
20025 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20027 * @brief Get the horizontal mode of a separator object
20029 * @param obj The separator object
20030 * @return If true, the separator is horizontal
20032 * @see elm_separator_horizontal_set()
20034 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20040 * @defgroup Spinner Spinner
20041 * @ingroup Elementary
20043 * @image html img/widget/spinner/preview-00.png
20044 * @image latex img/widget/spinner/preview-00.eps
20046 * A spinner is a widget which allows the user to increase or decrease
20047 * numeric values using arrow buttons, or edit values directly, clicking
20048 * over it and typing the new value.
20050 * By default the spinner will not wrap and has a label
20051 * of "%.0f" (just showing the integer value of the double).
20053 * A spinner has a label that is formatted with floating
20054 * point values and thus accepts a printf-style format string, like
20057 * It also allows specific values to be replaced by pre-defined labels.
20059 * Smart callbacks one can register to:
20061 * - "changed" - Whenever the spinner value is changed.
20062 * - "delay,changed" - A short time after the value is changed by the user.
20063 * This will be called only when the user stops dragging for a very short
20064 * period or when they release their finger/mouse, so it avoids possibly
20065 * expensive reactions to the value change.
20067 * Available styles for it:
20069 * - @c "vertical": up/down buttons at the right side and text left aligned.
20071 * Here is an example on its usage:
20072 * @ref spinner_example
20076 * @addtogroup Spinner
20081 * Add a new spinner widget to the given parent Elementary
20082 * (container) object.
20084 * @param parent The parent object.
20085 * @return a new spinner widget handle or @c NULL, on errors.
20087 * This function inserts a new spinner widget on the canvas.
20092 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20095 * Set the format string of the displayed label.
20097 * @param obj The spinner object.
20098 * @param fmt The format string for the label display.
20100 * If @c NULL, this sets the format to "%.0f". If not it sets the format
20101 * string for the label text. The label text is provided a floating point
20102 * value, so the label text can display up to 1 floating point value.
20103 * Note that this is optional.
20105 * Use a format string such as "%1.2f meters" for example, and it will
20106 * display values like: "3.14 meters" for a value equal to 3.14159.
20108 * Default is "%0.f".
20110 * @see elm_spinner_label_format_get()
20114 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20117 * Get the label format of the spinner.
20119 * @param obj The spinner object.
20120 * @return The text label format string in UTF-8.
20122 * @see elm_spinner_label_format_set() for details.
20126 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20129 * Set the minimum and maximum values for the spinner.
20131 * @param obj The spinner object.
20132 * @param min The minimum value.
20133 * @param max The maximum value.
20135 * Define the allowed range of values to be selected by the user.
20137 * If actual value is less than @p min, it will be updated to @p min. If it
20138 * is bigger then @p max, will be updated to @p max. Actual value can be
20139 * get with elm_spinner_value_get().
20141 * By default, min is equal to 0, and max is equal to 100.
20143 * @warning Maximum must be greater than minimum.
20145 * @see elm_spinner_min_max_get()
20149 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20152 * Get the minimum and maximum values of the spinner.
20154 * @param obj The spinner object.
20155 * @param min Pointer where to store the minimum value.
20156 * @param max Pointer where to store the maximum value.
20158 * @note If only one value is needed, the other pointer can be passed
20161 * @see elm_spinner_min_max_set() for details.
20165 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20168 * Set the step used to increment or decrement the spinner value.
20170 * @param obj The spinner object.
20171 * @param step The step value.
20173 * This value will be incremented or decremented to the displayed value.
20174 * It will be incremented while the user keep right or top arrow pressed,
20175 * and will be decremented while the user keep left or bottom arrow pressed.
20177 * The interval to increment / decrement can be set with
20178 * elm_spinner_interval_set().
20180 * By default step value is equal to 1.
20182 * @see elm_spinner_step_get()
20186 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20189 * Get the step used to increment or decrement the spinner value.
20191 * @param obj The spinner object.
20192 * @return The step value.
20194 * @see elm_spinner_step_get() for more details.
20198 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20201 * Set the value the spinner displays.
20203 * @param obj The spinner object.
20204 * @param val The value to be displayed.
20206 * Value will be presented on the label following format specified with
20207 * elm_spinner_format_set().
20209 * @warning The value must to be between min and max values. This values
20210 * are set by elm_spinner_min_max_set().
20212 * @see elm_spinner_value_get().
20213 * @see elm_spinner_format_set().
20214 * @see elm_spinner_min_max_set().
20218 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20221 * Get the value displayed by the spinner.
20223 * @param obj The spinner object.
20224 * @return The value displayed.
20226 * @see elm_spinner_value_set() for details.
20230 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20233 * Set whether the spinner should wrap when it reaches its
20234 * minimum or maximum value.
20236 * @param obj The spinner object.
20237 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20240 * Disabled by default. If disabled, when the user tries to increment the
20242 * but displayed value plus step value is bigger than maximum value,
20244 * won't allow it. The same happens when the user tries to decrement it,
20245 * but the value less step is less than minimum value.
20247 * When wrap is enabled, in such situations it will allow these changes,
20248 * but will get the value that would be less than minimum and subtracts
20249 * from maximum. Or add the value that would be more than maximum to
20253 * @li min value = 10
20254 * @li max value = 50
20255 * @li step value = 20
20256 * @li displayed value = 20
20258 * When the user decrement value (using left or bottom arrow), it will
20259 * displays @c 40, because max - (min - (displayed - step)) is
20260 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20262 * @see elm_spinner_wrap_get().
20266 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20269 * Get whether the spinner should wrap when it reaches its
20270 * minimum or maximum value.
20272 * @param obj The spinner object
20273 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20274 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20276 * @see elm_spinner_wrap_set() for details.
20280 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20283 * Set whether the spinner can be directly edited by the user or not.
20285 * @param obj The spinner object.
20286 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20287 * don't allow users to edit it directly.
20289 * Spinner objects can have edition @b disabled, in which state they will
20290 * be changed only by arrows.
20291 * Useful for contexts
20292 * where you don't want your users to interact with it writting the value.
20294 * when using special values, the user can see real value instead
20295 * of special label on edition.
20297 * It's enabled by default.
20299 * @see elm_spinner_editable_get()
20303 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20306 * Get whether the spinner can be directly edited by the user or not.
20308 * @param obj The spinner object.
20309 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20310 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20312 * @see elm_spinner_editable_set() for details.
20316 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20319 * Set a special string to display in the place of the numerical value.
20321 * @param obj The spinner object.
20322 * @param value The value to be replaced.
20323 * @param label The label to be used.
20325 * It's useful for cases when a user should select an item that is
20326 * better indicated by a label than a value. For example, weekdays or months.
20330 * sp = elm_spinner_add(win);
20331 * elm_spinner_min_max_set(sp, 1, 3);
20332 * elm_spinner_special_value_add(sp, 1, "January");
20333 * elm_spinner_special_value_add(sp, 2, "February");
20334 * elm_spinner_special_value_add(sp, 3, "March");
20335 * evas_object_show(sp);
20340 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20343 * Set the interval on time updates for an user mouse button hold
20344 * on spinner widgets' arrows.
20346 * @param obj The spinner object.
20347 * @param interval The (first) interval value in seconds.
20349 * This interval value is @b decreased while the user holds the
20350 * mouse pointer either incrementing or decrementing spinner's value.
20352 * This helps the user to get to a given value distant from the
20353 * current one easier/faster, as it will start to change quicker and
20354 * quicker on mouse button holds.
20356 * The calculation for the next change interval value, starting from
20357 * the one set with this call, is the previous interval divided by
20358 * @c 1.05, so it decreases a little bit.
20360 * The default starting interval value for automatic changes is
20363 * @see elm_spinner_interval_get()
20367 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20370 * Get the interval on time updates for an user mouse button hold
20371 * on spinner widgets' arrows.
20373 * @param obj The spinner object.
20374 * @return The (first) interval value, in seconds, set on it.
20376 * @see elm_spinner_interval_set() for more details.
20380 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20387 * @defgroup Index Index
20389 * @image html img/widget/index/preview-00.png
20390 * @image latex img/widget/index/preview-00.eps
20392 * An index widget gives you an index for fast access to whichever
20393 * group of other UI items one might have. It's a list of text
20394 * items (usually letters, for alphabetically ordered access).
20396 * Index widgets are by default hidden and just appear when the
20397 * user clicks over it's reserved area in the canvas. In its
20398 * default theme, it's an area one @ref Fingers "finger" wide on
20399 * the right side of the index widget's container.
20401 * When items on the index are selected, smart callbacks get
20402 * called, so that its user can make other container objects to
20403 * show a given area or child object depending on the index item
20404 * selected. You'd probably be using an index together with @ref
20405 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20408 * Smart events one can add callbacks for are:
20409 * - @c "changed" - When the selected index item changes. @c
20410 * event_info is the selected item's data pointer.
20411 * - @c "delay,changed" - When the selected index item changes, but
20412 * after a small idling period. @c event_info is the selected
20413 * item's data pointer.
20414 * - @c "selected" - When the user releases a mouse button and
20415 * selects an item. @c event_info is the selected item's data
20417 * - @c "level,up" - when the user moves a finger from the first
20418 * level to the second level
20419 * - @c "level,down" - when the user moves a finger from the second
20420 * level to the first level
20422 * The @c "delay,changed" event is so that it'll wait a small time
20423 * before actually reporting those events and, moreover, just the
20424 * last event happening on those time frames will actually be
20427 * Here are some examples on its usage:
20428 * @li @ref index_example_01
20429 * @li @ref index_example_02
20433 * @addtogroup Index
20437 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20440 * Add a new index widget to the given parent Elementary
20441 * (container) object
20443 * @param parent The parent object
20444 * @return a new index widget handle or @c NULL, on errors
20446 * This function inserts a new index widget on the canvas.
20450 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20453 * Set whether a given index widget is or not visible,
20456 * @param obj The index object
20457 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20459 * Not to be confused with visible as in @c evas_object_show() --
20460 * visible with regard to the widget's auto hiding feature.
20462 * @see elm_index_active_get()
20466 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20469 * Get whether a given index widget is currently visible or not.
20471 * @param obj The index object
20472 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20474 * @see elm_index_active_set() for more details
20478 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20481 * Set the items level for a given index widget.
20483 * @param obj The index object.
20484 * @param level @c 0 or @c 1, the currently implemented levels.
20486 * @see elm_index_item_level_get()
20490 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20493 * Get the items level set for a given index widget.
20495 * @param obj The index object.
20496 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20498 * @see elm_index_item_level_set() for more information
20502 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20505 * Returns the last selected item's data, for a given index widget.
20507 * @param obj The index object.
20508 * @return The item @b data associated to the last selected item on
20509 * @p obj (or @c NULL, on errors).
20511 * @warning The returned value is @b not an #Elm_Index_Item item
20512 * handle, but the data associated to it (see the @c item parameter
20513 * in elm_index_item_append(), as an example).
20517 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20520 * Append a new item on a given index widget.
20522 * @param obj The index object.
20523 * @param letter Letter under which the item should be indexed
20524 * @param item The item data to set for the index's item
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.
20535 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20538 * Prepend a new item on a given index widget.
20540 * @param obj The index object.
20541 * @param letter Letter under which the item should be indexed
20542 * @param item The item data to set for the index's item
20544 * Despite the most common usage of the @p letter argument is for
20545 * single char strings, one could use arbitrary strings as index
20548 * @c item will be the pointer returned back on @c "changed", @c
20549 * "delay,changed" and @c "selected" smart events.
20553 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20556 * Append a new item, on a given index widget, <b>after the item
20557 * having @p relative as data</b>.
20559 * @param obj The index object.
20560 * @param letter Letter under which the item should be indexed
20561 * @param item The item data to set for the index's item
20562 * @param relative The item data of the index item to be the
20563 * predecessor of this new one
20565 * Despite the most common usage of the @p letter argument is for
20566 * single char strings, one could use arbitrary strings as index
20569 * @c item will be the pointer returned back on @c "changed", @c
20570 * "delay,changed" and @c "selected" smart events.
20572 * @note If @p relative is @c NULL or if it's not found to be data
20573 * set on any previous item on @p obj, this function will behave as
20574 * elm_index_item_append().
20578 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20581 * Prepend a new item, on a given index widget, <b>after the item
20582 * having @p relative as data</b>.
20584 * @param obj The index object.
20585 * @param letter Letter under which the item should be indexed
20586 * @param item The item data to set for the index's item
20587 * @param relative The item data of the index item to be the
20588 * successor of this new one
20590 * Despite the most common usage of the @p letter argument is for
20591 * single char strings, one could use arbitrary strings as index
20594 * @c item will be the pointer returned back on @c "changed", @c
20595 * "delay,changed" and @c "selected" smart events.
20597 * @note If @p relative is @c NULL or if it's not found to be data
20598 * set on any previous item on @p obj, this function will behave as
20599 * elm_index_item_prepend().
20603 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20606 * Insert a new item into the given index widget, using @p cmp_func
20607 * function to sort items (by item handles).
20609 * @param obj The index object.
20610 * @param letter Letter under which the item should be indexed
20611 * @param item The item data to set for the index's item
20612 * @param cmp_func The comparing function to be used to sort index
20613 * items <b>by #Elm_Index_Item item handles</b>
20614 * @param cmp_data_func A @b fallback function to be called for the
20615 * sorting of index items <b>by item data</b>). It will be used
20616 * when @p cmp_func returns @c 0 (equality), which means an index
20617 * item with provided item data already exists. To decide which
20618 * data item should be pointed to by the index item in question, @p
20619 * cmp_data_func will be used. If @p cmp_data_func returns a
20620 * non-negative value, the previous index item data will be
20621 * replaced by the given @p item pointer. If the previous data need
20622 * to be freed, it should be done by the @p cmp_data_func function,
20623 * because all references to it will be lost. If this function is
20624 * not provided (@c NULL is given), index items will be @b
20625 * duplicated, if @p cmp_func returns @c 0.
20627 * Despite the most common usage of the @p letter argument is for
20628 * single char strings, one could use arbitrary strings as index
20631 * @c item will be the pointer returned back on @c "changed", @c
20632 * "delay,changed" and @c "selected" smart events.
20636 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);
20639 * Remove an item from a given index widget, <b>to be referenced by
20640 * it's data value</b>.
20642 * @param obj The index object
20643 * @param item The item's data pointer for the item to be removed
20646 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20647 * that callback function will be called by this one.
20649 * @warning The item to be removed from @p obj will be found via
20650 * its item data pointer, and not by an #Elm_Index_Item handle.
20654 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20657 * Find a given index widget's item, <b>using item data</b>.
20659 * @param obj The index object
20660 * @param item The item data pointed to by the desired index item
20661 * @return The index item handle, if found, or @c NULL otherwise
20665 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20668 * Removes @b all items from a given index widget.
20670 * @param obj The index object.
20672 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20673 * that callback function will be called for each item in @p obj.
20677 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20680 * Go to a given items level on a index widget
20682 * @param obj The index object
20683 * @param level The index level (one of @c 0 or @c 1)
20687 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20690 * Return the data associated with a given index widget item
20692 * @param it The index widget item handle
20693 * @return The data associated with @p it
20695 * @see elm_index_item_data_set()
20699 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20702 * Set the data associated with a given index widget item
20704 * @param it The index widget item handle
20705 * @param data The new data pointer to set to @p it
20707 * This sets new item data on @p it.
20709 * @warning The old data pointer won't be touched by this function, so
20710 * the user had better to free that old data himself/herself.
20714 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20717 * Set the function to be called when a given index widget item is freed.
20719 * @param it The item to set the callback on
20720 * @param func The function to call on the item's deletion
20722 * When called, @p func will have both @c data and @c event_info
20723 * arguments with the @p it item's data value and, naturally, the
20724 * @c obj argument with a handle to the parent index widget.
20728 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20731 * Get the letter (string) set on a given index widget item.
20733 * @param it The index item handle
20734 * @return The letter string set on @p it
20738 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20745 * @defgroup Photocam Photocam
20747 * @image html img/widget/photocam/preview-00.png
20748 * @image latex img/widget/photocam/preview-00.eps
20750 * This is a widget specifically for displaying high-resolution digital
20751 * camera photos giving speedy feedback (fast load), low memory footprint
20752 * and zooming and panning as well as fitting logic. It is entirely focused
20753 * on jpeg images, and takes advantage of properties of the jpeg format (via
20754 * evas loader features in the jpeg loader).
20756 * Signals that you can add callbacks for are:
20757 * @li "clicked" - This is called when a user has clicked the photo without
20759 * @li "press" - This is called when a user has pressed down on the photo.
20760 * @li "longpressed" - This is called when a user has pressed down on the
20761 * photo for a long time without dragging around.
20762 * @li "clicked,double" - This is called when a user has double-clicked the
20764 * @li "load" - Photo load begins.
20765 * @li "loaded" - This is called when the image file load is complete for the
20766 * first view (low resolution blurry version).
20767 * @li "load,detail" - Photo detailed data load begins.
20768 * @li "loaded,detail" - This is called when the image file load is complete
20769 * for the detailed image data (full resolution needed).
20770 * @li "zoom,start" - Zoom animation started.
20771 * @li "zoom,stop" - Zoom animation stopped.
20772 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20773 * @li "scroll" - the content has been scrolled (moved)
20774 * @li "scroll,anim,start" - scrolling animation has started
20775 * @li "scroll,anim,stop" - scrolling animation has stopped
20776 * @li "scroll,drag,start" - dragging the contents around has started
20777 * @li "scroll,drag,stop" - dragging the contents around has stopped
20779 * @ref tutorial_photocam shows the API in action.
20783 * @brief Types of zoom available.
20785 typedef enum _Elm_Photocam_Zoom_Mode
20787 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20788 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20789 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20790 ELM_PHOTOCAM_ZOOM_MODE_LAST
20791 } Elm_Photocam_Zoom_Mode;
20793 * @brief Add a new Photocam object
20795 * @param parent The parent object
20796 * @return The new object or NULL if it cannot be created
20798 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20800 * @brief Set the photo file to be shown
20802 * @param obj The photocam object
20803 * @param file The photo file
20804 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20806 * This sets (and shows) the specified file (with a relative or absolute
20807 * path) and will return a load error (same error that
20808 * evas_object_image_load_error_get() will return). The image will change and
20809 * adjust its size at this point and begin a background load process for this
20810 * photo that at some time in the future will be displayed at the full
20813 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20815 * @brief Returns the path of the current image file
20817 * @param obj The photocam object
20818 * @return Returns the path
20820 * @see elm_photocam_file_set()
20822 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20824 * @brief Set the zoom level of the photo
20826 * @param obj The photocam object
20827 * @param zoom The zoom level to set
20829 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20830 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20831 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20832 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20835 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20837 * @brief Get the zoom level of the photo
20839 * @param obj The photocam object
20840 * @return The current zoom level
20842 * This returns the current zoom level of the photocam object. Note that if
20843 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20844 * (which is the default), the zoom level may be changed at any time by the
20845 * photocam object itself to account for photo size and photocam viewpoer
20848 * @see elm_photocam_zoom_set()
20849 * @see elm_photocam_zoom_mode_set()
20851 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20853 * @brief Set the zoom mode
20855 * @param obj The photocam object
20856 * @param mode The desired mode
20858 * This sets the zoom mode to manual or one of several automatic levels.
20859 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20860 * elm_photocam_zoom_set() and will stay at that level until changed by code
20861 * or until zoom mode is changed. This is the default mode. The Automatic
20862 * modes will allow the photocam object to automatically adjust zoom mode
20863 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20864 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20865 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20866 * pixels within the frame are left unfilled.
20868 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20870 * @brief Get the zoom mode
20872 * @param obj The photocam object
20873 * @return The current zoom mode
20875 * This gets the current zoom mode of the photocam object.
20877 * @see elm_photocam_zoom_mode_set()
20879 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20881 * @brief Get the current image pixel width and height
20883 * @param obj The photocam object
20884 * @param w A pointer to the width return
20885 * @param h A pointer to the height return
20887 * This gets the current photo pixel width and height (for the original).
20888 * The size will be returned in the integers @p w and @p h that are pointed
20891 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20893 * @brief Get the area of the image that is currently shown
20896 * @param x A pointer to the X-coordinate of region
20897 * @param y A pointer to the Y-coordinate of region
20898 * @param w A pointer to the width
20899 * @param h A pointer to the height
20901 * @see elm_photocam_image_region_show()
20902 * @see elm_photocam_image_region_bring_in()
20904 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20906 * @brief Set the viewed portion of the image
20908 * @param obj The photocam object
20909 * @param x X-coordinate of region in image original pixels
20910 * @param y Y-coordinate of region in image original pixels
20911 * @param w Width of region in image original pixels
20912 * @param h Height of region in image original pixels
20914 * This shows the region of the image without using animation.
20916 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20918 * @brief Bring in the viewed portion of the image
20920 * @param obj The photocam object
20921 * @param x X-coordinate of region in image original pixels
20922 * @param y Y-coordinate of region in image original pixels
20923 * @param w Width of region in image original pixels
20924 * @param h Height of region in image original pixels
20926 * This shows the region of the image using animation.
20928 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20930 * @brief Set the paused state for photocam
20932 * @param obj The photocam object
20933 * @param paused The pause state to set
20935 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20936 * photocam. The default is off. This will stop zooming using animation on
20937 * zoom levels changes and change instantly. This will stop any existing
20938 * animations that are running.
20940 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20942 * @brief Get the paused state for photocam
20944 * @param obj The photocam object
20945 * @return The current paused state
20947 * This gets the current paused state for the photocam object.
20949 * @see elm_photocam_paused_set()
20951 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20953 * @brief Get the internal low-res image used for photocam
20955 * @param obj The photocam object
20956 * @return The internal image object handle, or NULL if none exists
20958 * This gets the internal image object inside photocam. Do not modify it. It
20959 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20960 * deleted at any time as well.
20962 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20964 * @brief Set the photocam scrolling bouncing.
20966 * @param obj The photocam object
20967 * @param h_bounce bouncing for horizontal
20968 * @param v_bounce bouncing for vertical
20970 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20972 * @brief Get the photocam scrolling bouncing.
20974 * @param obj The photocam object
20975 * @param h_bounce bouncing for horizontal
20976 * @param v_bounce bouncing for vertical
20978 * @see elm_photocam_bounce_set()
20980 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20986 * @defgroup Map Map
20987 * @ingroup Elementary
20989 * @image html img/widget/map/preview-00.png
20990 * @image latex img/widget/map/preview-00.eps
20992 * This is a widget specifically for displaying a map. It uses basically
20993 * OpenStreetMap provider http://www.openstreetmap.org/,
20994 * but custom providers can be added.
20996 * It supports some basic but yet nice features:
20997 * @li zoom and scroll
20998 * @li markers with content to be displayed when user clicks over it
20999 * @li group of markers
21002 * Smart callbacks one can listen to:
21004 * - "clicked" - This is called when a user has clicked the map without
21006 * - "press" - This is called when a user has pressed down on the map.
21007 * - "longpressed" - This is called when a user has pressed down on the map
21008 * for a long time without dragging around.
21009 * - "clicked,double" - This is called when a user has double-clicked
21011 * - "load,detail" - Map detailed data load begins.
21012 * - "loaded,detail" - This is called when all currently visible parts of
21013 * the map are loaded.
21014 * - "zoom,start" - Zoom animation started.
21015 * - "zoom,stop" - Zoom animation stopped.
21016 * - "zoom,change" - Zoom changed when using an auto zoom mode.
21017 * - "scroll" - the content has been scrolled (moved).
21018 * - "scroll,anim,start" - scrolling animation has started.
21019 * - "scroll,anim,stop" - scrolling animation has stopped.
21020 * - "scroll,drag,start" - dragging the contents around has started.
21021 * - "scroll,drag,stop" - dragging the contents around has stopped.
21022 * - "downloaded" - This is called when all currently required map images
21024 * - "route,load" - This is called when route request begins.
21025 * - "route,loaded" - This is called when route request ends.
21026 * - "name,load" - This is called when name request begins.
21027 * - "name,loaded- This is called when name request ends.
21029 * Available style for map widget:
21032 * Available style for markers:
21037 * Available style for marker bubble:
21040 * List of examples:
21041 * @li @ref map_example_01
21042 * @li @ref map_example_02
21043 * @li @ref map_example_03
21052 * @enum _Elm_Map_Zoom_Mode
21053 * @typedef Elm_Map_Zoom_Mode
21055 * Set map's zoom behavior. It can be set to manual or automatic.
21057 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21059 * Values <b> don't </b> work as bitmask, only one can be choosen.
21061 * @note Valid sizes are 2^zoom, consequently the map may be smaller
21062 * than the scroller view.
21064 * @see elm_map_zoom_mode_set()
21065 * @see elm_map_zoom_mode_get()
21069 typedef enum _Elm_Map_Zoom_Mode
21071 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21072 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21073 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21074 ELM_MAP_ZOOM_MODE_LAST
21075 } Elm_Map_Zoom_Mode;
21078 * @enum _Elm_Map_Route_Sources
21079 * @typedef Elm_Map_Route_Sources
21081 * Set route service to be used. By default used source is
21082 * #ELM_MAP_ROUTE_SOURCE_YOURS.
21084 * @see elm_map_route_source_set()
21085 * @see elm_map_route_source_get()
21089 typedef enum _Elm_Map_Route_Sources
21091 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21092 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. */
21093 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21094 ELM_MAP_ROUTE_SOURCE_LAST
21095 } Elm_Map_Route_Sources;
21097 typedef enum _Elm_Map_Name_Sources
21099 ELM_MAP_NAME_SOURCE_NOMINATIM,
21100 ELM_MAP_NAME_SOURCE_LAST
21101 } Elm_Map_Name_Sources;
21104 * @enum _Elm_Map_Route_Type
21105 * @typedef Elm_Map_Route_Type
21107 * Set type of transport used on route.
21109 * @see elm_map_route_add()
21113 typedef enum _Elm_Map_Route_Type
21115 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21116 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21117 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21118 ELM_MAP_ROUTE_TYPE_LAST
21119 } Elm_Map_Route_Type;
21122 * @enum _Elm_Map_Route_Method
21123 * @typedef Elm_Map_Route_Method
21125 * Set the routing method, what should be priorized, time or distance.
21127 * @see elm_map_route_add()
21131 typedef enum _Elm_Map_Route_Method
21133 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21134 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21135 ELM_MAP_ROUTE_METHOD_LAST
21136 } Elm_Map_Route_Method;
21138 typedef enum _Elm_Map_Name_Method
21140 ELM_MAP_NAME_METHOD_SEARCH,
21141 ELM_MAP_NAME_METHOD_REVERSE,
21142 ELM_MAP_NAME_METHOD_LAST
21143 } Elm_Map_Name_Method;
21145 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(). */
21146 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(). */
21147 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(). */
21148 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(). */
21149 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
21150 typedef struct _Elm_Map_Track Elm_Map_Track;
21152 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. */
21153 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21154 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21155 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21157 typedef char *(*ElmMapModuleSourceFunc) (void);
21158 typedef int (*ElmMapModuleZoomMinFunc) (void);
21159 typedef int (*ElmMapModuleZoomMaxFunc) (void);
21160 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21161 typedef int (*ElmMapModuleRouteSourceFunc) (void);
21162 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21163 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21164 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21165 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21168 * Add a new map widget to the given parent Elementary (container) object.
21170 * @param parent The parent object.
21171 * @return a new map widget handle or @c NULL, on errors.
21173 * This function inserts a new map widget on the canvas.
21177 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21180 * Set the zoom level of the map.
21182 * @param obj The map object.
21183 * @param zoom The zoom level to set.
21185 * This sets the zoom level.
21187 * It will respect limits defined by elm_map_source_zoom_min_set() and
21188 * elm_map_source_zoom_max_set().
21190 * By default these values are 0 (world map) and 18 (maximum zoom).
21192 * This function should be used when zoom mode is set to
21193 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21194 * with elm_map_zoom_mode_set().
21196 * @see elm_map_zoom_mode_set().
21197 * @see elm_map_zoom_get().
21201 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21204 * Get the zoom level of the map.
21206 * @param obj The map object.
21207 * @return The current zoom level.
21209 * This returns the current zoom level of the map object.
21211 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21212 * (which is the default), the zoom level may be changed at any time by the
21213 * map object itself to account for map size and map viewport size.
21215 * @see elm_map_zoom_set() for details.
21219 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21222 * Set the zoom mode used by the map object.
21224 * @param obj The map object.
21225 * @param mode The zoom mode of the map, being it one of
21226 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21227 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21229 * This sets the zoom mode to manual or one of the automatic levels.
21230 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21231 * elm_map_zoom_set() and will stay at that level until changed by code
21232 * or until zoom mode is changed. This is the default mode.
21234 * The Automatic modes will allow the map object to automatically
21235 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21236 * adjust zoom so the map fits inside the scroll frame with no pixels
21237 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21238 * ensure no pixels within the frame are left unfilled. Do not forget that
21239 * the valid sizes are 2^zoom, consequently the map may be smaller than
21240 * the scroller view.
21242 * @see elm_map_zoom_set()
21246 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21249 * Get the zoom mode used by the map object.
21251 * @param obj The map object.
21252 * @return The zoom mode of the map, being it one of
21253 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21254 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21256 * This function returns the current zoom mode used by the map object.
21258 * @see elm_map_zoom_mode_set() for more details.
21262 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21265 * Get the current coordinates of the map.
21267 * @param obj The map object.
21268 * @param lon Pointer where to store longitude.
21269 * @param lat Pointer where to store latitude.
21271 * This gets the current center coordinates of the map object. It can be
21272 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21274 * @see elm_map_geo_region_bring_in()
21275 * @see elm_map_geo_region_show()
21279 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21282 * Animatedly bring in given coordinates to the center of the map.
21284 * @param obj The map object.
21285 * @param lon Longitude to center at.
21286 * @param lat Latitude to center at.
21288 * This causes map to jump to the given @p lat and @p lon coordinates
21289 * and show it (by scrolling) in the center of the viewport, if it is not
21290 * already centered. This will use animation to do so and take a period
21291 * of time to complete.
21293 * @see elm_map_geo_region_show() for a function to avoid animation.
21294 * @see elm_map_geo_region_get()
21298 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21301 * Show the given coordinates at the center of the map, @b immediately.
21303 * @param obj The map object.
21304 * @param lon Longitude to center at.
21305 * @param lat Latitude to center at.
21307 * This causes map to @b redraw its viewport's contents to the
21308 * region contining the given @p lat and @p lon, that will be moved to the
21309 * center of the map.
21311 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21312 * @see elm_map_geo_region_get()
21316 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21319 * Pause or unpause the map.
21321 * @param obj The map object.
21322 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21325 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21328 * The default is off.
21330 * This will stop zooming using animation, changing zoom levels will
21331 * change instantly. This will stop any existing animations that are running.
21333 * @see elm_map_paused_get()
21337 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21340 * Get a value whether map is paused or not.
21342 * @param obj The map object.
21343 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21344 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21346 * This gets the current paused state for the map object.
21348 * @see elm_map_paused_set() for details.
21352 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21355 * Set to show markers during zoom level changes or not.
21357 * @param obj The map object.
21358 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21361 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21364 * The default is off.
21366 * This will stop zooming using animation, changing zoom levels will
21367 * change instantly. This will stop any existing animations that are running.
21369 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21372 * The default is off.
21374 * Enabling it will force the map to stop displaying the markers during
21375 * zoom level changes. Set to on if you have a large number of markers.
21377 * @see elm_map_paused_markers_get()
21381 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21384 * Get a value whether markers will be displayed on zoom level changes or not
21386 * @param obj The map object.
21387 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21388 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21390 * This gets the current markers paused state for the map object.
21392 * @see elm_map_paused_markers_set() for details.
21396 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21399 * Get the information of downloading status.
21401 * @param obj The map object.
21402 * @param try_num Pointer where to store number of tiles being downloaded.
21403 * @param finish_num Pointer where to store number of tiles successfully
21406 * This gets the current downloading status for the map object, the number
21407 * of tiles being downloaded and the number of tiles already downloaded.
21411 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21414 * Convert a pixel coordinate (x,y) into a geographic coordinate
21415 * (longitude, latitude).
21417 * @param obj The map object.
21418 * @param x the coordinate.
21419 * @param y the coordinate.
21420 * @param size the size in pixels of the map.
21421 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21422 * @param lon Pointer where to store the longitude that correspond to x.
21423 * @param lat Pointer where to store the latitude that correspond to y.
21425 * @note Origin pixel point is the top left corner of the viewport.
21426 * Map zoom and size are taken on account.
21428 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21432 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);
21435 * Convert a geographic coordinate (longitude, latitude) into a pixel
21436 * coordinate (x, y).
21438 * @param obj The map object.
21439 * @param lon the longitude.
21440 * @param lat the latitude.
21441 * @param size the size in pixels of the map. The map is a square
21442 * and generally his size is : pow(2.0, zoom)*256.
21443 * @param x Pointer where to store the horizontal pixel coordinate that
21444 * correspond to the longitude.
21445 * @param y Pointer where to store the vertical pixel coordinate that
21446 * correspond to the latitude.
21448 * @note Origin pixel point is the top left corner of the viewport.
21449 * Map zoom and size are taken on account.
21451 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21455 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);
21458 * Convert a geographic coordinate (longitude, latitude) into a name
21461 * @param obj The map object.
21462 * @param lon the longitude.
21463 * @param lat the latitude.
21464 * @return name A #Elm_Map_Name handle for this coordinate.
21466 * To get the string for this address, elm_map_name_address_get()
21469 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21473 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21476 * Convert a name (address) into a geographic coordinate
21477 * (longitude, latitude).
21479 * @param obj The map object.
21480 * @param name The address.
21481 * @return name A #Elm_Map_Name handle for this address.
21483 * To get the longitude and latitude, elm_map_name_region_get()
21486 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21490 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21493 * Convert a pixel coordinate into a rotated pixel coordinate.
21495 * @param obj The map object.
21496 * @param x horizontal coordinate of the point to rotate.
21497 * @param y vertical coordinate of the point to rotate.
21498 * @param cx rotation's center horizontal position.
21499 * @param cy rotation's center vertical position.
21500 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21501 * @param xx Pointer where to store rotated x.
21502 * @param yy Pointer where to store rotated y.
21506 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);
21509 * Add a new marker to the map object.
21511 * @param obj The map object.
21512 * @param lon The longitude of the marker.
21513 * @param lat The latitude of the marker.
21514 * @param clas The class, to use when marker @b isn't grouped to others.
21515 * @param clas_group The class group, to use when marker is grouped to others
21516 * @param data The data passed to the callbacks.
21518 * @return The created marker or @c NULL upon failure.
21520 * A marker will be created and shown in a specific point of the map, defined
21521 * by @p lon and @p lat.
21523 * It will be displayed using style defined by @p class when this marker
21524 * is displayed alone (not grouped). A new class can be created with
21525 * elm_map_marker_class_new().
21527 * If the marker is grouped to other markers, it will be displayed with
21528 * style defined by @p class_group. Markers with the same group are grouped
21529 * if they are close. A new group class can be created with
21530 * elm_map_marker_group_class_new().
21532 * Markers created with this method can be deleted with
21533 * elm_map_marker_remove().
21535 * A marker can have associated content to be displayed by a bubble,
21536 * when a user click over it, as well as an icon. These objects will
21537 * be fetch using class' callback functions.
21539 * @see elm_map_marker_class_new()
21540 * @see elm_map_marker_group_class_new()
21541 * @see elm_map_marker_remove()
21545 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);
21548 * Set the maximum numbers of markers' content to be displayed in a group.
21550 * @param obj The map object.
21551 * @param max The maximum numbers of items displayed in a bubble.
21553 * A bubble will be displayed when the user clicks over the group,
21554 * and will place the content of markers that belong to this group
21557 * A group can have a long list of markers, consequently the creation
21558 * of the content of the bubble can be very slow.
21560 * In order to avoid this, a maximum number of items is displayed
21563 * By default this number is 30.
21565 * Marker with the same group class are grouped if they are close.
21567 * @see elm_map_marker_add()
21571 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21574 * Remove a marker from the map.
21576 * @param marker The marker to remove.
21578 * @see elm_map_marker_add()
21582 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21585 * Get the current coordinates of the marker.
21587 * @param marker marker.
21588 * @param lat Pointer where to store the marker's latitude.
21589 * @param lon Pointer where to store the marker's longitude.
21591 * These values are set when adding markers, with function
21592 * elm_map_marker_add().
21594 * @see elm_map_marker_add()
21598 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21601 * Animatedly bring in given marker to the center of the map.
21603 * @param marker The marker to center at.
21605 * This causes map to jump to the given @p marker's coordinates
21606 * and show it (by scrolling) in the center of the viewport, if it is not
21607 * already centered. This will use animation to do so and take a period
21608 * of time to complete.
21610 * @see elm_map_marker_show() for a function to avoid animation.
21611 * @see elm_map_marker_region_get()
21615 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21618 * Show the given marker at the center of the map, @b immediately.
21620 * @param marker The marker to center at.
21622 * This causes map to @b redraw its viewport's contents to the
21623 * region contining the given @p marker's coordinates, that will be
21624 * moved to the center of the map.
21626 * @see elm_map_marker_bring_in() for a function to move with animation.
21627 * @see elm_map_markers_list_show() if more than one marker need to be
21629 * @see elm_map_marker_region_get()
21633 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21636 * Move and zoom the map to display a list of markers.
21638 * @param markers A list of #Elm_Map_Marker handles.
21640 * The map will be centered on the center point of the markers in the list.
21641 * Then the map will be zoomed in order to fit the markers using the maximum
21642 * zoom which allows display of all the markers.
21644 * @warning All the markers should belong to the same map object.
21646 * @see elm_map_marker_show() to show a single marker.
21647 * @see elm_map_marker_bring_in()
21651 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21654 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21656 * @param marker The marker wich content should be returned.
21657 * @return Return the evas object if it exists, else @c NULL.
21659 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21660 * elm_map_marker_class_get_cb_set() should be used.
21662 * This content is what will be inside the bubble that will be displayed
21663 * when an user clicks over the marker.
21665 * This returns the actual Evas object used to be placed inside
21666 * the bubble. This may be @c NULL, as it may
21667 * not have been created or may have been deleted, at any time, by
21668 * the map. <b>Do not modify this object</b> (move, resize,
21669 * show, hide, etc.), as the map is controlling it. This
21670 * function is for querying, emitting custom signals or hooking
21671 * lower level callbacks for events on that object. Do not delete
21672 * this object under any circumstances.
21676 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21679 * Update the marker
21681 * @param marker The marker to be updated.
21683 * If a content is set to this marker, it will call function to delete it,
21684 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21685 * #ElmMapMarkerGetFunc.
21687 * These functions are set for the marker class with
21688 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21692 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21695 * Close all the bubbles opened by the user.
21697 * @param obj The map object.
21699 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21700 * when the user clicks on a marker.
21702 * This functions is set for the marker class with
21703 * elm_map_marker_class_get_cb_set().
21707 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21710 * Create a new group class.
21712 * @param obj The map object.
21713 * @return Returns the new group class.
21715 * Each marker must be associated to a group class. Markers in the same
21716 * group are grouped if they are close.
21718 * The group class defines the style of the marker when a marker is grouped
21719 * to others markers. When it is alone, another class will be used.
21721 * A group class will need to be provided when creating a marker with
21722 * elm_map_marker_add().
21724 * Some properties and functions can be set by class, as:
21725 * - style, with elm_map_group_class_style_set()
21726 * - data - to be associated to the group class. It can be set using
21727 * elm_map_group_class_data_set().
21728 * - min zoom to display markers, set with
21729 * elm_map_group_class_zoom_displayed_set().
21730 * - max zoom to group markers, set using
21731 * elm_map_group_class_zoom_grouped_set().
21732 * - visibility - set if markers will be visible or not, set with
21733 * elm_map_group_class_hide_set().
21734 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21735 * It can be set using elm_map_group_class_icon_cb_set().
21737 * @see elm_map_marker_add()
21738 * @see elm_map_group_class_style_set()
21739 * @see elm_map_group_class_data_set()
21740 * @see elm_map_group_class_zoom_displayed_set()
21741 * @see elm_map_group_class_zoom_grouped_set()
21742 * @see elm_map_group_class_hide_set()
21743 * @see elm_map_group_class_icon_cb_set()
21747 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21750 * Set the marker's style of a group class.
21752 * @param clas The group class.
21753 * @param style The style to be used by markers.
21755 * Each marker must be associated to a group class, and will use the style
21756 * defined by such class when grouped to other markers.
21758 * The following styles are provided by default theme:
21759 * @li @c radio - blue circle
21760 * @li @c radio2 - green circle
21763 * @see elm_map_group_class_new() for more details.
21764 * @see elm_map_marker_add()
21768 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21771 * Set the icon callback function of a group class.
21773 * @param clas The group class.
21774 * @param icon_get The callback function that will return the icon.
21776 * Each marker must be associated to a group class, and it can display a
21777 * custom icon. The function @p icon_get must return this icon.
21779 * @see elm_map_group_class_new() for more details.
21780 * @see elm_map_marker_add()
21784 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21787 * Set the data associated to the group class.
21789 * @param clas The group class.
21790 * @param data The new user data.
21792 * This data will be passed for callback functions, like icon get callback,
21793 * that can be set with elm_map_group_class_icon_cb_set().
21795 * If a data was previously set, the object will lose the pointer for it,
21796 * so if needs to be freed, you must do it yourself.
21798 * @see elm_map_group_class_new() for more details.
21799 * @see elm_map_group_class_icon_cb_set()
21800 * @see elm_map_marker_add()
21804 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21807 * Set the minimum zoom from where the markers are displayed.
21809 * @param clas The group class.
21810 * @param zoom The minimum zoom.
21812 * Markers only will be displayed when the map is displayed at @p zoom
21815 * @see elm_map_group_class_new() for more details.
21816 * @see elm_map_marker_add()
21820 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21823 * Set the zoom from where the markers are no more grouped.
21825 * @param clas The group class.
21826 * @param zoom The maximum zoom.
21828 * Markers only will be grouped when the map is displayed at
21829 * less than @p zoom.
21831 * @see elm_map_group_class_new() for more details.
21832 * @see elm_map_marker_add()
21836 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21839 * Set if the markers associated to the group class @clas are hidden or not.
21841 * @param clas The group class.
21842 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21845 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21850 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21853 * Create a new marker class.
21855 * @param obj The map object.
21856 * @return Returns the new group class.
21858 * Each marker must be associated to a class.
21860 * The marker class defines the style of the marker when a marker is
21861 * displayed alone, i.e., not grouped to to others markers. When grouped
21862 * it will use group class style.
21864 * A marker class will need to be provided when creating a marker with
21865 * elm_map_marker_add().
21867 * Some properties and functions can be set by class, as:
21868 * - style, with elm_map_marker_class_style_set()
21869 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21870 * It can be set using elm_map_marker_class_icon_cb_set().
21871 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21872 * Set using elm_map_marker_class_get_cb_set().
21873 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21874 * Set using elm_map_marker_class_del_cb_set().
21876 * @see elm_map_marker_add()
21877 * @see elm_map_marker_class_style_set()
21878 * @see elm_map_marker_class_icon_cb_set()
21879 * @see elm_map_marker_class_get_cb_set()
21880 * @see elm_map_marker_class_del_cb_set()
21884 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21887 * Set the marker's style of a marker class.
21889 * @param clas The marker class.
21890 * @param style The style to be used by markers.
21892 * Each marker must be associated to a marker class, and will use the style
21893 * defined by such class when alone, i.e., @b not grouped to other markers.
21895 * The following styles are provided by default theme:
21900 * @see elm_map_marker_class_new() for more details.
21901 * @see elm_map_marker_add()
21905 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21908 * Set the icon callback function of a marker class.
21910 * @param clas The marker class.
21911 * @param icon_get The callback function that will return the icon.
21913 * Each marker must be associated to a marker class, and it can display a
21914 * custom icon. The function @p icon_get must return this icon.
21916 * @see elm_map_marker_class_new() for more details.
21917 * @see elm_map_marker_add()
21921 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21924 * Set the bubble content callback function of a marker class.
21926 * @param clas The marker class.
21927 * @param get The callback function that will return the content.
21929 * Each marker must be associated to a marker class, and it can display a
21930 * a content on a bubble that opens when the user click over the marker.
21931 * The function @p get must return this content object.
21933 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21936 * @see elm_map_marker_class_new() for more details.
21937 * @see elm_map_marker_class_del_cb_set()
21938 * @see elm_map_marker_add()
21942 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21945 * Set the callback function used to delete bubble content of a marker class.
21947 * @param clas The marker class.
21948 * @param del The callback function that will delete the content.
21950 * Each marker must be associated to a marker class, and it can display a
21951 * a content on a bubble that opens when the user click over the marker.
21952 * The function to return such content can be set with
21953 * elm_map_marker_class_get_cb_set().
21955 * If this content must be freed, a callback function need to be
21956 * set for that task with this function.
21958 * If this callback is defined it will have to delete (or not) the
21959 * object inside, but if the callback is not defined the object will be
21960 * destroyed with evas_object_del().
21962 * @see elm_map_marker_class_new() for more details.
21963 * @see elm_map_marker_class_get_cb_set()
21964 * @see elm_map_marker_add()
21968 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21971 * Get the list of available sources.
21973 * @param obj The map object.
21974 * @return The source names list.
21976 * It will provide a list with all available sources, that can be set as
21977 * current source with elm_map_source_name_set(), or get with
21978 * elm_map_source_name_get().
21980 * Available sources:
21986 * @see elm_map_source_name_set() for more details.
21987 * @see elm_map_source_name_get()
21991 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21994 * Set the source of the map.
21996 * @param obj The map object.
21997 * @param source The source to be used.
21999 * Map widget retrieves images that composes the map from a web service.
22000 * This web service can be set with this method.
22002 * A different service can return a different maps with different
22003 * information and it can use different zoom values.
22005 * The @p source_name need to match one of the names provided by
22006 * elm_map_source_names_get().
22008 * The current source can be get using elm_map_source_name_get().
22010 * @see elm_map_source_names_get()
22011 * @see elm_map_source_name_get()
22016 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
22019 * Get the name of currently used source.
22021 * @param obj The map object.
22022 * @return Returns the name of the source in use.
22024 * @see elm_map_source_name_set() for more details.
22028 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22031 * Set the source of the route service to be used by the map.
22033 * @param obj The map object.
22034 * @param source The route service to be used, being it one of
22035 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22036 * and #ELM_MAP_ROUTE_SOURCE_ORS.
22038 * Each one has its own algorithm, so the route retrieved may
22039 * differ depending on the source route. Now, only the default is working.
22041 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22042 * http://www.yournavigation.org/.
22044 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22045 * assumptions. Its routing core is based on Contraction Hierarchies.
22047 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22049 * @see elm_map_route_source_get().
22053 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22056 * Get the current route source.
22058 * @param obj The map object.
22059 * @return The source of the route service used by the map.
22061 * @see elm_map_route_source_set() for details.
22065 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22068 * Set the minimum zoom of the source.
22070 * @param obj The map object.
22071 * @param zoom New minimum zoom value to be used.
22073 * By default, it's 0.
22077 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22080 * Get the minimum zoom of the source.
22082 * @param obj The map object.
22083 * @return Returns the minimum zoom of the source.
22085 * @see elm_map_source_zoom_min_set() for details.
22089 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22092 * Set the maximum zoom of the source.
22094 * @param obj The map object.
22095 * @param zoom New maximum zoom value to be used.
22097 * By default, it's 18.
22101 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22104 * Get the maximum zoom of the source.
22106 * @param obj The map object.
22107 * @return Returns the maximum zoom of the source.
22109 * @see elm_map_source_zoom_min_set() for details.
22113 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22116 * Set the user agent used by the map object to access routing services.
22118 * @param obj The map object.
22119 * @param user_agent The user agent to be used by the map.
22121 * User agent is a client application implementing a network protocol used
22122 * in communications within a client–server distributed computing system
22124 * The @p user_agent identification string will transmitted in a header
22125 * field @c User-Agent.
22127 * @see elm_map_user_agent_get()
22131 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22134 * Get the user agent used by the map object.
22136 * @param obj The map object.
22137 * @return The user agent identification string used by the map.
22139 * @see elm_map_user_agent_set() for details.
22143 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22146 * Add a new route to the map object.
22148 * @param obj The map object.
22149 * @param type The type of transport to be considered when tracing a route.
22150 * @param method The routing method, what should be priorized.
22151 * @param flon The start longitude.
22152 * @param flat The start latitude.
22153 * @param tlon The destination longitude.
22154 * @param tlat The destination latitude.
22156 * @return The created route or @c NULL upon failure.
22158 * A route will be traced by point on coordinates (@p flat, @p flon)
22159 * to point on coordinates (@p tlat, @p tlon), using the route service
22160 * set with elm_map_route_source_set().
22162 * It will take @p type on consideration to define the route,
22163 * depending if the user will be walking or driving, the route may vary.
22164 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22165 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22167 * Another parameter is what the route should priorize, the minor distance
22168 * or the less time to be spend on the route. So @p method should be one
22169 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22171 * Routes created with this method can be deleted with
22172 * elm_map_route_remove(), colored with elm_map_route_color_set(),
22173 * and distance can be get with elm_map_route_distance_get().
22175 * @see elm_map_route_remove()
22176 * @see elm_map_route_color_set()
22177 * @see elm_map_route_distance_get()
22178 * @see elm_map_route_source_set()
22182 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);
22185 * Remove a route from the map.
22187 * @param route The route to remove.
22189 * @see elm_map_route_add()
22193 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22196 * Set the route color.
22198 * @param route The route object.
22199 * @param r Red channel value, from 0 to 255.
22200 * @param g Green channel value, from 0 to 255.
22201 * @param b Blue channel value, from 0 to 255.
22202 * @param a Alpha channel value, from 0 to 255.
22204 * It uses an additive color model, so each color channel represents
22205 * how much of each primary colors must to be used. 0 represents
22206 * ausence of this color, so if all of the three are set to 0,
22207 * the color will be black.
22209 * These component values should be integers in the range 0 to 255,
22210 * (single 8-bit byte).
22212 * This sets the color used for the route. By default, it is set to
22213 * solid red (r = 255, g = 0, b = 0, a = 255).
22215 * For alpha channel, 0 represents completely transparent, and 255, opaque.
22217 * @see elm_map_route_color_get()
22221 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22224 * Get the route color.
22226 * @param route The route object.
22227 * @param r Pointer where to store the red channel value.
22228 * @param g Pointer where to store the green channel value.
22229 * @param b Pointer where to store the blue channel value.
22230 * @param a Pointer where to store the alpha channel value.
22232 * @see elm_map_route_color_set() for details.
22236 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22239 * Get the route distance in kilometers.
22241 * @param route The route object.
22242 * @return The distance of route (unit : km).
22246 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22249 * Get the information of route nodes.
22251 * @param route The route object.
22252 * @return Returns a string with the nodes of route.
22256 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22259 * Get the information of route waypoint.
22261 * @param route the route object.
22262 * @return Returns a string with information about waypoint of route.
22266 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22269 * Get the address of the name.
22271 * @param name The name handle.
22272 * @return Returns the address string of @p name.
22274 * This gets the coordinates of the @p name, created with one of the
22275 * conversion functions.
22277 * @see elm_map_utils_convert_name_into_coord()
22278 * @see elm_map_utils_convert_coord_into_name()
22282 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22285 * Get the current coordinates of the name.
22287 * @param name The name handle.
22288 * @param lat Pointer where to store the latitude.
22289 * @param lon Pointer where to store The longitude.
22291 * This gets the coordinates of the @p name, created with one of the
22292 * conversion functions.
22294 * @see elm_map_utils_convert_name_into_coord()
22295 * @see elm_map_utils_convert_coord_into_name()
22299 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22302 * Remove a name from the map.
22304 * @param name The name to remove.
22306 * Basically the struct handled by @p name will be freed, so convertions
22307 * between address and coordinates will be lost.
22309 * @see elm_map_utils_convert_name_into_coord()
22310 * @see elm_map_utils_convert_coord_into_name()
22314 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22319 * @param obj The map object.
22320 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22321 * @param cx Rotation's center horizontal position.
22322 * @param cy Rotation's center vertical position.
22324 * @see elm_map_rotate_get()
22328 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22331 * Get the rotate degree of the map
22333 * @param obj The map object
22334 * @param degree Pointer where to store degrees from 0.0 to 360.0
22335 * to rotate arount Z axis.
22336 * @param cx Pointer where to store rotation's center horizontal position.
22337 * @param cy Pointer where to store rotation's center vertical position.
22339 * @see elm_map_rotate_set() to set map rotation.
22343 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);
22346 * Enable or disable mouse wheel to be used to zoom in / out the map.
22348 * @param obj The map object.
22349 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22352 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22354 * It's disabled by default.
22356 * @see elm_map_wheel_disabled_get()
22360 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22363 * Get a value whether mouse wheel is enabled or not.
22365 * @param obj The map object.
22366 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22367 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22369 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22371 * @see elm_map_wheel_disabled_set() for details.
22375 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22379 * Add a track on the map
22381 * @param obj The map object.
22382 * @param emap The emap route object.
22383 * @return The route object. This is an elm object of type Route.
22385 * @see elm_route_add() for details.
22389 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22393 * Remove a track from the map
22395 * @param obj The map object.
22396 * @param route The track to remove.
22400 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22407 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22409 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22411 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22412 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22413 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22414 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22418 * @defgroup Panel Panel
22420 * @image html img/widget/panel/preview-00.png
22421 * @image latex img/widget/panel/preview-00.eps
22423 * @brief A panel is a type of animated container that contains subobjects.
22424 * It can be expanded or contracted by clicking the button on it's edge.
22426 * Orientations are as follows:
22427 * @li ELM_PANEL_ORIENT_TOP
22428 * @li ELM_PANEL_ORIENT_LEFT
22429 * @li ELM_PANEL_ORIENT_RIGHT
22431 * @ref tutorial_panel shows one way to use this widget.
22434 typedef enum _Elm_Panel_Orient
22436 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22437 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22438 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22439 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22440 } Elm_Panel_Orient;
22442 * @brief Adds a panel object
22444 * @param parent The parent object
22446 * @return The panel object, or NULL on failure
22448 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22450 * @brief Sets the orientation of the panel
22452 * @param parent The parent object
22453 * @param orient The panel orientation. Can be one of the following:
22454 * @li ELM_PANEL_ORIENT_TOP
22455 * @li ELM_PANEL_ORIENT_LEFT
22456 * @li ELM_PANEL_ORIENT_RIGHT
22458 * Sets from where the panel will (dis)appear.
22460 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22462 * @brief Get the orientation of the panel.
22464 * @param obj The panel object
22465 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22467 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22469 * @brief Set the content of the panel.
22471 * @param obj The panel object
22472 * @param content The panel content
22474 * Once the content object is set, a previously set one will be deleted.
22475 * If you want to keep that old content object, use the
22476 * elm_panel_content_unset() function.
22478 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22480 * @brief Get the content of the panel.
22482 * @param obj The panel object
22483 * @return The content that is being used
22485 * Return the content object which is set for this widget.
22487 * @see elm_panel_content_set()
22489 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22491 * @brief Unset the content of the panel.
22493 * @param obj The panel object
22494 * @return The content that was being used
22496 * Unparent and return the content object which was set for this widget.
22498 * @see elm_panel_content_set()
22500 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22502 * @brief Set the state of the panel.
22504 * @param obj The panel object
22505 * @param hidden If true, the panel will run the animation to contract
22507 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22509 * @brief Get the state of the panel.
22511 * @param obj The panel object
22512 * @param hidden If true, the panel is in the "hide" state
22514 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22516 * @brief Toggle the hidden state of the panel from code
22518 * @param obj The panel object
22520 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22526 * @defgroup Panes Panes
22527 * @ingroup Elementary
22529 * @image html img/widget/panes/preview-00.png
22530 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22532 * @image html img/panes.png
22533 * @image latex img/panes.eps width=\textwidth
22535 * The panes adds a dragable bar between two contents. When dragged
22536 * this bar will resize contents size.
22538 * Panes can be displayed vertically or horizontally, and contents
22539 * size proportion can be customized (homogeneous by default).
22541 * Smart callbacks one can listen to:
22542 * - "press" - The panes has been pressed (button wasn't released yet).
22543 * - "unpressed" - The panes was released after being pressed.
22544 * - "clicked" - The panes has been clicked>
22545 * - "clicked,double" - The panes has been double clicked
22547 * Available styles for it:
22550 * Here is an example on its usage:
22551 * @li @ref panes_example
22555 * @addtogroup Panes
22560 * Add a new panes widget to the given parent Elementary
22561 * (container) object.
22563 * @param parent The parent object.
22564 * @return a new panes widget handle or @c NULL, on errors.
22566 * This function inserts a new panes widget on the canvas.
22570 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22573 * Set the left content of the panes widget.
22575 * @param obj The panes object.
22576 * @param content The new left content object.
22578 * Once the content object is set, a previously set one will be deleted.
22579 * If you want to keep that old content object, use the
22580 * elm_panes_content_left_unset() function.
22582 * If panes is displayed vertically, left content will be displayed at
22585 * @see elm_panes_content_left_get()
22586 * @see elm_panes_content_right_set() to set content on the other side.
22590 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22593 * Set the right content of the panes widget.
22595 * @param obj The panes object.
22596 * @param content The new right content object.
22598 * Once the content object is set, a previously set one will be deleted.
22599 * If you want to keep that old content object, use the
22600 * elm_panes_content_right_unset() function.
22602 * If panes is displayed vertically, left content will be displayed at
22605 * @see elm_panes_content_right_get()
22606 * @see elm_panes_content_left_set() to set content on the other side.
22610 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22613 * Get the left content of the panes.
22615 * @param obj The panes object.
22616 * @return The left content object that is being used.
22618 * Return the left content object which is set for this widget.
22620 * @see elm_panes_content_left_set() for details.
22624 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22627 * Get the right content of the panes.
22629 * @param obj The panes object
22630 * @return The right content object that is being used
22632 * Return the right content object which is set for this widget.
22634 * @see elm_panes_content_right_set() for details.
22638 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22641 * Unset the left content used for the panes.
22643 * @param obj The panes object.
22644 * @return The left content object that was being used.
22646 * Unparent and return the left content object which was set for this widget.
22648 * @see elm_panes_content_left_set() for details.
22649 * @see elm_panes_content_left_get().
22653 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22656 * Unset the right content used for the panes.
22658 * @param obj The panes object.
22659 * @return The right content object that was being used.
22661 * Unparent and return the right content object which was set for this
22664 * @see elm_panes_content_right_set() for details.
22665 * @see elm_panes_content_right_get().
22669 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22672 * Get the size proportion of panes widget's left side.
22674 * @param obj The panes object.
22675 * @return float value between 0.0 and 1.0 representing size proportion
22678 * @see elm_panes_content_left_size_set() for more details.
22682 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22685 * Set the size proportion of panes widget's left side.
22687 * @param obj The panes object.
22688 * @param size Value between 0.0 and 1.0 representing size proportion
22691 * By default it's homogeneous, i.e., both sides have the same size.
22693 * If something different is required, it can be set with this function.
22694 * For example, if the left content should be displayed over
22695 * 75% of the panes size, @p size should be passed as @c 0.75.
22696 * This way, right content will be resized to 25% of panes size.
22698 * If displayed vertically, left content is displayed at top, and
22699 * right content at bottom.
22701 * @note This proportion will change when user drags the panes bar.
22703 * @see elm_panes_content_left_size_get()
22707 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22710 * Set the orientation of a given panes widget.
22712 * @param obj The panes object.
22713 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22714 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22716 * Use this function to change how your panes is to be
22717 * disposed: vertically or horizontally.
22719 * By default it's displayed horizontally.
22721 * @see elm_panes_horizontal_get()
22725 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22728 * Retrieve the orientation of a given panes widget.
22730 * @param obj The panes object.
22731 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22732 * @c EINA_FALSE if it's @b vertical (and on errors).
22734 * @see elm_panes_horizontal_set() for more details.
22738 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22745 * @defgroup Flip Flip
22747 * @image html img/widget/flip/preview-00.png
22748 * @image latex img/widget/flip/preview-00.eps
22750 * This widget holds 2 content objects(Evas_Object): one on the front and one
22751 * on the back. It allows you to flip from front to back and vice-versa using
22752 * various animations.
22754 * If either the front or back contents are not set the flip will treat that
22755 * as transparent. So if you wore to set the front content but not the back,
22756 * and then call elm_flip_go() you would see whatever is below the flip.
22758 * For a list of supported animations see elm_flip_go().
22760 * Signals that you can add callbacks for are:
22761 * "animate,begin" - when a flip animation was started
22762 * "animate,done" - when a flip animation is finished
22764 * @ref tutorial_flip show how to use most of the API.
22768 typedef enum _Elm_Flip_Mode
22770 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22771 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22772 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22773 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22774 ELM_FLIP_CUBE_LEFT,
22775 ELM_FLIP_CUBE_RIGHT,
22777 ELM_FLIP_CUBE_DOWN,
22778 ELM_FLIP_PAGE_LEFT,
22779 ELM_FLIP_PAGE_RIGHT,
22783 typedef enum _Elm_Flip_Interaction
22785 ELM_FLIP_INTERACTION_NONE,
22786 ELM_FLIP_INTERACTION_ROTATE,
22787 ELM_FLIP_INTERACTION_CUBE,
22788 ELM_FLIP_INTERACTION_PAGE
22789 } Elm_Flip_Interaction;
22790 typedef enum _Elm_Flip_Direction
22792 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22793 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22794 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22795 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22796 } Elm_Flip_Direction;
22798 * @brief Add a new flip to the parent
22800 * @param parent The parent object
22801 * @return The new object or NULL if it cannot be created
22803 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22805 * @brief Set the front content of the flip widget.
22807 * @param obj The flip object
22808 * @param content The new front content object
22810 * Once the content object is set, a previously set one will be deleted.
22811 * If you want to keep that old content object, use the
22812 * elm_flip_content_front_unset() function.
22814 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22816 * @brief Set the back content of the flip widget.
22818 * @param obj The flip object
22819 * @param content The new back content object
22821 * Once the content object is set, a previously set one will be deleted.
22822 * If you want to keep that old content object, use the
22823 * elm_flip_content_back_unset() function.
22825 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22827 * @brief Get the front content used for the flip
22829 * @param obj The flip object
22830 * @return The front content object that is being used
22832 * Return the front content object which is set for this widget.
22834 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22836 * @brief Get the back content used for the flip
22838 * @param obj The flip object
22839 * @return The back content object that is being used
22841 * Return the back content object which is set for this widget.
22843 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22845 * @brief Unset the front content used for the flip
22847 * @param obj The flip object
22848 * @return The front content object that was being used
22850 * Unparent and return the front content object which was set for this widget.
22852 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22854 * @brief Unset the back content used for the flip
22856 * @param obj The flip object
22857 * @return The back content object that was being used
22859 * Unparent and return the back content object which was set for this widget.
22861 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22863 * @brief Get flip front visibility state
22865 * @param obj The flip objct
22866 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22869 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22871 * @brief Set flip perspective
22873 * @param obj The flip object
22874 * @param foc The coordinate to set the focus on
22875 * @param x The X coordinate
22876 * @param y The Y coordinate
22878 * @warning This function currently does nothing.
22880 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22882 * @brief Runs the flip animation
22884 * @param obj The flip object
22885 * @param mode The mode type
22887 * Flips the front and back contents using the @p mode animation. This
22888 * efectively hides the currently visible content and shows the hidden one.
22890 * There a number of possible animations to use for the flipping:
22891 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22892 * around a horizontal axis in the middle of its height, the other content
22893 * is shown as the other side of the flip.
22894 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22895 * around a vertical axis in the middle of its width, the other content is
22896 * shown as the other side of the flip.
22897 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22898 * around a diagonal axis in the middle of its width, the other content is
22899 * shown as the other side of the flip.
22900 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22901 * around a diagonal axis in the middle of its height, the other content is
22902 * shown as the other side of the flip.
22903 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22904 * as if the flip was a cube, the other content is show as the right face of
22906 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22907 * right as if the flip was a cube, the other content is show as the left
22908 * face of the cube.
22909 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22910 * flip was a cube, the other content is show as the bottom face of the cube.
22911 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22912 * the flip was a cube, the other content is show as the upper face of the
22914 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22915 * if the flip was a book, the other content is shown as the page below that.
22916 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22917 * as if the flip was a book, the other content is shown as the page below
22919 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22920 * flip was a book, the other content is shown as the page below that.
22921 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22922 * flip was a book, the other content is shown as the page below that.
22924 * @image html elm_flip.png
22925 * @image latex elm_flip.eps width=\textwidth
22927 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22929 * @brief Set the interactive flip mode
22931 * @param obj The flip object
22932 * @param mode The interactive flip mode to use
22934 * This sets if the flip should be interactive (allow user to click and
22935 * drag a side of the flip to reveal the back page and cause it to flip).
22936 * By default a flip is not interactive. You may also need to set which
22937 * sides of the flip are "active" for flipping and how much space they use
22938 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22939 * and elm_flip_interacton_direction_hitsize_set()
22941 * The four avilable mode of interaction are:
22942 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22943 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22944 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22945 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22947 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22948 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22949 * happen, those can only be acheived with elm_flip_go();
22951 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22953 * @brief Get the interactive flip mode
22955 * @param obj The flip object
22956 * @return The interactive flip mode
22958 * Returns the interactive flip mode set by elm_flip_interaction_set()
22960 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22962 * @brief Set which directions of the flip respond to interactive flip
22964 * @param obj The flip object
22965 * @param dir The direction to change
22966 * @param enabled If that direction is enabled or not
22968 * By default all directions are disabled, so you may want to enable the
22969 * desired directions for flipping if you need interactive flipping. You must
22970 * call this function once for each direction that should be enabled.
22972 * @see elm_flip_interaction_set()
22974 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22976 * @brief Get the enabled state of that flip direction
22978 * @param obj The flip object
22979 * @param dir The direction to check
22980 * @return If that direction is enabled or not
22982 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22984 * @see elm_flip_interaction_set()
22986 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22988 * @brief Set the amount of the flip that is sensitive to interactive flip
22990 * @param obj The flip object
22991 * @param dir The direction to modify
22992 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22994 * Set the amount of the flip that is sensitive to interactive flip, with 0
22995 * representing no area in the flip and 1 representing the entire flip. There
22996 * is however a consideration to be made in that the area will never be
22997 * smaller than the finger size set(as set in your Elementary configuration).
22999 * @see elm_flip_interaction_set()
23001 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
23003 * @brief Get the amount of the flip that is sensitive to interactive flip
23005 * @param obj The flip object
23006 * @param dir The direction to check
23007 * @return The size set for that direction
23009 * Returns the amount os sensitive area set by
23010 * elm_flip_interacton_direction_hitsize_set().
23012 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
23017 /* scrolledentry */
23018 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23019 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
23020 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23021 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
23022 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23023 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23024 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23025 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23026 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23027 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23028 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
23029 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
23030 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23031 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23032 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23033 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23034 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23035 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23036 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23037 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23038 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23039 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23040 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23041 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23042 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23043 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23044 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23045 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23046 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23047 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23048 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23049 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23050 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23051 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23052 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23053 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);
23054 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23055 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23056 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);
23057 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23058 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);
23059 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23060 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23061 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23062 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23063 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23064 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23065 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23066 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23067 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);
23068 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);
23069 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);
23070 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);
23071 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);
23072 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);
23073 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23074 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23075 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23076 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23077 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23078 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23079 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23082 * @defgroup Conformant Conformant
23083 * @ingroup Elementary
23085 * @image html img/widget/conformant/preview-00.png
23086 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23088 * @image html img/conformant.png
23089 * @image latex img/conformant.eps width=\textwidth
23091 * The aim is to provide a widget that can be used in elementary apps to
23092 * account for space taken up by the indicator, virtual keypad & softkey
23093 * windows when running the illume2 module of E17.
23095 * So conformant content will be sized and positioned considering the
23096 * space required for such stuff, and when they popup, as a keyboard
23097 * shows when an entry is selected, conformant content won't change.
23099 * Available styles for it:
23102 * See how to use this widget in this example:
23103 * @ref conformant_example
23107 * @addtogroup Conformant
23112 * Add a new conformant widget to the given parent Elementary
23113 * (container) object.
23115 * @param parent The parent object.
23116 * @return A new conformant widget handle or @c NULL, on errors.
23118 * This function inserts a new conformant widget on the canvas.
23120 * @ingroup Conformant
23122 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23125 * Set the content of the conformant widget.
23127 * @param obj The conformant object.
23128 * @param content The content to be displayed by the conformant.
23130 * Content will be sized and positioned considering the space required
23131 * to display a virtual keyboard. So it won't fill all the conformant
23132 * size. This way is possible to be sure that content won't resize
23133 * or be re-positioned after the keyboard is displayed.
23135 * Once the content object is set, a previously set one will be deleted.
23136 * If you want to keep that old content object, use the
23137 * elm_conformat_content_unset() function.
23139 * @see elm_conformant_content_unset()
23140 * @see elm_conformant_content_get()
23142 * @ingroup Conformant
23144 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23147 * Get the content of the conformant widget.
23149 * @param obj The conformant object.
23150 * @return The content that is being used.
23152 * Return the content object which is set for this widget.
23153 * It won't be unparent from conformant. For that, use
23154 * elm_conformant_content_unset().
23156 * @see elm_conformant_content_set() for more details.
23157 * @see elm_conformant_content_unset()
23159 * @ingroup Conformant
23161 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23164 * Unset the content of the conformant widget.
23166 * @param obj The conformant object.
23167 * @return The content that was being used.
23169 * Unparent and return the content object which was set for this widget.
23171 * @see elm_conformant_content_set() for more details.
23173 * @ingroup Conformant
23175 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23178 * Returns the Evas_Object that represents the content area.
23180 * @param obj The conformant object.
23181 * @return The content area of the widget.
23183 * @ingroup Conformant
23185 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23192 * @defgroup Mapbuf Mapbuf
23193 * @ingroup Elementary
23195 * @image html img/widget/mapbuf/preview-00.png
23196 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23198 * This holds one content object and uses an Evas Map of transformation
23199 * points to be later used with this content. So the content will be
23200 * moved, resized, etc as a single image. So it will improve performance
23201 * when you have a complex interafce, with a lot of elements, and will
23202 * need to resize or move it frequently (the content object and its
23205 * See how to use this widget in this example:
23206 * @ref mapbuf_example
23210 * @addtogroup Mapbuf
23215 * Add a new mapbuf widget to the given parent Elementary
23216 * (container) object.
23218 * @param parent The parent object.
23219 * @return A new mapbuf widget handle or @c NULL, on errors.
23221 * This function inserts a new mapbuf widget on the canvas.
23225 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23228 * Set the content of the mapbuf.
23230 * @param obj The mapbuf object.
23231 * @param content The content that will be filled in this mapbuf object.
23233 * Once the content object is set, a previously set one will be deleted.
23234 * If you want to keep that old content object, use the
23235 * elm_mapbuf_content_unset() function.
23237 * To enable map, elm_mapbuf_enabled_set() should be used.
23241 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23244 * Get the content of the mapbuf.
23246 * @param obj The mapbuf object.
23247 * @return The content that is being used.
23249 * Return the content object which is set for this widget.
23251 * @see elm_mapbuf_content_set() for details.
23255 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23258 * Unset the content of the mapbuf.
23260 * @param obj The mapbuf object.
23261 * @return The content that was being used.
23263 * Unparent and return the content object which was set for this widget.
23265 * @see elm_mapbuf_content_set() for details.
23269 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23272 * Enable or disable the map.
23274 * @param obj The mapbuf object.
23275 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23277 * This enables the map that is set or disables it. On enable, the object
23278 * geometry will be saved, and the new geometry will change (position and
23279 * size) to reflect the map geometry set.
23281 * Also, when enabled, alpha and smooth states will be used, so if the
23282 * content isn't solid, alpha should be enabled, for example, otherwise
23283 * a black retangle will fill the content.
23285 * When disabled, the stored map will be freed and geometry prior to
23286 * enabling the map will be restored.
23288 * It's disabled by default.
23290 * @see elm_mapbuf_alpha_set()
23291 * @see elm_mapbuf_smooth_set()
23295 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23298 * Get a value whether map is enabled or not.
23300 * @param obj The mapbuf object.
23301 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23302 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23304 * @see elm_mapbuf_enabled_set() for details.
23308 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23311 * Enable or disable smooth map rendering.
23313 * @param obj The mapbuf object.
23314 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23317 * This sets smoothing for map rendering. If the object is a type that has
23318 * its own smoothing settings, then both the smooth settings for this object
23319 * and the map must be turned off.
23321 * By default smooth maps are enabled.
23325 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23328 * Get a value whether smooth map rendering is enabled or not.
23330 * @param obj The mapbuf object.
23331 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23332 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23334 * @see elm_mapbuf_smooth_set() for details.
23338 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23341 * Set or unset alpha flag for map rendering.
23343 * @param obj The mapbuf object.
23344 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23347 * This sets alpha flag for map rendering. If the object is a type that has
23348 * its own alpha settings, then this will take precedence. Only image objects
23349 * have this currently. It stops alpha blending of the map area, and is
23350 * useful if you know the object and/or all sub-objects is 100% solid.
23352 * Alpha is enabled by default.
23356 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23359 * Get a value whether alpha blending is enabled or not.
23361 * @param obj The mapbuf object.
23362 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23363 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23365 * @see elm_mapbuf_alpha_set() for details.
23369 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23376 * @defgroup Flipselector Flip Selector
23378 * @image html img/widget/flipselector/preview-00.png
23379 * @image latex img/widget/flipselector/preview-00.eps
23381 * A flip selector is a widget to show a set of @b text items, one
23382 * at a time, with the same sheet switching style as the @ref Clock
23383 * "clock" widget, when one changes the current displaying sheet
23384 * (thus, the "flip" in the name).
23386 * User clicks to flip sheets which are @b held for some time will
23387 * make the flip selector to flip continuosly and automatically for
23388 * the user. The interval between flips will keep growing in time,
23389 * so that it helps the user to reach an item which is distant from
23390 * the current selection.
23392 * Smart callbacks one can register to:
23393 * - @c "selected" - when the widget's selected text item is changed
23394 * - @c "overflowed" - when the widget's current selection is changed
23395 * from the first item in its list to the last
23396 * - @c "underflowed" - when the widget's current selection is changed
23397 * from the last item in its list to the first
23399 * Available styles for it:
23402 * Here is an example on its usage:
23403 * @li @ref flipselector_example
23407 * @addtogroup Flipselector
23411 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23414 * Add a new flip selector widget to the given parent Elementary
23415 * (container) widget
23417 * @param parent The parent object
23418 * @return a new flip selector widget handle or @c NULL, on errors
23420 * This function inserts a new flip selector widget on the canvas.
23422 * @ingroup Flipselector
23424 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23427 * Programmatically select the next item of a flip selector widget
23429 * @param obj The flipselector object
23431 * @note The selection will be animated. Also, if it reaches the
23432 * end of its list of member items, it will continue with the first
23435 * @ingroup Flipselector
23437 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23440 * Programmatically select the previous item of a flip selector
23443 * @param obj The flipselector object
23445 * @note The selection will be animated. Also, if it reaches the
23446 * beginning of its list of member items, it will continue with the
23447 * last one backwards.
23449 * @ingroup Flipselector
23451 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23454 * Append a (text) item to a flip selector widget
23456 * @param obj The flipselector object
23457 * @param label The (text) label of the new item
23458 * @param func Convenience callback function to take place when
23460 * @param data Data passed to @p func, above
23461 * @return A handle to the item added or @c NULL, on errors
23463 * The widget's list of labels to show will be appended with the
23464 * given value. If the user wishes so, a callback function pointer
23465 * can be passed, which will get called when this same item is
23468 * @note The current selection @b won't be modified by appending an
23469 * element to the list.
23471 * @note The maximum length of the text label is going to be
23472 * determined <b>by the widget's theme</b>. Strings larger than
23473 * that value are going to be @b truncated.
23475 * @ingroup Flipselector
23477 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23480 * Prepend a (text) item to a flip selector widget
23482 * @param obj The flipselector object
23483 * @param label The (text) label of the new item
23484 * @param func Convenience callback function to take place when
23486 * @param data Data passed to @p func, above
23487 * @return A handle to the item added or @c NULL, on errors
23489 * The widget's list of labels to show will be prepended with the
23490 * given value. If the user wishes so, a callback function pointer
23491 * can be passed, which will get called when this same item is
23494 * @note The current selection @b won't be modified by prepending
23495 * an element to the list.
23497 * @note The maximum length of the text label is going to be
23498 * determined <b>by the widget's theme</b>. Strings larger than
23499 * that value are going to be @b truncated.
23501 * @ingroup Flipselector
23503 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23506 * Get the internal list of items in a given flip selector widget.
23508 * @param obj The flipselector object
23509 * @return The list of items (#Elm_Flipselector_Item as data) or
23510 * @c NULL on errors.
23512 * This list is @b not to be modified in any way and must not be
23513 * freed. Use the list members with functions like
23514 * elm_flipselector_item_label_set(),
23515 * elm_flipselector_item_label_get(),
23516 * elm_flipselector_item_del(),
23517 * elm_flipselector_item_selected_get(),
23518 * elm_flipselector_item_selected_set().
23520 * @warning This list is only valid until @p obj object's internal
23521 * items list is changed. It should be fetched again with another
23522 * call to this function when changes happen.
23524 * @ingroup Flipselector
23526 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23529 * Get the first item in the given flip selector widget's list of
23532 * @param obj The flipselector object
23533 * @return The first item or @c NULL, if it has no items (and on
23536 * @see elm_flipselector_item_append()
23537 * @see elm_flipselector_last_item_get()
23539 * @ingroup Flipselector
23541 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23544 * Get the last item in the given flip selector widget's list of
23547 * @param obj The flipselector object
23548 * @return The last item or @c NULL, if it has no items (and on
23551 * @see elm_flipselector_item_prepend()
23552 * @see elm_flipselector_first_item_get()
23554 * @ingroup Flipselector
23556 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23559 * Get the currently selected item in a flip selector widget.
23561 * @param obj The flipselector object
23562 * @return The selected item or @c NULL, if the widget has no items
23565 * @ingroup Flipselector
23567 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23570 * Set whether a given flip selector widget's item should be the
23571 * currently selected one.
23573 * @param item The flip selector item
23574 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23576 * This sets whether @p item is or not the selected (thus, under
23577 * display) one. If @p item is different than one under display,
23578 * the latter will be unselected. If the @p item is set to be
23579 * unselected, on the other hand, the @b first item in the widget's
23580 * internal members list will be the new selected one.
23582 * @see elm_flipselector_item_selected_get()
23584 * @ingroup Flipselector
23586 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23589 * Get whether a given flip selector widget's item is the currently
23592 * @param item The flip selector item
23593 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23596 * @see elm_flipselector_item_selected_set()
23598 * @ingroup Flipselector
23600 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23603 * Delete a given item from a flip selector widget.
23605 * @param item The item to delete
23607 * @ingroup Flipselector
23609 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23612 * Get the label of a given flip selector widget's item.
23614 * @param item The item to get label from
23615 * @return The text label of @p item or @c NULL, on errors
23617 * @see elm_flipselector_item_label_set()
23619 * @ingroup Flipselector
23621 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23624 * Set the label of a given flip selector widget's item.
23626 * @param item The item to set label on
23627 * @param label The text label string, in UTF-8 encoding
23629 * @see elm_flipselector_item_label_get()
23631 * @ingroup Flipselector
23633 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23636 * Gets the item before @p item in a flip selector widget's
23637 * internal list of items.
23639 * @param item The item to fetch previous from
23640 * @return The item before the @p item, in its parent's list. If
23641 * there is no previous item for @p item or there's an
23642 * error, @c NULL is returned.
23644 * @see elm_flipselector_item_next_get()
23646 * @ingroup Flipselector
23648 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23651 * Gets the item after @p item in a flip selector widget's
23652 * internal list of items.
23654 * @param item The item to fetch next from
23655 * @return The item after the @p item, in its parent's list. If
23656 * there is no next item for @p item or there's an
23657 * error, @c NULL is returned.
23659 * @see elm_flipselector_item_next_get()
23661 * @ingroup Flipselector
23663 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23666 * Set the interval on time updates for an user mouse button hold
23667 * on a flip selector widget.
23669 * @param obj The flip selector object
23670 * @param interval The (first) interval value in seconds
23672 * This interval value is @b decreased while the user holds the
23673 * mouse pointer either flipping up or flipping doww a given flip
23676 * This helps the user to get to a given item distant from the
23677 * current one easier/faster, as it will start to flip quicker and
23678 * quicker on mouse button holds.
23680 * The calculation for the next flip interval value, starting from
23681 * the one set with this call, is the previous interval divided by
23682 * 1.05, so it decreases a little bit.
23684 * The default starting interval value for automatic flips is
23687 * @see elm_flipselector_interval_get()
23689 * @ingroup Flipselector
23691 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23694 * Get the interval on time updates for an user mouse button hold
23695 * on a flip selector widget.
23697 * @param obj The flip selector object
23698 * @return The (first) interval value, in seconds, set on it
23700 * @see elm_flipselector_interval_set() for more details
23702 * @ingroup Flipselector
23704 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23710 * @addtogroup Calendar
23715 * @enum _Elm_Calendar_Mark_Repeat
23716 * @typedef Elm_Calendar_Mark_Repeat
23718 * Event periodicity, used to define if a mark should be repeated
23719 * @b beyond event's day. It's set when a mark is added.
23721 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23722 * there will be marks every week after this date. Marks will be displayed
23723 * at 13th, 20th, 27th, 3rd June ...
23725 * Values don't work as bitmask, only one can be choosen.
23727 * @see elm_calendar_mark_add()
23729 * @ingroup Calendar
23731 typedef enum _Elm_Calendar_Mark_Repeat
23733 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23734 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23735 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23736 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*/
23737 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. */
23738 } Elm_Calendar_Mark_Repeat;
23740 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(). */
23743 * Add a new calendar widget to the given parent Elementary
23744 * (container) object.
23746 * @param parent The parent object.
23747 * @return a new calendar widget handle or @c NULL, on errors.
23749 * This function inserts a new calendar widget on the canvas.
23751 * @ref calendar_example_01
23753 * @ingroup Calendar
23755 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23758 * Get weekdays names displayed by the calendar.
23760 * @param obj The calendar object.
23761 * @return Array of seven strings to be used as weekday names.
23763 * By default, weekdays abbreviations get from system are displayed:
23764 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23765 * The first string is related to Sunday, the second to Monday...
23767 * @see elm_calendar_weekdays_name_set()
23769 * @ref calendar_example_05
23771 * @ingroup Calendar
23773 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23776 * Set weekdays names to be displayed by the calendar.
23778 * @param obj The calendar object.
23779 * @param weekdays Array of seven strings to be used as weekday names.
23780 * @warning It must have 7 elements, or it will access invalid memory.
23781 * @warning The strings must be NULL terminated ('@\0').
23783 * By default, weekdays abbreviations get from system are displayed:
23784 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23786 * The first string should be related to Sunday, the second to Monday...
23788 * The usage should be like this:
23790 * const char *weekdays[] =
23792 * "Sunday", "Monday", "Tuesday", "Wednesday",
23793 * "Thursday", "Friday", "Saturday"
23795 * elm_calendar_weekdays_names_set(calendar, weekdays);
23798 * @see elm_calendar_weekdays_name_get()
23800 * @ref calendar_example_02
23802 * @ingroup Calendar
23804 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23807 * Set the minimum and maximum values for the year
23809 * @param obj The calendar object
23810 * @param min The minimum year, greater than 1901;
23811 * @param max The maximum year;
23813 * Maximum must be greater than minimum, except if you don't wan't to set
23815 * Default values are 1902 and -1.
23817 * If the maximum year is a negative value, it will be limited depending
23818 * on the platform architecture (year 2037 for 32 bits);
23820 * @see elm_calendar_min_max_year_get()
23822 * @ref calendar_example_03
23824 * @ingroup Calendar
23826 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23829 * Get the minimum and maximum values for the year
23831 * @param obj The calendar object.
23832 * @param min The minimum year.
23833 * @param max The maximum year.
23835 * Default values are 1902 and -1.
23837 * @see elm_calendar_min_max_year_get() for more details.
23839 * @ref calendar_example_05
23841 * @ingroup Calendar
23843 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23846 * Enable or disable day selection
23848 * @param obj The calendar object.
23849 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23852 * Enabled by default. If disabled, the user still can select months,
23853 * but not days. Selected days are highlighted on calendar.
23854 * It should be used if you won't need such selection for the widget usage.
23856 * When a day is selected, or month is changed, smart callbacks for
23857 * signal "changed" will be called.
23859 * @see elm_calendar_day_selection_enable_get()
23861 * @ref calendar_example_04
23863 * @ingroup Calendar
23865 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23868 * Get a value whether day selection is enabled or not.
23870 * @see elm_calendar_day_selection_enable_set() for details.
23872 * @param obj The calendar object.
23873 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23874 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23876 * @ref calendar_example_05
23878 * @ingroup Calendar
23880 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23884 * Set selected date to be highlighted on calendar.
23886 * @param obj The calendar object.
23887 * @param selected_time A @b tm struct to represent the selected date.
23889 * Set the selected date, changing the displayed month if needed.
23890 * Selected date changes when the user goes to next/previous month or
23891 * select a day pressing over it on calendar.
23893 * @see elm_calendar_selected_time_get()
23895 * @ref calendar_example_04
23897 * @ingroup Calendar
23899 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23902 * Get selected date.
23904 * @param obj The calendar object
23905 * @param selected_time A @b tm struct to point to selected date
23906 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23909 * Get date selected by the user or set by function
23910 * elm_calendar_selected_time_set().
23911 * Selected date changes when the user goes to next/previous month or
23912 * select a day pressing over it on calendar.
23914 * @see elm_calendar_selected_time_get()
23916 * @ref calendar_example_05
23918 * @ingroup Calendar
23920 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23923 * Set a function to format the string that will be used to display
23926 * @param obj The calendar object
23927 * @param format_function Function to set the month-year string given
23928 * the selected date
23930 * By default it uses strftime with "%B %Y" format string.
23931 * It should allocate the memory that will be used by the string,
23932 * that will be freed by the widget after usage.
23933 * A pointer to the string and a pointer to the time struct will be provided.
23938 * _format_month_year(struct tm *selected_time)
23941 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23942 * return strdup(buf);
23945 * elm_calendar_format_function_set(calendar, _format_month_year);
23948 * @ref calendar_example_02
23950 * @ingroup Calendar
23952 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23955 * Add a new mark to the calendar
23957 * @param obj The calendar object
23958 * @param mark_type A string used to define the type of mark. It will be
23959 * emitted to the theme, that should display a related modification on these
23960 * days representation.
23961 * @param mark_time A time struct to represent the date of inclusion of the
23962 * mark. For marks that repeats it will just be displayed after the inclusion
23963 * date in the calendar.
23964 * @param repeat Repeat the event following this periodicity. Can be a unique
23965 * mark (that don't repeat), daily, weekly, monthly or annually.
23966 * @return The created mark or @p NULL upon failure.
23968 * Add a mark that will be drawn in the calendar respecting the insertion
23969 * time and periodicity. It will emit the type as signal to the widget theme.
23970 * Default theme supports "holiday" and "checked", but it can be extended.
23972 * It won't immediately update the calendar, drawing the marks.
23973 * For this, call elm_calendar_marks_draw(). However, when user selects
23974 * next or previous month calendar forces marks drawn.
23976 * Marks created with this method can be deleted with
23977 * elm_calendar_mark_del().
23981 * struct tm selected_time;
23982 * time_t current_time;
23984 * current_time = time(NULL) + 5 * 84600;
23985 * localtime_r(¤t_time, &selected_time);
23986 * elm_calendar_mark_add(cal, "holiday", selected_time,
23987 * ELM_CALENDAR_ANNUALLY);
23989 * current_time = time(NULL) + 1 * 84600;
23990 * localtime_r(¤t_time, &selected_time);
23991 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23993 * elm_calendar_marks_draw(cal);
23996 * @see elm_calendar_marks_draw()
23997 * @see elm_calendar_mark_del()
23999 * @ref calendar_example_06
24001 * @ingroup Calendar
24003 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);
24006 * Delete mark from the calendar.
24008 * @param mark The mark to be deleted.
24010 * If deleting all calendar marks is required, elm_calendar_marks_clear()
24011 * should be used instead of getting marks list and deleting each one.
24013 * @see elm_calendar_mark_add()
24015 * @ref calendar_example_06
24017 * @ingroup Calendar
24019 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
24022 * Remove all calendar's marks
24024 * @param obj The calendar object.
24026 * @see elm_calendar_mark_add()
24027 * @see elm_calendar_mark_del()
24029 * @ingroup Calendar
24031 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24035 * Get a list of all the calendar marks.
24037 * @param obj The calendar object.
24038 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24040 * @see elm_calendar_mark_add()
24041 * @see elm_calendar_mark_del()
24042 * @see elm_calendar_marks_clear()
24044 * @ingroup Calendar
24046 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24049 * Draw calendar marks.
24051 * @param obj The calendar object.
24053 * Should be used after adding, removing or clearing marks.
24054 * It will go through the entire marks list updating the calendar.
24055 * If lots of marks will be added, add all the marks and then call
24058 * When the month is changed, i.e. user selects next or previous month,
24059 * marks will be drawed.
24061 * @see elm_calendar_mark_add()
24062 * @see elm_calendar_mark_del()
24063 * @see elm_calendar_marks_clear()
24065 * @ref calendar_example_06
24067 * @ingroup Calendar
24069 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24072 * Set a day text color to the same that represents Saturdays.
24074 * @param obj The calendar object.
24075 * @param pos The text position. Position is the cell counter, from left
24076 * to right, up to down. It starts on 0 and ends on 41.
24078 * @deprecated use elm_calendar_mark_add() instead like:
24081 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24082 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24085 * @see elm_calendar_mark_add()
24087 * @ingroup Calendar
24089 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24092 * Set a day text color to the same that represents Sundays.
24094 * @param obj The calendar object.
24095 * @param pos The text position. Position is the cell counter, from left
24096 * to right, up to down. It starts on 0 and ends on 41.
24098 * @deprecated use elm_calendar_mark_add() instead like:
24101 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24102 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24105 * @see elm_calendar_mark_add()
24107 * @ingroup Calendar
24109 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24112 * Set a day text color to the same that represents Weekdays.
24114 * @param obj The calendar object
24115 * @param pos The text position. Position is the cell counter, from left
24116 * to right, up to down. It starts on 0 and ends on 41.
24118 * @deprecated use elm_calendar_mark_add() instead like:
24121 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24123 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24124 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24125 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24126 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24127 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24128 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24129 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24130 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24131 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24134 * @see elm_calendar_mark_add()
24136 * @ingroup Calendar
24138 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24141 * Set the interval on time updates for an user mouse button hold
24142 * on calendar widgets' month selection.
24144 * @param obj The calendar object
24145 * @param interval The (first) interval value in seconds
24147 * This interval value is @b decreased while the user holds the
24148 * mouse pointer either selecting next or previous month.
24150 * This helps the user to get to a given month distant from the
24151 * current one easier/faster, as it will start to change quicker and
24152 * quicker on mouse button holds.
24154 * The calculation for the next change interval value, starting from
24155 * the one set with this call, is the previous interval divided by
24156 * 1.05, so it decreases a little bit.
24158 * The default starting interval value for automatic changes is
24161 * @see elm_calendar_interval_get()
24163 * @ingroup Calendar
24165 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24168 * Get the interval on time updates for an user mouse button hold
24169 * on calendar widgets' month selection.
24171 * @param obj The calendar object
24172 * @return The (first) interval value, in seconds, set on it
24174 * @see elm_calendar_interval_set() for more details
24176 * @ingroup Calendar
24178 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24185 * @defgroup Diskselector Diskselector
24186 * @ingroup Elementary
24188 * @image html img/widget/diskselector/preview-00.png
24189 * @image latex img/widget/diskselector/preview-00.eps
24191 * A diskselector is a kind of list widget. It scrolls horizontally,
24192 * and can contain label and icon objects. Three items are displayed
24193 * with the selected one in the middle.
24195 * It can act like a circular list with round mode and labels can be
24196 * reduced for a defined length for side items.
24198 * Smart callbacks one can listen to:
24199 * - "selected" - when item is selected, i.e. scroller stops.
24201 * Available styles for it:
24204 * List of examples:
24205 * @li @ref diskselector_example_01
24206 * @li @ref diskselector_example_02
24210 * @addtogroup Diskselector
24214 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(). */
24217 * Add a new diskselector widget to the given parent Elementary
24218 * (container) object.
24220 * @param parent The parent object.
24221 * @return a new diskselector widget handle or @c NULL, on errors.
24223 * This function inserts a new diskselector widget on the canvas.
24225 * @ingroup Diskselector
24227 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24230 * Enable or disable round mode.
24232 * @param obj The diskselector object.
24233 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24236 * Disabled by default. If round mode is enabled the items list will
24237 * work like a circle list, so when the user reaches the last item,
24238 * the first one will popup.
24240 * @see elm_diskselector_round_get()
24242 * @ingroup Diskselector
24244 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24247 * Get a value whether round mode is enabled or not.
24249 * @see elm_diskselector_round_set() for details.
24251 * @param obj The diskselector object.
24252 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24253 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24255 * @ingroup Diskselector
24257 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24260 * Get the side labels max length.
24262 * @deprecated use elm_diskselector_side_label_length_get() instead:
24264 * @param obj The diskselector object.
24265 * @return The max length defined for side labels, or 0 if not a valid
24268 * @ingroup Diskselector
24270 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24273 * Set the side labels max length.
24275 * @deprecated use elm_diskselector_side_label_length_set() instead:
24277 * @param obj The diskselector object.
24278 * @param len The max length defined for side labels.
24280 * @ingroup Diskselector
24282 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24285 * Get the side labels max length.
24287 * @see elm_diskselector_side_label_length_set() for details.
24289 * @param obj The diskselector object.
24290 * @return The max length defined for side labels, or 0 if not a valid
24293 * @ingroup Diskselector
24295 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24298 * Set the side labels max length.
24300 * @param obj The diskselector object.
24301 * @param len The max length defined for side labels.
24303 * Length is the number of characters of items' label that will be
24304 * visible when it's set on side positions. It will just crop
24305 * the string after defined size. E.g.:
24307 * An item with label "January" would be displayed on side position as
24308 * "Jan" if max length is set to 3, or "Janu", if this property
24311 * When it's selected, the entire label will be displayed, except for
24312 * width restrictions. In this case label will be cropped and "..."
24313 * will be concatenated.
24315 * Default side label max length is 3.
24317 * This property will be applyed over all items, included before or
24318 * later this function call.
24320 * @ingroup Diskselector
24322 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24325 * Set the number of items to be displayed.
24327 * @param obj The diskselector object.
24328 * @param num The number of items the diskselector will display.
24330 * Default value is 3, and also it's the minimun. If @p num is less
24331 * than 3, it will be set to 3.
24333 * Also, it can be set on theme, using data item @c display_item_num
24334 * on group "elm/diskselector/item/X", where X is style set.
24337 * group { name: "elm/diskselector/item/X";
24339 * item: "display_item_num" "5";
24342 * @ingroup Diskselector
24344 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24347 * Get the number of items in the diskselector object.
24349 * @param obj The diskselector object.
24351 * @ingroup Diskselector
24353 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24356 * Set bouncing behaviour when the scrolled content reaches an edge.
24358 * Tell the internal scroller object whether it should bounce or not
24359 * when it reaches the respective edges for each axis.
24361 * @param obj The diskselector object.
24362 * @param h_bounce Whether to bounce or not in the horizontal axis.
24363 * @param v_bounce Whether to bounce or not in the vertical axis.
24365 * @see elm_scroller_bounce_set()
24367 * @ingroup Diskselector
24369 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24372 * Get the bouncing behaviour of the internal scroller.
24374 * Get whether the internal scroller should bounce when the edge of each
24375 * axis is reached scrolling.
24377 * @param obj The diskselector object.
24378 * @param h_bounce Pointer where to store the bounce state of the horizontal
24380 * @param v_bounce Pointer where to store the bounce state of the vertical
24383 * @see elm_scroller_bounce_get()
24384 * @see elm_diskselector_bounce_set()
24386 * @ingroup Diskselector
24388 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24391 * Get the scrollbar policy.
24393 * @see elm_diskselector_scroller_policy_get() for details.
24395 * @param obj The diskselector object.
24396 * @param policy_h Pointer where to store horizontal scrollbar policy.
24397 * @param policy_v Pointer where to store vertical scrollbar policy.
24399 * @ingroup Diskselector
24401 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);
24404 * Set the scrollbar policy.
24406 * @param obj The diskselector object.
24407 * @param policy_h Horizontal scrollbar policy.
24408 * @param policy_v Vertical scrollbar policy.
24410 * This sets the scrollbar visibility policy for the given scroller.
24411 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24412 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24413 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24414 * This applies respectively for the horizontal and vertical scrollbars.
24416 * The both are disabled by default, i.e., are set to
24417 * #ELM_SCROLLER_POLICY_OFF.
24419 * @ingroup Diskselector
24421 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24424 * Remove all diskselector's items.
24426 * @param obj The diskselector object.
24428 * @see elm_diskselector_item_del()
24429 * @see elm_diskselector_item_append()
24431 * @ingroup Diskselector
24433 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24436 * Get a list of all the diskselector items.
24438 * @param obj The diskselector object.
24439 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24440 * or @c NULL on failure.
24442 * @see elm_diskselector_item_append()
24443 * @see elm_diskselector_item_del()
24444 * @see elm_diskselector_clear()
24446 * @ingroup Diskselector
24448 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24451 * Appends a new item to the diskselector object.
24453 * @param obj The diskselector object.
24454 * @param label The label of the diskselector item.
24455 * @param icon The icon object to use at left side of the item. An
24456 * icon can be any Evas object, but usually it is an icon created
24457 * with elm_icon_add().
24458 * @param func The function to call when the item is selected.
24459 * @param data The data to associate with the item for related callbacks.
24461 * @return The created item or @c NULL upon failure.
24463 * A new item will be created and appended to the diskselector, i.e., will
24464 * be set as last item. Also, if there is no selected item, it will
24465 * be selected. This will always happens for the first appended item.
24467 * If no icon is set, label will be centered on item position, otherwise
24468 * the icon will be placed at left of the label, that will be shifted
24471 * Items created with this method can be deleted with
24472 * elm_diskselector_item_del().
24474 * Associated @p data can be properly freed when item is deleted if a
24475 * callback function is set with elm_diskselector_item_del_cb_set().
24477 * If a function is passed as argument, it will be called everytime this item
24478 * is selected, i.e., the user stops the diskselector with this
24479 * item on center position. If such function isn't needed, just passing
24480 * @c NULL as @p func is enough. The same should be done for @p data.
24482 * Simple example (with no function callback or data associated):
24484 * disk = elm_diskselector_add(win);
24485 * ic = elm_icon_add(win);
24486 * elm_icon_file_set(ic, "path/to/image", NULL);
24487 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24488 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24491 * @see elm_diskselector_item_del()
24492 * @see elm_diskselector_item_del_cb_set()
24493 * @see elm_diskselector_clear()
24494 * @see elm_icon_add()
24496 * @ingroup Diskselector
24498 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);
24502 * Delete them item from the diskselector.
24504 * @param it The item of diskselector to be deleted.
24506 * If deleting all diskselector items is required, elm_diskselector_clear()
24507 * should be used instead of getting items list and deleting each one.
24509 * @see elm_diskselector_clear()
24510 * @see elm_diskselector_item_append()
24511 * @see elm_diskselector_item_del_cb_set()
24513 * @ingroup Diskselector
24515 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24518 * Set the function called when a diskselector item is freed.
24520 * @param it The item to set the callback on
24521 * @param func The function called
24523 * If there is a @p func, then it will be called prior item's memory release.
24524 * That will be called with the following arguments:
24526 * @li item's Evas object;
24529 * This way, a data associated to a diskselector item could be properly
24532 * @ingroup Diskselector
24534 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24537 * Get the data associated to the item.
24539 * @param it The diskselector item
24540 * @return The data associated to @p it
24542 * The return value is a pointer to data associated to @p item when it was
24543 * created, with function elm_diskselector_item_append(). If no data
24544 * was passed as argument, it will return @c NULL.
24546 * @see elm_diskselector_item_append()
24548 * @ingroup Diskselector
24550 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24553 * Set the icon associated to the item.
24555 * @param it The diskselector item
24556 * @param icon The icon object to associate with @p it
24558 * The icon object to use at left side of the item. An
24559 * icon can be any Evas object, but usually it is an icon created
24560 * with elm_icon_add().
24562 * Once the icon object is set, a previously set one will be deleted.
24563 * @warning Setting the same icon for two items will cause the icon to
24564 * dissapear from the first item.
24566 * If an icon was passed as argument on item creation, with function
24567 * elm_diskselector_item_append(), it will be already
24568 * associated to the item.
24570 * @see elm_diskselector_item_append()
24571 * @see elm_diskselector_item_icon_get()
24573 * @ingroup Diskselector
24575 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24578 * Get the icon associated to the item.
24580 * @param it The diskselector item
24581 * @return The icon associated to @p it
24583 * The return value is a pointer to the icon associated to @p item when it was
24584 * created, with function elm_diskselector_item_append(), or later
24585 * with function elm_diskselector_item_icon_set. If no icon
24586 * was passed as argument, it will return @c NULL.
24588 * @see elm_diskselector_item_append()
24589 * @see elm_diskselector_item_icon_set()
24591 * @ingroup Diskselector
24593 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24596 * Set the label of item.
24598 * @param it The item of diskselector.
24599 * @param label The label of item.
24601 * The label to be displayed by the item.
24603 * If no icon is set, label will be centered on item position, otherwise
24604 * the icon will be placed at left of the label, that will be shifted
24607 * An item with label "January" would be displayed on side position as
24608 * "Jan" if max length is set to 3 with function
24609 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24612 * When this @p item is selected, the entire label will be displayed,
24613 * except for width restrictions.
24614 * In this case label will be cropped and "..." will be concatenated,
24615 * but only for display purposes. It will keep the entire string, so
24616 * if diskselector is resized the remaining characters will be displayed.
24618 * If a label was passed as argument on item creation, with function
24619 * elm_diskselector_item_append(), it will be already
24620 * displayed by the item.
24622 * @see elm_diskselector_side_label_lenght_set()
24623 * @see elm_diskselector_item_label_get()
24624 * @see elm_diskselector_item_append()
24626 * @ingroup Diskselector
24628 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24631 * Get the label of item.
24633 * @param it The item of diskselector.
24634 * @return The label of item.
24636 * The return value is a pointer to the label associated to @p item when it was
24637 * created, with function elm_diskselector_item_append(), or later
24638 * with function elm_diskselector_item_label_set. If no label
24639 * was passed as argument, it will return @c NULL.
24641 * @see elm_diskselector_item_label_set() for more details.
24642 * @see elm_diskselector_item_append()
24644 * @ingroup Diskselector
24646 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24649 * Get the selected item.
24651 * @param obj The diskselector object.
24652 * @return The selected diskselector item.
24654 * The selected item can be unselected with function
24655 * elm_diskselector_item_selected_set(), and the first item of
24656 * diskselector will be selected.
24658 * The selected item always will be centered on diskselector, with
24659 * full label displayed, i.e., max lenght set to side labels won't
24660 * apply on the selected item. More details on
24661 * elm_diskselector_side_label_length_set().
24663 * @ingroup Diskselector
24665 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24668 * Set the selected state of an item.
24670 * @param it The diskselector item
24671 * @param selected The selected state
24673 * This sets the selected state of the given item @p it.
24674 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24676 * If a new item is selected the previosly selected will be unselected.
24677 * Previoulsy selected item can be get with function
24678 * elm_diskselector_selected_item_get().
24680 * If the item @p it is unselected, the first item of diskselector will
24683 * Selected items will be visible on center position of diskselector.
24684 * So if it was on another position before selected, or was invisible,
24685 * diskselector will animate items until the selected item reaches center
24688 * @see elm_diskselector_item_selected_get()
24689 * @see elm_diskselector_selected_item_get()
24691 * @ingroup Diskselector
24693 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24696 * Get whether the @p item is selected or not.
24698 * @param it The diskselector item.
24699 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24700 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24702 * @see elm_diskselector_selected_item_set() for details.
24703 * @see elm_diskselector_item_selected_get()
24705 * @ingroup Diskselector
24707 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24710 * Get the first item of the diskselector.
24712 * @param obj The diskselector object.
24713 * @return The first item, or @c NULL if none.
24715 * The list of items follows append order. So it will return the first
24716 * item appended to the widget that wasn't deleted.
24718 * @see elm_diskselector_item_append()
24719 * @see elm_diskselector_items_get()
24721 * @ingroup Diskselector
24723 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24726 * Get the last item of the diskselector.
24728 * @param obj The diskselector object.
24729 * @return The last item, or @c NULL if none.
24731 * The list of items follows append order. So it will return last first
24732 * item appended to the widget that wasn't deleted.
24734 * @see elm_diskselector_item_append()
24735 * @see elm_diskselector_items_get()
24737 * @ingroup Diskselector
24739 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24742 * Get the item before @p item in diskselector.
24744 * @param it The diskselector item.
24745 * @return The item before @p item, or @c NULL if none or on failure.
24747 * The list of items follows append order. So it will return item appended
24748 * just before @p item and that wasn't deleted.
24750 * If it is the first item, @c NULL will be returned.
24751 * First item can be get by elm_diskselector_first_item_get().
24753 * @see elm_diskselector_item_append()
24754 * @see elm_diskselector_items_get()
24756 * @ingroup Diskselector
24758 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24761 * Get the item after @p item in diskselector.
24763 * @param it The diskselector item.
24764 * @return The item after @p item, or @c NULL if none or on failure.
24766 * The list of items follows append order. So it will return item appended
24767 * just after @p item and that wasn't deleted.
24769 * If it is the last item, @c NULL will be returned.
24770 * Last item can be get by elm_diskselector_last_item_get().
24772 * @see elm_diskselector_item_append()
24773 * @see elm_diskselector_items_get()
24775 * @ingroup Diskselector
24777 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24780 * Set the text to be shown in the diskselector item.
24782 * @param item Target item
24783 * @param text The text to set in the content
24785 * Setup the text as tooltip to object. The item can have only one tooltip,
24786 * so any previous tooltip data is removed.
24788 * @see elm_object_tooltip_text_set() for more details.
24790 * @ingroup Diskselector
24792 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24795 * Set the content to be shown in the tooltip item.
24797 * Setup the tooltip to item. The item can have only one tooltip,
24798 * so any previous tooltip data is removed. @p func(with @p data) will
24799 * be called every time that need show the tooltip and it should
24800 * return a valid Evas_Object. This object is then managed fully by
24801 * tooltip system and is deleted when the tooltip is gone.
24803 * @param item the diskselector item being attached a tooltip.
24804 * @param func the function used to create the tooltip contents.
24805 * @param data what to provide to @a func as callback data/context.
24806 * @param del_cb called when data is not needed anymore, either when
24807 * another callback replaces @p func, the tooltip is unset with
24808 * elm_diskselector_item_tooltip_unset() or the owner @a item
24809 * dies. This callback receives as the first parameter the
24810 * given @a data, and @c event_info is the item.
24812 * @see elm_object_tooltip_content_cb_set() for more details.
24814 * @ingroup Diskselector
24816 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);
24819 * Unset tooltip from item.
24821 * @param item diskselector item to remove previously set tooltip.
24823 * Remove tooltip from item. The callback provided as del_cb to
24824 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24825 * it is not used anymore.
24827 * @see elm_object_tooltip_unset() for more details.
24828 * @see elm_diskselector_item_tooltip_content_cb_set()
24830 * @ingroup Diskselector
24832 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24836 * Sets a different style for this item tooltip.
24838 * @note before you set a style you should define a tooltip with
24839 * elm_diskselector_item_tooltip_content_cb_set() or
24840 * elm_diskselector_item_tooltip_text_set()
24842 * @param item diskselector item with tooltip already set.
24843 * @param style the theme style to use (default, transparent, ...)
24845 * @see elm_object_tooltip_style_set() for more details.
24847 * @ingroup Diskselector
24849 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24852 * Get the style for this item tooltip.
24854 * @param item diskselector item with tooltip already set.
24855 * @return style the theme style in use, defaults to "default". If the
24856 * object does not have a tooltip set, then NULL is returned.
24858 * @see elm_object_tooltip_style_get() for more details.
24859 * @see elm_diskselector_item_tooltip_style_set()
24861 * @ingroup Diskselector
24863 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24866 * Set the cursor to be shown when mouse is over the diskselector item
24868 * @param item Target item
24869 * @param cursor the cursor name to be used.
24871 * @see elm_object_cursor_set() for more details.
24873 * @ingroup Diskselector
24875 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24878 * Get the cursor to be shown when mouse is over the diskselector item
24880 * @param item diskselector item with cursor already set.
24881 * @return the cursor name.
24883 * @see elm_object_cursor_get() for more details.
24884 * @see elm_diskselector_cursor_set()
24886 * @ingroup Diskselector
24888 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24892 * Unset the cursor to be shown when mouse is over the diskselector item
24894 * @param item Target item
24896 * @see elm_object_cursor_unset() for more details.
24897 * @see elm_diskselector_cursor_set()
24899 * @ingroup Diskselector
24901 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24904 * Sets a different style for this item cursor.
24906 * @note before you set a style you should define a cursor with
24907 * elm_diskselector_item_cursor_set()
24909 * @param item diskselector item with cursor already set.
24910 * @param style the theme style to use (default, transparent, ...)
24912 * @see elm_object_cursor_style_set() for more details.
24914 * @ingroup Diskselector
24916 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24920 * Get the style for this item cursor.
24922 * @param item diskselector item with cursor already set.
24923 * @return style the theme style in use, defaults to "default". If the
24924 * object does not have a cursor set, then @c NULL is returned.
24926 * @see elm_object_cursor_style_get() for more details.
24927 * @see elm_diskselector_item_cursor_style_set()
24929 * @ingroup Diskselector
24931 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24935 * Set if the cursor set should be searched on the theme or should use
24936 * the provided by the engine, only.
24938 * @note before you set if should look on theme you should define a cursor
24939 * with elm_diskselector_item_cursor_set().
24940 * By default it will only look for cursors provided by the engine.
24942 * @param item widget item with cursor already set.
24943 * @param engine_only boolean to define if cursors set with
24944 * elm_diskselector_item_cursor_set() should be searched only
24945 * between cursors provided by the engine or searched on widget's
24948 * @see elm_object_cursor_engine_only_set() for more details.
24950 * @ingroup Diskselector
24952 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24955 * Get the cursor engine only usage for this item cursor.
24957 * @param item widget item with cursor already set.
24958 * @return engine_only boolean to define it cursors should be looked only
24959 * between the provided by the engine or searched on widget's theme as well.
24960 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24962 * @see elm_object_cursor_engine_only_get() for more details.
24963 * @see elm_diskselector_item_cursor_engine_only_set()
24965 * @ingroup Diskselector
24967 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24974 * @defgroup Colorselector Colorselector
24978 * @image html img/widget/colorselector/preview-00.png
24979 * @image latex img/widget/colorselector/preview-00.eps
24981 * @brief Widget for user to select a color.
24983 * Signals that you can add callbacks for are:
24984 * "changed" - When the color value changes(event_info is NULL).
24986 * See @ref tutorial_colorselector.
24989 * @brief Add a new colorselector to the parent
24991 * @param parent The parent object
24992 * @return The new object or NULL if it cannot be created
24994 * @ingroup Colorselector
24996 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24998 * Set a color for the colorselector
25000 * @param obj Colorselector object
25001 * @param r r-value of color
25002 * @param g g-value of color
25003 * @param b b-value of color
25004 * @param a a-value of color
25006 * @ingroup Colorselector
25008 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
25010 * Get a color from the colorselector
25012 * @param obj Colorselector object
25013 * @param r integer pointer for r-value of color
25014 * @param g integer pointer for g-value of color
25015 * @param b integer pointer for b-value of color
25016 * @param a integer pointer for a-value of color
25018 * @ingroup Colorselector
25020 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
25026 * @defgroup Ctxpopup Ctxpopup
25028 * @image html img/widget/ctxpopup/preview-00.png
25029 * @image latex img/widget/ctxpopup/preview-00.eps
25031 * @brief Context popup widet.
25033 * A ctxpopup is a widget that, when shown, pops up a list of items.
25034 * It automatically chooses an area inside its parent object's view
25035 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25036 * optimally fit into it. In the default theme, it will also point an
25037 * arrow to it's top left position at the time one shows it. Ctxpopup
25038 * items have a label and/or an icon. It is intended for a small
25039 * number of items (hence the use of list, not genlist).
25041 * @note Ctxpopup is a especialization of @ref Hover.
25043 * Signals that you can add callbacks for are:
25044 * "dismissed" - the ctxpopup was dismissed
25046 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25049 typedef enum _Elm_Ctxpopup_Direction
25051 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25053 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25054 the clicked area */
25055 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25056 the clicked area */
25057 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25059 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25060 } Elm_Ctxpopup_Direction;
25063 * @brief Add a new Ctxpopup object to the parent.
25065 * @param parent Parent object
25066 * @return New object or @c NULL, if it cannot be created
25068 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25070 * @brief Set the Ctxpopup's parent
25072 * @param obj The ctxpopup object
25073 * @param area The parent to use
25075 * Set the parent object.
25077 * @note elm_ctxpopup_add() will automatically call this function
25078 * with its @c parent argument.
25080 * @see elm_ctxpopup_add()
25081 * @see elm_hover_parent_set()
25083 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25085 * @brief Get the Ctxpopup's parent
25087 * @param obj The ctxpopup object
25089 * @see elm_ctxpopup_hover_parent_set() for more information
25091 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25093 * @brief Clear all items in the given ctxpopup object.
25095 * @param obj Ctxpopup object
25097 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25099 * @brief Change the ctxpopup's orientation to horizontal or vertical.
25101 * @param obj Ctxpopup object
25102 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25104 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25106 * @brief Get the value of current ctxpopup object's orientation.
25108 * @param obj Ctxpopup object
25109 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25111 * @see elm_ctxpopup_horizontal_set()
25113 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25115 * @brief Add a new item to a ctxpopup object.
25117 * @param obj Ctxpopup object
25118 * @param icon Icon to be set on new item
25119 * @param label The Label of the new item
25120 * @param func Convenience function called when item selected
25121 * @param data Data passed to @p func
25122 * @return A handle to the item added or @c NULL, on errors
25124 * @warning Ctxpopup can't hold both an item list and a content at the same
25125 * time. When an item is added, any previous content will be removed.
25127 * @see elm_ctxpopup_content_set()
25129 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);
25131 * @brief Delete the given item in a ctxpopup object.
25133 * @param it Ctxpopup item to be deleted
25135 * @see elm_ctxpopup_item_append()
25137 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25139 * @brief Set the ctxpopup item's state as disabled or enabled.
25141 * @param it Ctxpopup item to be enabled/disabled
25142 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25144 * When disabled the item is greyed out to indicate it's state.
25146 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25148 * @brief Get the ctxpopup item's disabled/enabled state.
25150 * @param it Ctxpopup item to be enabled/disabled
25151 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25153 * @see elm_ctxpopup_item_disabled_set()
25155 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25157 * @brief Get the icon object for the given ctxpopup item.
25159 * @param it Ctxpopup item
25160 * @return icon object or @c NULL, if the item does not have icon or an error
25163 * @see elm_ctxpopup_item_append()
25164 * @see elm_ctxpopup_item_icon_set()
25166 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25168 * @brief Sets the side icon associated with the ctxpopup item
25170 * @param it Ctxpopup item
25171 * @param icon Icon object to be set
25173 * Once the icon object is set, a previously set one will be deleted.
25174 * @warning Setting the same icon for two items will cause the icon to
25175 * dissapear from the first item.
25177 * @see elm_ctxpopup_item_append()
25179 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25181 * @brief Get the label for the given ctxpopup item.
25183 * @param it Ctxpopup item
25184 * @return label string or @c NULL, if the item does not have label or an
25187 * @see elm_ctxpopup_item_append()
25188 * @see elm_ctxpopup_item_label_set()
25190 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25192 * @brief (Re)set the label on the given ctxpopup item.
25194 * @param it Ctxpopup item
25195 * @param label String to set as label
25197 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25199 * @brief Set an elm widget as the content of the ctxpopup.
25201 * @param obj Ctxpopup object
25202 * @param content Content to be swallowed
25204 * If the content object is already set, a previous one will bedeleted. If
25205 * you want to keep that old content object, use the
25206 * elm_ctxpopup_content_unset() function.
25208 * @deprecated use elm_object_content_set()
25210 * @warning Ctxpopup can't hold both a item list and a content at the same
25211 * time. When a content is set, any previous items will be removed.
25213 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25215 * @brief Unset the ctxpopup content
25217 * @param obj Ctxpopup object
25218 * @return The content that was being used
25220 * Unparent and return the content object which was set for this widget.
25222 * @deprecated use elm_object_content_unset()
25224 * @see elm_ctxpopup_content_set()
25226 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25228 * @brief Set the direction priority of a ctxpopup.
25230 * @param obj Ctxpopup object
25231 * @param first 1st priority of direction
25232 * @param second 2nd priority of direction
25233 * @param third 3th priority of direction
25234 * @param fourth 4th priority of direction
25236 * This functions gives a chance to user to set the priority of ctxpopup
25237 * showing direction. This doesn't guarantee the ctxpopup will appear in the
25238 * requested direction.
25240 * @see Elm_Ctxpopup_Direction
25242 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);
25244 * @brief Get the direction priority of a ctxpopup.
25246 * @param obj Ctxpopup object
25247 * @param first 1st priority of direction to be returned
25248 * @param second 2nd priority of direction to be returned
25249 * @param third 3th priority of direction to be returned
25250 * @param fourth 4th priority of direction to be returned
25252 * @see elm_ctxpopup_direction_priority_set() for more information.
25254 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);
25257 * @brief Get the current direction of a ctxpopup.
25259 * @param obj Ctxpopup object
25260 * @return current direction of a ctxpopup
25262 * @warning Once the ctxpopup showed up, the direction would be determined
25264 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25273 * @defgroup Transit Transit
25274 * @ingroup Elementary
25276 * Transit is designed to apply various animated transition effects to @c
25277 * Evas_Object, such like translation, rotation, etc. For using these
25278 * effects, create an @ref Elm_Transit and add the desired transition effects.
25280 * Once the effects are added into transit, they will be automatically
25281 * managed (their callback will be called until the duration is ended, and
25282 * they will be deleted on completion).
25286 * Elm_Transit *trans = elm_transit_add();
25287 * elm_transit_object_add(trans, obj);
25288 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25289 * elm_transit_duration_set(transit, 1);
25290 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25291 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25292 * elm_transit_repeat_times_set(transit, 3);
25295 * Some transition effects are used to change the properties of objects. They
25297 * @li @ref elm_transit_effect_translation_add
25298 * @li @ref elm_transit_effect_color_add
25299 * @li @ref elm_transit_effect_rotation_add
25300 * @li @ref elm_transit_effect_wipe_add
25301 * @li @ref elm_transit_effect_zoom_add
25302 * @li @ref elm_transit_effect_resizing_add
25304 * Other transition effects are used to make one object disappear and another
25305 * object appear on its old place. These effects are:
25307 * @li @ref elm_transit_effect_flip_add
25308 * @li @ref elm_transit_effect_resizable_flip_add
25309 * @li @ref elm_transit_effect_fade_add
25310 * @li @ref elm_transit_effect_blend_add
25312 * It's also possible to make a transition chain with @ref
25313 * elm_transit_chain_transit_add.
25315 * @warning We strongly recommend to use elm_transit just when edje can not do
25316 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25317 * animations can be manipulated inside the theme.
25319 * List of examples:
25320 * @li @ref transit_example_01_explained
25321 * @li @ref transit_example_02_explained
25322 * @li @ref transit_example_03_c
25323 * @li @ref transit_example_04_c
25329 * @enum Elm_Transit_Tween_Mode
25331 * The type of acceleration used in the transition.
25335 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25336 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25337 over time, then decrease again
25339 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25341 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25343 } Elm_Transit_Tween_Mode;
25346 * @enum Elm_Transit_Effect_Flip_Axis
25348 * The axis where flip effect should be applied.
25352 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25353 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25354 } Elm_Transit_Effect_Flip_Axis;
25356 * @enum Elm_Transit_Effect_Wipe_Dir
25358 * The direction where the wipe effect should occur.
25362 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25363 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25364 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25365 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25366 } Elm_Transit_Effect_Wipe_Dir;
25367 /** @enum Elm_Transit_Effect_Wipe_Type
25369 * Whether the wipe effect should show or hide the object.
25373 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25375 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25377 } Elm_Transit_Effect_Wipe_Type;
25380 * @typedef Elm_Transit
25382 * The Transit created with elm_transit_add(). This type has the information
25383 * about the objects which the transition will be applied, and the
25384 * transition effects that will be used. It also contains info about
25385 * duration, number of repetitions, auto-reverse, etc.
25387 typedef struct _Elm_Transit Elm_Transit;
25388 typedef void Elm_Transit_Effect;
25390 * @typedef Elm_Transit_Effect_Transition_Cb
25392 * Transition callback called for this effect on each transition iteration.
25394 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25396 * Elm_Transit_Effect_End_Cb
25398 * Transition callback called for this effect when the transition is over.
25400 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25403 * Elm_Transit_Del_Cb
25405 * A callback called when the transit is deleted.
25407 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25412 * @note Is not necessary to delete the transit object, it will be deleted at
25413 * the end of its operation.
25414 * @note The transit will start playing when the program enter in the main loop, is not
25415 * necessary to give a start to the transit.
25417 * @return The transit object.
25421 EAPI Elm_Transit *elm_transit_add(void);
25424 * Stops the animation and delete the @p transit object.
25426 * Call this function if you wants to stop the animation before the duration
25427 * time. Make sure the @p transit object is still alive with
25428 * elm_transit_del_cb_set() function.
25429 * All added effects will be deleted, calling its repective data_free_cb
25430 * functions. The function setted by elm_transit_del_cb_set() will be called.
25432 * @see elm_transit_del_cb_set()
25434 * @param transit The transit object to be deleted.
25437 * @warning Just call this function if you are sure the transit is alive.
25439 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25442 * Add a new effect to the transit.
25444 * @note The cb function and the data are the key to the effect. If you try to
25445 * add an already added effect, nothing is done.
25446 * @note After the first addition of an effect in @p transit, if its
25447 * effect list become empty again, the @p transit will be killed by
25448 * elm_transit_del(transit) function.
25452 * Elm_Transit *transit = elm_transit_add();
25453 * elm_transit_effect_add(transit,
25454 * elm_transit_effect_blend_op,
25455 * elm_transit_effect_blend_context_new(),
25456 * elm_transit_effect_blend_context_free);
25459 * @param transit The transit object.
25460 * @param transition_cb The operation function. It is called when the
25461 * animation begins, it is the function that actually performs the animation.
25462 * It is called with the @p data, @p transit and the time progression of the
25463 * animation (a double value between 0.0 and 1.0).
25464 * @param effect The context data of the effect.
25465 * @param end_cb The function to free the context data, it will be called
25466 * at the end of the effect, it must finalize the animation and free the
25470 * @warning The transit free the context data at the and of the transition with
25471 * the data_free_cb function, do not use the context data in another transit.
25473 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);
25476 * Delete an added effect.
25478 * This function will remove the effect from the @p transit, calling the
25479 * data_free_cb to free the @p data.
25481 * @see elm_transit_effect_add()
25483 * @note If the effect is not found, nothing is done.
25484 * @note If the effect list become empty, this function will call
25485 * elm_transit_del(transit), that is, it will kill the @p transit.
25487 * @param transit The transit object.
25488 * @param transition_cb The operation function.
25489 * @param effect The context data of the effect.
25493 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);
25496 * Add new object to apply the effects.
25498 * @note After the first addition of an object in @p transit, if its
25499 * object list become empty again, the @p transit will be killed by
25500 * elm_transit_del(transit) function.
25501 * @note If the @p obj belongs to another transit, the @p obj will be
25502 * removed from it and it will only belong to the @p transit. If the old
25503 * transit stays without objects, it will die.
25504 * @note When you add an object into the @p transit, its state from
25505 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25506 * transit ends, if you change this state whith evas_object_pass_events_set()
25507 * after add the object, this state will change again when @p transit stops to
25510 * @param transit The transit object.
25511 * @param obj Object to be animated.
25514 * @warning It is not allowed to add a new object after transit begins to go.
25516 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25519 * Removes an added object from the transit.
25521 * @note If the @p obj is not in the @p transit, nothing is done.
25522 * @note If the list become empty, this function will call
25523 * elm_transit_del(transit), that is, it will kill the @p transit.
25525 * @param transit The transit object.
25526 * @param obj Object to be removed from @p transit.
25529 * @warning It is not allowed to remove objects after transit begins to go.
25531 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25534 * Get the objects of the transit.
25536 * @param transit The transit object.
25537 * @return a Eina_List with the objects from the transit.
25541 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25544 * Enable/disable keeping up the objects states.
25545 * If it is not kept, the objects states will be reset when transition ends.
25547 * @note @p transit can not be NULL.
25548 * @note One state includes geometry, color, map data.
25550 * @param transit The transit object.
25551 * @param state_keep Keeping or Non Keeping.
25555 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25558 * Get a value whether the objects states will be reset or not.
25560 * @note @p transit can not be NULL
25562 * @see elm_transit_objects_final_state_keep_set()
25564 * @param transit The transit object.
25565 * @return EINA_TRUE means the states of the objects will be reset.
25566 * If @p transit is NULL, EINA_FALSE is returned
25570 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25573 * Set the event enabled when transit is operating.
25575 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25576 * events from mouse and keyboard during the animation.
25577 * @note When you add an object with elm_transit_object_add(), its state from
25578 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25579 * transit ends, if you change this state with evas_object_pass_events_set()
25580 * after adding the object, this state will change again when @p transit stops
25583 * @param transit The transit object.
25584 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25585 * ignored otherwise.
25589 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25592 * Get the value of event enabled status.
25594 * @see elm_transit_event_enabled_set()
25596 * @param transit The Transit object
25597 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25598 * EINA_FALSE is returned
25602 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25605 * Set the user-callback function when the transit is deleted.
25607 * @note Using this function twice will overwrite the first function setted.
25608 * @note the @p transit object will be deleted after call @p cb function.
25610 * @param transit The transit object.
25611 * @param cb Callback function pointer. This function will be called before
25612 * the deletion of the transit.
25613 * @param data Callback funtion user data. It is the @p op parameter.
25617 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25620 * Set reverse effect automatically.
25622 * If auto reverse is setted, after running the effects with the progress
25623 * parameter from 0 to 1, it will call the effecs again with the progress
25624 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25625 * where the duration was setted with the function elm_transit_add and
25626 * the repeat with the function elm_transit_repeat_times_set().
25628 * @param transit The transit object.
25629 * @param reverse EINA_TRUE means the auto_reverse is on.
25633 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25636 * Get if the auto reverse is on.
25638 * @see elm_transit_auto_reverse_set()
25640 * @param transit The transit object.
25641 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25642 * EINA_FALSE is returned
25646 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25649 * Set the transit repeat count. Effect will be repeated by repeat count.
25651 * This function sets the number of repetition the transit will run after
25652 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25653 * If the @p repeat is a negative number, it will repeat infinite times.
25655 * @note If this function is called during the transit execution, the transit
25656 * will run @p repeat times, ignoring the times it already performed.
25658 * @param transit The transit object
25659 * @param repeat Repeat count
25663 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25666 * Get the transit repeat count.
25668 * @see elm_transit_repeat_times_set()
25670 * @param transit The Transit object.
25671 * @return The repeat count. If @p transit is NULL
25676 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25679 * Set the transit animation acceleration type.
25681 * This function sets the tween mode of the transit that can be:
25682 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25683 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25684 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25685 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25687 * @param transit The transit object.
25688 * @param tween_mode The tween type.
25692 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25695 * Get the transit animation acceleration type.
25697 * @note @p transit can not be NULL
25699 * @param transit The transit object.
25700 * @return The tween type. If @p transit is NULL
25701 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25705 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25708 * Set the transit animation time
25710 * @note @p transit can not be NULL
25712 * @param transit The transit object.
25713 * @param duration The animation time.
25717 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25720 * Get the transit animation time
25722 * @note @p transit can not be NULL
25724 * @param transit The transit object.
25726 * @return The transit animation time.
25730 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25733 * Starts the transition.
25734 * Once this API is called, the transit begins to measure the time.
25736 * @note @p transit can not be NULL
25738 * @param transit The transit object.
25742 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25745 * Pause/Resume the transition.
25747 * If you call elm_transit_go again, the transit will be started from the
25748 * beginning, and will be unpaused.
25750 * @note @p transit can not be NULL
25752 * @param transit The transit object.
25753 * @param paused Whether the transition should be paused or not.
25757 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25760 * Get the value of paused status.
25762 * @see elm_transit_paused_set()
25764 * @note @p transit can not be NULL
25766 * @param transit The transit object.
25767 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25768 * EINA_FALSE is returned
25772 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25775 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25777 * The value returned is a fraction (current time / total time). It
25778 * represents the progression position relative to the total.
25780 * @note @p transit can not be NULL
25782 * @param transit The transit object.
25784 * @return The time progression value. If @p transit is NULL
25789 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25792 * Makes the chain relationship between two transits.
25794 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25795 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25797 * @param transit The transit object.
25798 * @param chain_transit The chain transit object. This transit will be operated
25799 * after transit is done.
25801 * This function adds @p chain_transit transition to a chain after the @p
25802 * transit, and will be started as soon as @p transit ends. See @ref
25803 * transit_example_02_explained for a full example.
25807 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25810 * Cut off the chain relationship between two transits.
25812 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25813 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25815 * @param transit The transit object.
25816 * @param chain_transit The chain transit object.
25818 * This function remove the @p chain_transit transition from the @p transit.
25822 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25825 * Get the current chain transit list.
25827 * @note @p transit can not be NULL.
25829 * @param transit The transit object.
25830 * @return chain transit list.
25834 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25837 * Add the Resizing Effect to Elm_Transit.
25839 * @note This API is one of the facades. It creates resizing effect context
25840 * and add it's required APIs to elm_transit_effect_add.
25842 * @see elm_transit_effect_add()
25844 * @param transit Transit object.
25845 * @param from_w Object width size when effect begins.
25846 * @param from_h Object height size when effect begins.
25847 * @param to_w Object width size when effect ends.
25848 * @param to_h Object height size when effect ends.
25849 * @return Resizing effect context data.
25853 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);
25856 * Add the Translation Effect to Elm_Transit.
25858 * @note This API is one of the facades. It creates translation effect context
25859 * and add it's required APIs to elm_transit_effect_add.
25861 * @see elm_transit_effect_add()
25863 * @param transit Transit object.
25864 * @param from_dx X Position variation when effect begins.
25865 * @param from_dy Y Position variation when effect begins.
25866 * @param to_dx X Position variation when effect ends.
25867 * @param to_dy Y Position variation when effect ends.
25868 * @return Translation effect context data.
25871 * @warning It is highly recommended just create a transit with this effect when
25872 * the window that the objects of the transit belongs has already been created.
25873 * This is because this effect needs the geometry information about the objects,
25874 * and if the window was not created yet, it can get a wrong information.
25876 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);
25879 * Add the Zoom Effect to Elm_Transit.
25881 * @note This API is one of the facades. It creates zoom effect context
25882 * and add it's required APIs to elm_transit_effect_add.
25884 * @see elm_transit_effect_add()
25886 * @param transit Transit object.
25887 * @param from_rate Scale rate when effect begins (1 is current rate).
25888 * @param to_rate Scale rate when effect ends.
25889 * @return Zoom effect context data.
25892 * @warning It is highly recommended just create a transit with this effect when
25893 * the window that the objects of the transit belongs has already been created.
25894 * This is because this effect needs the geometry information about the objects,
25895 * and if the window was not created yet, it can get a wrong information.
25897 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25900 * Add the Flip Effect to Elm_Transit.
25902 * @note This API is one of the facades. It creates flip effect context
25903 * and add it's required APIs to elm_transit_effect_add.
25904 * @note This effect is applied to each pair of objects in the order they are listed
25905 * in the transit list of objects. The first object in the pair will be the
25906 * "front" object and the second will be the "back" object.
25908 * @see elm_transit_effect_add()
25910 * @param transit Transit object.
25911 * @param axis Flipping Axis(X or Y).
25912 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25913 * @return Flip effect context data.
25916 * @warning It is highly recommended just create a transit with this effect when
25917 * the window that the objects of the transit belongs has already been created.
25918 * This is because this effect needs the geometry information about the objects,
25919 * and if the window was not created yet, it can get a wrong information.
25921 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25924 * Add the Resizable Flip Effect to Elm_Transit.
25926 * @note This API is one of the facades. It creates resizable flip effect context
25927 * and add it's required APIs to elm_transit_effect_add.
25928 * @note This effect is applied to each pair of objects in the order they are listed
25929 * in the transit list of objects. The first object in the pair will be the
25930 * "front" object and the second will be the "back" object.
25932 * @see elm_transit_effect_add()
25934 * @param transit Transit object.
25935 * @param axis Flipping Axis(X or Y).
25936 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25937 * @return Resizable flip effect context data.
25940 * @warning It is highly recommended just create a transit with this effect when
25941 * the window that the objects of the transit belongs has already been created.
25942 * This is because this effect needs the geometry information about the objects,
25943 * and if the window was not created yet, it can get a wrong information.
25945 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25948 * Add the Wipe Effect to Elm_Transit.
25950 * @note This API is one of the facades. It creates wipe effect context
25951 * and add it's required APIs to elm_transit_effect_add.
25953 * @see elm_transit_effect_add()
25955 * @param transit Transit object.
25956 * @param type Wipe type. Hide or show.
25957 * @param dir Wipe Direction.
25958 * @return Wipe effect context data.
25961 * @warning It is highly recommended just create a transit with this effect when
25962 * the window that the objects of the transit belongs has already been created.
25963 * This is because this effect needs the geometry information about the objects,
25964 * and if the window was not created yet, it can get a wrong information.
25966 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25969 * Add the Color Effect to Elm_Transit.
25971 * @note This API is one of the facades. It creates color effect context
25972 * and add it's required APIs to elm_transit_effect_add.
25974 * @see elm_transit_effect_add()
25976 * @param transit Transit object.
25977 * @param from_r RGB R when effect begins.
25978 * @param from_g RGB G when effect begins.
25979 * @param from_b RGB B when effect begins.
25980 * @param from_a RGB A when effect begins.
25981 * @param to_r RGB R when effect ends.
25982 * @param to_g RGB G when effect ends.
25983 * @param to_b RGB B when effect ends.
25984 * @param to_a RGB A when effect ends.
25985 * @return Color effect context data.
25989 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);
25992 * Add the Fade Effect to Elm_Transit.
25994 * @note This API is one of the facades. It creates fade effect context
25995 * and add it's required APIs to elm_transit_effect_add.
25996 * @note This effect is applied to each pair of objects in the order they are listed
25997 * in the transit list of objects. The first object in the pair will be the
25998 * "before" object and the second will be the "after" object.
26000 * @see elm_transit_effect_add()
26002 * @param transit Transit object.
26003 * @return Fade effect context data.
26006 * @warning It is highly recommended just create a transit with this effect when
26007 * the window that the objects of the transit belongs has already been created.
26008 * This is because this effect needs the color information about the objects,
26009 * and if the window was not created yet, it can get a wrong information.
26011 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
26014 * Add the Blend Effect to Elm_Transit.
26016 * @note This API is one of the facades. It creates blend effect context
26017 * and add it's required APIs to elm_transit_effect_add.
26018 * @note This effect is applied to each pair of objects in the order they are listed
26019 * in the transit list of objects. The first object in the pair will be the
26020 * "before" object and the second will be the "after" object.
26022 * @see elm_transit_effect_add()
26024 * @param transit Transit object.
26025 * @return Blend effect context data.
26028 * @warning It is highly recommended just create a transit with this effect when
26029 * the window that the objects of the transit belongs has already been created.
26030 * This is because this effect needs the color information about the objects,
26031 * and if the window was not created yet, it can get a wrong information.
26033 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26036 * Add the Rotation Effect to Elm_Transit.
26038 * @note This API is one of the facades. It creates rotation effect context
26039 * and add it's required APIs to elm_transit_effect_add.
26041 * @see elm_transit_effect_add()
26043 * @param transit Transit object.
26044 * @param from_degree Degree when effect begins.
26045 * @param to_degree Degree when effect is ends.
26046 * @return Rotation effect context data.
26049 * @warning It is highly recommended just create a transit with this effect when
26050 * the window that the objects of the transit belongs has already been created.
26051 * This is because this effect needs the geometry information about the objects,
26052 * and if the window was not created yet, it can get a wrong information.
26054 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26057 * Add the ImageAnimation Effect to Elm_Transit.
26059 * @note This API is one of the facades. It creates image animation effect context
26060 * and add it's required APIs to elm_transit_effect_add.
26061 * The @p images parameter is a list images paths. This list and
26062 * its contents will be deleted at the end of the effect by
26063 * elm_transit_effect_image_animation_context_free() function.
26067 * char buf[PATH_MAX];
26068 * Eina_List *images = NULL;
26069 * Elm_Transit *transi = elm_transit_add();
26071 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26072 * images = eina_list_append(images, eina_stringshare_add(buf));
26074 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26075 * images = eina_list_append(images, eina_stringshare_add(buf));
26076 * elm_transit_effect_image_animation_add(transi, images);
26080 * @see elm_transit_effect_add()
26082 * @param transit Transit object.
26083 * @param images Eina_List of images file paths. This list and
26084 * its contents will be deleted at the end of the effect by
26085 * elm_transit_effect_image_animation_context_free() function.
26086 * @return Image Animation effect context data.
26090 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26095 typedef struct _Elm_Store Elm_Store;
26096 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
26097 typedef struct _Elm_Store_Item Elm_Store_Item;
26098 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
26099 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
26100 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26101 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
26102 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
26103 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
26104 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
26105 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
26107 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26108 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26109 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26110 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26114 ELM_STORE_ITEM_MAPPING_NONE = 0,
26115 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26116 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26117 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26118 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26119 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26120 // can add more here as needed by common apps
26121 ELM_STORE_ITEM_MAPPING_LAST
26122 } Elm_Store_Item_Mapping_Type;
26124 struct _Elm_Store_Item_Mapping_Icon
26126 // FIXME: allow edje file icons
26128 Elm_Icon_Lookup_Order lookup_order;
26129 Eina_Bool standard_name : 1;
26130 Eina_Bool no_scale : 1;
26131 Eina_Bool smooth : 1;
26132 Eina_Bool scale_up : 1;
26133 Eina_Bool scale_down : 1;
26136 struct _Elm_Store_Item_Mapping_Empty
26141 struct _Elm_Store_Item_Mapping_Photo
26146 struct _Elm_Store_Item_Mapping_Custom
26148 Elm_Store_Item_Mapping_Cb func;
26151 struct _Elm_Store_Item_Mapping
26153 Elm_Store_Item_Mapping_Type type;
26158 Elm_Store_Item_Mapping_Empty empty;
26159 Elm_Store_Item_Mapping_Icon icon;
26160 Elm_Store_Item_Mapping_Photo photo;
26161 Elm_Store_Item_Mapping_Custom custom;
26162 // add more types here
26166 struct _Elm_Store_Item_Info
26168 Elm_Genlist_Item_Class *item_class;
26169 const Elm_Store_Item_Mapping *mapping;
26174 struct _Elm_Store_Item_Info_Filesystem
26176 Elm_Store_Item_Info base;
26180 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26181 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26183 EAPI void elm_store_free(Elm_Store *st);
26185 EAPI Elm_Store *elm_store_filesystem_new(void);
26186 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26187 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26188 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26190 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26192 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26193 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26194 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26195 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26196 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26197 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26199 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26200 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26201 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26202 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26203 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26204 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26205 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26208 * @defgroup SegmentControl SegmentControl
26209 * @ingroup Elementary
26211 * @image html img/widget/segment_control/preview-00.png
26212 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26214 * @image html img/segment_control.png
26215 * @image latex img/segment_control.eps width=\textwidth
26217 * Segment control widget is a horizontal control made of multiple segment
26218 * items, each segment item functioning similar to discrete two state button.
26219 * A segment control groups the items together and provides compact
26220 * single button with multiple equal size segments.
26222 * Segment item size is determined by base widget
26223 * size and the number of items added.
26224 * Only one segment item can be at selected state. A segment item can display
26225 * combination of Text and any Evas_Object like Images or other widget.
26227 * Smart callbacks one can listen to:
26228 * - "changed" - When the user clicks on a segment item which is not
26229 * previously selected and get selected. The event_info parameter is the
26230 * segment item index.
26232 * Available styles for it:
26235 * Here is an example on its usage:
26236 * @li @ref segment_control_example
26240 * @addtogroup SegmentControl
26244 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26247 * Add a new segment control widget to the given parent Elementary
26248 * (container) object.
26250 * @param parent The parent object.
26251 * @return a new segment control widget handle or @c NULL, on errors.
26253 * This function inserts a new segment control widget on the canvas.
26255 * @ingroup SegmentControl
26257 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26260 * Append a new item to the segment control object.
26262 * @param obj The segment control object.
26263 * @param icon The icon object to use for the left side of the item. An
26264 * icon can be any Evas object, but usually it is an icon created
26265 * with elm_icon_add().
26266 * @param label The label of the item.
26267 * Note that, NULL is different from empty string "".
26268 * @return The created item or @c NULL upon failure.
26270 * A new item will be created and appended to the segment control, i.e., will
26271 * be set as @b last item.
26273 * If it should be inserted at another position,
26274 * elm_segment_control_item_insert_at() should be used instead.
26276 * Items created with this function can be deleted with function
26277 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26279 * @note @p label set to @c NULL is different from empty string "".
26281 * only has icon, it will be displayed bigger and centered. If it has
26282 * icon and label, even that an empty string, icon will be smaller and
26283 * positioned at left.
26287 * sc = elm_segment_control_add(win);
26288 * ic = elm_icon_add(win);
26289 * elm_icon_file_set(ic, "path/to/image", NULL);
26290 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26291 * elm_segment_control_item_add(sc, ic, "label");
26292 * evas_object_show(sc);
26295 * @see elm_segment_control_item_insert_at()
26296 * @see elm_segment_control_item_del()
26298 * @ingroup SegmentControl
26300 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26303 * Insert a new item to the segment control object at specified position.
26305 * @param obj The segment control object.
26306 * @param icon The icon object to use for the left side of the item. An
26307 * icon can be any Evas object, but usually it is an icon created
26308 * with elm_icon_add().
26309 * @param label The label of the item.
26310 * @param index Item position. Value should be between 0 and items count.
26311 * @return The created item or @c NULL upon failure.
26313 * Index values must be between @c 0, when item will be prepended to
26314 * segment control, and items count, that can be get with
26315 * elm_segment_control_item_count_get(), case when item will be appended
26316 * to segment control, just like elm_segment_control_item_add().
26318 * Items created with this function can be deleted with function
26319 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26321 * @note @p label set to @c NULL is different from empty string "".
26323 * only has icon, it will be displayed bigger and centered. If it has
26324 * icon and label, even that an empty string, icon will be smaller and
26325 * positioned at left.
26327 * @see elm_segment_control_item_add()
26328 * @see elm_segment_control_item_count_get()
26329 * @see elm_segment_control_item_del()
26331 * @ingroup SegmentControl
26333 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);
26336 * Remove a segment control item from its parent, deleting it.
26338 * @param it The item to be removed.
26340 * Items can be added with elm_segment_control_item_add() or
26341 * elm_segment_control_item_insert_at().
26343 * @ingroup SegmentControl
26345 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26348 * Remove a segment control item at given index from its parent,
26351 * @param obj The segment control object.
26352 * @param index The position of the segment control item to be deleted.
26354 * Items can be added with elm_segment_control_item_add() or
26355 * elm_segment_control_item_insert_at().
26357 * @ingroup SegmentControl
26359 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26362 * Get the Segment items count from segment control.
26364 * @param obj The segment control object.
26365 * @return Segment items count.
26367 * It will just return the number of items added to segment control @p obj.
26369 * @ingroup SegmentControl
26371 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26374 * Get the item placed at specified index.
26376 * @param obj The segment control object.
26377 * @param index The index of the segment item.
26378 * @return The segment control item or @c NULL on failure.
26380 * Index is the position of an item in segment control widget. Its
26381 * range is from @c 0 to <tt> count - 1 </tt>.
26382 * Count is the number of items, that can be get with
26383 * elm_segment_control_item_count_get().
26385 * @ingroup SegmentControl
26387 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26390 * Get the label of item.
26392 * @param obj The segment control object.
26393 * @param index The index of the segment item.
26394 * @return The label of the item at @p index.
26396 * The return value is a pointer to the label 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_label_set. If no label
26399 * was passed as argument, it will return @c NULL.
26401 * @see elm_segment_control_item_label_set() for more details.
26402 * @see elm_segment_control_item_add()
26404 * @ingroup SegmentControl
26406 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26409 * Set the label of item.
26411 * @param it The item of segment control.
26412 * @param text The label of item.
26414 * The label to be displayed by the item.
26415 * Label will be at right of the icon (if set).
26417 * If a label was passed as argument on item creation, with function
26418 * elm_control_segment_item_add(), it will be already
26419 * displayed by the item.
26421 * @see elm_segment_control_item_label_get()
26422 * @see elm_segment_control_item_add()
26424 * @ingroup SegmentControl
26426 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26429 * Get the icon associated to the item.
26431 * @param obj The segment control object.
26432 * @param index The index of the segment item.
26433 * @return The left side icon associated to the item at @p index.
26435 * The return value is a pointer to the icon associated to the item when
26436 * it was created, with function elm_segment_control_item_add(), or later
26437 * with function elm_segment_control_item_icon_set(). If no icon
26438 * was passed as argument, it will return @c NULL.
26440 * @see elm_segment_control_item_add()
26441 * @see elm_segment_control_item_icon_set()
26443 * @ingroup SegmentControl
26445 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26448 * Set the icon associated to the item.
26450 * @param it The segment control item.
26451 * @param icon The icon object to associate with @p it.
26453 * The icon object to use at left side of the item. An
26454 * icon can be any Evas object, but usually it is an icon created
26455 * with elm_icon_add().
26457 * Once the icon object is set, a previously set one will be deleted.
26458 * @warning Setting the same icon for two items will cause the icon to
26459 * dissapear from the first item.
26461 * If an icon was passed as argument on item creation, with function
26462 * elm_segment_control_item_add(), it will be already
26463 * associated to the item.
26465 * @see elm_segment_control_item_add()
26466 * @see elm_segment_control_item_icon_get()
26468 * @ingroup SegmentControl
26470 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26473 * Get the index of an item.
26475 * @param it The segment control item.
26476 * @return The position of item in segment control widget.
26478 * Index is the position of an item in segment control widget. Its
26479 * range is from @c 0 to <tt> count - 1 </tt>.
26480 * Count is the number of items, that can be get with
26481 * elm_segment_control_item_count_get().
26483 * @ingroup SegmentControl
26485 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26488 * Get the base object of the item.
26490 * @param it The segment control item.
26491 * @return The base object associated with @p it.
26493 * Base object is the @c Evas_Object that represents that item.
26495 * @ingroup SegmentControl
26497 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26500 * Get the selected item.
26502 * @param obj The segment control object.
26503 * @return The selected item or @c NULL if none of segment items is
26506 * The selected item can be unselected with function
26507 * elm_segment_control_item_selected_set().
26509 * The selected item always will be highlighted on segment control.
26511 * @ingroup SegmentControl
26513 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26516 * Set the selected state of an item.
26518 * @param it The segment control item
26519 * @param select The selected state
26521 * This sets the selected state of the given item @p it.
26522 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26524 * If a new item is selected the previosly selected will be unselected.
26525 * Previoulsy selected item can be get with function
26526 * elm_segment_control_item_selected_get().
26528 * The selected item always will be highlighted on segment control.
26530 * @see elm_segment_control_item_selected_get()
26532 * @ingroup SegmentControl
26534 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26541 * @defgroup Grid Grid
26543 * The grid is a grid layout widget that lays out a series of children as a
26544 * fixed "grid" of widgets using a given percentage of the grid width and
26545 * height each using the child object.
26547 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26548 * widgets size itself. The default is 100 x 100, so that means the
26549 * position and sizes of children will effectively be percentages (0 to 100)
26550 * of the width or height of the grid widget
26556 * Add a new grid to the parent
26558 * @param parent The parent object
26559 * @return The new object or NULL if it cannot be created
26563 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26566 * Set the virtual size of the grid
26568 * @param obj The grid object
26569 * @param w The virtual width of the grid
26570 * @param h The virtual height of the grid
26574 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26577 * Get the virtual size of the grid
26579 * @param obj The grid object
26580 * @param w Pointer to integer to store the virtual width of the grid
26581 * @param h Pointer to integer to store the virtual height of the grid
26585 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26588 * Pack child at given position and size
26590 * @param obj The grid object
26591 * @param subobj The child to pack
26592 * @param x The virtual x coord at which to pack it
26593 * @param y The virtual y coord at which to pack it
26594 * @param w The virtual width at which to pack it
26595 * @param h The virtual height at which to pack it
26599 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26602 * Unpack a child from a grid object
26604 * @param obj The grid object
26605 * @param subobj The child to unpack
26609 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26612 * Faster way to remove all child objects from a grid object.
26614 * @param obj The grid object
26615 * @param clear If true, it will delete just removed children
26619 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26622 * Set packing of an existing child at to position and size
26624 * @param subobj The child to set packing of
26625 * @param x The virtual x coord at which to pack it
26626 * @param y The virtual y coord at which to pack it
26627 * @param w The virtual width at which to pack it
26628 * @param h The virtual height at which to pack it
26632 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26635 * get packing of a child
26637 * @param subobj The child to query
26638 * @param x Pointer to integer to store the virtual x coord
26639 * @param y Pointer to integer to store the virtual y coord
26640 * @param w Pointer to integer to store the virtual width
26641 * @param h Pointer to integer to store the virtual height
26645 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26651 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26652 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26653 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26654 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26655 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
26656 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
26659 * @defgroup Video Video
26661 * This object display an player that let you control an Elm_Video
26662 * object. It take care of updating it's content according to what is
26663 * going on inside the Emotion object. It does activate the remember
26664 * function on the linked Elm_Video object.
26666 * Signals that you can add callback for are :
26668 * "forward,clicked" - the user clicked the forward button.
26669 * "info,clicked" - the user clicked the info button.
26670 * "next,clicked" - the user clicked the next button.
26671 * "pause,clicked" - the user clicked the pause button.
26672 * "play,clicked" - the user clicked the play button.
26673 * "prev,clicked" - the user clicked the prev button.
26674 * "rewind,clicked" - the user clicked the rewind button.
26675 * "stop,clicked" - the user clicked the stop button.
26677 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26678 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26679 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26680 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26681 EAPI void elm_video_play(Evas_Object *video);
26682 EAPI void elm_video_pause(Evas_Object *video);
26683 EAPI void elm_video_stop(Evas_Object *video);
26684 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26685 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26686 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26687 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26688 EAPI double elm_video_audio_level_get(Evas_Object *video);
26689 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26690 EAPI double elm_video_play_position_get(Evas_Object *video);
26691 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26692 EAPI double elm_video_play_length_get(Evas_Object *video);
26693 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26694 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26695 EAPI const char *elm_video_title_get(Evas_Object *video);
26697 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26698 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26701 * @defgroup Naviframe Naviframe
26703 * @brief Naviframe is a kind of view manager for the applications.
26705 * Naviframe provides functions to switch different pages with stack
26706 * mechanism. It means if one page(item) needs to be changed to the new one,
26707 * then naviframe would push the new page to it's internal stack. Of course,
26708 * it can be back to the previous page by popping the top page. Naviframe
26709 * provides some transition effect while the pages are switching (same as
26712 * Since each item could keep the different styles, users could keep the
26713 * same look & feel for the pages or different styles for the items in it's
26716 * Signals that you can add callback for are:
26718 * @li "transition,finished" - When the transition is finished in changing
26720 * @li "title,clicked" - User clicked title area
26722 * Default contents parts for the naviframe items that you can use for are:
26724 * @li "elm.swallow.content" - The main content of the page
26725 * @li "elm.swallow.prev_btn" - The button to go to the previous page
26726 * @li "elm.swallow.next_btn" - The button to go to the next page
26728 * Default text parts of naviframe items that you can be used are:
26730 * @li "elm.text.title" - The title label in the title area
26732 * @ref tutorial_naviframe gives a good overview of the usage of the API.
26736 * @brief Add a new Naviframe object to the parent.
26738 * @param parent Parent object
26739 * @return New object or @c NULL, if it cannot be created
26741 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26743 * @brief Push a new item to the top of the naviframe stack (and show it).
26745 * @param obj The naviframe object
26746 * @param title_label The label in the title area. The name of the title
26747 * label part is "elm.text.title"
26748 * @param prev_btn The button to go to the previous item. If it is NULL,
26749 * then naviframe will create a back button automatically. The name of
26750 * the prev_btn part is "elm.swallow.prev_btn"
26751 * @param next_btn The button to go to the next item. Or It could be just an
26752 * extra function button. The name of the next_btn part is
26753 * "elm.swallow.next_btn"
26754 * @param content The main content object. The name of content part is
26755 * "elm.swallow.content"
26756 * @param item_style The current item style name. @c NULL would be default.
26757 * @return The created item or @c NULL upon failure.
26759 * The item pushed becomes one page of the naviframe, this item will be
26760 * deleted when it is popped.
26762 * @see also elm_naviframe_item_style_set()
26764 * The following styles are available for this item:
26767 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);
26769 * @brief Pop an item that is on top of the stack
26771 * @param obj The naviframe object
26772 * @return @c NULL or the content object(if the
26773 * elm_naviframe_content_preserve_on_pop_get is true).
26775 * This pops an item that is on the top(visible) of the naviframe, makes it
26776 * disappear, then deletes the item. The item that was underneath it on the
26777 * stack will become visible.
26779 * @see also elm_naviframe_content_preserve_on_pop_get()
26781 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26783 * @brief Pop the items between the top and the above one on the given item.
26785 * @param it The naviframe item
26787 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26789 * @brief preserve the content objects when items are popped.
26791 * @param obj The naviframe object
26792 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
26794 * @see also elm_naviframe_content_preserve_on_pop_get()
26796 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26798 * @brief Get a value whether preserve mode is enabled or not.
26800 * @param obj The naviframe object
26801 * @return If @c EINA_TRUE, preserve mode is enabled
26803 * @see also elm_naviframe_content_preserve_on_pop_set()
26805 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26807 * @brief Get a top item on the naviframe stack
26809 * @param obj The naviframe object
26810 * @return The top item on the naviframe stack or @c NULL, if the stack is
26813 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26815 * @brief Get a bottom item on the naviframe stack
26817 * @param obj The naviframe object
26818 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
26821 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26823 * @brief Set an item style
26825 * @param obj The naviframe item
26826 * @param item_style The current item style name. @c NULL would be default
26828 * The following styles are available for this item:
26831 * @see also elm_naviframe_item_style_get()
26833 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26835 * @brief Get an item style
26837 * @param obj The naviframe item
26838 * @return The current item style name
26840 * @see also elm_naviframe_item_style_set()
26842 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26844 * @brief Show/Hide the title area
26846 * @param it The naviframe item
26847 * @param visible If @c EINA_TRUE, title area will be visible, hidden
26850 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
26852 * @see also elm_naviframe_item_title_visible_get()
26854 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26856 * @brief Get a value whether title area is visible or not.
26858 * @param it The naviframe item
26859 * @return If @c EINA_TRUE, title area is visible
26861 * @see also elm_naviframe_item_title_visible_set()
26863 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);