3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to build it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
310 * @brief Elementary's API
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
390 # include <Ethumb_Client.h>
402 # ifdef ELEMENTARY_BUILD
404 # define EAPI __declspec(dllexport)
407 # endif /* ! DLL_EXPORT */
409 # define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
414 # define EAPI __attribute__ ((visibility("default")))
421 #endif /* ! _WIN32 */
426 # define EAPI_MAIN EAPI
429 /* allow usage from c++ */
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
437 typedef struct _Elm_Version
445 EAPI extern Elm_Version *elm_version;
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
452 * @defgroup General General
454 * @brief General Elementary API. Functions that don't relate to
455 * Elementary objects specifically.
457 * Here are documented functions which init/shutdown the library,
458 * that apply to generic Elementary objects, that deal with
459 * configuration, et cetera.
461 * @ref general_functions_example_page "This" example contemplates
462 * some of these functions.
466 * @addtogroup General
471 * Defines couple of standard Evas_Object layers to be used
472 * with evas_object_layer_set().
474 * @note whenever extending with new values, try to keep some padding
475 * to siblings so there is room for further extensions.
477 typedef enum _Elm_Object_Layer
479 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
487 /**************************************************************************/
488 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
491 * Emitted when any Elementary's policy value is changed.
493 EAPI extern int ELM_EVENT_POLICY_CHANGED;
496 * @typedef Elm_Event_Policy_Changed
498 * Data on the event when an Elementary policy has changed
500 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
503 * @struct _Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 struct _Elm_Event_Policy_Changed
509 unsigned int policy; /**< the policy identifier */
510 int new_value; /**< value the policy had before the change */
511 int old_value; /**< new value the policy got */
515 * Policy identifiers.
517 typedef enum _Elm_Policy
519 ELM_POLICY_QUIT, /**< under which circumstances the application
520 * should quit automatically. @see
524 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
527 typedef enum _Elm_Policy_Quit
529 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533 * window is closed */
534 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536 typedef enum _Elm_Focus_Direction
540 } Elm_Focus_Direction;
542 typedef enum _Elm_Text_Format
544 ELM_TEXT_FORMAT_PLAIN_UTF8,
545 ELM_TEXT_FORMAT_MARKUP_UTF8
549 * Line wrapping types.
551 typedef enum _Elm_Wrap_Type
553 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
562 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
563 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
564 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
565 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
566 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
567 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
568 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
569 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
570 ELM_INPUT_PANEL_LAYOUT_INVALID
571 } Elm_Input_Panel_Layout;
574 * @typedef Elm_Object_Item
575 * An Elementary Object item handle.
578 typedef struct _Elm_Object_Item Elm_Object_Item;
582 * Called back when a widget's tooltip is activated and needs content.
583 * @param data user-data given to elm_object_tooltip_content_cb_set()
584 * @param obj owner widget.
585 * @param tooltip The tooltip object (affix content to this!)
587 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
590 * Called back when a widget's item tooltip is activated and needs content.
591 * @param data user-data given to elm_object_tooltip_content_cb_set()
592 * @param obj owner widget.
593 * @param tooltip The tooltip object (affix content to this!)
594 * @param item context dependent item. As an example, if tooltip was
595 * set on Elm_List_Item, then it is of this type.
597 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
599 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
601 #ifndef ELM_LIB_QUICKLAUNCH
602 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
604 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
607 /**************************************************************************/
611 * Initialize Elementary
613 * @param[in] argc System's argument count value
614 * @param[in] argv System's pointer to array of argument strings
615 * @return The init counter value.
617 * This function initializes Elementary and increments a counter of
618 * the number of calls to it. It returns the new counter's value.
620 * @warning This call is exported only for use by the @c ELM_MAIN()
621 * macro. There is no need to use this if you use this macro (which
622 * is highly advisable). An elm_main() should contain the entry
623 * point code for your application, having the same prototype as
624 * elm_init(), and @b not being static (putting the @c EAPI symbol
625 * in front of its type declaration is advisable). The @c
626 * ELM_MAIN() call should be placed just after it.
629 * @dontinclude bg_example_01.c
633 * See the full @ref bg_example_01_c "example".
635 * @see elm_shutdown().
638 EAPI int elm_init(int argc, char **argv);
641 * Shut down Elementary
643 * @return The init counter value.
645 * This should be called at the end of your application, just
646 * before it ceases to do any more processing. This will clean up
647 * any permanent resources your application may have allocated via
648 * Elementary that would otherwise persist.
650 * @see elm_init() for an example
654 EAPI int elm_shutdown(void);
657 * Run Elementary's main loop
659 * This call should be issued just after all initialization is
660 * completed. This function will not return until elm_exit() is
661 * called. It will keep looping, running the main
662 * (event/processing) loop for Elementary.
664 * @see elm_init() for an example
668 EAPI void elm_run(void);
671 * Exit Elementary's main loop
673 * If this call is issued, it will flag the main loop to cease
674 * processing and return back to its parent function (usually your
675 * elm_main() function).
677 * @see elm_init() for an example. There, just after a request to
678 * close the window comes, the main loop will be left.
680 * @note By using the #ELM_POLICY_QUIT on your Elementary
681 * applications, you'll this function called automatically for you.
685 EAPI void elm_exit(void);
688 * Provide information in order to make Elementary determine the @b
689 * run time location of the software in question, so other data files
690 * such as images, sound files, executable utilities, libraries,
691 * modules and locale files can be found.
693 * @param mainfunc This is your application's main function name,
694 * whose binary's location is to be found. Providing @c NULL
695 * will make Elementary not to use it
696 * @param dom This will be used as the application's "domain", in the
697 * form of a prefix to any environment variables that may
698 * override prefix detection and the directory name, inside the
699 * standard share or data directories, where the software's
700 * data files will be looked for.
701 * @param checkfile This is an (optional) magic file's path to check
702 * for existence (and it must be located in the data directory,
703 * under the share directory provided above). Its presence will
704 * help determine the prefix found was correct. Pass @c NULL if
705 * the check is not to be done.
707 * This function allows one to re-locate the application somewhere
708 * else after compilation, if the developer wishes for easier
709 * distribution of pre-compiled binaries.
711 * The prefix system is designed to locate where the given software is
712 * installed (under a common path prefix) at run time and then report
713 * specific locations of this prefix and common directories inside
714 * this prefix like the binary, library, data and locale directories,
715 * through the @c elm_app_*_get() family of functions.
717 * Call elm_app_info_set() early on before you change working
718 * directory or anything about @c argv[0], so it gets accurate
721 * It will then try and trace back which file @p mainfunc comes from,
722 * if provided, to determine the application's prefix directory.
724 * The @p dom parameter provides a string prefix to prepend before
725 * environment variables, allowing a fallback to @b specific
726 * environment variables to locate the software. You would most
727 * probably provide a lowercase string there, because it will also
728 * serve as directory domain, explained next. For environment
729 * variables purposes, this string is made uppercase. For example if
730 * @c "myapp" is provided as the prefix, then the program would expect
731 * @c "MYAPP_PREFIX" as a master environment variable to specify the
732 * exact install prefix for the software, or more specific environment
733 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
734 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
735 * the user or scripts before launching. If not provided (@c NULL),
736 * environment variables will not be used to override compiled-in
737 * defaults or auto detections.
739 * The @p dom string also provides a subdirectory inside the system
740 * shared data directory for data files. For example, if the system
741 * directory is @c /usr/local/share, then this directory name is
742 * appended, creating @c /usr/local/share/myapp, if it @p was @c
743 * "myapp". It is expected the application installs data files in
746 * The @p checkfile is a file name or path of something inside the
747 * share or data directory to be used to test that the prefix
748 * detection worked. For example, your app will install a wallpaper
749 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
750 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
753 * @see elm_app_compile_bin_dir_set()
754 * @see elm_app_compile_lib_dir_set()
755 * @see elm_app_compile_data_dir_set()
756 * @see elm_app_compile_locale_set()
757 * @see elm_app_prefix_dir_get()
758 * @see elm_app_bin_dir_get()
759 * @see elm_app_lib_dir_get()
760 * @see elm_app_data_dir_get()
761 * @see elm_app_locale_dir_get()
763 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
766 * Provide information on the @b fallback application's binaries
767 * directory, on scenarios where they get overriden by
768 * elm_app_info_set().
770 * @param dir The path to the default binaries directory (compile time
773 * @note Elementary will as well use this path to determine actual
774 * names of binaries' directory paths, maybe changing it to be @c
775 * something/local/bin instead of @c something/bin, only, for
778 * @warning You should call this function @b before
779 * elm_app_info_set().
781 EAPI void elm_app_compile_bin_dir_set(const char *dir);
784 * Provide information on the @b fallback application's libraries
785 * directory, on scenarios where they get overriden by
786 * elm_app_info_set().
788 * @param dir The path to the default libraries directory (compile
791 * @note Elementary will as well use this path to determine actual
792 * names of libraries' directory paths, maybe changing it to be @c
793 * something/lib32 or @c something/lib64 instead of @c something/lib,
796 * @warning You should call this function @b before
797 * elm_app_info_set().
799 EAPI void elm_app_compile_lib_dir_set(const char *dir);
802 * Provide information on the @b fallback application's data
803 * directory, on scenarios where they get overriden by
804 * elm_app_info_set().
806 * @param dir The path to the default data directory (compile time
809 * @note Elementary will as well use this path to determine actual
810 * names of data directory paths, maybe changing it to be @c
811 * something/local/share instead of @c something/share, only, for
814 * @warning You should call this function @b before
815 * elm_app_info_set().
817 EAPI void elm_app_compile_data_dir_set(const char *dir);
820 * Provide information on the @b fallback application's locale
821 * directory, on scenarios where they get overriden by
822 * elm_app_info_set().
824 * @param dir The path to the default locale directory (compile time
827 * @warning You should call this function @b before
828 * elm_app_info_set().
830 EAPI void elm_app_compile_locale_set(const char *dir);
833 * Retrieve the application's run time prefix directory, as set by
834 * elm_app_info_set() and the way (environment) the application was
837 * @return The directory prefix the application is actually using
839 EAPI const char *elm_app_prefix_dir_get(void);
842 * Retrieve the application's run time binaries prefix directory, as
843 * set by elm_app_info_set() and the way (environment) the application
846 * @return The binaries directory prefix the application is actually
849 EAPI const char *elm_app_bin_dir_get(void);
852 * Retrieve the application's run time libraries prefix directory, as
853 * set by elm_app_info_set() and the way (environment) the application
856 * @return The libraries directory prefix the application is actually
859 EAPI const char *elm_app_lib_dir_get(void);
862 * Retrieve the application's run time data prefix directory, as
863 * set by elm_app_info_set() and the way (environment) the application
866 * @return The data directory prefix the application is actually
869 EAPI const char *elm_app_data_dir_get(void);
872 * Retrieve the application's run time locale prefix directory, as
873 * set by elm_app_info_set() and the way (environment) the application
876 * @return The locale directory prefix the application is actually
879 EAPI const char *elm_app_locale_dir_get(void);
881 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
882 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
883 EAPI int elm_quicklaunch_init(int argc, char **argv);
884 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_shutdown(void);
886 EAPI int elm_quicklaunch_shutdown(void);
887 EAPI void elm_quicklaunch_seed(void);
888 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
889 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
890 EAPI void elm_quicklaunch_cleanup(void);
891 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
892 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
894 EAPI Eina_Bool elm_need_efreet(void);
895 EAPI Eina_Bool elm_need_e_dbus(void);
898 * This must be called before any other function that handle with
899 * elm_thumb objects or ethumb_client instances.
903 EAPI Eina_Bool elm_need_ethumb(void);
906 * Set a new policy's value (for a given policy group/identifier).
908 * @param policy policy identifier, as in @ref Elm_Policy.
909 * @param value policy value, which depends on the identifier
911 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
913 * Elementary policies define applications' behavior,
914 * somehow. These behaviors are divided in policy groups (see
915 * #Elm_Policy enumeration). This call will emit the Ecore event
916 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
917 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
920 * @note Currently, we have only one policy identifier/group
921 * (#ELM_POLICY_QUIT), which has two possible values.
925 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
928 * Gets the policy value set for given policy identifier.
930 * @param policy policy identifier, as in #Elm_Policy.
931 * @return The currently set policy value, for that
932 * identifier. Will be @c 0 if @p policy passed is invalid.
936 EAPI int elm_policy_get(unsigned int policy);
939 * Set a label of an object
941 * @param obj The Elementary object
942 * @param part The text part name to set (NULL for the default label)
943 * @param label The new text of the label
945 * @note Elementary objects may have many labels (e.g. Action Slider)
949 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
951 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
954 * Get a label of an object
956 * @param obj The Elementary object
957 * @param part The text part name to get (NULL for the default label)
958 * @return text of the label or NULL for any error
960 * @note Elementary objects may have many labels (e.g. Action Slider)
964 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
966 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
969 * Set a content of an object
971 * @param obj The Elementary object
972 * @param part The content part name to set (NULL for the default content)
973 * @param content The new content of the object
975 * @note Elementary objects may have many contents
979 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
981 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
984 * Get a content of an object
986 * @param obj The Elementary object
987 * @param item The content part name to get (NULL for the default content)
988 * @return content of the object or NULL for any error
990 * @note Elementary objects may have many contents
994 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
996 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
999 * Unset a content of an object
1001 * @param obj The Elementary object
1002 * @param item The content part name to unset (NULL for the default content)
1004 * @note Elementary objects may have many contents
1008 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1010 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1013 * Set a content of an object item
1015 * @param it The Elementary object item
1016 * @param part The content part name to set (NULL for the default content)
1017 * @param content The new content of the object item
1019 * @note Elementary object items may have many contents
1023 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1025 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1028 * Get a content of an object item
1030 * @param it The Elementary object item
1031 * @param part The content part name to unset (NULL for the default content)
1032 * @return content of the object item or NULL for any error
1034 * @note Elementary object items may have many contents
1038 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1040 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1043 * Unset a content of an object item
1045 * @param it The Elementary object item
1046 * @param part The content part name to unset (NULL for the default content)
1048 * @note Elementary object items may have many contents
1052 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1054 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1057 * Set a label of an objec itemt
1059 * @param it The Elementary object item
1060 * @param part The text part name to set (NULL for the default label)
1061 * @param label The new text of the label
1063 * @note Elementary object items may have many labels
1067 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1069 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1072 * Get a label of an object
1074 * @param it The Elementary object item
1075 * @param part The text part name to get (NULL for the default label)
1076 * @return text of the label or NULL for any error
1078 * @note Elementary object items may have many labels
1082 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1085 * Set the text to read out when in accessibility mode
1087 * @param obj The object which is to be described
1088 * @param txt The text that describes the widget to people with poor or no vision
1092 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1095 * Set the text to read out when in accessibility mode
1097 * @param it The object item which is to be described
1098 * @param txt The text that describes the widget to people with poor or no vision
1102 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1105 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1108 * Get the data associated with an object item
1109 * @param it The object item
1110 * @return The data associated with @p it
1114 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1117 * Set the data associated with an object item
1118 * @param it The object item
1119 * @param data The data to be associated with @p it
1123 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1130 * @defgroup Caches Caches
1132 * These are functions which let one fine-tune some cache values for
1133 * Elementary applications, thus allowing for performance adjustments.
1139 * @brief Flush all caches.
1141 * Frees all data that was in cache and is not currently being used to reduce
1142 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1143 * to calling all of the following functions:
1144 * @li edje_file_cache_flush()
1145 * @li edje_collection_cache_flush()
1146 * @li eet_clearcache()
1147 * @li evas_image_cache_flush()
1148 * @li evas_font_cache_flush()
1149 * @li evas_render_dump()
1150 * @note Evas caches are flushed for every canvas associated with a window.
1154 EAPI void elm_all_flush(void);
1157 * Get the configured cache flush interval time
1159 * This gets the globally configured cache flush interval time, in
1162 * @return The cache flush interval time
1165 * @see elm_all_flush()
1167 EAPI int elm_cache_flush_interval_get(void);
1170 * Set the configured cache flush interval time
1172 * This sets the globally configured cache flush interval time, in ticks
1174 * @param size The cache flush interval time
1177 * @see elm_all_flush()
1179 EAPI void elm_cache_flush_interval_set(int size);
1182 * Set the configured cache flush interval time for all applications on the
1185 * This sets the globally configured cache flush interval time -- in ticks
1186 * -- for all applications on the display.
1188 * @param size The cache flush interval time
1191 EAPI void elm_cache_flush_interval_all_set(int size);
1194 * Get the configured cache flush enabled state
1196 * This gets the globally configured cache flush state - if it is enabled
1197 * or not. When cache flushing is enabled, elementary will regularly
1198 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1199 * memory and allow usage to re-seed caches and data in memory where it
1200 * can do so. An idle application will thus minimise its memory usage as
1201 * data will be freed from memory and not be re-loaded as it is idle and
1202 * not rendering or doing anything graphically right now.
1204 * @return The cache flush state
1207 * @see elm_all_flush()
1209 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1212 * Set the configured cache flush enabled state
1214 * This sets the globally configured cache flush enabled state
1216 * @param size The cache flush enabled state
1219 * @see elm_all_flush()
1221 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1224 * Set the configured cache flush enabled state for all applications on the
1227 * This sets the globally configured cache flush enabled state for all
1228 * applications on the display.
1230 * @param size The cache flush enabled state
1233 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1236 * Get the configured font cache size
1238 * This gets the globally configured font cache size, in bytes
1240 * @return The font cache size
1243 EAPI int elm_font_cache_get(void);
1246 * Set the configured font cache size
1248 * This sets the globally configured font cache size, in bytes
1250 * @param size The font cache size
1253 EAPI void elm_font_cache_set(int size);
1256 * Set the configured font cache size for all applications on the
1259 * This sets the globally configured font cache size -- in bytes
1260 * -- for all applications on the display.
1262 * @param size The font cache size
1265 EAPI void elm_font_cache_all_set(int size);
1268 * Get the configured image cache size
1270 * This gets the globally configured image cache size, in bytes
1272 * @return The image cache size
1275 EAPI int elm_image_cache_get(void);
1278 * Set the configured image cache size
1280 * This sets the globally configured image cache size, in bytes
1282 * @param size The image cache size
1285 EAPI void elm_image_cache_set(int size);
1288 * Set the configured image cache size for all applications on the
1291 * This sets the globally configured image cache size -- in bytes
1292 * -- for all applications on the display.
1294 * @param size The image cache size
1297 EAPI void elm_image_cache_all_set(int size);
1300 * Get the configured edje file cache size.
1302 * This gets the globally configured edje file cache size, in number
1305 * @return The edje file cache size
1308 EAPI int elm_edje_file_cache_get(void);
1311 * Set the configured edje file cache size
1313 * This sets the globally configured edje file cache size, in number
1316 * @param size The edje file cache size
1319 EAPI void elm_edje_file_cache_set(int size);
1322 * Set the configured edje file cache size for all applications on the
1325 * This sets the globally configured edje file cache size -- in number
1326 * of files -- for all applications on the display.
1328 * @param size The edje file cache size
1331 EAPI void elm_edje_file_cache_all_set(int size);
1334 * Get the configured edje collections (groups) cache size.
1336 * This gets the globally configured edje collections cache size, in
1337 * number of collections.
1339 * @return The edje collections cache size
1342 EAPI int elm_edje_collection_cache_get(void);
1345 * Set the configured edje collections (groups) cache size
1347 * This sets the globally configured edje collections cache size, in
1348 * number of collections.
1350 * @param size The edje collections cache size
1353 EAPI void elm_edje_collection_cache_set(int size);
1356 * Set the configured edje collections (groups) cache size for all
1357 * applications on the display
1359 * This sets the globally configured edje collections cache size -- in
1360 * number of collections -- for all applications on the display.
1362 * @param size The edje collections cache size
1365 EAPI void elm_edje_collection_cache_all_set(int size);
1372 * @defgroup Scaling Widget Scaling
1374 * Different widgets can be scaled independently. These functions
1375 * allow you to manipulate this scaling on a per-widget basis. The
1376 * object and all its children get their scaling factors multiplied
1377 * by the scale factor set. This is multiplicative, in that if a
1378 * child also has a scale size set it is in turn multiplied by its
1379 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1380 * double size, @c 0.5 is half, etc.
1382 * @ref general_functions_example_page "This" example contemplates
1383 * some of these functions.
1387 * Get the global scaling factor
1389 * This gets the globally configured scaling factor that is applied to all
1392 * @return The scaling factor
1395 EAPI double elm_scale_get(void);
1398 * Set the global scaling factor
1400 * This sets the globally configured scaling factor that is applied to all
1403 * @param scale The scaling factor to set
1406 EAPI void elm_scale_set(double scale);
1409 * Set the global scaling factor for all applications on the display
1411 * This sets the globally configured scaling factor that is applied to all
1412 * objects for all applications.
1413 * @param scale The scaling factor to set
1416 EAPI void elm_scale_all_set(double scale);
1419 * Set the scaling factor for a given Elementary object
1421 * @param obj The Elementary to operate on
1422 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1427 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1430 * Get the scaling factor for a given Elementary object
1432 * @param obj The object
1433 * @return The scaling factor set by elm_object_scale_set()
1437 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1440 * @defgroup Password_last_show Password last input show
1442 * Last show feature of password mode enables user to view
1443 * the last input entered for few seconds before masking it.
1444 * These functions allow to set this feature in password mode
1445 * of entry widget and also allow to manipulate the duration
1446 * for which the input has to be visible.
1452 * Get show last setting of password mode.
1454 * This gets the show last input setting of password mode which might be
1455 * enabled or disabled.
1457 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1459 * @ingroup Password_last_show
1461 EAPI Eina_Bool elm_password_show_last_get(void);
1464 * Set show last setting in password mode.
1466 * This enables or disables show last setting of password mode.
1468 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1469 * @see elm_password_show_last_timeout_set()
1470 * @ingroup Password_last_show
1472 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1475 * Get's the timeout value in last show password mode.
1477 * This gets the time out value for which the last input entered in password
1478 * mode will be visible.
1480 * @return The timeout value of last show password mode.
1481 * @ingroup Password_last_show
1483 EAPI double elm_password_show_last_timeout_get(void);
1486 * Set's the timeout value in last show password mode.
1488 * This sets the time out value for which the last input entered in password
1489 * mode will be visible.
1491 * @param password_show_last_timeout The timeout value.
1492 * @see elm_password_show_last_set()
1493 * @ingroup Password_last_show
1495 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1502 * @defgroup UI-Mirroring Selective Widget mirroring
1504 * These functions allow you to set ui-mirroring on specific
1505 * widgets or the whole interface. Widgets can be in one of two
1506 * modes, automatic and manual. Automatic means they'll be changed
1507 * according to the system mirroring mode and manual means only
1508 * explicit changes will matter. You are not supposed to change
1509 * mirroring state of a widget set to automatic, will mostly work,
1510 * but the behavior is not really defined.
1515 EAPI Eina_Bool elm_mirrored_get(void);
1516 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1519 * Get the system mirrored mode. This determines the default mirrored mode
1522 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1524 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1527 * Set the system mirrored mode. This determines the default mirrored mode
1530 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1532 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1535 * Returns the widget's mirrored mode setting.
1537 * @param obj The widget.
1538 * @return mirrored mode setting of the object.
1541 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1544 * Sets the widget's mirrored mode setting.
1545 * When widget in automatic mode, it follows the system mirrored mode set by
1546 * elm_mirrored_set().
1547 * @param obj The widget.
1548 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1550 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1557 * Set the style to use by a widget
1559 * Sets the style name that will define the appearance of a widget. Styles
1560 * vary from widget to widget and may also be defined by other themes
1561 * by means of extensions and overlays.
1563 * @param obj The Elementary widget to style
1564 * @param style The style name to use
1566 * @see elm_theme_extension_add()
1567 * @see elm_theme_extension_del()
1568 * @see elm_theme_overlay_add()
1569 * @see elm_theme_overlay_del()
1573 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1575 * Get the style used by the widget
1577 * This gets the style being used for that widget. Note that the string
1578 * pointer is only valid as longas the object is valid and the style doesn't
1581 * @param obj The Elementary widget to query for its style
1582 * @return The style name used
1584 * @see elm_object_style_set()
1588 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591 * @defgroup Styles Styles
1593 * Widgets can have different styles of look. These generic API's
1594 * set styles of widgets, if they support them (and if the theme(s)
1597 * @ref general_functions_example_page "This" example contemplates
1598 * some of these functions.
1602 * Set the disabled state of an Elementary object.
1604 * @param obj The Elementary object to operate on
1605 * @param disabled The state to put in in: @c EINA_TRUE for
1606 * disabled, @c EINA_FALSE for enabled
1608 * Elementary objects can be @b disabled, in which state they won't
1609 * receive input and, in general, will be themed differently from
1610 * their normal state, usually greyed out. Useful for contexts
1611 * where you don't want your users to interact with some of the
1612 * parts of you interface.
1614 * This sets the state for the widget, either disabling it or
1619 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1622 * Get the disabled state of an Elementary object.
1624 * @param obj The Elementary object to operate on
1625 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1626 * if it's enabled (or on errors)
1628 * This gets the state of the widget, which might be enabled or disabled.
1632 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635 * @defgroup WidgetNavigation Widget Tree Navigation.
1637 * How to check if an Evas Object is an Elementary widget? How to
1638 * get the first elementary widget that is parent of the given
1639 * object? These are all covered in widget tree navigation.
1641 * @ref general_functions_example_page "This" example contemplates
1642 * some of these functions.
1646 * Check if the given Evas Object is an Elementary widget.
1648 * @param obj the object to query.
1649 * @return @c EINA_TRUE if it is an elementary widget variant,
1650 * @c EINA_FALSE otherwise
1651 * @ingroup WidgetNavigation
1653 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1656 * Get the first parent of the given object that is an Elementary
1659 * @param obj the Elementary object to query parent from.
1660 * @return the parent object that is an Elementary widget, or @c
1661 * NULL, if it was not found.
1663 * Use this to query for an object's parent widget.
1665 * @note Most of Elementary users wouldn't be mixing non-Elementary
1666 * smart objects in the objects tree of an application, as this is
1667 * an advanced usage of Elementary with Evas. So, except for the
1668 * application's window, which is the root of that tree, all other
1669 * objects would have valid Elementary widget parents.
1671 * @ingroup WidgetNavigation
1673 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1676 * Get the top level parent of an Elementary widget.
1678 * @param obj The object to query.
1679 * @return The top level Elementary widget, or @c NULL if parent cannot be
1681 * @ingroup WidgetNavigation
1683 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1686 * Get the string that represents this Elementary widget.
1688 * @note Elementary is weird and exposes itself as a single
1689 * Evas_Object_Smart_Class of type "elm_widget", so
1690 * evas_object_type_get() always return that, making debug and
1691 * language bindings hard. This function tries to mitigate this
1692 * problem, but the solution is to change Elementary to use
1693 * proper inheritance.
1695 * @param obj the object to query.
1696 * @return Elementary widget name, or @c NULL if not a valid widget.
1697 * @ingroup WidgetNavigation
1699 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1702 * @defgroup Config Elementary Config
1704 * Elementary configuration is formed by a set options bounded to a
1705 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1706 * "finger size", etc. These are functions with which one syncronizes
1707 * changes made to those values to the configuration storing files, de
1708 * facto. You most probably don't want to use the functions in this
1709 * group unlees you're writing an elementary configuration manager.
1715 * Save back Elementary's configuration, so that it will persist on
1718 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1721 * This function will take effect -- thus, do I/O -- immediately. Use
1722 * it when you want to apply all configuration changes at once. The
1723 * current configuration set will get saved onto the current profile
1724 * configuration file.
1727 EAPI Eina_Bool elm_config_save(void);
1730 * Reload Elementary's configuration, bounded to current selected
1733 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1736 * Useful when you want to force reloading of configuration values for
1737 * a profile. If one removes user custom configuration directories,
1738 * for example, it will force a reload with system values insted.
1741 EAPI void elm_config_reload(void);
1748 * @defgroup Profile Elementary Profile
1750 * Profiles are pre-set options that affect the whole look-and-feel of
1751 * Elementary-based applications. There are, for example, profiles
1752 * aimed at desktop computer applications and others aimed at mobile,
1753 * touchscreen-based ones. You most probably don't want to use the
1754 * functions in this group unlees you're writing an elementary
1755 * configuration manager.
1761 * Get Elementary's profile in use.
1763 * This gets the global profile that is applied to all Elementary
1766 * @return The profile's name
1769 EAPI const char *elm_profile_current_get(void);
1772 * Get an Elementary's profile directory path in the filesystem. One
1773 * may want to fetch a system profile's dir or an user one (fetched
1776 * @param profile The profile's name
1777 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1778 * or a system one (@c EINA_FALSE)
1779 * @return The profile's directory path.
1782 * @note You must free it with elm_profile_dir_free().
1784 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1787 * Free an Elementary's profile directory path, as returned by
1788 * elm_profile_dir_get().
1790 * @param p_dir The profile's path
1794 EAPI void elm_profile_dir_free(const char *p_dir);
1797 * Get Elementary's list of available profiles.
1799 * @return The profiles list. List node data are the profile name
1803 * @note One must free this list, after usage, with the function
1804 * elm_profile_list_free().
1806 EAPI Eina_List *elm_profile_list_get(void);
1809 * Free Elementary's list of available profiles.
1811 * @param l The profiles list, as returned by elm_profile_list_get().
1815 EAPI void elm_profile_list_free(Eina_List *l);
1818 * Set Elementary's profile.
1820 * This sets the global profile that is applied to Elementary
1821 * applications. Just the process the call comes from will be
1824 * @param profile The profile's name
1828 EAPI void elm_profile_set(const char *profile);
1831 * Set Elementary's profile.
1833 * This sets the global profile that is applied to all Elementary
1834 * applications. All running Elementary windows will be affected.
1836 * @param profile The profile's name
1840 EAPI void elm_profile_all_set(const char *profile);
1847 * @defgroup Engine Elementary Engine
1849 * These are functions setting and querying which rendering engine
1850 * Elementary will use for drawing its windows' pixels.
1852 * The following are the available engines:
1853 * @li "software_x11"
1856 * @li "software_16_x11"
1857 * @li "software_8_x11"
1860 * @li "software_gdi"
1861 * @li "software_16_wince_gdi"
1863 * @li "software_16_sdl"
1871 * @brief Get Elementary's rendering engine in use.
1873 * @return The rendering engine's name
1874 * @note there's no need to free the returned string, here.
1876 * This gets the global rendering engine that is applied to all Elementary
1879 * @see elm_engine_set()
1881 EAPI const char *elm_engine_current_get(void);
1884 * @brief Set Elementary's rendering engine for use.
1886 * @param engine The rendering engine's name
1888 * This sets global rendering engine that is applied to all Elementary
1889 * applications. Note that it will take effect only to Elementary windows
1890 * created after this is called.
1892 * @see elm_win_add()
1894 EAPI void elm_engine_set(const char *engine);
1901 * @defgroup Fonts Elementary Fonts
1903 * These are functions dealing with font rendering, selection and the
1904 * like for Elementary applications. One might fetch which system
1905 * fonts are there to use and set custom fonts for individual classes
1906 * of UI items containing text (text classes).
1911 typedef struct _Elm_Text_Class
1917 typedef struct _Elm_Font_Overlay
1919 const char *text_class;
1921 Evas_Font_Size size;
1924 typedef struct _Elm_Font_Properties
1928 } Elm_Font_Properties;
1931 * Get Elementary's list of supported text classes.
1933 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1936 * Release the list with elm_text_classes_list_free().
1938 EAPI const Eina_List *elm_text_classes_list_get(void);
1941 * Free Elementary's list of supported text classes.
1945 * @see elm_text_classes_list_get().
1947 EAPI void elm_text_classes_list_free(const Eina_List *list);
1950 * Get Elementary's list of font overlays, set with
1951 * elm_font_overlay_set().
1953 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1958 * For each text class, one can set a <b>font overlay</b> for it,
1959 * overriding the default font properties for that class coming from
1960 * the theme in use. There is no need to free this list.
1962 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1964 EAPI const Eina_List *elm_font_overlay_list_get(void);
1967 * Set a font overlay for a given Elementary text class.
1969 * @param text_class Text class name
1970 * @param font Font name and style string
1971 * @param size Font size
1975 * @p font has to be in the format returned by
1976 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1977 * and elm_font_overlay_unset().
1979 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1982 * Unset a font overlay for a given Elementary text class.
1984 * @param text_class Text class name
1988 * This will bring back text elements belonging to text class
1989 * @p text_class back to their default font settings.
1991 EAPI void elm_font_overlay_unset(const char *text_class);
1994 * Apply the changes made with elm_font_overlay_set() and
1995 * elm_font_overlay_unset() on the current Elementary window.
1999 * This applies all font overlays set to all objects in the UI.
2001 EAPI void elm_font_overlay_apply(void);
2004 * Apply the changes made with elm_font_overlay_set() and
2005 * elm_font_overlay_unset() on all Elementary application windows.
2009 * This applies all font overlays set to all objects in the UI.
2011 EAPI void elm_font_overlay_all_apply(void);
2014 * Translate a font (family) name string in fontconfig's font names
2015 * syntax into an @c Elm_Font_Properties struct.
2017 * @param font The font name and styles string
2018 * @return the font properties struct
2022 * @note The reverse translation can be achived with
2023 * elm_font_fontconfig_name_get(), for one style only (single font
2024 * instance, not family).
2026 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2029 * Free font properties return by elm_font_properties_get().
2031 * @param efp the font properties struct
2035 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2038 * Translate a font name, bound to a style, into fontconfig's font names
2041 * @param name The font (family) name
2042 * @param style The given style (may be @c NULL)
2044 * @return the font name and style string
2048 * @note The reverse translation can be achived with
2049 * elm_font_properties_get(), for one style only (single font
2050 * instance, not family).
2052 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2055 * Free the font string return by elm_font_fontconfig_name_get().
2057 * @param efp the font properties struct
2061 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2064 * Create a font hash table of available system fonts.
2066 * One must call it with @p list being the return value of
2067 * evas_font_available_list(). The hash will be indexed by font
2068 * (family) names, being its values @c Elm_Font_Properties blobs.
2070 * @param list The list of available system fonts, as returned by
2071 * evas_font_available_list().
2072 * @return the font hash.
2076 * @note The user is supposed to get it populated at least with 3
2077 * default font families (Sans, Serif, Monospace), which should be
2078 * present on most systems.
2080 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2083 * Free the hash return by elm_font_available_hash_add().
2085 * @param hash the hash to be freed.
2089 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2096 * @defgroup Fingers Fingers
2098 * Elementary is designed to be finger-friendly for touchscreens,
2099 * and so in addition to scaling for display resolution, it can
2100 * also scale based on finger "resolution" (or size). You can then
2101 * customize the granularity of the areas meant to receive clicks
2104 * Different profiles may have pre-set values for finger sizes.
2106 * @ref general_functions_example_page "This" example contemplates
2107 * some of these functions.
2113 * Get the configured "finger size"
2115 * @return The finger size
2117 * This gets the globally configured finger size, <b>in pixels</b>
2121 EAPI Evas_Coord elm_finger_size_get(void);
2124 * Set the configured finger size
2126 * This sets the globally configured finger size in pixels
2128 * @param size The finger size
2131 EAPI void elm_finger_size_set(Evas_Coord size);
2134 * Set the configured finger size for all applications on the display
2136 * This sets the globally configured finger size in pixels for all
2137 * applications on the display
2139 * @param size The finger size
2142 EAPI void elm_finger_size_all_set(Evas_Coord size);
2149 * @defgroup Focus Focus
2151 * An Elementary application has, at all times, one (and only one)
2152 * @b focused object. This is what determines where the input
2153 * events go to within the application's window. Also, focused
2154 * objects can be decorated differently, in order to signal to the
2155 * user where the input is, at a given moment.
2157 * Elementary applications also have the concept of <b>focus
2158 * chain</b>: one can cycle through all the windows' focusable
2159 * objects by input (tab key) or programmatically. The default
2160 * focus chain for an application is the one define by the order in
2161 * which the widgets where added in code. One will cycle through
2162 * top level widgets, and, for each one containg sub-objects, cycle
2163 * through them all, before returning to the level
2164 * above. Elementary also allows one to set @b custom focus chains
2165 * for their applications.
2167 * Besides the focused decoration a widget may exhibit, when it
2168 * gets focus, Elementary has a @b global focus highlight object
2169 * that can be enabled for a window. If one chooses to do so, this
2170 * extra highlight effect will surround the current focused object,
2173 * @note Some Elementary widgets are @b unfocusable, after
2174 * creation, by their very nature: they are not meant to be
2175 * interacted with input events, but are there just for visual
2178 * @ref general_functions_example_page "This" example contemplates
2179 * some of these functions.
2183 * Get the enable status of the focus highlight
2185 * This gets whether the highlight on focused objects is enabled or not
2188 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2191 * Set the enable status of the focus highlight
2193 * Set whether to show or not the highlight on focused objects
2194 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2197 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2200 * Get the enable status of the highlight animation
2202 * Get whether the focus highlight, if enabled, will animate its switch from
2203 * one object to the next
2206 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2209 * Set the enable status of the highlight animation
2211 * Set whether the focus highlight, if enabled, will animate its switch from
2212 * one object to the next
2213 * @param animate Enable animation if EINA_TRUE, disable otherwise
2216 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2219 * Get the whether an Elementary object has the focus or not.
2221 * @param obj The Elementary object to get the information from
2222 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2223 * not (and on errors).
2225 * @see elm_object_focus_set()
2229 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2232 * Set/unset focus to a given Elementary object.
2234 * @param obj The Elementary object to operate on.
2235 * @param enable @c EINA_TRUE Set focus to a given object,
2236 * @c EINA_FALSE Unset focus to a given object.
2238 * @note When you set focus to this object, if it can handle focus, will
2239 * take the focus away from the one who had it previously and will, for
2240 * now on, be the one receiving input events. Unsetting focus will remove
2241 * the focus from @p obj, passing it back to the previous element in the
2244 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2248 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2251 * Make a given Elementary object the focused one.
2253 * @param obj The Elementary object to make focused.
2255 * @note This object, if it can handle focus, will take the focus
2256 * away from the one who had it previously and will, for now on, be
2257 * the one receiving input events.
2259 * @see elm_object_focus_get()
2260 * @deprecated use elm_object_focus_set() instead.
2264 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2267 * Remove the focus from an Elementary object
2269 * @param obj The Elementary to take focus from
2271 * This removes the focus from @p obj, passing it back to the
2272 * previous element in the focus chain list.
2274 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2275 * @deprecated use elm_object_focus_set() instead.
2279 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2282 * Set the ability for an Element object to be focused
2284 * @param obj The Elementary object to operate on
2285 * @param enable @c EINA_TRUE if the object can be focused, @c
2286 * EINA_FALSE if not (and on errors)
2288 * This sets whether the object @p obj is able to take focus or
2289 * not. Unfocusable objects do nothing when programmatically
2290 * focused, being the nearest focusable parent object the one
2291 * really getting focus. Also, when they receive mouse input, they
2292 * will get the event, but not take away the focus from where it
2297 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2300 * Get whether an Elementary object is focusable or not
2302 * @param obj The Elementary object to operate on
2303 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2304 * EINA_FALSE if not (and on errors)
2306 * @note Objects which are meant to be interacted with by input
2307 * events are created able to be focused, by default. All the
2312 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2315 * Set custom focus chain.
2317 * This function overwrites any previous custom focus chain within
2318 * the list of objects. The previous list will be deleted and this list
2319 * will be managed by elementary. After it is set, don't modify it.
2321 * @note On focus cycle, only will be evaluated children of this container.
2323 * @param obj The container object
2324 * @param objs Chain of objects to pass focus
2327 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2330 * Unset a custom focus chain on a given Elementary widget
2332 * @param obj The container object to remove focus chain from
2334 * Any focus chain previously set on @p obj (for its child objects)
2335 * is removed entirely after this call.
2339 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2342 * Get custom focus chain
2344 * @param obj The container object
2347 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2350 * Append object to custom focus chain.
2352 * @note If relative_child equal to NULL or not in custom chain, the object
2353 * will be added in end.
2355 * @note On focus cycle, only will be evaluated children of this container.
2357 * @param obj The container object
2358 * @param child The child to be added in custom chain
2359 * @param relative_child The relative object to position the child
2362 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2365 * Prepend object to custom focus chain.
2367 * @note If relative_child equal to NULL or not in custom chain, the object
2368 * will be added in begin.
2370 * @note On focus cycle, only will be evaluated children of this container.
2372 * @param obj The container object
2373 * @param child The child to be added in custom chain
2374 * @param relative_child The relative object to position the child
2377 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2380 * Give focus to next object in object tree.
2382 * Give focus to next object in focus chain of one object sub-tree.
2383 * If the last object of chain already have focus, the focus will go to the
2384 * first object of chain.
2386 * @param obj The object root of sub-tree
2387 * @param dir Direction to cycle the focus
2391 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2394 * Give focus to near object in one direction.
2396 * Give focus to near object in direction of one object.
2397 * If none focusable object in given direction, the focus will not change.
2399 * @param obj The reference object
2400 * @param x Horizontal component of direction to focus
2401 * @param y Vertical component of direction to focus
2405 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2408 * Make the elementary object and its children to be unfocusable
2411 * @param obj The Elementary object to operate on
2412 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2413 * @c EINA_FALSE for focusable.
2415 * This sets whether the object @p obj and its children objects
2416 * are able to take focus or not. If the tree is set as unfocusable,
2417 * newest focused object which is not in this tree will get focus.
2418 * This API can be helpful for an object to be deleted.
2419 * When an object will be deleted soon, it and its children may not
2420 * want to get focus (by focus reverting or by other focus controls).
2421 * Then, just use this API before deleting.
2423 * @see elm_object_tree_unfocusable_get()
2427 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2430 * Get whether an Elementary object and its children are unfocusable or not.
2432 * @param obj The Elementary object to get the information from
2433 * @return @c EINA_TRUE, if the tree is unfocussable,
2434 * @c EINA_FALSE if not (and on errors).
2436 * @see elm_object_tree_unfocusable_set()
2440 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2443 * @defgroup Scrolling Scrolling
2445 * These are functions setting how scrollable views in Elementary
2446 * widgets should behave on user interaction.
2452 * Get whether scrollers should bounce when they reach their
2453 * viewport's edge during a scroll.
2455 * @return the thumb scroll bouncing state
2457 * This is the default behavior for touch screens, in general.
2458 * @ingroup Scrolling
2460 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2463 * Set whether scrollers should bounce when they reach their
2464 * viewport's edge during a scroll.
2466 * @param enabled the thumb scroll bouncing state
2468 * @see elm_thumbscroll_bounce_enabled_get()
2469 * @ingroup Scrolling
2471 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2474 * Set whether scrollers should bounce when they reach their
2475 * viewport's edge during a scroll, for all Elementary application
2478 * @param enabled the thumb scroll bouncing state
2480 * @see elm_thumbscroll_bounce_enabled_get()
2481 * @ingroup Scrolling
2483 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2486 * Get the amount of inertia a scroller will impose at bounce
2489 * @return the thumb scroll bounce friction
2491 * @ingroup Scrolling
2493 EAPI double elm_scroll_bounce_friction_get(void);
2496 * Set the amount of inertia a scroller will impose at bounce
2499 * @param friction the thumb scroll bounce friction
2501 * @see elm_thumbscroll_bounce_friction_get()
2502 * @ingroup Scrolling
2504 EAPI void elm_scroll_bounce_friction_set(double friction);
2507 * Set the amount of inertia a scroller will impose at bounce
2508 * animations, for all Elementary application windows.
2510 * @param friction the thumb scroll bounce friction
2512 * @see elm_thumbscroll_bounce_friction_get()
2513 * @ingroup Scrolling
2515 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2518 * Get the amount of inertia a <b>paged</b> scroller will impose at
2519 * page fitting animations.
2521 * @return the page scroll friction
2523 * @ingroup Scrolling
2525 EAPI double elm_scroll_page_scroll_friction_get(void);
2528 * Set the amount of inertia a <b>paged</b> scroller will impose at
2529 * page fitting animations.
2531 * @param friction the page scroll friction
2533 * @see elm_thumbscroll_page_scroll_friction_get()
2534 * @ingroup Scrolling
2536 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2539 * Set the amount of inertia a <b>paged</b> scroller will impose at
2540 * page fitting animations, for all Elementary application windows.
2542 * @param friction the page scroll friction
2544 * @see elm_thumbscroll_page_scroll_friction_get()
2545 * @ingroup Scrolling
2547 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2550 * Get the amount of inertia a scroller will impose at region bring
2553 * @return the bring in scroll friction
2555 * @ingroup Scrolling
2557 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2560 * Set the amount of inertia a scroller will impose at region bring
2563 * @param friction the bring in scroll friction
2565 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2566 * @ingroup Scrolling
2568 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2571 * Set the amount of inertia a scroller will impose at region bring
2572 * animations, for all Elementary application windows.
2574 * @param friction the bring in scroll friction
2576 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2577 * @ingroup Scrolling
2579 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2582 * Get the amount of inertia scrollers will impose at animations
2583 * triggered by Elementary widgets' zooming API.
2585 * @return the zoom friction
2587 * @ingroup Scrolling
2589 EAPI double elm_scroll_zoom_friction_get(void);
2592 * Set the amount of inertia scrollers will impose at animations
2593 * triggered by Elementary widgets' zooming API.
2595 * @param friction the zoom friction
2597 * @see elm_thumbscroll_zoom_friction_get()
2598 * @ingroup Scrolling
2600 EAPI void elm_scroll_zoom_friction_set(double friction);
2603 * Set the amount of inertia scrollers will impose at animations
2604 * triggered by Elementary widgets' zooming API, for all Elementary
2605 * application windows.
2607 * @param friction the zoom friction
2609 * @see elm_thumbscroll_zoom_friction_get()
2610 * @ingroup Scrolling
2612 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2615 * Get whether scrollers should be draggable from any point in their
2618 * @return the thumb scroll state
2620 * @note This is the default behavior for touch screens, in general.
2621 * @note All other functions namespaced with "thumbscroll" will only
2622 * have effect if this mode is enabled.
2624 * @ingroup Scrolling
2626 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2629 * Set whether scrollers should be draggable from any point in their
2632 * @param enabled the thumb scroll state
2634 * @see elm_thumbscroll_enabled_get()
2635 * @ingroup Scrolling
2637 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2640 * Set whether scrollers should be draggable from any point in their
2641 * views, for all Elementary application windows.
2643 * @param enabled the thumb scroll state
2645 * @see elm_thumbscroll_enabled_get()
2646 * @ingroup Scrolling
2648 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2651 * Get the number of pixels one should travel while dragging a
2652 * scroller's view to actually trigger scrolling.
2654 * @return the thumb scroll threshould
2656 * One would use higher values for touch screens, in general, because
2657 * of their inherent imprecision.
2658 * @ingroup Scrolling
2660 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2663 * Set the number of pixels one should travel while dragging a
2664 * scroller's view to actually trigger scrolling.
2666 * @param threshold the thumb scroll threshould
2668 * @see elm_thumbscroll_threshould_get()
2669 * @ingroup Scrolling
2671 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2674 * Set the number of pixels one should travel while dragging a
2675 * scroller's view to actually trigger scrolling, for all Elementary
2676 * application windows.
2678 * @param threshold the thumb scroll threshould
2680 * @see elm_thumbscroll_threshould_get()
2681 * @ingroup Scrolling
2683 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2686 * Get the minimum speed of mouse cursor movement which will trigger
2687 * list self scrolling animation after a mouse up event
2690 * @return the thumb scroll momentum threshould
2692 * @ingroup Scrolling
2694 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2697 * Set the minimum speed of mouse cursor movement which will trigger
2698 * list self scrolling animation after a mouse up event
2701 * @param threshold the thumb scroll momentum threshould
2703 * @see elm_thumbscroll_momentum_threshould_get()
2704 * @ingroup Scrolling
2706 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2709 * Set the minimum speed of mouse cursor movement which will trigger
2710 * list self scrolling animation after a mouse up event
2711 * (pixels/second), for all Elementary application windows.
2713 * @param threshold the thumb scroll momentum threshould
2715 * @see elm_thumbscroll_momentum_threshould_get()
2716 * @ingroup Scrolling
2718 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2721 * Get the amount of inertia a scroller will impose at self scrolling
2724 * @return the thumb scroll friction
2726 * @ingroup Scrolling
2728 EAPI double elm_scroll_thumbscroll_friction_get(void);
2731 * Set the amount of inertia a scroller will impose at self scrolling
2734 * @param friction the thumb scroll friction
2736 * @see elm_thumbscroll_friction_get()
2737 * @ingroup Scrolling
2739 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2742 * Set the amount of inertia a scroller will impose at self scrolling
2743 * animations, for all Elementary application windows.
2745 * @param friction the thumb scroll friction
2747 * @see elm_thumbscroll_friction_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2753 * Get the amount of lag between your actual mouse cursor dragging
2754 * movement and a scroller's view movement itself, while pushing it
2755 * into bounce state manually.
2757 * @return the thumb scroll border friction
2759 * @ingroup Scrolling
2761 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2764 * Set the amount of lag between your actual mouse cursor dragging
2765 * movement and a scroller's view movement itself, while pushing it
2766 * into bounce state manually.
2768 * @param friction the thumb scroll border friction. @c 0.0 for
2769 * perfect synchrony between two movements, @c 1.0 for maximum
2772 * @see elm_thumbscroll_border_friction_get()
2773 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2775 * @ingroup Scrolling
2777 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2780 * Set the amount of lag between your actual mouse cursor dragging
2781 * movement and a scroller's view movement itself, while pushing it
2782 * into bounce state manually, for all Elementary application windows.
2784 * @param friction the thumb scroll border friction. @c 0.0 for
2785 * perfect synchrony between two movements, @c 1.0 for maximum
2788 * @see elm_thumbscroll_border_friction_get()
2789 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2791 * @ingroup Scrolling
2793 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2800 * @defgroup Scrollhints Scrollhints
2802 * Objects when inside a scroller can scroll, but this may not always be
2803 * desirable in certain situations. This allows an object to hint to itself
2804 * and parents to "not scroll" in one of 2 ways. If any child object of a
2805 * scroller has pushed a scroll freeze or hold then it affects all parent
2806 * scrollers until all children have released them.
2808 * 1. To hold on scrolling. This means just flicking and dragging may no
2809 * longer scroll, but pressing/dragging near an edge of the scroller will
2810 * still scroll. This is automatically used by the entry object when
2813 * 2. To totally freeze scrolling. This means it stops. until
2820 * Push the scroll hold by 1
2822 * This increments the scroll hold count by one. If it is more than 0 it will
2823 * take effect on the parents of the indicated object.
2825 * @param obj The object
2826 * @ingroup Scrollhints
2828 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2831 * Pop the scroll hold by 1
2833 * This decrements the scroll hold count by one. If it is more than 0 it will
2834 * take effect on the parents of the indicated object.
2836 * @param obj The object
2837 * @ingroup Scrollhints
2839 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2842 * Push the scroll freeze by 1
2844 * This increments the scroll freeze count by one. If it is more
2845 * than 0 it will take effect on the parents of the indicated
2848 * @param obj The object
2849 * @ingroup Scrollhints
2851 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2854 * Pop the scroll freeze by 1
2856 * This decrements the scroll freeze count by one. If it is more
2857 * than 0 it will take effect on the parents of the indicated
2860 * @param obj The object
2861 * @ingroup Scrollhints
2863 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2866 * Lock the scrolling of the given widget (and thus all parents)
2868 * This locks the given object from scrolling in the X axis (and implicitly
2869 * also locks all parent scrollers too from doing the same).
2871 * @param obj The object
2872 * @param lock The lock state (1 == locked, 0 == unlocked)
2873 * @ingroup Scrollhints
2875 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2878 * Lock the scrolling of the given widget (and thus all parents)
2880 * This locks the given object from scrolling in the Y axis (and implicitly
2881 * also locks all parent scrollers too from doing the same).
2883 * @param obj The object
2884 * @param lock The lock state (1 == locked, 0 == unlocked)
2885 * @ingroup Scrollhints
2887 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2890 * Get the scrolling lock of the given widget
2892 * This gets the lock for X axis scrolling.
2894 * @param obj The object
2895 * @ingroup Scrollhints
2897 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2900 * Get the scrolling lock of the given widget
2902 * This gets the lock for X axis scrolling.
2904 * @param obj The object
2905 * @ingroup Scrollhints
2907 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2914 * Send a signal to the widget edje object.
2916 * This function sends a signal to the edje object of the obj. An
2917 * edje program can respond to a signal by specifying matching
2918 * 'signal' and 'source' fields.
2920 * @param obj The object
2921 * @param emission The signal's name.
2922 * @param source The signal's source.
2925 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2928 * Add a callback for a signal emitted by widget edje object.
2930 * This function connects a callback function to a signal emitted by the
2931 * edje object of the obj.
2932 * Globs can occur in either the emission or source name.
2934 * @param obj The object
2935 * @param emission The signal's name.
2936 * @param source The signal's source.
2937 * @param func The callback function to be executed when the signal is
2939 * @param data A pointer to data to pass in to the callback function.
2942 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);
2945 * Remove a signal-triggered callback from a widget edje object.
2947 * This function removes a callback, previoulsy attached to a
2948 * signal emitted by the edje object of the obj. The parameters
2949 * emission, source and func must match exactly those passed to a
2950 * previous call to elm_object_signal_callback_add(). The data
2951 * pointer that was passed to this call will be returned.
2953 * @param obj The object
2954 * @param emission The signal's name.
2955 * @param source The signal's source.
2956 * @param func The callback function to be executed when the signal is
2958 * @return The data pointer
2961 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);
2964 * Add a callback for input events (key up, key down, mouse wheel)
2965 * on a given Elementary widget
2967 * @param obj The widget to add an event callback on
2968 * @param func The callback function to be executed when the event
2970 * @param data Data to pass in to @p func
2972 * Every widget in an Elementary interface set to receive focus,
2973 * with elm_object_focus_allow_set(), will propagate @b all of its
2974 * key up, key down and mouse wheel input events up to its parent
2975 * object, and so on. All of the focusable ones in this chain which
2976 * had an event callback set, with this call, will be able to treat
2977 * those events. There are two ways of making the propagation of
2978 * these event upwards in the tree of widgets to @b cease:
2979 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2980 * the event was @b not processed, so the propagation will go on.
2981 * - The @c event_info pointer passed to @p func will contain the
2982 * event's structure and, if you OR its @c event_flags inner
2983 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2984 * one has already handled it, thus killing the event's
2987 * @note Your event callback will be issued on those events taking
2988 * place only if no other child widget of @obj has consumed the
2991 * @note Not to be confused with @c
2992 * evas_object_event_callback_add(), which will add event callbacks
2993 * per type on general Evas objects (no event propagation
2994 * infrastructure taken in account).
2996 * @note Not to be confused with @c
2997 * elm_object_signal_callback_add(), which will add callbacks to @b
2998 * signals coming from a widget's theme, not input events.
3000 * @note Not to be confused with @c
3001 * edje_object_signal_callback_add(), which does the same as
3002 * elm_object_signal_callback_add(), but directly on an Edje
3005 * @note Not to be confused with @c
3006 * evas_object_smart_callback_add(), which adds callbacks to smart
3007 * objects' <b>smart events</b>, and not input events.
3009 * @see elm_object_event_callback_del()
3013 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3016 * Remove an event callback from a widget.
3018 * This function removes a callback, previoulsy attached to event emission
3020 * The parameters func and data must match exactly those passed to
3021 * a previous call to elm_object_event_callback_add(). The data pointer that
3022 * was passed to this call will be returned.
3024 * @param obj The object
3025 * @param func The callback function to be executed when the event is
3027 * @param data Data to pass in to the callback function.
3028 * @return The data pointer
3031 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3034 * Adjust size of an element for finger usage.
3036 * @param times_w How many fingers should fit horizontally
3037 * @param w Pointer to the width size to adjust
3038 * @param times_h How many fingers should fit vertically
3039 * @param h Pointer to the height size to adjust
3041 * This takes width and height sizes (in pixels) as input and a
3042 * size multiple (which is how many fingers you want to place
3043 * within the area, being "finger" the size set by
3044 * elm_finger_size_set()), and adjusts the size to be large enough
3045 * to accommodate the resulting size -- if it doesn't already
3046 * accommodate it. On return the @p w and @p h sizes pointed to by
3047 * these parameters will be modified, on those conditions.
3049 * @note This is kind of a low level Elementary call, most useful
3050 * on size evaluation times for widgets. An external user wouldn't
3051 * be calling, most of the time.
3055 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3058 * Get the duration for occuring long press event.
3060 * @return Timeout for long press event
3061 * @ingroup Longpress
3063 EAPI double elm_longpress_timeout_get(void);
3066 * Set the duration for occuring long press event.
3068 * @param lonpress_timeout Timeout for long press event
3069 * @ingroup Longpress
3071 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3074 * @defgroup Debug Debug
3075 * don't use it unless you are sure
3081 * Print Tree object hierarchy in stdout
3083 * @param obj The root object
3086 EAPI void elm_object_tree_dump(const Evas_Object *top);
3089 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3091 * @param obj The root object
3092 * @param file The path of output file
3095 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3102 * @defgroup Theme Theme
3104 * Elementary uses Edje to theme its widgets, naturally. But for the most
3105 * part this is hidden behind a simpler interface that lets the user set
3106 * extensions and choose the style of widgets in a much easier way.
3108 * Instead of thinking in terms of paths to Edje files and their groups
3109 * each time you want to change the appearance of a widget, Elementary
3110 * works so you can add any theme file with extensions or replace the
3111 * main theme at one point in the application, and then just set the style
3112 * of widgets with elm_object_style_set() and related functions. Elementary
3113 * will then look in its list of themes for a matching group and apply it,
3114 * and when the theme changes midway through the application, all widgets
3115 * will be updated accordingly.
3117 * There are three concepts you need to know to understand how Elementary
3118 * theming works: default theme, extensions and overlays.
3120 * Default theme, obviously enough, is the one that provides the default
3121 * look of all widgets. End users can change the theme used by Elementary
3122 * by setting the @c ELM_THEME environment variable before running an
3123 * application, or globally for all programs using the @c elementary_config
3124 * utility. Applications can change the default theme using elm_theme_set(),
3125 * but this can go against the user wishes, so it's not an adviced practice.
3127 * Ideally, applications should find everything they need in the already
3128 * provided theme, but there may be occasions when that's not enough and
3129 * custom styles are required to correctly express the idea. For this
3130 * cases, Elementary has extensions.
3132 * Extensions allow the application developer to write styles of its own
3133 * to apply to some widgets. This requires knowledge of how each widget
3134 * is themed, as extensions will always replace the entire group used by
3135 * the widget, so important signals and parts need to be there for the
3136 * object to behave properly (see documentation of Edje for details).
3137 * Once the theme for the extension is done, the application needs to add
3138 * it to the list of themes Elementary will look into, using
3139 * elm_theme_extension_add(), and set the style of the desired widgets as
3140 * he would normally with elm_object_style_set().
3142 * Overlays, on the other hand, can replace the look of all widgets by
3143 * overriding the default style. Like extensions, it's up to the application
3144 * developer to write the theme for the widgets it wants, the difference
3145 * being that when looking for the theme, Elementary will check first the
3146 * list of overlays, then the set theme and lastly the list of extensions,
3147 * so with overlays it's possible to replace the default view and every
3148 * widget will be affected. This is very much alike to setting the whole
3149 * theme for the application and will probably clash with the end user
3150 * options, not to mention the risk of ending up with not matching styles
3151 * across the program. Unless there's a very special reason to use them,
3152 * overlays should be avoided for the resons exposed before.
3154 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3155 * keeps one default internally and every function that receives one of
3156 * these can be called with NULL to refer to this default (except for
3157 * elm_theme_free()). It's possible to create a new instance of a
3158 * ::Elm_Theme to set other theme for a specific widget (and all of its
3159 * children), but this is as discouraged, if not even more so, than using
3160 * overlays. Don't use this unless you really know what you are doing.
3162 * But to be less negative about things, you can look at the following
3164 * @li @ref theme_example_01 "Using extensions"
3165 * @li @ref theme_example_02 "Using overlays"
3170 * @typedef Elm_Theme
3172 * Opaque handler for the list of themes Elementary looks for when
3173 * rendering widgets.
3175 * Stay out of this unless you really know what you are doing. For most
3176 * cases, sticking to the default is all a developer needs.
3178 typedef struct _Elm_Theme Elm_Theme;
3181 * Create a new specific theme
3183 * This creates an empty specific theme that only uses the default theme. A
3184 * specific theme has its own private set of extensions and overlays too
3185 * (which are empty by default). Specific themes do not fall back to themes
3186 * of parent objects. They are not intended for this use. Use styles, overlays
3187 * and extensions when needed, but avoid specific themes unless there is no
3188 * other way (example: you want to have a preview of a new theme you are
3189 * selecting in a "theme selector" window. The preview is inside a scroller
3190 * and should display what the theme you selected will look like, but not
3191 * actually apply it yet. The child of the scroller will have a specific
3192 * theme set to show this preview before the user decides to apply it to all
3195 EAPI Elm_Theme *elm_theme_new(void);
3197 * Free a specific theme
3199 * @param th The theme to free
3201 * This frees a theme created with elm_theme_new().
3203 EAPI void elm_theme_free(Elm_Theme *th);
3205 * Copy the theme fom the source to the destination theme
3207 * @param th The source theme to copy from
3208 * @param thdst The destination theme to copy data to
3210 * This makes a one-time static copy of all the theme config, extensions
3211 * and overlays from @p th to @p thdst. If @p th references a theme, then
3212 * @p thdst is also set to reference it, with all the theme settings,
3213 * overlays and extensions that @p th had.
3215 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3217 * Tell the source theme to reference the ref theme
3219 * @param th The theme that will do the referencing
3220 * @param thref The theme that is the reference source
3222 * This clears @p th to be empty and then sets it to refer to @p thref
3223 * so @p th acts as an override to @p thref, but where its overrides
3224 * don't apply, it will fall through to @p thref for configuration.
3226 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3228 * Return the theme referred to
3230 * @param th The theme to get the reference from
3231 * @return The referenced theme handle
3233 * This gets the theme set as the reference theme by elm_theme_ref_set().
3234 * If no theme is set as a reference, NULL is returned.
3236 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3238 * Return the default theme
3240 * @return The default theme handle
3242 * This returns the internal default theme setup handle that all widgets
3243 * use implicitly unless a specific theme is set. This is also often use
3244 * as a shorthand of NULL.
3246 EAPI Elm_Theme *elm_theme_default_get(void);
3248 * Prepends a theme overlay to the list of overlays
3250 * @param th The theme to add to, or if NULL, the default theme
3251 * @param item The Edje file path to be used
3253 * Use this if your application needs to provide some custom overlay theme
3254 * (An Edje file that replaces some default styles of widgets) where adding
3255 * new styles, or changing system theme configuration is not possible. Do
3256 * NOT use this instead of a proper system theme configuration. Use proper
3257 * configuration files, profiles, environment variables etc. to set a theme
3258 * so that the theme can be altered by simple confiugration by a user. Using
3259 * this call to achieve that effect is abusing the API and will create lots
3262 * @see elm_theme_extension_add()
3264 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3266 * Delete a theme overlay from the list of overlays
3268 * @param th The theme to delete from, or if NULL, the default theme
3269 * @param item The name of the theme overlay
3271 * @see elm_theme_overlay_add()
3273 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3275 * Appends a theme extension to the list of extensions.
3277 * @param th The theme to add to, or if NULL, the default theme
3278 * @param item The Edje file path to be used
3280 * This is intended when an application needs more styles of widgets or new
3281 * widget themes that the default does not provide (or may not provide). The
3282 * application has "extended" usage by coming up with new custom style names
3283 * for widgets for specific uses, but as these are not "standard", they are
3284 * not guaranteed to be provided by a default theme. This means the
3285 * application is required to provide these extra elements itself in specific
3286 * Edje files. This call adds one of those Edje files to the theme search
3287 * path to be search after the default theme. The use of this call is
3288 * encouraged when default styles do not meet the needs of the application.
3289 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3291 * @see elm_object_style_set()
3293 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3295 * Deletes a theme extension from the list of extensions.
3297 * @param th The theme to delete from, or if NULL, the default theme
3298 * @param item The name of the theme extension
3300 * @see elm_theme_extension_add()
3302 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3304 * Set the theme search order for the given theme
3306 * @param th The theme to set the search order, or if NULL, the default theme
3307 * @param theme Theme search string
3309 * This sets the search string for the theme in path-notation from first
3310 * theme to search, to last, delimited by the : character. Example:
3312 * "shiny:/path/to/file.edj:default"
3314 * See the ELM_THEME environment variable for more information.
3316 * @see elm_theme_get()
3317 * @see elm_theme_list_get()
3319 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3321 * Return the theme search order
3323 * @param th The theme to get the search order, or if NULL, the default theme
3324 * @return The internal search order path
3326 * This function returns a colon separated string of theme elements as
3327 * returned by elm_theme_list_get().
3329 * @see elm_theme_set()
3330 * @see elm_theme_list_get()
3332 EAPI const char *elm_theme_get(Elm_Theme *th);
3334 * Return a list of theme elements to be used in a theme.
3336 * @param th Theme to get the list of theme elements from.
3337 * @return The internal list of theme elements
3339 * This returns the internal list of theme elements (will only be valid as
3340 * long as the theme is not modified by elm_theme_set() or theme is not
3341 * freed by elm_theme_free(). This is a list of strings which must not be
3342 * altered as they are also internal. If @p th is NULL, then the default
3343 * theme element list is returned.
3345 * A theme element can consist of a full or relative path to a .edj file,
3346 * or a name, without extension, for a theme to be searched in the known
3347 * theme paths for Elemementary.
3349 * @see elm_theme_set()
3350 * @see elm_theme_get()
3352 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3354 * Return the full patrh for a theme element
3356 * @param f The theme element name
3357 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3358 * @return The full path to the file found.
3360 * This returns a string you should free with free() on success, NULL on
3361 * failure. This will search for the given theme element, and if it is a
3362 * full or relative path element or a simple searchable name. The returned
3363 * path is the full path to the file, if searched, and the file exists, or it
3364 * is simply the full path given in the element or a resolved path if
3365 * relative to home. The @p in_search_path boolean pointed to is set to
3366 * EINA_TRUE if the file was a searchable file andis in the search path,
3367 * and EINA_FALSE otherwise.
3369 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3371 * Flush the current theme.
3373 * @param th Theme to flush
3375 * This flushes caches that let elementary know where to find theme elements
3376 * in the given theme. If @p th is NULL, then the default theme is flushed.
3377 * Call this function if source theme data has changed in such a way as to
3378 * make any caches Elementary kept invalid.
3380 EAPI void elm_theme_flush(Elm_Theme *th);
3382 * This flushes all themes (default and specific ones).
3384 * This will flush all themes in the current application context, by calling
3385 * elm_theme_flush() on each of them.
3387 EAPI void elm_theme_full_flush(void);
3389 * Set the theme for all elementary using applications on the current display
3391 * @param theme The name of the theme to use. Format same as the ELM_THEME
3392 * environment variable.
3394 EAPI void elm_theme_all_set(const char *theme);
3396 * Return a list of theme elements in the theme search path
3398 * @return A list of strings that are the theme element names.
3400 * This lists all available theme files in the standard Elementary search path
3401 * for theme elements, and returns them in alphabetical order as theme
3402 * element names in a list of strings. Free this with
3403 * elm_theme_name_available_list_free() when you are done with the list.
3405 EAPI Eina_List *elm_theme_name_available_list_new(void);
3407 * Free the list returned by elm_theme_name_available_list_new()
3409 * This frees the list of themes returned by
3410 * elm_theme_name_available_list_new(). Once freed the list should no longer
3411 * be used. a new list mys be created.
3413 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3415 * Set a specific theme to be used for this object and its children
3417 * @param obj The object to set the theme on
3418 * @param th The theme to set
3420 * This sets a specific theme that will be used for the given object and any
3421 * child objects it has. If @p th is NULL then the theme to be used is
3422 * cleared and the object will inherit its theme from its parent (which
3423 * ultimately will use the default theme if no specific themes are set).
3425 * Use special themes with great care as this will annoy users and make
3426 * configuration difficult. Avoid any custom themes at all if it can be
3429 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3431 * Get the specific theme to be used
3433 * @param obj The object to get the specific theme from
3434 * @return The specifc theme set.
3436 * This will return a specific theme set, or NULL if no specific theme is
3437 * set on that object. It will not return inherited themes from parents, only
3438 * the specific theme set for that specific object. See elm_object_theme_set()
3439 * for more information.
3441 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3444 * Get a data item from a theme
3446 * @param th The theme, or NULL for default theme
3447 * @param key The data key to search with
3448 * @return The data value, or NULL on failure
3450 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3451 * It works the same way as edje_file_data_get() except that the return is stringshared.
3453 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3459 /** @defgroup Win Win
3461 * @image html img/widget/win/preview-00.png
3462 * @image latex img/widget/win/preview-00.eps
3464 * The window class of Elementary. Contains functions to manipulate
3465 * windows. The Evas engine used to render the window contents is specified
3466 * in the system or user elementary config files (whichever is found last),
3467 * and can be overridden with the ELM_ENGINE environment variable for
3468 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3469 * compilation setup and modules actually installed at runtime) are (listed
3470 * in order of best supported and most likely to be complete and work to
3473 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3474 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3476 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3478 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3480 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3482 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3483 * rendering using SDL as the buffer)
3484 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3485 * GDI with software)
3486 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3487 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3488 * grayscale using dedicated 8bit software engine in X11)
3489 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3490 * X11 using 16bit software engine)
3491 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3492 * (Windows CE rendering via GDI with 16bit software renderer)
3493 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3494 * buffer with 16bit software renderer)
3496 * All engines use a simple string to select the engine to render, EXCEPT
3497 * the "shot" engine. This actually encodes the output of the virtual
3498 * screenshot and how long to delay in the engine string. The engine string
3499 * is encoded in the following way:
3501 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3503 * Where options are separated by a ":" char if more than one option is
3504 * given, with delay, if provided being the first option and file the last
3505 * (order is important). The delay specifies how long to wait after the
3506 * window is shown before doing the virtual "in memory" rendering and then
3507 * save the output to the file specified by the file option (and then exit).
3508 * If no delay is given, the default is 0.5 seconds. If no file is given the
3509 * default output file is "out.png". Repeat option is for continous
3510 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3511 * fixed to "out001.png" Some examples of using the shot engine:
3513 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3514 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3515 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3516 * ELM_ENGINE="shot:delay=2.0" elementary_test
3517 * ELM_ENGINE="shot:" elementary_test
3519 * Signals that you can add callbacks for are:
3521 * @li "delete,request": the user requested to close the window. See
3522 * elm_win_autodel_set().
3523 * @li "focus,in": window got focus
3524 * @li "focus,out": window lost focus
3525 * @li "moved": window that holds the canvas was moved
3528 * @li @ref win_example_01
3533 * Defines the types of window that can be created
3535 * These are hints set on the window so that a running Window Manager knows
3536 * how the window should be handled and/or what kind of decorations it
3539 * Currently, only the X11 backed engines use them.
3541 typedef enum _Elm_Win_Type
3543 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3544 window. Almost every window will be created with this
3546 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3547 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3548 window holding desktop icons. */
3549 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3550 be kept on top of any other window by the Window
3552 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3554 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3555 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3557 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3558 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3559 entry in a menubar is clicked. Typically used
3560 with elm_win_override_set(). This hint exists
3561 for completion only, as the EFL way of
3562 implementing a menu would not normally use a
3563 separate window for its contents. */
3564 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3565 triggered by right-clicking an object. */
3566 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3567 explanatory text that typically appear after the
3568 mouse cursor hovers over an object for a while.
3569 Typically used with elm_win_override_set() and also
3570 not very commonly used in the EFL. */
3571 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3572 battery life or a new E-Mail received. */
3573 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3574 usually used in the EFL. */
3575 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3576 object being dragged across different windows, or even
3577 applications. Typically used with
3578 elm_win_override_set(). */
3579 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3580 buffer. No actual window is created for this
3581 type, instead the window and all of its
3582 contents will be rendered to an image buffer.
3583 This allows to have children window inside a
3584 parent one just like any other object would
3585 be, and do other things like applying @c
3586 Evas_Map effects to it. This is the only type
3587 of window that requires the @c parent
3588 parameter of elm_win_add() to be a valid @c
3593 * The differents layouts that can be requested for the virtual keyboard.
3595 * When the application window is being managed by Illume, it may request
3596 * any of the following layouts for the virtual keyboard.
3598 typedef enum _Elm_Win_Keyboard_Mode
3600 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3601 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3602 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3603 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3604 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3605 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3606 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3607 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3608 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3609 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3610 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3611 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3612 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3613 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3614 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3615 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3616 } Elm_Win_Keyboard_Mode;
3619 * Available commands that can be sent to the Illume manager.
3621 * When running under an Illume session, a window may send commands to the
3622 * Illume manager to perform different actions.
3624 typedef enum _Elm_Illume_Command
3626 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3628 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3630 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3632 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3633 } Elm_Illume_Command;
3636 * Adds a window object. If this is the first window created, pass NULL as
3639 * @param parent Parent object to add the window to, or NULL
3640 * @param name The name of the window
3641 * @param type The window type, one of #Elm_Win_Type.
3643 * The @p parent paramter can be @c NULL for every window @p type except
3644 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3645 * which the image object will be created.
3647 * @return The created object, or NULL on failure
3649 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3651 * Add @p subobj as a resize object of window @p obj.
3654 * Setting an object as a resize object of the window means that the
3655 * @p subobj child's size and position will be controlled by the window
3656 * directly. That is, the object will be resized to match the window size
3657 * and should never be moved or resized manually by the developer.
3659 * In addition, resize objects of the window control what the minimum size
3660 * of it will be, as well as whether it can or not be resized by the user.
3662 * For the end user to be able to resize a window by dragging the handles
3663 * or borders provided by the Window Manager, or using any other similar
3664 * mechanism, all of the resize objects in the window should have their
3665 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3667 * @param obj The window object
3668 * @param subobj The resize object to add
3670 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3672 * Delete @p subobj as a resize object of window @p obj.
3674 * This function removes the object @p subobj from the resize objects of
3675 * the window @p obj. It will not delete the object itself, which will be
3676 * left unmanaged and should be deleted by the developer, manually handled
3677 * or set as child of some other container.
3679 * @param obj The window object
3680 * @param subobj The resize object to add
3682 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3684 * Set the title of the window
3686 * @param obj The window object
3687 * @param title The title to set
3689 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3691 * Get the title of the window
3693 * The returned string is an internal one and should not be freed or
3694 * modified. It will also be rendered invalid if a new title is set or if
3695 * the window is destroyed.
3697 * @param obj The window object
3700 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3702 * Set the window's autodel state.
3704 * When closing the window in any way outside of the program control, like
3705 * pressing the X button in the titlebar or using a command from the
3706 * Window Manager, a "delete,request" signal is emitted to indicate that
3707 * this event occurred and the developer can take any action, which may
3708 * include, or not, destroying the window object.
3710 * When the @p autodel parameter is set, the window will be automatically
3711 * destroyed when this event occurs, after the signal is emitted.
3712 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3713 * and is up to the program to do so when it's required.
3715 * @param obj The window object
3716 * @param autodel If true, the window will automatically delete itself when
3719 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3721 * Get the window's autodel state.
3723 * @param obj The window object
3724 * @return If the window will automatically delete itself when closed
3726 * @see elm_win_autodel_set()
3728 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3730 * Activate a window object.
3732 * This function sends a request to the Window Manager to activate the
3733 * window pointed by @p obj. If honored by the WM, the window will receive
3734 * the keyboard focus.
3736 * @note This is just a request that a Window Manager may ignore, so calling
3737 * this function does not ensure in any way that the window will be the
3738 * active one after it.
3740 * @param obj The window object
3742 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3744 * Lower a window object.
3746 * Places the window pointed by @p obj at the bottom of the stack, so that
3747 * no other window is covered by it.
3749 * If elm_win_override_set() is not set, the Window Manager may ignore this
3752 * @param obj The window object
3754 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3756 * Raise a window object.
3758 * Places the window pointed by @p obj at the top of the stack, so that it's
3759 * not covered by any other window.
3761 * If elm_win_override_set() is not set, the Window Manager may ignore this
3764 * @param obj The window object
3766 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3768 * Set the borderless state of a window.
3770 * This function requests the Window Manager to not draw any decoration
3771 * around the window.
3773 * @param obj The window object
3774 * @param borderless If true, the window is borderless
3776 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3778 * Get the borderless state of a window.
3780 * @param obj The window object
3781 * @return If true, the window is borderless
3783 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3785 * Set the shaped state of a window.
3787 * Shaped windows, when supported, will render the parts of the window that
3788 * has no content, transparent.
3790 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3791 * background object or cover the entire window in any other way, or the
3792 * parts of the canvas that have no data will show framebuffer artifacts.
3794 * @param obj The window object
3795 * @param shaped If true, the window is shaped
3797 * @see elm_win_alpha_set()
3799 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3801 * Get the shaped state of a window.
3803 * @param obj The window object
3804 * @return If true, the window is shaped
3806 * @see elm_win_shaped_set()
3808 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3810 * Set the alpha channel state of a window.
3812 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3813 * possibly making parts of the window completely or partially transparent.
3814 * This is also subject to the underlying system supporting it, like for
3815 * example, running under a compositing manager. If no compositing is
3816 * available, enabling this option will instead fallback to using shaped
3817 * windows, with elm_win_shaped_set().
3819 * @param obj The window object
3820 * @param alpha If true, the window has an alpha channel
3822 * @see elm_win_alpha_set()
3824 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3826 * Get the transparency state of a window.
3828 * @param obj The window object
3829 * @return If true, the window is transparent
3831 * @see elm_win_transparent_set()
3833 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3835 * Set the transparency state of a window.
3837 * Use elm_win_alpha_set() instead.
3839 * @param obj The window object
3840 * @param transparent If true, the window is transparent
3842 * @see elm_win_alpha_set()
3844 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3846 * Get the alpha channel state of a window.
3848 * @param obj The window object
3849 * @return If true, the window has an alpha channel
3851 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3853 * Set the override state of a window.
3855 * A window with @p override set to EINA_TRUE will not be managed by the
3856 * Window Manager. This means that no decorations of any kind will be shown
3857 * for it, moving and resizing must be handled by the application, as well
3858 * as the window visibility.
3860 * This should not be used for normal windows, and even for not so normal
3861 * ones, it should only be used when there's a good reason and with a lot
3862 * of care. Mishandling override windows may result situations that
3863 * disrupt the normal workflow of the end user.
3865 * @param obj The window object
3866 * @param override If true, the window is overridden
3868 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3870 * Get the override state of a window.
3872 * @param obj The window object
3873 * @return If true, the window is overridden
3875 * @see elm_win_override_set()
3877 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3879 * Set the fullscreen state of a window.
3881 * @param obj The window object
3882 * @param fullscreen If true, the window is fullscreen
3884 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3886 * Get the fullscreen state of a window.
3888 * @param obj The window object
3889 * @return If true, the window is fullscreen
3891 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3893 * Set the maximized state of a window.
3895 * @param obj The window object
3896 * @param maximized If true, the window is maximized
3898 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3900 * Get the maximized state of a window.
3902 * @param obj The window object
3903 * @return If true, the window is maximized
3905 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3907 * Set the iconified state of a window.
3909 * @param obj The window object
3910 * @param iconified If true, the window is iconified
3912 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3914 * Get the iconified state of a window.
3916 * @param obj The window object
3917 * @return If true, the window is iconified
3919 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3921 * Set the layer of the window.
3923 * What this means exactly will depend on the underlying engine used.
3925 * In the case of X11 backed engines, the value in @p layer has the
3926 * following meanings:
3927 * @li < 3: The window will be placed below all others.
3928 * @li > 5: The window will be placed above all others.
3929 * @li other: The window will be placed in the default layer.
3931 * @param obj The window object
3932 * @param layer The layer of the window
3934 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3936 * Get the layer of the window.
3938 * @param obj The window object
3939 * @return The layer of the window
3941 * @see elm_win_layer_set()
3943 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3945 * Set the rotation of the window.
3947 * Most engines only work with multiples of 90.
3949 * This function is used to set the orientation of the window @p obj to
3950 * match that of the screen. The window itself will be resized to adjust
3951 * to the new geometry of its contents. If you want to keep the window size,
3952 * see elm_win_rotation_with_resize_set().
3954 * @param obj The window object
3955 * @param rotation The rotation of the window, in degrees (0-360),
3956 * counter-clockwise.
3958 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3960 * Rotates the window and resizes it.
3962 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3963 * that they fit inside the current window geometry.
3965 * @param obj The window object
3966 * @param layer The rotation of the window in degrees (0-360),
3967 * counter-clockwise.
3969 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3971 * Get the rotation of the window.
3973 * @param obj The window object
3974 * @return The rotation of the window in degrees (0-360)
3976 * @see elm_win_rotation_set()
3977 * @see elm_win_rotation_with_resize_set()
3979 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3981 * Set the sticky state of the window.
3983 * Hints the Window Manager that the window in @p obj should be left fixed
3984 * at its position even when the virtual desktop it's on moves or changes.
3986 * @param obj The window object
3987 * @param sticky If true, the window's sticky state is enabled
3989 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3991 * Get the sticky state of the window.
3993 * @param obj The window object
3994 * @return If true, the window's sticky state is enabled
3996 * @see elm_win_sticky_set()
3998 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4000 * Set if this window is an illume conformant window
4002 * @param obj The window object
4003 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4005 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4007 * Get if this window is an illume conformant window
4009 * @param obj The window object
4010 * @return A boolean if this window is illume conformant or not
4012 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4014 * Set a window to be an illume quickpanel window
4016 * By default window objects are not quickpanel windows.
4018 * @param obj The window object
4019 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4021 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4023 * Get if this window is a quickpanel or not
4025 * @param obj The window object
4026 * @return A boolean if this window is a quickpanel or not
4028 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030 * Set the major priority of a quickpanel window
4032 * @param obj The window object
4033 * @param priority The major priority for this quickpanel
4035 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4037 * Get the major priority of a quickpanel window
4039 * @param obj The window object
4040 * @return The major priority of this quickpanel
4042 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044 * Set the minor priority of a quickpanel window
4046 * @param obj The window object
4047 * @param priority The minor priority for this quickpanel
4049 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4051 * Get the minor priority of a quickpanel window
4053 * @param obj The window object
4054 * @return The minor priority of this quickpanel
4056 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4058 * Set which zone this quickpanel should appear in
4060 * @param obj The window object
4061 * @param zone The requested zone for this quickpanel
4063 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4065 * Get which zone this quickpanel should appear in
4067 * @param obj The window object
4068 * @return The requested zone for this quickpanel
4070 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072 * Set the window to be skipped by keyboard focus
4074 * This sets the window to be skipped by normal keyboard input. This means
4075 * a window manager will be asked to not focus this window as well as omit
4076 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4078 * Call this and enable it on a window BEFORE you show it for the first time,
4079 * otherwise it may have no effect.
4081 * Use this for windows that have only output information or might only be
4082 * interacted with by the mouse or fingers, and never for typing input.
4083 * Be careful that this may have side-effects like making the window
4084 * non-accessible in some cases unless the window is specially handled. Use
4087 * @param obj The window object
4088 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4090 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4092 * Send a command to the windowing environment
4094 * This is intended to work in touchscreen or small screen device
4095 * environments where there is a more simplistic window management policy in
4096 * place. This uses the window object indicated to select which part of the
4097 * environment to control (the part that this window lives in), and provides
4098 * a command and an optional parameter structure (use NULL for this if not
4101 * @param obj The window object that lives in the environment to control
4102 * @param command The command to send
4103 * @param params Optional parameters for the command
4105 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4107 * Get the inlined image object handle
4109 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4110 * then the window is in fact an evas image object inlined in the parent
4111 * canvas. You can get this object (be careful to not manipulate it as it
4112 * is under control of elementary), and use it to do things like get pixel
4113 * data, save the image to a file, etc.
4115 * @param obj The window object to get the inlined image from
4116 * @return The inlined image object, or NULL if none exists
4118 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4120 * Set the enabled status for the focus highlight in a window
4122 * This function will enable or disable the focus highlight only for the
4123 * given window, regardless of the global setting for it
4125 * @param obj The window where to enable the highlight
4126 * @param enabled The enabled value for the highlight
4128 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4130 * Get the enabled value of the focus highlight for this window
4132 * @param obj The window in which to check if the focus highlight is enabled
4134 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4136 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138 * Set the style for the focus highlight on this window
4140 * Sets the style to use for theming the highlight of focused objects on
4141 * the given window. If @p style is NULL, the default will be used.
4143 * @param obj The window where to set the style
4144 * @param style The style to set
4146 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4148 * Get the style set for the focus highlight object
4150 * Gets the style set for this windows highilght object, or NULL if none
4153 * @param obj The window to retrieve the highlights style from
4155 * @return The style set or NULL if none was. Default is used in that case.
4157 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4159 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4160 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4161 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4162 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4163 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4164 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4165 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4167 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4168 * (blank mouse, private mouse obj, defaultmouse)
4172 * Sets the keyboard mode of the window.
4174 * @param obj The window object
4175 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4177 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4179 * Gets the keyboard mode of the window.
4181 * @param obj The window object
4182 * @return The mode, one of #Elm_Win_Keyboard_Mode
4184 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4186 * Sets whether the window is a keyboard.
4188 * @param obj The window object
4189 * @param is_keyboard If true, the window is a virtual keyboard
4191 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4193 * Gets whether the window is a keyboard.
4195 * @param obj The window object
4196 * @return If the window is a virtual keyboard
4198 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4201 * Get the screen position of a window.
4203 * @param obj The window object
4204 * @param x The int to store the x coordinate to
4205 * @param y The int to store the y coordinate to
4207 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4213 * @defgroup Inwin Inwin
4215 * @image html img/widget/inwin/preview-00.png
4216 * @image latex img/widget/inwin/preview-00.eps
4217 * @image html img/widget/inwin/preview-01.png
4218 * @image latex img/widget/inwin/preview-01.eps
4219 * @image html img/widget/inwin/preview-02.png
4220 * @image latex img/widget/inwin/preview-02.eps
4222 * An inwin is a window inside a window that is useful for a quick popup.
4223 * It does not hover.
4225 * It works by creating an object that will occupy the entire window, so it
4226 * must be created using an @ref Win "elm_win" as parent only. The inwin
4227 * object can be hidden or restacked below every other object if it's
4228 * needed to show what's behind it without destroying it. If this is done,
4229 * the elm_win_inwin_activate() function can be used to bring it back to
4230 * full visibility again.
4232 * There are three styles available in the default theme. These are:
4233 * @li default: The inwin is sized to take over most of the window it's
4235 * @li minimal: The size of the inwin will be the minimum necessary to show
4237 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4238 * possible, but it's sized vertically the most it needs to fit its\
4241 * Some examples of Inwin can be found in the following:
4242 * @li @ref inwin_example_01
4247 * Adds an inwin to the current window
4249 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4250 * Never call this function with anything other than the top-most window
4251 * as its parameter, unless you are fond of undefined behavior.
4253 * After creating the object, the widget will set itself as resize object
4254 * for the window with elm_win_resize_object_add(), so when shown it will
4255 * appear to cover almost the entire window (how much of it depends on its
4256 * content and the style used). It must not be added into other container
4257 * objects and it needs not be moved or resized manually.
4259 * @param parent The parent object
4260 * @return The new object or NULL if it cannot be created
4262 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4264 * Activates an inwin object, ensuring its visibility
4266 * This function will make sure that the inwin @p obj is completely visible
4267 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4268 * to the front. It also sets the keyboard focus to it, which will be passed
4271 * The object's theme will also receive the signal "elm,action,show" with
4274 * @param obj The inwin to activate
4276 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4278 * Set the content of an inwin object.
4280 * Once the content object is set, a previously set one will be deleted.
4281 * If you want to keep that old content object, use the
4282 * elm_win_inwin_content_unset() function.
4284 * @param obj The inwin object
4285 * @param content The object to set as content
4287 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4289 * Get the content of an inwin object.
4291 * Return the content object which is set for this widget.
4293 * The returned object is valid as long as the inwin is still alive and no
4294 * other content is set on it. Deleting the object will notify the inwin
4295 * about it and this one will be left empty.
4297 * If you need to remove an inwin's content to be reused somewhere else,
4298 * see elm_win_inwin_content_unset().
4300 * @param obj The inwin object
4301 * @return The content that is being used
4303 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4305 * Unset the content of an inwin object.
4307 * Unparent and return the content object which was set for this widget.
4309 * @param obj The inwin object
4310 * @return The content that was being used
4312 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4316 /* X specific calls - won't work on non-x engines (return 0) */
4319 * Get the Ecore_X_Window of an Evas_Object
4321 * @param obj The object
4323 * @return The Ecore_X_Window of @p obj
4327 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329 /* smart callbacks called:
4330 * "delete,request" - the user requested to delete the window
4331 * "focus,in" - window got focus
4332 * "focus,out" - window lost focus
4333 * "moved" - window that holds the canvas was moved
4339 * @image html img/widget/bg/preview-00.png
4340 * @image latex img/widget/bg/preview-00.eps
4342 * @brief Background object, used for setting a solid color, image or Edje
4343 * group as background to a window or any container object.
4345 * The bg object is used for setting a solid background to a window or
4346 * packing into any container object. It works just like an image, but has
4347 * some properties useful to a background, like setting it to tiled,
4348 * centered, scaled or stretched.
4350 * Here is some sample code using it:
4351 * @li @ref bg_01_example_page
4352 * @li @ref bg_02_example_page
4353 * @li @ref bg_03_example_page
4357 typedef enum _Elm_Bg_Option
4359 ELM_BG_OPTION_CENTER, /**< center the background */
4360 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4361 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4362 ELM_BG_OPTION_TILE /**< tile background at its original size */
4366 * Add a new background to the parent
4368 * @param parent The parent object
4369 * @return The new object or NULL if it cannot be created
4373 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4376 * Set the file (image or edje) used for the background
4378 * @param obj The bg object
4379 * @param file The file path
4380 * @param group Optional key (group in Edje) within the file
4382 * This sets the image file used in the background object. The image (or edje)
4383 * will be stretched (retaining aspect if its an image file) to completely fill
4384 * the bg object. This may mean some parts are not visible.
4386 * @note Once the image of @p obj is set, a previously set one will be deleted,
4387 * even if @p file is NULL.
4391 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4394 * Get the file (image or edje) used for the background
4396 * @param obj The bg object
4397 * @param file The file path
4398 * @param group Optional key (group in Edje) within the file
4402 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4405 * Set the option used for the background image
4407 * @param obj The bg object
4408 * @param option The desired background option (TILE, SCALE)
4410 * This sets the option used for manipulating the display of the background
4411 * image. The image can be tiled or scaled.
4415 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4418 * Get the option used for the background image
4420 * @param obj The bg object
4421 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4425 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4427 * Set the option used for the background color
4429 * @param obj The bg object
4434 * This sets the color used for the background rectangle. Its range goes
4439 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4441 * Get the option used for the background color
4443 * @param obj The bg object
4450 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4453 * Set the overlay object used for the background object.
4455 * @param obj The bg object
4456 * @param overlay The overlay object
4458 * This provides a way for elm_bg to have an 'overlay' that will be on top
4459 * of the bg. Once the over object is set, a previously set one will be
4460 * deleted, even if you set the new one to NULL. If you want to keep that
4461 * old content object, use the elm_bg_overlay_unset() function.
4466 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4469 * Get the overlay object used for the background object.
4471 * @param obj The bg object
4472 * @return The content that is being used
4474 * Return the content object which is set for this widget
4478 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 * Get the overlay object used for the background object.
4483 * @param obj The bg object
4484 * @return The content that was being used
4486 * Unparent and return the overlay object which was set for this widget
4490 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4493 * Set the size of the pixmap representation of the image.
4495 * This option just makes sense if an image is going to be set in the bg.
4497 * @param obj The bg object
4498 * @param w The new width of the image pixmap representation.
4499 * @param h The new height of the image pixmap representation.
4501 * This function sets a new size for pixmap representation of the given bg
4502 * image. It allows the image to be loaded already in the specified size,
4503 * reducing the memory usage and load time when loading a big image with load
4504 * size set to a smaller size.
4506 * NOTE: this is just a hint, the real size of the pixmap may differ
4507 * depending on the type of image being loaded, being bigger than requested.
4511 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4512 /* smart callbacks called:
4516 * @defgroup Icon Icon
4518 * @image html img/widget/icon/preview-00.png
4519 * @image latex img/widget/icon/preview-00.eps
4521 * An object that provides standard icon images (delete, edit, arrows, etc.)
4522 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4524 * The icon image requested can be in the elementary theme, or in the
4525 * freedesktop.org paths. It's possible to set the order of preference from
4526 * where the image will be used.
4528 * This API is very similar to @ref Image, but with ready to use images.
4530 * Default images provided by the theme are described below.
4532 * The first list contains icons that were first intended to be used in
4533 * toolbars, but can be used in many other places too:
4549 * Now some icons that were designed to be used in menus (but again, you can
4550 * use them anywhere else):
4555 * @li menu/arrow_down
4556 * @li menu/arrow_left
4557 * @li menu/arrow_right
4566 * And here we have some media player specific icons:
4567 * @li media_player/forward
4568 * @li media_player/info
4569 * @li media_player/next
4570 * @li media_player/pause
4571 * @li media_player/play
4572 * @li media_player/prev
4573 * @li media_player/rewind
4574 * @li media_player/stop
4576 * Signals that you can add callbacks for are:
4578 * "clicked" - This is called when a user has clicked the icon
4580 * An example of usage for this API follows:
4581 * @li @ref tutorial_icon
4589 typedef enum _Elm_Icon_Type
4596 * @enum _Elm_Icon_Lookup_Order
4597 * @typedef Elm_Icon_Lookup_Order
4599 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4600 * theme, FDO paths, or both?
4604 typedef enum _Elm_Icon_Lookup_Order
4606 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4607 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4608 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4609 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4610 } Elm_Icon_Lookup_Order;
4613 * Add a new icon object to the parent.
4615 * @param parent The parent object
4616 * @return The new object or NULL if it cannot be created
4618 * @see elm_icon_file_set()
4622 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4624 * Set the file that will be used as icon.
4626 * @param obj The icon object
4627 * @param file The path to file that will be used as icon image
4628 * @param group The group that the icon belongs to in edje file
4630 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4632 * @note The icon image set by this function can be changed by
4633 * elm_icon_standard_set().
4635 * @see elm_icon_file_get()
4639 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4641 * Set a location in memory to be used as an icon
4643 * @param obj The icon object
4644 * @param img The binary data that will be used as an image
4645 * @param size The size of binary data @p img
4646 * @param format Optional format of @p img to pass to the image loader
4647 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4649 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4651 * @note The icon image set by this function can be changed by
4652 * elm_icon_standard_set().
4656 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);
4658 * Get the file that will be used as icon.
4660 * @param obj The icon object
4661 * @param file The path to file that will be used as icon icon image
4662 * @param group The group that the icon belongs to in edje file
4664 * @see elm_icon_file_set()
4668 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4669 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4671 * Set the icon by icon standards names.
4673 * @param obj The icon object
4674 * @param name The icon name
4676 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4678 * For example, freedesktop.org defines standard icon names such as "home",
4679 * "network", etc. There can be different icon sets to match those icon
4680 * keys. The @p name given as parameter is one of these "keys", and will be
4681 * used to look in the freedesktop.org paths and elementary theme. One can
4682 * change the lookup order with elm_icon_order_lookup_set().
4684 * If name is not found in any of the expected locations and it is the
4685 * absolute path of an image file, this image will be used.
4687 * @note The icon image set by this function can be changed by
4688 * elm_icon_file_set().
4690 * @see elm_icon_standard_get()
4691 * @see elm_icon_file_set()
4695 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4697 * Get the icon name set by icon standard names.
4699 * @param obj The icon object
4700 * @return The icon name
4702 * If the icon image was set using elm_icon_file_set() instead of
4703 * elm_icon_standard_set(), then this function will return @c NULL.
4705 * @see elm_icon_standard_set()
4709 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4711 * Set the smooth effect for an icon object.
4713 * @param obj The icon object
4714 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4715 * otherwise. Default is @c EINA_TRUE.
4717 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4718 * scaling provides a better resulting image, but is slower.
4720 * The smooth scaling should be disabled when making animations that change
4721 * the icon size, since they will be faster. Animations that don't require
4722 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4723 * is already scaled, since the scaled icon image will be cached).
4725 * @see elm_icon_smooth_get()
4729 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4731 * Get the smooth effect for an icon object.
4733 * @param obj The icon object
4734 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4736 * @see elm_icon_smooth_set()
4740 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4742 * Disable scaling of this object.
4744 * @param obj The icon object.
4745 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4746 * otherwise. Default is @c EINA_FALSE.
4748 * This function disables scaling of the icon object through the function
4749 * elm_object_scale_set(). However, this does not affect the object
4750 * size/resize in any way. For that effect, take a look at
4751 * elm_icon_scale_set().
4753 * @see elm_icon_no_scale_get()
4754 * @see elm_icon_scale_set()
4755 * @see elm_object_scale_set()
4759 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4761 * Get whether scaling is disabled on the object.
4763 * @param obj The icon object
4764 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4766 * @see elm_icon_no_scale_set()
4770 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4772 * Set if the object is (up/down) resizable.
4774 * @param obj The icon object
4775 * @param scale_up A bool to set if the object is resizable up. Default is
4777 * @param scale_down A bool to set if the object is resizable down. Default
4780 * This function limits the icon object resize ability. If @p scale_up is set to
4781 * @c EINA_FALSE, the object can't have its height or width resized to a value
4782 * higher than the original icon size. Same is valid for @p scale_down.
4784 * @see elm_icon_scale_get()
4788 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4790 * Get if the object is (up/down) resizable.
4792 * @param obj The icon object
4793 * @param scale_up A bool to set if the object is resizable up
4794 * @param scale_down A bool to set if the object is resizable down
4796 * @see elm_icon_scale_set()
4800 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4802 * Get the object's image size
4804 * @param obj The icon object
4805 * @param w A pointer to store the width in
4806 * @param h A pointer to store the height in
4810 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4812 * Set if the icon fill the entire object area.
4814 * @param obj The icon object
4815 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4816 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4818 * When the icon object is resized to a different aspect ratio from the
4819 * original icon image, the icon image will still keep its aspect. This flag
4820 * tells how the image should fill the object's area. They are: keep the
4821 * entire icon inside the limits of height and width of the object (@p
4822 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4823 * of the object, and the icon will fill the entire object (@p fill_outside
4826 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4827 * retain property to false. Thus, the icon image will always keep its
4828 * original aspect ratio.
4830 * @see elm_icon_fill_outside_get()
4831 * @see elm_image_fill_outside_set()
4835 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4837 * Get if the object is filled outside.
4839 * @param obj The icon object
4840 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4842 * @see elm_icon_fill_outside_set()
4846 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4848 * Set the prescale size for the icon.
4850 * @param obj The icon object
4851 * @param size The prescale size. This value is used for both width and
4854 * This function sets a new size for pixmap representation of the given
4855 * icon. It allows the icon to be loaded already in the specified size,
4856 * reducing the memory usage and load time when loading a big icon with load
4857 * size set to a smaller size.
4859 * It's equivalent to the elm_bg_load_size_set() function for bg.
4861 * @note this is just a hint, the real size of the pixmap may differ
4862 * depending on the type of icon being loaded, being bigger than requested.
4864 * @see elm_icon_prescale_get()
4865 * @see elm_bg_load_size_set()
4869 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4871 * Get the prescale size for the icon.
4873 * @param obj The icon object
4874 * @return The prescale size
4876 * @see elm_icon_prescale_set()
4880 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882 * Sets the icon lookup order used by elm_icon_standard_set().
4884 * @param obj The icon object
4885 * @param order The icon lookup order (can be one of
4886 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4887 * or ELM_ICON_LOOKUP_THEME)
4889 * @see elm_icon_order_lookup_get()
4890 * @see Elm_Icon_Lookup_Order
4894 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4896 * Gets the icon lookup order.
4898 * @param obj The icon object
4899 * @return The icon lookup order
4901 * @see elm_icon_order_lookup_set()
4902 * @see Elm_Icon_Lookup_Order
4906 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4908 * Get if the icon supports animation or not.
4910 * @param obj The icon object
4911 * @return @c EINA_TRUE if the icon supports animation,
4912 * @c EINA_FALSE otherwise.
4914 * Return if this elm icon's image can be animated. Currently Evas only
4915 * supports gif animation. If the return value is EINA_FALSE, other
4916 * elm_icon_animated_XXX APIs won't work.
4919 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4921 * Set animation mode of the icon.
4923 * @param obj The icon object
4924 * @param anim @c EINA_TRUE if the object do animation job,
4925 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4927 * Even though elm icon's file can be animated,
4928 * sometimes appication developer want to just first page of image.
4929 * In that time, don't call this function, because default value is EINA_FALSE
4930 * Only when you want icon support anition,
4931 * use this function and set animated to EINA_TURE
4934 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4936 * Get animation mode of the icon.
4938 * @param obj The icon object
4939 * @return The animation mode of the icon object
4940 * @see elm_icon_animated_set
4943 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4945 * Set animation play mode of the icon.
4947 * @param obj The icon object
4948 * @param play @c EINA_TRUE the object play animation images,
4949 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4951 * If you want to play elm icon's animation, you set play to EINA_TURE.
4952 * For example, you make gif player using this set/get API and click event.
4954 * 1. Click event occurs
4955 * 2. Check play flag using elm_icon_animaged_play_get
4956 * 3. If elm icon was playing, set play to EINA_FALSE.
4957 * Then animation will be stopped and vice versa
4960 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4962 * Get animation play mode of the icon.
4964 * @param obj The icon object
4965 * @return The play mode of the icon object
4967 * @see elm_icon_animated_lay_get
4970 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4977 * @defgroup Image Image
4979 * @image html img/widget/image/preview-00.png
4980 * @image latex img/widget/image/preview-00.eps
4983 * An object that allows one to load an image file to it. It can be used
4984 * anywhere like any other elementary widget.
4986 * This widget provides most of the functionality provided from @ref Bg or @ref
4987 * Icon, but with a slightly different API (use the one that fits better your
4990 * The features not provided by those two other image widgets are:
4991 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4992 * @li change the object orientation with elm_image_orient_set();
4993 * @li and turning the image editable with elm_image_editable_set().
4995 * Signals that you can add callbacks for are:
4997 * @li @c "clicked" - This is called when a user has clicked the image
4999 * An example of usage for this API follows:
5000 * @li @ref tutorial_image
5009 * @enum _Elm_Image_Orient
5010 * @typedef Elm_Image_Orient
5012 * Possible orientation options for elm_image_orient_set().
5014 * @image html elm_image_orient_set.png
5015 * @image latex elm_image_orient_set.eps width=\textwidth
5019 typedef enum _Elm_Image_Orient
5021 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5022 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5023 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5024 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5025 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5026 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5027 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5028 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5032 * Add a new image to the parent.
5034 * @param parent The parent object
5035 * @return The new object or NULL if it cannot be created
5037 * @see elm_image_file_set()
5041 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5043 * Set the file that will be used as image.
5045 * @param obj The image object
5046 * @param file The path to file that will be used as image
5047 * @param group The group that the image belongs in edje file (if it's an
5050 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5052 * @see elm_image_file_get()
5056 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5058 * Get the file that will be used as image.
5060 * @param obj The image object
5061 * @param file The path to file
5062 * @param group The group that the image belongs in edje file
5064 * @see elm_image_file_set()
5068 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5070 * Set the smooth effect for an image.
5072 * @param obj The image object
5073 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5074 * otherwise. Default is @c EINA_TRUE.
5076 * Set the scaling algorithm to be used when scaling the image. Smooth
5077 * scaling provides a better resulting image, but is slower.
5079 * The smooth scaling should be disabled when making animations that change
5080 * the image size, since it will be faster. Animations that don't require
5081 * resizing of the image can keep the smooth scaling enabled (even if the
5082 * image is already scaled, since the scaled image will be cached).
5084 * @see elm_image_smooth_get()
5088 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5090 * Get the smooth effect for an image.
5092 * @param obj The image object
5093 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5095 * @see elm_image_smooth_get()
5099 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5101 * Gets the current size of the image.
5103 * @param obj The image object.
5104 * @param w Pointer to store width, or NULL.
5105 * @param h Pointer to store height, or NULL.
5107 * This is the real size of the image, not the size of the object.
5109 * On error, neither w or h will be written.
5113 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5115 * Disable scaling of this object.
5117 * @param obj The image object.
5118 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5119 * otherwise. Default is @c EINA_FALSE.
5121 * This function disables scaling of the elm_image widget through the
5122 * function elm_object_scale_set(). However, this does not affect the widget
5123 * size/resize in any way. For that effect, take a look at
5124 * elm_image_scale_set().
5126 * @see elm_image_no_scale_get()
5127 * @see elm_image_scale_set()
5128 * @see elm_object_scale_set()
5132 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5134 * Get whether scaling is disabled on the object.
5136 * @param obj The image object
5137 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5139 * @see elm_image_no_scale_set()
5143 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5145 * Set if the object is (up/down) resizable.
5147 * @param obj The image object
5148 * @param scale_up A bool to set if the object is resizable up. Default is
5150 * @param scale_down A bool to set if the object is resizable down. Default
5153 * This function limits the image resize ability. If @p scale_up is set to
5154 * @c EINA_FALSE, the object can't have its height or width resized to a value
5155 * higher than the original image size. Same is valid for @p scale_down.
5157 * @see elm_image_scale_get()
5161 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5163 * Get if the object is (up/down) resizable.
5165 * @param obj The image object
5166 * @param scale_up A bool to set if the object is resizable up
5167 * @param scale_down A bool to set if the object is resizable down
5169 * @see elm_image_scale_set()
5173 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5175 * Set if the image fill the entire object area when keeping the aspect ratio.
5177 * @param obj The image object
5178 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5179 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5181 * When the image should keep its aspect ratio even if resized to another
5182 * aspect ratio, there are two possibilities to resize it: keep the entire
5183 * image inside the limits of height and width of the object (@p fill_outside
5184 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5185 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5187 * @note This option will have no effect if
5188 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5190 * @see elm_image_fill_outside_get()
5191 * @see elm_image_aspect_ratio_retained_set()
5195 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5197 * Get if the object is filled outside
5199 * @param obj The image object
5200 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5202 * @see elm_image_fill_outside_set()
5206 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5208 * Set the prescale size for the image
5210 * @param obj The image object
5211 * @param size The prescale size. This value is used for both width and
5214 * This function sets a new size for pixmap representation of the given
5215 * image. It allows the image to be loaded already in the specified size,
5216 * reducing the memory usage and load time when loading a big image with load
5217 * size set to a smaller size.
5219 * It's equivalent to the elm_bg_load_size_set() function for bg.
5221 * @note this is just a hint, the real size of the pixmap may differ
5222 * depending on the type of image being loaded, being bigger than requested.
5224 * @see elm_image_prescale_get()
5225 * @see elm_bg_load_size_set()
5229 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5231 * Get the prescale size for the image
5233 * @param obj The image object
5234 * @return The prescale size
5236 * @see elm_image_prescale_set()
5240 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5242 * Set the image orientation.
5244 * @param obj The image object
5245 * @param orient The image orientation
5246 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5247 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5248 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5249 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5250 * Default is #ELM_IMAGE_ORIENT_NONE.
5252 * This function allows to rotate or flip the given image.
5254 * @see elm_image_orient_get()
5255 * @see @ref Elm_Image_Orient
5259 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5261 * Get the image orientation.
5263 * @param obj The image object
5264 * @return The image orientation
5265 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5266 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5267 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5268 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5270 * @see elm_image_orient_set()
5271 * @see @ref Elm_Image_Orient
5275 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5277 * Make the image 'editable'.
5279 * @param obj Image object.
5280 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5282 * This means the image is a valid drag target for drag and drop, and can be
5283 * cut or pasted too.
5287 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5289 * Make the image 'editable'.
5291 * @param obj Image object.
5292 * @return Editability.
5294 * This means the image is a valid drag target for drag and drop, and can be
5295 * cut or pasted too.
5299 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5301 * Get the basic Evas_Image object from this object (widget).
5303 * @param obj The image object to get the inlined image from
5304 * @return The inlined image object, or NULL if none exists
5306 * This function allows one to get the underlying @c Evas_Object of type
5307 * Image from this elementary widget. It can be useful to do things like get
5308 * the pixel data, save the image to a file, etc.
5310 * @note Be careful to not manipulate it, as it is under control of
5315 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317 * Set whether the original aspect ratio of the image should be kept on resize.
5319 * @param obj The image object.
5320 * @param retained @c EINA_TRUE if the image should retain the aspect,
5321 * @c EINA_FALSE otherwise.
5323 * The original aspect ratio (width / height) of the image is usually
5324 * distorted to match the object's size. Enabling this option will retain
5325 * this original aspect, and the way that the image is fit into the object's
5326 * area depends on the option set by elm_image_fill_outside_set().
5328 * @see elm_image_aspect_ratio_retained_get()
5329 * @see elm_image_fill_outside_set()
5333 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5335 * Get if the object retains the original aspect ratio.
5337 * @param obj The image object.
5338 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5343 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5350 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5352 typedef enum _Elm_GLView_Mode
5354 ELM_GLVIEW_ALPHA = 1,
5355 ELM_GLVIEW_DEPTH = 2,
5356 ELM_GLVIEW_STENCIL = 4
5360 * Defines a policy for the glview resizing.
5362 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5364 typedef enum _Elm_GLView_Resize_Policy
5366 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5367 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5368 } Elm_GLView_Resize_Policy;
5370 typedef enum _Elm_GLView_Render_Policy
5372 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5373 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5374 } Elm_GLView_Render_Policy;
5379 * A simple GLView widget that allows GL rendering.
5381 * Signals that you can add callbacks for are:
5387 * Add a new glview to the parent
5389 * @param parent The parent object
5390 * @return The new object or NULL if it cannot be created
5394 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5397 * Sets the size of the glview
5399 * @param obj The glview object
5400 * @param width width of the glview object
5401 * @param height height of the glview object
5405 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5408 * Gets the size of the glview.
5410 * @param obj The glview object
5411 * @param width width of the glview object
5412 * @param height height of the glview object
5414 * Note that this function returns the actual image size of the
5415 * glview. This means that when the scale policy is set to
5416 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5421 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5424 * Gets the gl api struct for gl rendering
5426 * @param obj The glview object
5427 * @return The api object or NULL if it cannot be created
5431 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5434 * Set the mode of the GLView. Supports Three simple modes.
5436 * @param obj The glview object
5437 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5438 * @return True if set properly.
5442 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5445 * Set the resize policy for the glview object.
5447 * @param obj The glview object.
5448 * @param policy The scaling policy.
5450 * By default, the resize policy is set to
5451 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5452 * destroys the previous surface and recreates the newly specified
5453 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5454 * however, glview only scales the image object and not the underlying
5459 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5462 * Set the render policy for the glview object.
5464 * @param obj The glview object.
5465 * @param policy The render policy.
5467 * By default, the render policy is set to
5468 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5469 * that during the render loop, glview is only redrawn if it needs
5470 * to be redrawn. (i.e. When it is visible) If the policy is set to
5471 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5472 * whether it is visible/need redrawing or not.
5476 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5479 * Set the init function that runs once in the main loop.
5481 * @param obj The glview object.
5482 * @param func The init function to be registered.
5484 * The registered init function gets called once during the render loop.
5488 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5491 * Set the render function that runs in the main loop.
5493 * @param obj The glview object.
5494 * @param func The delete function to be registered.
5496 * The registered del function gets called when GLView object is deleted.
5500 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5503 * Set the resize function that gets called when resize happens.
5505 * @param obj The glview object.
5506 * @param func The resize function to be registered.
5510 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5513 * Set the render function that runs in the main loop.
5515 * @param obj The glview object.
5516 * @param func The render function to be registered.
5520 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5523 * Notifies that there has been changes in the GLView.
5525 * @param obj The glview object.
5529 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5539 * @image html img/widget/box/preview-00.png
5540 * @image latex img/widget/box/preview-00.eps width=\textwidth
5542 * @image html img/box.png
5543 * @image latex img/box.eps width=\textwidth
5545 * A box arranges objects in a linear fashion, governed by a layout function
5546 * that defines the details of this arrangement.
5548 * By default, the box will use an internal function to set the layout to
5549 * a single row, either vertical or horizontal. This layout is affected
5550 * by a number of parameters, such as the homogeneous flag set by
5551 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5552 * elm_box_align_set() and the hints set to each object in the box.
5554 * For this default layout, it's possible to change the orientation with
5555 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5556 * placing its elements ordered from top to bottom. When horizontal is set,
5557 * the order will go from left to right. If the box is set to be
5558 * homogeneous, every object in it will be assigned the same space, that
5559 * of the largest object. Padding can be used to set some spacing between
5560 * the cell given to each object. The alignment of the box, set with
5561 * elm_box_align_set(), determines how the bounding box of all the elements
5562 * will be placed within the space given to the box widget itself.
5564 * The size hints of each object also affect how they are placed and sized
5565 * within the box. evas_object_size_hint_min_set() will give the minimum
5566 * size the object can have, and the box will use it as the basis for all
5567 * latter calculations. Elementary widgets set their own minimum size as
5568 * needed, so there's rarely any need to use it manually.
5570 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5571 * used to tell whether the object will be allocated the minimum size it
5572 * needs or if the space given to it should be expanded. It's important
5573 * to realize that expanding the size given to the object is not the same
5574 * thing as resizing the object. It could very well end being a small
5575 * widget floating in a much larger empty space. If not set, the weight
5576 * for objects will normally be 0.0 for both axis, meaning the widget will
5577 * not be expanded. To take as much space possible, set the weight to
5578 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5580 * Besides how much space each object is allocated, it's possible to control
5581 * how the widget will be placed within that space using
5582 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5583 * for both axis, meaning the object will be centered, but any value from
5584 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5585 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5586 * is -1.0, means the object will be resized to fill the entire space it
5589 * In addition, customized functions to define the layout can be set, which
5590 * allow the application developer to organize the objects within the box
5591 * in any number of ways.
5593 * The special elm_box_layout_transition() function can be used
5594 * to switch from one layout to another, animating the motion of the
5595 * children of the box.
5597 * @note Objects should not be added to box objects using _add() calls.
5599 * Some examples on how to use boxes follow:
5600 * @li @ref box_example_01
5601 * @li @ref box_example_02
5606 * @typedef Elm_Box_Transition
5608 * Opaque handler containing the parameters to perform an animated
5609 * transition of the layout the box uses.
5611 * @see elm_box_transition_new()
5612 * @see elm_box_layout_set()
5613 * @see elm_box_layout_transition()
5615 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5618 * Add a new box to the parent
5620 * By default, the box will be in vertical mode and non-homogeneous.
5622 * @param parent The parent object
5623 * @return The new object or NULL if it cannot be created
5625 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5627 * Set the horizontal orientation
5629 * By default, box object arranges their contents vertically from top to
5631 * By calling this function with @p horizontal as EINA_TRUE, the box will
5632 * become horizontal, arranging contents from left to right.
5634 * @note This flag is ignored if a custom layout function is set.
5636 * @param obj The box object
5637 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5638 * EINA_FALSE = vertical)
5640 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5642 * Get the horizontal orientation
5644 * @param obj The box object
5645 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5647 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5649 * Set the box to arrange its children homogeneously
5651 * If enabled, homogeneous layout makes all items the same size, according
5652 * to the size of the largest of its children.
5654 * @note This flag is ignored if a custom layout function is set.
5656 * @param obj The box object
5657 * @param homogeneous The homogeneous flag
5659 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5661 * Get whether the box is using homogeneous mode or not
5663 * @param obj The box object
5664 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5666 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5667 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5668 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5670 * Add an object to the beginning of the pack list
5672 * Pack @p subobj into the box @p obj, placing it first in the list of
5673 * children objects. The actual position the object will get on screen
5674 * depends on the layout used. If no custom layout is set, it will be at
5675 * the top or left, depending if the box is vertical or horizontal,
5678 * @param obj The box object
5679 * @param subobj The object to add to the box
5681 * @see elm_box_pack_end()
5682 * @see elm_box_pack_before()
5683 * @see elm_box_pack_after()
5684 * @see elm_box_unpack()
5685 * @see elm_box_unpack_all()
5686 * @see elm_box_clear()
5688 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5690 * Add an object at the end of the pack list
5692 * Pack @p subobj into the box @p obj, placing it last in the list of
5693 * children objects. The actual position the object will get on screen
5694 * depends on the layout used. If no custom layout is set, it will be at
5695 * the bottom or right, depending if the box is vertical or horizontal,
5698 * @param obj The box object
5699 * @param subobj The object to add to the box
5701 * @see elm_box_pack_start()
5702 * @see elm_box_pack_before()
5703 * @see elm_box_pack_after()
5704 * @see elm_box_unpack()
5705 * @see elm_box_unpack_all()
5706 * @see elm_box_clear()
5708 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5710 * Adds an object to the box before the indicated object
5712 * This will add the @p subobj to the box indicated before the object
5713 * indicated with @p before. If @p before is not already in the box, results
5714 * are undefined. Before means either to the left of the indicated object or
5715 * above it depending on orientation.
5717 * @param obj The box object
5718 * @param subobj The object to add to the box
5719 * @param before The object before which to add it
5721 * @see elm_box_pack_start()
5722 * @see elm_box_pack_end()
5723 * @see elm_box_pack_after()
5724 * @see elm_box_unpack()
5725 * @see elm_box_unpack_all()
5726 * @see elm_box_clear()
5728 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5730 * Adds an object to the box after the indicated object
5732 * This will add the @p subobj to the box indicated after the object
5733 * indicated with @p after. If @p after is not already in the box, results
5734 * are undefined. After means either to the right of the indicated object or
5735 * below it depending on orientation.
5737 * @param obj The box object
5738 * @param subobj The object to add to the box
5739 * @param after The object after which to add it
5741 * @see elm_box_pack_start()
5742 * @see elm_box_pack_end()
5743 * @see elm_box_pack_before()
5744 * @see elm_box_unpack()
5745 * @see elm_box_unpack_all()
5746 * @see elm_box_clear()
5748 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5750 * Clear the box of all children
5752 * Remove all the elements contained by the box, deleting the respective
5755 * @param obj The box object
5757 * @see elm_box_unpack()
5758 * @see elm_box_unpack_all()
5760 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5764 * Remove the object given by @p subobj from the box @p obj without
5767 * @param obj The box object
5769 * @see elm_box_unpack_all()
5770 * @see elm_box_clear()
5772 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5774 * Remove all items from the box, without deleting them
5776 * Clear the box from all children, but don't delete the respective objects.
5777 * If no other references of the box children exist, the objects will never
5778 * be deleted, and thus the application will leak the memory. Make sure
5779 * when using this function that you hold a reference to all the objects
5780 * in the box @p obj.
5782 * @param obj The box object
5784 * @see elm_box_clear()
5785 * @see elm_box_unpack()
5787 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5789 * Retrieve a list of the objects packed into the box
5791 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5792 * The order of the list corresponds to the packing order the box uses.
5794 * You must free this list with eina_list_free() once you are done with it.
5796 * @param obj The box object
5798 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5800 * Set the space (padding) between the box's elements.
5802 * Extra space in pixels that will be added between a box child and its
5803 * neighbors after its containing cell has been calculated. This padding
5804 * is set for all elements in the box, besides any possible padding that
5805 * individual elements may have through their size hints.
5807 * @param obj The box object
5808 * @param horizontal The horizontal space between elements
5809 * @param vertical The vertical space between elements
5811 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5813 * Get the space (padding) between the box's elements.
5815 * @param obj The box object
5816 * @param horizontal The horizontal space between elements
5817 * @param vertical The vertical space between elements
5819 * @see elm_box_padding_set()
5821 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5823 * Set the alignment of the whole bouding box of contents.
5825 * Sets how the bounding box containing all the elements of the box, after
5826 * their sizes and position has been calculated, will be aligned within
5827 * the space given for the whole box widget.
5829 * @param obj The box object
5830 * @param horizontal The horizontal alignment of elements
5831 * @param vertical The vertical alignment of elements
5833 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5835 * Get the alignment of the whole bouding box of contents.
5837 * @param obj The box object
5838 * @param horizontal The horizontal alignment of elements
5839 * @param vertical The vertical alignment of elements
5841 * @see elm_box_align_set()
5843 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5846 * Set the layout defining function to be used by the box
5848 * Whenever anything changes that requires the box in @p obj to recalculate
5849 * the size and position of its elements, the function @p cb will be called
5850 * to determine what the layout of the children will be.
5852 * Once a custom function is set, everything about the children layout
5853 * is defined by it. The flags set by elm_box_horizontal_set() and
5854 * elm_box_homogeneous_set() no longer have any meaning, and the values
5855 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5856 * layout function to decide if they are used and how. These last two
5857 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5858 * passed to @p cb. The @c Evas_Object the function receives is not the
5859 * Elementary widget, but the internal Evas Box it uses, so none of the
5860 * functions described here can be used on it.
5862 * Any of the layout functions in @c Evas can be used here, as well as the
5863 * special elm_box_layout_transition().
5865 * The final @p data argument received by @p cb is the same @p data passed
5866 * here, and the @p free_data function will be called to free it
5867 * whenever the box is destroyed or another layout function is set.
5869 * Setting @p cb to NULL will revert back to the default layout function.
5871 * @param obj The box object
5872 * @param cb The callback function used for layout
5873 * @param data Data that will be passed to layout function
5874 * @param free_data Function called to free @p data
5876 * @see elm_box_layout_transition()
5878 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);
5880 * Special layout function that animates the transition from one layout to another
5882 * Normally, when switching the layout function for a box, this will be
5883 * reflected immediately on screen on the next render, but it's also
5884 * possible to do this through an animated transition.
5886 * This is done by creating an ::Elm_Box_Transition and setting the box
5887 * layout to this function.
5891 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5892 * evas_object_box_layout_vertical, // start
5893 * NULL, // data for initial layout
5894 * NULL, // free function for initial data
5895 * evas_object_box_layout_horizontal, // end
5896 * NULL, // data for final layout
5897 * NULL, // free function for final data
5898 * anim_end, // will be called when animation ends
5899 * NULL); // data for anim_end function\
5900 * elm_box_layout_set(box, elm_box_layout_transition, t,
5901 * elm_box_transition_free);
5904 * @note This function can only be used with elm_box_layout_set(). Calling
5905 * it directly will not have the expected results.
5907 * @see elm_box_transition_new
5908 * @see elm_box_transition_free
5909 * @see elm_box_layout_set
5911 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5913 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5915 * If you want to animate the change from one layout to another, you need
5916 * to set the layout function of the box to elm_box_layout_transition(),
5917 * passing as user data to it an instance of ::Elm_Box_Transition with the
5918 * necessary information to perform this animation. The free function to
5919 * set for the layout is elm_box_transition_free().
5921 * The parameters to create an ::Elm_Box_Transition sum up to how long
5922 * will it be, in seconds, a layout function to describe the initial point,
5923 * another for the final position of the children and one function to be
5924 * called when the whole animation ends. This last function is useful to
5925 * set the definitive layout for the box, usually the same as the end
5926 * layout for the animation, but could be used to start another transition.
5928 * @param start_layout The layout function that will be used to start the animation
5929 * @param start_layout_data The data to be passed the @p start_layout function
5930 * @param start_layout_free_data Function to free @p start_layout_data
5931 * @param end_layout The layout function that will be used to end the animation
5932 * @param end_layout_free_data The data to be passed the @p end_layout function
5933 * @param end_layout_free_data Function to free @p end_layout_data
5934 * @param transition_end_cb Callback function called when animation ends
5935 * @param transition_end_data Data to be passed to @p transition_end_cb
5936 * @return An instance of ::Elm_Box_Transition
5938 * @see elm_box_transition_new
5939 * @see elm_box_layout_transition
5941 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);
5943 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5945 * This function is mostly useful as the @c free_data parameter in
5946 * elm_box_layout_set() when elm_box_layout_transition().
5948 * @param data The Elm_Box_Transition instance to be freed.
5950 * @see elm_box_transition_new
5951 * @see elm_box_layout_transition
5953 EAPI void elm_box_transition_free(void *data);
5960 * @defgroup Button Button
5962 * @image html img/widget/button/preview-00.png
5963 * @image latex img/widget/button/preview-00.eps
5964 * @image html img/widget/button/preview-01.png
5965 * @image latex img/widget/button/preview-01.eps
5966 * @image html img/widget/button/preview-02.png
5967 * @image latex img/widget/button/preview-02.eps
5969 * This is a push-button. Press it and run some function. It can contain
5970 * a simple label and icon object and it also has an autorepeat feature.
5972 * This widgets emits the following signals:
5973 * @li "clicked": the user clicked the button (press/release).
5974 * @li "repeated": the user pressed the button without releasing it.
5975 * @li "pressed": button was pressed.
5976 * @li "unpressed": button was released after being pressed.
5977 * In all three cases, the @c event parameter of the callback will be
5980 * Also, defined in the default theme, the button has the following styles
5982 * @li default: a normal button.
5983 * @li anchor: Like default, but the button fades away when the mouse is not
5984 * over it, leaving only the text or icon.
5985 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5986 * continuous look across its options.
5987 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5989 * Follow through a complete example @ref button_example_01 "here".
5993 * Add a new button to the parent's canvas
5995 * @param parent The parent object
5996 * @return The new object or NULL if it cannot be created
5998 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6000 * Set the label used in the button
6002 * The passed @p label can be NULL to clean any existing text in it and
6003 * leave the button as an icon only object.
6005 * @param obj The button object
6006 * @param label The text will be written on the button
6007 * @deprecated use elm_object_text_set() instead.
6009 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6011 * Get the label set for the button
6013 * The string returned is an internal pointer and should not be freed or
6014 * altered. It will also become invalid when the button is destroyed.
6015 * The string returned, if not NULL, is a stringshare, so if you need to
6016 * keep it around even after the button is destroyed, you can use
6017 * eina_stringshare_ref().
6019 * @param obj The button object
6020 * @return The text set to the label, or NULL if nothing is set
6021 * @deprecated use elm_object_text_set() instead.
6023 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6025 * Set the icon used for the button
6027 * Setting a new icon will delete any other that was previously set, making
6028 * any reference to them invalid. If you need to maintain the previous
6029 * object alive, unset it first with elm_button_icon_unset().
6031 * @param obj The button object
6032 * @param icon The icon object for the button
6034 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6036 * Get the icon used for the button
6038 * Return the icon object which is set for this widget. If the button is
6039 * destroyed or another icon is set, the returned object will be deleted
6040 * and any reference to it will be invalid.
6042 * @param obj The button object
6043 * @return The icon object that is being used
6045 * @see elm_button_icon_unset()
6047 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 * Remove the icon set without deleting it and return the object
6051 * This function drops the reference the button holds of the icon object
6052 * and returns this last object. It is used in case you want to remove any
6053 * icon, or set another one, without deleting the actual object. The button
6054 * will be left without an icon set.
6056 * @param obj The button object
6057 * @return The icon object that was being used
6059 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6061 * Turn on/off the autorepeat event generated when the button is kept pressed
6063 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6064 * signal when they are clicked.
6066 * When on, keeping a button pressed will continuously emit a @c repeated
6067 * signal until the button is released. The time it takes until it starts
6068 * emitting the signal is given by
6069 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6070 * new emission by elm_button_autorepeat_gap_timeout_set().
6072 * @param obj The button object
6073 * @param on A bool to turn on/off the event
6075 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6077 * Get whether the autorepeat feature is enabled
6079 * @param obj The button object
6080 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6082 * @see elm_button_autorepeat_set()
6084 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6086 * Set the initial timeout before the autorepeat event is generated
6088 * Sets the timeout, in seconds, since the button is pressed until the
6089 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6090 * won't be any delay and the even will be fired the moment the button is
6093 * @param obj The button object
6094 * @param t Timeout in seconds
6096 * @see elm_button_autorepeat_set()
6097 * @see elm_button_autorepeat_gap_timeout_set()
6099 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6101 * Get the initial timeout before the autorepeat event is generated
6103 * @param obj The button object
6104 * @return Timeout in seconds
6106 * @see elm_button_autorepeat_initial_timeout_set()
6108 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6110 * Set the interval between each generated autorepeat event
6112 * After the first @c repeated event is fired, all subsequent ones will
6113 * follow after a delay of @p t seconds for each.
6115 * @param obj The button object
6116 * @param t Interval in seconds
6118 * @see elm_button_autorepeat_initial_timeout_set()
6120 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6122 * Get the interval between each generated autorepeat event
6124 * @param obj The button object
6125 * @return Interval in seconds
6127 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6133 * @defgroup File_Selector_Button File Selector Button
6135 * @image html img/widget/fileselector_button/preview-00.png
6136 * @image latex img/widget/fileselector_button/preview-00.eps
6137 * @image html img/widget/fileselector_button/preview-01.png
6138 * @image latex img/widget/fileselector_button/preview-01.eps
6139 * @image html img/widget/fileselector_button/preview-02.png
6140 * @image latex img/widget/fileselector_button/preview-02.eps
6142 * This is a button that, when clicked, creates an Elementary
6143 * window (or inner window) <b> with a @ref Fileselector "file
6144 * selector widget" within</b>. When a file is chosen, the (inner)
6145 * window is closed and the button emits a signal having the
6146 * selected file as it's @c event_info.
6148 * This widget encapsulates operations on its internal file
6149 * selector on its own API. There is less control over its file
6150 * selector than that one would have instatiating one directly.
6152 * The following styles are available for this button:
6155 * @li @c "hoversel_vertical"
6156 * @li @c "hoversel_vertical_entry"
6158 * Smart callbacks one can register to:
6159 * - @c "file,chosen" - the user has selected a path, whose string
6160 * pointer comes as the @c event_info data (a stringshared
6163 * Here is an example on its usage:
6164 * @li @ref fileselector_button_example
6166 * @see @ref File_Selector_Entry for a similar widget.
6171 * Add a new file selector button widget to the given parent
6172 * Elementary (container) object
6174 * @param parent The parent object
6175 * @return a new file selector button widget handle or @c NULL, on
6178 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6181 * Set the label for a given file selector button widget
6183 * @param obj The file selector button widget
6184 * @param label The text label to be displayed on @p obj
6186 * @deprecated use elm_object_text_set() instead.
6188 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6191 * Get the label set for a given file selector button widget
6193 * @param obj The file selector button widget
6194 * @return The button label
6196 * @deprecated use elm_object_text_set() instead.
6198 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6201 * Set the icon on a given file selector button widget
6203 * @param obj The file selector button widget
6204 * @param icon The icon object for the button
6206 * Once the icon object is set, a previously set one will be
6207 * deleted. If you want to keep the latter, use the
6208 * elm_fileselector_button_icon_unset() function.
6210 * @see elm_fileselector_button_icon_get()
6212 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6215 * Get the icon set for a given file selector button widget
6217 * @param obj The file selector button widget
6218 * @return The icon object currently set on @p obj or @c NULL, if
6221 * @see elm_fileselector_button_icon_set()
6223 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6226 * Unset the icon used in a given file selector button widget
6228 * @param obj The file selector button widget
6229 * @return The icon object that was being used on @p obj or @c
6232 * Unparent and return the icon object which was set for this
6235 * @see elm_fileselector_button_icon_set()
6237 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6240 * Set the title for a given file selector button widget's window
6242 * @param obj The file selector button widget
6243 * @param title The title string
6245 * This will change the window's title, when the file selector pops
6246 * out after a click on the button. Those windows have the default
6247 * (unlocalized) value of @c "Select a file" as titles.
6249 * @note It will only take any effect if the file selector
6250 * button widget is @b not under "inwin mode".
6252 * @see elm_fileselector_button_window_title_get()
6254 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6257 * Get the title set for a given file selector button widget's
6260 * @param obj The file selector button widget
6261 * @return Title of the file selector button's window
6263 * @see elm_fileselector_button_window_title_get() for more details
6265 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6268 * Set the size of a given file selector button widget's window,
6269 * holding the file selector itself.
6271 * @param obj The file selector button widget
6272 * @param width The window's width
6273 * @param height The window's height
6275 * @note it will only take any effect if the file selector button
6276 * widget is @b not under "inwin mode". The default size for the
6277 * window (when applicable) is 400x400 pixels.
6279 * @see elm_fileselector_button_window_size_get()
6281 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6284 * Get the size of a given file selector button widget's window,
6285 * holding the file selector itself.
6287 * @param obj The file selector button widget
6288 * @param width Pointer into which to store the width value
6289 * @param height Pointer into which to store the height value
6291 * @note Use @c NULL pointers on the size values you're not
6292 * interested in: they'll be ignored by the function.
6294 * @see elm_fileselector_button_window_size_set(), for more details
6296 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6299 * Set the initial file system path for a given file selector
6302 * @param obj The file selector button widget
6303 * @param path The path string
6305 * It must be a <b>directory</b> path, which will have the contents
6306 * displayed initially in the file selector's view, when invoked
6307 * from @p obj. The default initial path is the @c "HOME"
6308 * environment variable's value.
6310 * @see elm_fileselector_button_path_get()
6312 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6315 * Get the initial file system path set for a given file selector
6318 * @param obj The file selector button widget
6319 * @return path The path string
6321 * @see elm_fileselector_button_path_set() for more details
6323 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6326 * Enable/disable a tree view in the given file selector button
6327 * widget's internal file selector
6329 * @param obj The file selector button widget
6330 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6333 * This has the same effect as elm_fileselector_expandable_set(),
6334 * but now applied to a file selector button's internal file
6337 * @note There's no way to put a file selector button's internal
6338 * file selector in "grid mode", as one may do with "pure" file
6341 * @see elm_fileselector_expandable_get()
6343 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6346 * Get whether tree view is enabled for the given file selector
6347 * button widget's internal file selector
6349 * @param obj The file selector button widget
6350 * @return @c EINA_TRUE if @p obj widget's internal file selector
6351 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6353 * @see elm_fileselector_expandable_set() for more details
6355 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6358 * Set whether a given file selector button widget's internal file
6359 * selector is to display folders only or the directory contents,
6362 * @param obj The file selector button widget
6363 * @param only @c EINA_TRUE to make @p obj widget's internal file
6364 * selector only display directories, @c EINA_FALSE to make files
6365 * to be displayed in it too
6367 * This has the same effect as elm_fileselector_folder_only_set(),
6368 * but now applied to a file selector button's internal file
6371 * @see elm_fileselector_folder_only_get()
6373 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6376 * Get whether a given file selector button widget's internal file
6377 * selector is displaying folders only or the directory contents,
6380 * @param obj The file selector button widget
6381 * @return @c EINA_TRUE if @p obj widget's internal file
6382 * selector is only displaying directories, @c EINA_FALSE if files
6383 * are being displayed in it too (and on errors)
6385 * @see elm_fileselector_button_folder_only_set() for more details
6387 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6390 * Enable/disable the file name entry box where the user can type
6391 * in a name for a file, in a given file selector button widget's
6392 * internal file selector.
6394 * @param obj The file selector button widget
6395 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6396 * file selector a "saving dialog", @c EINA_FALSE otherwise
6398 * This has the same effect as elm_fileselector_is_save_set(),
6399 * but now applied to a file selector button's internal file
6402 * @see elm_fileselector_is_save_get()
6404 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6407 * Get whether the given file selector button widget's internal
6408 * file selector is in "saving dialog" mode
6410 * @param obj The file selector button widget
6411 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6412 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6415 * @see elm_fileselector_button_is_save_set() for more details
6417 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6420 * Set whether a given file selector button widget's internal file
6421 * selector will raise an Elementary "inner window", instead of a
6422 * dedicated Elementary window. By default, it won't.
6424 * @param obj The file selector button widget
6425 * @param value @c EINA_TRUE to make it use an inner window, @c
6426 * EINA_TRUE to make it use a dedicated window
6428 * @see elm_win_inwin_add() for more information on inner windows
6429 * @see elm_fileselector_button_inwin_mode_get()
6431 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6434 * Get whether a given file selector button widget's internal file
6435 * selector will raise an Elementary "inner window", instead of a
6436 * dedicated Elementary window.
6438 * @param obj The file selector button widget
6439 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6440 * if it will use a dedicated window
6442 * @see elm_fileselector_button_inwin_mode_set() for more details
6444 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6451 * @defgroup File_Selector_Entry File Selector Entry
6453 * @image html img/widget/fileselector_entry/preview-00.png
6454 * @image latex img/widget/fileselector_entry/preview-00.eps
6456 * This is an entry made to be filled with or display a <b>file
6457 * system path string</b>. Besides the entry itself, the widget has
6458 * a @ref File_Selector_Button "file selector button" on its side,
6459 * which will raise an internal @ref Fileselector "file selector widget",
6460 * when clicked, for path selection aided by file system
6463 * This file selector may appear in an Elementary window or in an
6464 * inner window. When a file is chosen from it, the (inner) window
6465 * is closed and the selected file's path string is exposed both as
6466 * an smart event and as the new text on the entry.
6468 * This widget encapsulates operations on its internal file
6469 * selector on its own API. There is less control over its file
6470 * selector than that one would have instatiating one directly.
6472 * Smart callbacks one can register to:
6473 * - @c "changed" - The text within the entry was changed
6474 * - @c "activated" - The entry has had editing finished and
6475 * changes are to be "committed"
6476 * - @c "press" - The entry has been clicked
6477 * - @c "longpressed" - The entry has been clicked (and held) for a
6479 * - @c "clicked" - The entry has been clicked
6480 * - @c "clicked,double" - The entry has been double clicked
6481 * - @c "focused" - The entry has received focus
6482 * - @c "unfocused" - The entry has lost focus
6483 * - @c "selection,paste" - A paste action has occurred on the
6485 * - @c "selection,copy" - A copy action has occurred on the entry
6486 * - @c "selection,cut" - A cut action has occurred on the entry
6487 * - @c "unpressed" - The file selector entry's button was released
6488 * after being pressed.
6489 * - @c "file,chosen" - The user has selected a path via the file
6490 * selector entry's internal file selector, whose string pointer
6491 * comes as the @c event_info data (a stringshared string)
6493 * Here is an example on its usage:
6494 * @li @ref fileselector_entry_example
6496 * @see @ref File_Selector_Button for a similar widget.
6501 * Add a new file selector entry widget to the given parent
6502 * Elementary (container) object
6504 * @param parent The parent object
6505 * @return a new file selector entry widget handle or @c NULL, on
6508 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6511 * Set the label for a given file selector entry widget's button
6513 * @param obj The file selector entry widget
6514 * @param label The text label to be displayed on @p obj widget's
6517 * @deprecated use elm_object_text_set() instead.
6519 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6522 * Get the label set for a given file selector entry widget's button
6524 * @param obj The file selector entry widget
6525 * @return The widget button's label
6527 * @deprecated use elm_object_text_set() instead.
6529 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6532 * Set the icon on a given file selector entry widget's button
6534 * @param obj The file selector entry widget
6535 * @param icon The icon object for the entry's button
6537 * Once the icon object is set, a previously set one will be
6538 * deleted. If you want to keep the latter, use the
6539 * elm_fileselector_entry_button_icon_unset() function.
6541 * @see elm_fileselector_entry_button_icon_get()
6543 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6546 * Get the icon set for a given file selector entry widget's button
6548 * @param obj The file selector entry widget
6549 * @return The icon object currently set on @p obj widget's button
6550 * or @c NULL, if none is
6552 * @see elm_fileselector_entry_button_icon_set()
6554 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6557 * Unset the icon used in a given file selector entry widget's
6560 * @param obj The file selector entry widget
6561 * @return The icon object that was being used on @p obj widget's
6562 * button or @c NULL, on errors
6564 * Unparent and return the icon object which was set for this
6567 * @see elm_fileselector_entry_button_icon_set()
6569 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6572 * Set the title for a given file selector entry widget's window
6574 * @param obj The file selector entry widget
6575 * @param title The title string
6577 * This will change the window's title, when the file selector pops
6578 * out after a click on the entry's button. Those windows have the
6579 * default (unlocalized) value of @c "Select a file" as titles.
6581 * @note It will only take any effect if the file selector
6582 * entry widget is @b not under "inwin mode".
6584 * @see elm_fileselector_entry_window_title_get()
6586 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6589 * Get the title set for a given file selector entry widget's
6592 * @param obj The file selector entry widget
6593 * @return Title of the file selector entry's window
6595 * @see elm_fileselector_entry_window_title_get() for more details
6597 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6600 * Set the size of a given file selector entry widget's window,
6601 * holding the file selector itself.
6603 * @param obj The file selector entry widget
6604 * @param width The window's width
6605 * @param height The window's height
6607 * @note it will only take any effect if the file selector entry
6608 * widget is @b not under "inwin mode". The default size for the
6609 * window (when applicable) is 400x400 pixels.
6611 * @see elm_fileselector_entry_window_size_get()
6613 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6616 * Get the size of a given file selector entry widget's window,
6617 * holding the file selector itself.
6619 * @param obj The file selector entry widget
6620 * @param width Pointer into which to store the width value
6621 * @param height Pointer into which to store the height value
6623 * @note Use @c NULL pointers on the size values you're not
6624 * interested in: they'll be ignored by the function.
6626 * @see elm_fileselector_entry_window_size_set(), for more details
6628 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6631 * Set the initial file system path and the entry's path string for
6632 * a given file selector entry widget
6634 * @param obj The file selector entry widget
6635 * @param path The path string
6637 * It must be a <b>directory</b> path, which will have the contents
6638 * displayed initially in the file selector's view, when invoked
6639 * from @p obj. The default initial path is the @c "HOME"
6640 * environment variable's value.
6642 * @see elm_fileselector_entry_path_get()
6644 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6647 * Get the entry's path string for a given file selector entry
6650 * @param obj The file selector entry widget
6651 * @return path The path string
6653 * @see elm_fileselector_entry_path_set() for more details
6655 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6658 * Enable/disable a tree view in the given file selector entry
6659 * widget's internal file selector
6661 * @param obj The file selector entry widget
6662 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6665 * This has the same effect as elm_fileselector_expandable_set(),
6666 * but now applied to a file selector entry's internal file
6669 * @note There's no way to put a file selector entry's internal
6670 * file selector in "grid mode", as one may do with "pure" file
6673 * @see elm_fileselector_expandable_get()
6675 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6678 * Get whether tree view is enabled for the given file selector
6679 * entry widget's internal file selector
6681 * @param obj The file selector entry widget
6682 * @return @c EINA_TRUE if @p obj widget's internal file selector
6683 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6685 * @see elm_fileselector_expandable_set() for more details
6687 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690 * Set whether a given file selector entry widget's internal file
6691 * selector is to display folders only or the directory contents,
6694 * @param obj The file selector entry widget
6695 * @param only @c EINA_TRUE to make @p obj widget's internal file
6696 * selector only display directories, @c EINA_FALSE to make files
6697 * to be displayed in it too
6699 * This has the same effect as elm_fileselector_folder_only_set(),
6700 * but now applied to a file selector entry's internal file
6703 * @see elm_fileselector_folder_only_get()
6705 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6708 * Get whether a given file selector entry widget's internal file
6709 * selector is displaying folders only or the directory contents,
6712 * @param obj The file selector entry widget
6713 * @return @c EINA_TRUE if @p obj widget's internal file
6714 * selector is only displaying directories, @c EINA_FALSE if files
6715 * are being displayed in it too (and on errors)
6717 * @see elm_fileselector_entry_folder_only_set() for more details
6719 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6722 * Enable/disable the file name entry box where the user can type
6723 * in a name for a file, in a given file selector entry widget's
6724 * internal file selector.
6726 * @param obj The file selector entry widget
6727 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6728 * file selector a "saving dialog", @c EINA_FALSE otherwise
6730 * This has the same effect as elm_fileselector_is_save_set(),
6731 * but now applied to a file selector entry's internal file
6734 * @see elm_fileselector_is_save_get()
6736 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6739 * Get whether the given file selector entry widget's internal
6740 * file selector is in "saving dialog" mode
6742 * @param obj The file selector entry widget
6743 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6744 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6747 * @see elm_fileselector_entry_is_save_set() for more details
6749 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6752 * Set whether a given file selector entry widget's internal file
6753 * selector will raise an Elementary "inner window", instead of a
6754 * dedicated Elementary window. By default, it won't.
6756 * @param obj The file selector entry widget
6757 * @param value @c EINA_TRUE to make it use an inner window, @c
6758 * EINA_TRUE to make it use a dedicated window
6760 * @see elm_win_inwin_add() for more information on inner windows
6761 * @see elm_fileselector_entry_inwin_mode_get()
6763 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6766 * Get whether a given file selector entry widget's internal file
6767 * selector will raise an Elementary "inner window", instead of a
6768 * dedicated Elementary window.
6770 * @param obj The file selector entry widget
6771 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6772 * if it will use a dedicated window
6774 * @see elm_fileselector_entry_inwin_mode_set() for more details
6776 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6779 * Set the initial file system path for a given file selector entry
6782 * @param obj The file selector entry widget
6783 * @param path The path string
6785 * It must be a <b>directory</b> path, which will have the contents
6786 * displayed initially in the file selector's view, when invoked
6787 * from @p obj. The default initial path is the @c "HOME"
6788 * environment variable's value.
6790 * @see elm_fileselector_entry_path_get()
6792 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6795 * Get the parent directory's path to the latest file selection on
6796 * a given filer selector entry widget
6798 * @param obj The file selector object
6799 * @return The (full) path of the directory of the last selection
6800 * on @p obj widget, a @b stringshared string
6802 * @see elm_fileselector_entry_path_set()
6804 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6811 * @defgroup Scroller Scroller
6813 * A scroller holds a single object and "scrolls it around". This means that
6814 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6815 * region around, allowing to move through a much larger object that is
6816 * contained in the scroller. The scroiller will always have a small minimum
6817 * size by default as it won't be limited by the contents of the scroller.
6819 * Signals that you can add callbacks for are:
6820 * @li "edge,left" - the left edge of the content has been reached
6821 * @li "edge,right" - the right edge of the content has been reached
6822 * @li "edge,top" - the top edge of the content has been reached
6823 * @li "edge,bottom" - the bottom edge of the content has been reached
6824 * @li "scroll" - the content has been scrolled (moved)
6825 * @li "scroll,anim,start" - scrolling animation has started
6826 * @li "scroll,anim,stop" - scrolling animation has stopped
6827 * @li "scroll,drag,start" - dragging the contents around has started
6828 * @li "scroll,drag,stop" - dragging the contents around has stopped
6829 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6832 * @note When Elemementary is in embedded mode the scrollbars will not be
6833 * dragable, they appear merely as indicators of how much has been scrolled.
6834 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6835 * fingerscroll) won't work.
6837 * In @ref tutorial_scroller you'll find an example of how to use most of
6842 * @brief Type that controls when scrollbars should appear.
6844 * @see elm_scroller_policy_set()
6846 typedef enum _Elm_Scroller_Policy
6848 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6849 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6850 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6851 ELM_SCROLLER_POLICY_LAST
6852 } Elm_Scroller_Policy;
6854 * @brief Add a new scroller to the parent
6856 * @param parent The parent object
6857 * @return The new object or NULL if it cannot be created
6859 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6861 * @brief Set the content of the scroller widget (the object to be scrolled around).
6863 * @param obj The scroller object
6864 * @param content The new content object
6866 * Once the content object is set, a previously set one will be deleted.
6867 * If you want to keep that old content object, use the
6868 * elm_scroller_content_unset() function.
6870 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6872 * @brief Get the content of the scroller widget
6874 * @param obj The slider object
6875 * @return The content that is being used
6877 * Return the content object which is set for this widget
6879 * @see elm_scroller_content_set()
6881 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6883 * @brief Unset the content of the scroller widget
6885 * @param obj The slider object
6886 * @return The content that was being used
6888 * Unparent and return the content object which was set for this widget
6890 * @see elm_scroller_content_set()
6892 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6894 * @brief Set custom theme elements for the scroller
6896 * @param obj The scroller object
6897 * @param widget The widget name to use (default is "scroller")
6898 * @param base The base name to use (default is "base")
6900 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6902 * @brief Make the scroller minimum size limited to the minimum size of the content
6904 * @param obj The scroller object
6905 * @param w Enable limiting minimum size horizontally
6906 * @param h Enable limiting minimum size vertically
6908 * By default the scroller will be as small as its design allows,
6909 * irrespective of its content. This will make the scroller minimum size the
6910 * right size horizontally and/or vertically to perfectly fit its content in
6913 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6915 * @brief Show a specific virtual region within the scroller content object
6917 * @param obj The scroller object
6918 * @param x X coordinate of the region
6919 * @param y Y coordinate of the region
6920 * @param w Width of the region
6921 * @param h Height of the region
6923 * This will ensure all (or part if it does not fit) of the designated
6924 * region in the virtual content object (0, 0 starting at the top-left of the
6925 * virtual content object) is shown within the scroller.
6927 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);
6929 * @brief Set the scrollbar visibility policy
6931 * @param obj The scroller object
6932 * @param policy_h Horizontal scrollbar policy
6933 * @param policy_v Vertical scrollbar policy
6935 * This sets the scrollbar visibility policy for the given scroller.
6936 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6937 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6938 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6939 * respectively for the horizontal and vertical scrollbars.
6941 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6943 * @brief Gets scrollbar visibility policy
6945 * @param obj The scroller object
6946 * @param policy_h Horizontal scrollbar policy
6947 * @param policy_v Vertical scrollbar policy
6949 * @see elm_scroller_policy_set()
6951 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6953 * @brief Get the currently visible content region
6955 * @param obj The scroller object
6956 * @param x X coordinate of the region
6957 * @param y Y coordinate of the region
6958 * @param w Width of the region
6959 * @param h Height of the region
6961 * This gets the current region in the content object that is visible through
6962 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6963 * w, @p h values pointed to.
6965 * @note All coordinates are relative to the content.
6967 * @see elm_scroller_region_show()
6969 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);
6971 * @brief Get the size of the content object
6973 * @param obj The scroller object
6974 * @param w Width return
6975 * @param h Height return
6977 * This gets the size of the content object of the scroller.
6979 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6981 * @brief Set bouncing behavior
6983 * @param obj The scroller object
6984 * @param h_bounce Will the scroller bounce horizontally or not
6985 * @param v_bounce Will the scroller bounce vertically or not
6987 * When scrolling, the scroller may "bounce" when reaching an edge of the
6988 * content object. This is a visual way to indicate the end has been reached.
6989 * This is enabled by default for both axis. This will set if it is enabled
6990 * for that axis with the boolean parameters for each axis.
6992 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6994 * @brief Get the bounce mode
6996 * @param obj The Scroller object
6997 * @param h_bounce Allow bounce horizontally
6998 * @param v_bounce Allow bounce vertically
7000 * @see elm_scroller_bounce_set()
7002 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7004 * @brief Set scroll page size relative to viewport size.
7006 * @param obj The scroller object
7007 * @param h_pagerel The horizontal page relative size
7008 * @param v_pagerel The vertical page relative size
7010 * The scroller is capable of limiting scrolling by the user to "pages". That
7011 * is to jump by and only show a "whole page" at a time as if the continuous
7012 * area of the scroller content is split into page sized pieces. This sets
7013 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7014 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7015 * axis. This is mutually exclusive with page size
7016 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7017 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7018 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7021 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7023 * @brief Set scroll page size.
7025 * @param obj The scroller object
7026 * @param h_pagesize The horizontal page size
7027 * @param v_pagesize The vertical page size
7029 * This sets the page size to an absolute fixed value, with 0 turning it off
7032 * @see elm_scroller_page_relative_set()
7034 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7036 * @brief Get scroll current page number.
7038 * @param obj The scroller object
7039 * @param h_pagenumber The horizoptal page number
7040 * @param v_pagenumber The vertical page number
7042 * The page number starts from 0. 0 is the first page.
7043 * Current page means the page which meet the top-left of the viewport.
7044 * If there are two or more pages in the viewport, it returns the number of page
7045 * which meet the top-left of the viewport.
7047 * @see elm_scroller_last_page_get()
7048 * @see elm_scroller_page_show()
7049 * @see elm_scroller_page_brint_in()
7051 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7053 * @brief Get scroll last page number.
7055 * @param obj The scroller object
7056 * @param h_pagenumber The horizoptal page number
7057 * @param v_pagenumber The vertical page number
7059 * The page number starts from 0. 0 is the first page.
7060 * This returns the last page number among the pages.
7062 * @see elm_scroller_current_page_get()
7063 * @see elm_scroller_page_show()
7064 * @see elm_scroller_page_brint_in()
7066 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7068 * Show a specific virtual region within the scroller content object by page number.
7070 * @param obj The scroller object
7071 * @param h_pagenumber The horizoptal page number
7072 * @param v_pagenumber The vertical page number
7074 * 0, 0 of the indicated page is located at the top-left of the viewport.
7075 * This will jump to the page directly without animation.
7080 * sc = elm_scroller_add(win);
7081 * elm_scroller_content_set(sc, content);
7082 * elm_scroller_page_relative_set(sc, 1, 0);
7083 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7084 * elm_scroller_page_show(sc, h_page + 1, v_page);
7087 * @see elm_scroller_page_bring_in()
7089 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7091 * Show a specific virtual region within the scroller content object by page number.
7093 * @param obj The scroller object
7094 * @param h_pagenumber The horizoptal page number
7095 * @param v_pagenumber The vertical page number
7097 * 0, 0 of the indicated page is located at the top-left of the viewport.
7098 * This will slide to the page with animation.
7103 * sc = elm_scroller_add(win);
7104 * elm_scroller_content_set(sc, content);
7105 * elm_scroller_page_relative_set(sc, 1, 0);
7106 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7107 * elm_scroller_page_bring_in(sc, h_page, v_page);
7110 * @see elm_scroller_page_show()
7112 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7114 * @brief Show a specific virtual region within the scroller content object.
7116 * @param obj The scroller object
7117 * @param x X coordinate of the region
7118 * @param y Y coordinate of the region
7119 * @param w Width of the region
7120 * @param h Height of the region
7122 * This will ensure all (or part if it does not fit) of the designated
7123 * region in the virtual content object (0, 0 starting at the top-left of the
7124 * virtual content object) is shown within the scroller. Unlike
7125 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7126 * to this location (if configuration in general calls for transitions). It
7127 * may not jump immediately to the new location and make take a while and
7128 * show other content along the way.
7130 * @see elm_scroller_region_show()
7132 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);
7134 * @brief Set event propagation on a scroller
7136 * @param obj The scroller object
7137 * @param propagation If propagation is enabled or not
7139 * This enables or disabled event propagation from the scroller content to
7140 * the scroller and its parent. By default event propagation is disabled.
7142 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7144 * @brief Get event propagation for a scroller
7146 * @param obj The scroller object
7147 * @return The propagation state
7149 * This gets the event propagation for a scroller.
7151 * @see elm_scroller_propagate_events_set()
7153 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7159 * @defgroup Label Label
7161 * @image html img/widget/label/preview-00.png
7162 * @image latex img/widget/label/preview-00.eps
7164 * @brief Widget to display text, with simple html-like markup.
7166 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7167 * text doesn't fit the geometry of the label it will be ellipsized or be
7168 * cut. Elementary provides several themes for this widget:
7169 * @li default - No animation
7170 * @li marker - Centers the text in the label and make it bold by default
7171 * @li slide_long - The entire text appears from the right of the screen and
7172 * slides until it disappears in the left of the screen(reappering on the
7174 * @li slide_short - The text appears in the left of the label and slides to
7175 * the right to show the overflow. When all of the text has been shown the
7176 * position is reset.
7177 * @li slide_bounce - The text appears in the left of the label and slides to
7178 * the right to show the overflow. When all of the text has been shown the
7179 * animation reverses, moving the text to the left.
7181 * Custom themes can of course invent new markup tags and style them any way
7184 * See @ref tutorial_label for a demonstration of how to use a label widget.
7188 * @brief Add a new label to the parent
7190 * @param parent The parent object
7191 * @return The new object or NULL if it cannot be created
7193 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7195 * @brief Set the label on the label object
7197 * @param obj The label object
7198 * @param label The label will be used on the label object
7199 * @deprecated See elm_object_text_set()
7201 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 */
7203 * @brief Get the label used on the label object
7205 * @param obj The label object
7206 * @return The string inside the label
7207 * @deprecated See elm_object_text_get()
7209 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7211 * @brief Set the wrapping behavior of the label
7213 * @param obj The label object
7214 * @param wrap To wrap text or not
7216 * By default no wrapping is done. Possible values for @p wrap are:
7217 * @li ELM_WRAP_NONE - No wrapping
7218 * @li ELM_WRAP_CHAR - wrap between characters
7219 * @li ELM_WRAP_WORD - wrap between words
7220 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7222 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7224 * @brief Get the wrapping behavior of the label
7226 * @param obj The label object
7229 * @see elm_label_line_wrap_set()
7231 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7233 * @brief Set wrap width of the label
7235 * @param obj The label object
7236 * @param w The wrap width in pixels at a minimum where words need to wrap
7238 * This function sets the maximum width size hint of the label.
7240 * @warning This is only relevant if the label is inside a container.
7242 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7244 * @brief Get wrap width of the label
7246 * @param obj The label object
7247 * @return The wrap width in pixels at a minimum where words need to wrap
7249 * @see elm_label_wrap_width_set()
7251 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7253 * @brief Set wrap height of the label
7255 * @param obj The label object
7256 * @param h The wrap height in pixels at a minimum where words need to wrap
7258 * This function sets the maximum height size hint of the label.
7260 * @warning This is only relevant if the label is inside a container.
7262 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7264 * @brief get wrap width of the label
7266 * @param obj The label object
7267 * @return The wrap height in pixels at a minimum where words need to wrap
7269 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7271 * @brief Set the font size on the label object.
7273 * @param obj The label object
7274 * @param size font size
7276 * @warning NEVER use this. It is for hyper-special cases only. use styles
7277 * instead. e.g. "big", "medium", "small" - or better name them by use:
7278 * "title", "footnote", "quote" etc.
7280 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7282 * @brief Set the text color on the label object
7284 * @param obj The label object
7285 * @param r Red property background color of The label object
7286 * @param g Green property background color of The label object
7287 * @param b Blue property background color of The label object
7288 * @param a Alpha property background color of The label object
7290 * @warning NEVER use this. It is for hyper-special cases only. use styles
7291 * instead. e.g. "big", "medium", "small" - or better name them by use:
7292 * "title", "footnote", "quote" etc.
7294 EAPI void elm_label_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7296 * @brief Set the text align on the label object
7298 * @param obj The label object
7299 * @param align align mode ("left", "center", "right")
7301 * @warning NEVER use this. It is for hyper-special cases only. use styles
7302 * instead. e.g. "big", "medium", "small" - or better name them by use:
7303 * "title", "footnote", "quote" etc.
7305 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7307 * @brief Set background color of the label
7309 * @param obj The label object
7310 * @param r Red property background color of The label object
7311 * @param g Green property background color of The label object
7312 * @param b Blue property background color of The label object
7313 * @param a Alpha property background alpha of The label object
7315 * @warning NEVER use this. It is for hyper-special cases only. use styles
7316 * instead. e.g. "big", "medium", "small" - or better name them by use:
7317 * "title", "footnote", "quote" etc.
7319 EAPI void elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7321 * @brief Set the ellipsis behavior of the label
7323 * @param obj The label object
7324 * @param ellipsis To ellipsis text or not
7326 * If set to true and the text doesn't fit in the label an ellipsis("...")
7327 * will be shown at the end of the widget.
7329 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7330 * choosen wrap method was ELM_WRAP_WORD.
7332 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7334 * @brief Set the text slide of the label
7336 * @param obj The label object
7337 * @param slide To start slide or stop
7339 * If set to true the text of the label will slide throught the length of
7342 * @warning This only work with the themes "slide_short", "slide_long" and
7345 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7347 * @brief Get the text slide mode of the label
7349 * @param obj The label object
7350 * @return slide slide mode value
7352 * @see elm_label_slide_set()
7354 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7356 * @brief Set the slide duration(speed) of the label
7358 * @param obj The label object
7359 * @return The duration in seconds in moving text from slide begin position
7360 * to slide end position
7362 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7364 * @brief Get the slide duration(speed) of the label
7366 * @param obj The label object
7367 * @return The duration time in moving text from slide begin position to slide end position
7369 * @see elm_label_slide_duration_set()
7371 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7377 * @defgroup Toggle Toggle
7379 * @image html img/widget/toggle/preview-00.png
7380 * @image latex img/widget/toggle/preview-00.eps
7382 * @brief A toggle is a slider which can be used to toggle between
7383 * two values. It has two states: on and off.
7385 * Signals that you can add callbacks for are:
7386 * @li "changed" - Whenever the toggle value has been changed. Is not called
7387 * until the toggle is released by the cursor (assuming it
7388 * has been triggered by the cursor in the first place).
7390 * @ref tutorial_toggle show how to use a toggle.
7394 * @brief Add a toggle to @p parent.
7396 * @param parent The parent object
7398 * @return The toggle object
7400 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7402 * @brief Sets the label to be displayed with the toggle.
7404 * @param obj The toggle object
7405 * @param label The label to be displayed
7407 * @deprecated use elm_object_text_set() instead.
7409 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7411 * @brief Gets the label of the toggle
7413 * @param obj toggle object
7414 * @return The label of the toggle
7416 * @deprecated use elm_object_text_get() instead.
7418 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7420 * @brief Set the icon used for the toggle
7422 * @param obj The toggle object
7423 * @param icon The icon object for the button
7425 * Once the icon object is set, a previously set one will be deleted
7426 * If you want to keep that old content object, use the
7427 * elm_toggle_icon_unset() function.
7429 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7431 * @brief Get the icon used for the toggle
7433 * @param obj The toggle object
7434 * @return The icon object that is being used
7436 * Return the icon object which is set for this widget.
7438 * @see elm_toggle_icon_set()
7440 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7442 * @brief Unset the icon used for the toggle
7444 * @param obj The toggle object
7445 * @return The icon object that was being used
7447 * Unparent and return the icon object which was set for this widget.
7449 * @see elm_toggle_icon_set()
7451 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7453 * @brief Sets the labels to be associated with the on and off states of the toggle.
7455 * @param obj The toggle object
7456 * @param onlabel The label displayed when the toggle is in the "on" state
7457 * @param offlabel The label displayed when the toggle is in the "off" state
7459 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7461 * @brief Gets the labels associated with the on and off states of the toggle.
7463 * @param obj The toggle object
7464 * @param onlabel A char** to place the onlabel of @p obj into
7465 * @param offlabel A char** to place the offlabel of @p obj into
7467 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7469 * @brief Sets the state of the toggle to @p state.
7471 * @param obj The toggle object
7472 * @param state The state of @p obj
7474 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7476 * @brief Gets the state of the toggle to @p state.
7478 * @param obj The toggle object
7479 * @return The state of @p obj
7481 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7483 * @brief Sets the state pointer of the toggle to @p statep.
7485 * @param obj The toggle object
7486 * @param statep The state pointer of @p obj
7488 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7494 * @defgroup Frame Frame
7496 * @image html img/widget/frame/preview-00.png
7497 * @image latex img/widget/frame/preview-00.eps
7499 * @brief Frame is a widget that holds some content and has a title.
7501 * The default look is a frame with a title, but Frame supports multple
7509 * @li outdent_bottom
7511 * Of all this styles only default shows the title. Frame emits no signals.
7513 * For a detailed example see the @ref tutorial_frame.
7518 * @brief Add a new frame to the parent
7520 * @param parent The parent object
7521 * @return The new object or NULL if it cannot be created
7523 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7525 * @brief Set the frame label
7527 * @param obj The frame object
7528 * @param label The label of this frame object
7530 * @deprecated use elm_object_text_set() instead.
7532 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7534 * @brief Get the frame label
7536 * @param obj The frame object
7538 * @return The label of this frame objet or NULL if unable to get frame
7540 * @deprecated use elm_object_text_get() instead.
7542 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7544 * @brief Set the content of the frame widget
7546 * Once the content object is set, a previously set one will be deleted.
7547 * If you want to keep that old content object, use the
7548 * elm_frame_content_unset() function.
7550 * @param obj The frame object
7551 * @param content The content will be filled in this frame object
7553 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7555 * @brief Get the content of the frame widget
7557 * Return the content object which is set for this widget
7559 * @param obj The frame object
7560 * @return The content that is being used
7562 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7564 * @brief Unset the content of the frame widget
7566 * Unparent and return the content object which was set for this widget
7568 * @param obj The frame object
7569 * @return The content that was being used
7571 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7577 * @defgroup Table Table
7579 * A container widget to arrange other widgets in a table where items can
7580 * also span multiple columns or rows - even overlap (and then be raised or
7581 * lowered accordingly to adjust stacking if they do overlap).
7583 * The followin are examples of how to use a table:
7584 * @li @ref tutorial_table_01
7585 * @li @ref tutorial_table_02
7590 * @brief Add a new table to the parent
7592 * @param parent The parent object
7593 * @return The new object or NULL if it cannot be created
7595 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7597 * @brief Set the homogeneous layout in the table
7599 * @param obj The layout object
7600 * @param homogeneous A boolean to set if the layout is homogeneous in the
7601 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7603 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7605 * @brief Get the current table homogeneous mode.
7607 * @param obj The table object
7608 * @return A boolean to indicating if the layout is homogeneous in the table
7609 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7611 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7613 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7615 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7617 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7619 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7621 * @brief Set padding between cells.
7623 * @param obj The layout object.
7624 * @param horizontal set the horizontal padding.
7625 * @param vertical set the vertical padding.
7627 * Default value is 0.
7629 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7631 * @brief Get padding between cells.
7633 * @param obj The layout object.
7634 * @param horizontal set the horizontal padding.
7635 * @param vertical set the vertical padding.
7637 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7639 * @brief Add a subobject on the table with the coordinates passed
7641 * @param obj The table object
7642 * @param subobj The subobject to be added to the table
7643 * @param x Row number
7644 * @param y Column number
7648 * @note All positioning inside the table is relative to rows and columns, so
7649 * a value of 0 for x and y, means the top left cell of the table, and a
7650 * value of 1 for w and h means @p subobj only takes that 1 cell.
7652 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7654 * @brief Remove child from table.
7656 * @param obj The table object
7657 * @param subobj The subobject
7659 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7661 * @brief Faster way to remove all child objects from a table object.
7663 * @param obj The table object
7664 * @param clear If true, will delete children, else just remove from table.
7666 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7668 * @brief Set the packing location of an existing child of the table
7670 * @param subobj The subobject to be modified in the table
7671 * @param x Row number
7672 * @param y Column number
7676 * Modifies the position of an object already in the table.
7678 * @note All positioning inside the table is relative to rows and columns, so
7679 * a value of 0 for x and y, means the top left cell of the table, and a
7680 * value of 1 for w and h means @p subobj only takes that 1 cell.
7682 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7684 * @brief Get the packing location of an existing child of the table
7686 * @param subobj The subobject to be modified in the table
7687 * @param x Row number
7688 * @param y Column number
7692 * @see elm_table_pack_set()
7694 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7700 * @defgroup Gengrid Gengrid (Generic grid)
7702 * This widget aims to position objects in a grid layout while
7703 * actually creating and rendering only the visible ones, using the
7704 * same idea as the @ref Genlist "genlist": the user defines a @b
7705 * class for each item, specifying functions that will be called at
7706 * object creation, deletion, etc. When those items are selected by
7707 * the user, a callback function is issued. Users may interact with
7708 * a gengrid via the mouse (by clicking on items to select them and
7709 * clicking on the grid's viewport and swiping to pan the whole
7710 * view) or via the keyboard, navigating through item with the
7713 * @section Gengrid_Layouts Gengrid layouts
7715 * Gengrids may layout its items in one of two possible layouts:
7719 * When in "horizontal mode", items will be placed in @b columns,
7720 * from top to bottom and, when the space for a column is filled,
7721 * another one is started on the right, thus expanding the grid
7722 * horizontally, making for horizontal scrolling. When in "vertical
7723 * mode" , though, items will be placed in @b rows, from left to
7724 * right and, when the space for a row is filled, another one is
7725 * started below, thus expanding the grid vertically (and making
7726 * for vertical scrolling).
7728 * @section Gengrid_Items Gengrid items
7730 * An item in a gengrid can have 0 or more text labels (they can be
7731 * regular text or textblock Evas objects - that's up to the style
7732 * to determine), 0 or more icons (which are simply objects
7733 * swallowed into the gengrid item's theming Edje object) and 0 or
7734 * more <b>boolean states</b>, which have the behavior left to the
7735 * user to define. The Edje part names for each of these properties
7736 * will be looked up, in the theme file for the gengrid, under the
7737 * Edje (string) data items named @c "labels", @c "icons" and @c
7738 * "states", respectively. For each of those properties, if more
7739 * than one part is provided, they must have names listed separated
7740 * by spaces in the data fields. For the default gengrid item
7741 * theme, we have @b one label part (@c "elm.text"), @b two icon
7742 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7745 * A gengrid item may be at one of several styles. Elementary
7746 * provides one by default - "default", but this can be extended by
7747 * system or application custom themes/overlays/extensions (see
7748 * @ref Theme "themes" for more details).
7750 * @section Gengrid_Item_Class Gengrid item classes
7752 * In order to have the ability to add and delete items on the fly,
7753 * gengrid implements a class (callback) system where the
7754 * application provides a structure with information about that
7755 * type of item (gengrid may contain multiple different items with
7756 * different classes, states and styles). Gengrid will call the
7757 * functions in this struct (methods) when an item is "realized"
7758 * (i.e., created dynamically, while the user is scrolling the
7759 * grid). All objects will simply be deleted when no longer needed
7760 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7761 * contains the following members:
7762 * - @c item_style - This is a constant string and simply defines
7763 * the name of the item style. It @b must be specified and the
7764 * default should be @c "default".
7765 * - @c func.label_get - This function is called when an item
7766 * object is actually created. The @c data parameter will point to
7767 * the same data passed to elm_gengrid_item_append() and related
7768 * item creation functions. The @c obj parameter is the gengrid
7769 * object itself, while the @c part one is the name string of one
7770 * of the existing text parts in the Edje group implementing the
7771 * item's theme. This function @b must return a strdup'()ed string,
7772 * as the caller will free() it when done. See
7773 * #Elm_Gengrid_Item_Label_Get_Cb.
7774 * - @c func.icon_get - This function is called when an item object
7775 * is actually created. The @c data parameter will point to the
7776 * same data passed to elm_gengrid_item_append() and related item
7777 * creation functions. The @c obj parameter is the gengrid object
7778 * itself, while the @c part one is the name string of one of the
7779 * existing (icon) swallow parts in the Edje group implementing the
7780 * item's theme. It must return @c NULL, when no icon is desired,
7781 * or a valid object handle, otherwise. The object will be deleted
7782 * by the gengrid on its deletion or when the item is "unrealized".
7783 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7784 * - @c func.state_get - This function is called when an item
7785 * object is actually created. The @c data parameter will point to
7786 * the same data passed to elm_gengrid_item_append() and related
7787 * item creation functions. The @c obj parameter is the gengrid
7788 * object itself, while the @c part one is the name string of one
7789 * of the state parts in the Edje group implementing the item's
7790 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7791 * true/on. Gengrids will emit a signal to its theming Edje object
7792 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7793 * "source" arguments, respectively, when the state is true (the
7794 * default is false), where @c XXX is the name of the (state) part.
7795 * See #Elm_Gengrid_Item_State_Get_Cb.
7796 * - @c func.del - This is called when elm_gengrid_item_del() is
7797 * called on an item or elm_gengrid_clear() is called on the
7798 * gengrid. This is intended for use when gengrid items are
7799 * deleted, so any data attached to the item (e.g. its data
7800 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7802 * @section Gengrid_Usage_Hints Usage hints
7804 * If the user wants to have multiple items selected at the same
7805 * time, elm_gengrid_multi_select_set() will permit it. If the
7806 * gengrid is single-selection only (the default), then
7807 * elm_gengrid_select_item_get() will return the selected item or
7808 * @c NULL, if none is selected. If the gengrid is under
7809 * multi-selection, then elm_gengrid_selected_items_get() will
7810 * return a list (that is only valid as long as no items are
7811 * modified (added, deleted, selected or unselected) of child items
7814 * If an item changes (internal (boolean) state, label or icon
7815 * changes), then use elm_gengrid_item_update() to have gengrid
7816 * update the item with the new state. A gengrid will re-"realize"
7817 * the item, thus calling the functions in the
7818 * #Elm_Gengrid_Item_Class set for that item.
7820 * To programmatically (un)select an item, use
7821 * elm_gengrid_item_selected_set(). To get its selected state use
7822 * elm_gengrid_item_selected_get(). To make an item disabled
7823 * (unable to be selected and appear differently) use
7824 * elm_gengrid_item_disabled_set() to set this and
7825 * elm_gengrid_item_disabled_get() to get the disabled state.
7827 * Grid cells will only have their selection smart callbacks called
7828 * when firstly getting selected. Any further clicks will do
7829 * nothing, unless you enable the "always select mode", with
7830 * elm_gengrid_always_select_mode_set(), thus making every click to
7831 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7832 * turn off the ability to select items entirely in the widget and
7833 * they will neither appear selected nor call the selection smart
7836 * Remember that you can create new styles and add your own theme
7837 * augmentation per application with elm_theme_extension_add(). If
7838 * you absolutely must have a specific style that overrides any
7839 * theme the user or system sets up you can use
7840 * elm_theme_overlay_add() to add such a file.
7842 * @section Gengrid_Smart_Events Gengrid smart events
7844 * Smart events that you can add callbacks for are:
7845 * - @c "activated" - The user has double-clicked or pressed
7846 * (enter|return|spacebar) on an item. The @c event_info parameter
7847 * is the gengrid item that was activated.
7848 * - @c "clicked,double" - The user has double-clicked an item.
7849 * The @c event_info parameter is the gengrid item that was double-clicked.
7850 * - @c "longpressed" - This is called when the item is pressed for a certain
7851 * amount of time. By default it's 1 second.
7852 * - @c "selected" - The user has made an item selected. The
7853 * @c event_info parameter is the gengrid item that was selected.
7854 * - @c "unselected" - The user has made an item unselected. The
7855 * @c event_info parameter is the gengrid item that was unselected.
7856 * - @c "realized" - This is called when the item in the gengrid
7857 * has its implementing Evas object instantiated, de facto. @c
7858 * event_info is the gengrid item that was created. The object
7859 * may be deleted at any time, so it is highly advised to the
7860 * caller @b not to use the object pointer returned from
7861 * elm_gengrid_item_object_get(), because it may point to freed
7863 * - @c "unrealized" - This is called when the implementing Evas
7864 * object for this item is deleted. @c event_info is the gengrid
7865 * item that was deleted.
7866 * - @c "changed" - Called when an item is added, removed, resized
7867 * or moved and when the gengrid is resized or gets "horizontal"
7869 * - @c "scroll,anim,start" - This is called when scrolling animation has
7871 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7873 * - @c "drag,start,up" - Called when the item in the gengrid has
7874 * been dragged (not scrolled) up.
7875 * - @c "drag,start,down" - Called when the item in the gengrid has
7876 * been dragged (not scrolled) down.
7877 * - @c "drag,start,left" - Called when the item in the gengrid has
7878 * been dragged (not scrolled) left.
7879 * - @c "drag,start,right" - Called when the item in the gengrid has
7880 * been dragged (not scrolled) right.
7881 * - @c "drag,stop" - Called when the item in the gengrid has
7882 * stopped being dragged.
7883 * - @c "drag" - Called when the item in the gengrid is being
7885 * - @c "scroll" - called when the content has been scrolled
7887 * - @c "scroll,drag,start" - called when dragging the content has
7889 * - @c "scroll,drag,stop" - called when dragging the content has
7892 * List of gengrid examples:
7893 * @li @ref gengrid_example
7897 * @addtogroup Gengrid
7901 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7902 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7903 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7904 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7905 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. */
7906 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. */
7907 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7909 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7910 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7911 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7912 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7915 * @struct _Elm_Gengrid_Item_Class
7917 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7920 struct _Elm_Gengrid_Item_Class
7922 const char *item_style;
7923 struct _Elm_Gengrid_Item_Class_Func
7925 Elm_Gengrid_Item_Label_Get_Cb label_get;
7926 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7927 Elm_Gengrid_Item_State_Get_Cb state_get;
7928 Elm_Gengrid_Item_Del_Cb del;
7930 }; /**< #Elm_Gengrid_Item_Class member definitions */
7933 * Add a new gengrid widget to the given parent Elementary
7934 * (container) object
7936 * @param parent The parent object
7937 * @return a new gengrid widget handle or @c NULL, on errors
7939 * This function inserts a new gengrid widget on the canvas.
7941 * @see elm_gengrid_item_size_set()
7942 * @see elm_gengrid_group_item_size_set()
7943 * @see elm_gengrid_horizontal_set()
7944 * @see elm_gengrid_item_append()
7945 * @see elm_gengrid_item_del()
7946 * @see elm_gengrid_clear()
7950 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7953 * Set the size for the items of a given gengrid widget
7955 * @param obj The gengrid object.
7956 * @param w The items' width.
7957 * @param h The items' height;
7959 * A gengrid, after creation, has still no information on the size
7960 * to give to each of its cells. So, you most probably will end up
7961 * with squares one @ref Fingers "finger" wide, the default
7962 * size. Use this function to force a custom size for you items,
7963 * making them as big as you wish.
7965 * @see elm_gengrid_item_size_get()
7969 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7972 * Get the size set for the items of a given gengrid widget
7974 * @param obj The gengrid object.
7975 * @param w Pointer to a variable where to store the items' width.
7976 * @param h Pointer to a variable where to store the items' height.
7978 * @note Use @c NULL pointers on the size values you're not
7979 * interested in: they'll be ignored by the function.
7981 * @see elm_gengrid_item_size_get() for more details
7985 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7988 * Set the size for the group items of a given gengrid widget
7990 * @param obj The gengrid object.
7991 * @param w The group items' width.
7992 * @param h The group 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 group items,
7998 * making them as big as you wish.
8000 * @see elm_gengrid_group_item_size_get()
8004 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8007 * Get the size set for the group items of a given gengrid widget
8009 * @param obj The gengrid object.
8010 * @param w Pointer to a variable where to store the group items' width.
8011 * @param h Pointer to a variable where to store the group 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_group_item_size_get() for more details
8020 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8023 * Set the items grid's alignment within a given gengrid widget
8025 * @param obj The gengrid object.
8026 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8027 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8029 * This sets the alignment of the whole grid of items of a gengrid
8030 * within its given viewport. By default, those values are both
8031 * 0.5, meaning that the gengrid will have its items grid placed
8032 * exactly in the middle of its viewport.
8034 * @note If given alignment values are out of the cited ranges,
8035 * they'll be changed to the nearest boundary values on the valid
8038 * @see elm_gengrid_align_get()
8042 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8045 * Get the items grid's alignment values within a given gengrid
8048 * @param obj The gengrid object.
8049 * @param align_x Pointer to a variable where to store the
8050 * horizontal alignment.
8051 * @param align_y Pointer to a variable where to store the vertical
8054 * @note Use @c NULL pointers on the alignment values you're not
8055 * interested in: they'll be ignored by the function.
8057 * @see elm_gengrid_align_set() for more details
8061 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8064 * Set whether a given gengrid widget is or not able have items
8067 * @param obj The gengrid object
8068 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8069 * @c EINA_FALSE to turn it off
8071 * If a gengrid is set to allow reordering, a click held for more
8072 * than 0.5 over a given item will highlight it specially,
8073 * signalling the gengrid has entered the reordering state. From
8074 * that time on, the user will be able to, while still holding the
8075 * mouse button down, move the item freely in the gengrid's
8076 * viewport, replacing to said item to the locations it goes to.
8077 * The replacements will be animated and, whenever the user
8078 * releases the mouse button, the item being replaced gets a new
8079 * definitive place in the grid.
8081 * @see elm_gengrid_reorder_mode_get()
8085 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8088 * Get whether a given gengrid widget is or not able have items
8091 * @param obj The gengrid object
8092 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8095 * @see elm_gengrid_reorder_mode_set() for more details
8099 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8102 * Append a new item in a given gengrid widget.
8104 * @param obj The gengrid object.
8105 * @param gic The item class for the item.
8106 * @param data The item data.
8107 * @param func Convenience function called when the item is
8109 * @param func_data Data to be passed to @p func.
8110 * @return A handle to the item added or @c NULL, on errors.
8112 * This adds an item to the beginning of the gengrid.
8114 * @see elm_gengrid_item_prepend()
8115 * @see elm_gengrid_item_insert_before()
8116 * @see elm_gengrid_item_insert_after()
8117 * @see elm_gengrid_item_del()
8121 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);
8124 * Prepend a new item in a given gengrid widget.
8126 * @param obj The gengrid object.
8127 * @param gic The item class for the item.
8128 * @param data The item data.
8129 * @param func Convenience function called when the item is
8131 * @param func_data Data to be passed to @p func.
8132 * @return A handle to the item added or @c NULL, on errors.
8134 * This adds an item to the end of the gengrid.
8136 * @see elm_gengrid_item_append()
8137 * @see elm_gengrid_item_insert_before()
8138 * @see elm_gengrid_item_insert_after()
8139 * @see elm_gengrid_item_del()
8143 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);
8146 * Insert an item before another in a gengrid widget
8148 * @param obj The gengrid object.
8149 * @param gic The item class for the item.
8150 * @param data The item data.
8151 * @param relative The item to place this new one before.
8152 * @param func Convenience function called when the item is
8154 * @param func_data Data to be passed to @p func.
8155 * @return A handle to the item added or @c NULL, on errors.
8157 * This inserts an item before another in the gengrid.
8159 * @see elm_gengrid_item_append()
8160 * @see elm_gengrid_item_prepend()
8161 * @see elm_gengrid_item_insert_after()
8162 * @see elm_gengrid_item_del()
8166 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);
8169 * Insert an item after another in a gengrid widget
8171 * @param obj The gengrid object.
8172 * @param gic The item class for the item.
8173 * @param data The item data.
8174 * @param relative The item to place this new one after.
8175 * @param func Convenience function called when the item is
8177 * @param func_data Data to be passed to @p func.
8178 * @return A handle to the item added or @c NULL, on errors.
8180 * This inserts an item after another in the gengrid.
8182 * @see elm_gengrid_item_append()
8183 * @see elm_gengrid_item_prepend()
8184 * @see elm_gengrid_item_insert_after()
8185 * @see elm_gengrid_item_del()
8189 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);
8191 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);
8193 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);
8196 * Set whether items on a given gengrid widget are to get their
8197 * selection callbacks issued for @b every subsequent selection
8198 * click on them or just for the first click.
8200 * @param obj The gengrid object
8201 * @param always_select @c EINA_TRUE to make items "always
8202 * selected", @c EINA_FALSE, otherwise
8204 * By default, grid items will only call their selection callback
8205 * function when firstly getting selected, any subsequent further
8206 * clicks will do nothing. With this call, you make those
8207 * subsequent clicks also to issue the selection callbacks.
8209 * @note <b>Double clicks</b> will @b always be reported on items.
8211 * @see elm_gengrid_always_select_mode_get()
8215 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8218 * Get whether items on a given gengrid widget have their selection
8219 * callbacks issued for @b every subsequent selection click on them
8220 * or just for the first click.
8222 * @param obj The gengrid object.
8223 * @return @c EINA_TRUE if the gengrid items are "always selected",
8224 * @c EINA_FALSE, otherwise
8226 * @see elm_gengrid_always_select_mode_set() for more details
8230 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8233 * Set whether items on a given gengrid widget can be selected or not.
8235 * @param obj The gengrid object
8236 * @param no_select @c EINA_TRUE to make items selectable,
8237 * @c EINA_FALSE otherwise
8239 * This will make items in @p obj selectable or not. In the latter
8240 * case, any user interaction on the gengrid items will neither make
8241 * them appear selected nor them call their selection callback
8244 * @see elm_gengrid_no_select_mode_get()
8248 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8251 * Get whether items on a given gengrid widget can be selected or
8254 * @param obj The gengrid object
8255 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8258 * @see elm_gengrid_no_select_mode_set() for more details
8262 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8265 * Enable or disable multi-selection in a given gengrid widget
8267 * @param obj The gengrid object.
8268 * @param multi @c EINA_TRUE, to enable multi-selection,
8269 * @c EINA_FALSE to disable it.
8271 * Multi-selection is the ability for one to have @b more than one
8272 * item selected, on a given gengrid, simultaneously. When it is
8273 * enabled, a sequence of clicks on different items will make them
8274 * all selected, progressively. A click on an already selected item
8275 * will unselect it. If interecting via the keyboard,
8276 * multi-selection is enabled while holding the "Shift" key.
8278 * @note By default, multi-selection is @b disabled on gengrids
8280 * @see elm_gengrid_multi_select_get()
8284 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8287 * Get whether multi-selection is enabled or disabled for a given
8290 * @param obj The gengrid object.
8291 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8292 * EINA_FALSE otherwise
8294 * @see elm_gengrid_multi_select_set() for more details
8298 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8301 * Enable or disable bouncing effect for a given gengrid widget
8303 * @param obj The gengrid object
8304 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8305 * @c EINA_FALSE to disable it
8306 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8307 * @c EINA_FALSE to disable it
8309 * The bouncing effect occurs whenever one reaches the gengrid's
8310 * edge's while panning it -- it will scroll past its limits a
8311 * little bit and return to the edge again, in a animated for,
8314 * @note By default, gengrids have bouncing enabled on both axis
8316 * @see elm_gengrid_bounce_get()
8320 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8323 * Get whether bouncing effects are enabled or disabled, for a
8324 * given gengrid widget, on each axis
8326 * @param obj The gengrid object
8327 * @param h_bounce Pointer to a variable where to store the
8328 * horizontal bouncing flag.
8329 * @param v_bounce Pointer to a variable where to store the
8330 * vertical bouncing flag.
8332 * @see elm_gengrid_bounce_set() for more details
8336 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8339 * Set a given gengrid widget's scrolling page size, relative to
8340 * its viewport size.
8342 * @param obj The gengrid object
8343 * @param h_pagerel The horizontal page (relative) size
8344 * @param v_pagerel The vertical page (relative) size
8346 * The gengrid's scroller is capable of binding scrolling by the
8347 * user to "pages". It means that, while scrolling and, specially
8348 * after releasing the mouse button, the grid will @b snap to the
8349 * nearest displaying page's area. When page sizes are set, the
8350 * grid's continuous content area is split into (equal) page sized
8353 * This function sets the size of a page <b>relatively to the
8354 * viewport dimensions</b> of the gengrid, for each axis. A value
8355 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8356 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8357 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8358 * 1.0. Values beyond those will make it behave behave
8359 * inconsistently. If you only want one axis to snap to pages, use
8360 * the value @c 0.0 for the other one.
8362 * There is a function setting page size values in @b absolute
8363 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8364 * is mutually exclusive to this one.
8366 * @see elm_gengrid_page_relative_get()
8370 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8373 * Get a given gengrid widget's scrolling page size, relative to
8374 * its viewport size.
8376 * @param obj The gengrid object
8377 * @param h_pagerel Pointer to a variable where to store the
8378 * horizontal page (relative) size
8379 * @param v_pagerel Pointer to a variable where to store the
8380 * vertical page (relative) size
8382 * @see elm_gengrid_page_relative_set() for more details
8386 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8389 * Set a given gengrid widget's scrolling page size
8391 * @param obj The gengrid object
8392 * @param h_pagerel The horizontal page size, in pixels
8393 * @param v_pagerel The vertical page size, in pixels
8395 * The gengrid's scroller is capable of binding scrolling by the
8396 * user to "pages". It means that, while scrolling and, specially
8397 * after releasing the mouse button, the grid will @b snap to the
8398 * nearest displaying page's area. When page sizes are set, the
8399 * grid's continuous content area is split into (equal) page sized
8402 * This function sets the size of a page of the gengrid, in pixels,
8403 * for each axis. Sane usable values are, between @c 0 and the
8404 * dimensions of @p obj, for each axis. Values beyond those will
8405 * make it behave behave inconsistently. If you only want one axis
8406 * to snap to pages, use the value @c 0 for the other one.
8408 * There is a function setting page size values in @b relative
8409 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8410 * use is mutually exclusive to this one.
8414 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8417 * @brief Get gengrid current page number.
8419 * @param obj The gengrid object
8420 * @param h_pagenumber The horizontal page number
8421 * @param v_pagenumber The vertical page number
8423 * The page number starts from 0. 0 is the first page.
8424 * Current page means the page which meet the top-left of the viewport.
8425 * If there are two or more pages in the viewport, it returns the number of page
8426 * which meet the top-left of the viewport.
8428 * @see elm_gengrid_last_page_get()
8429 * @see elm_gengrid_page_show()
8430 * @see elm_gengrid_page_brint_in()
8432 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8435 * @brief Get scroll last page number.
8437 * @param obj The gengrid object
8438 * @param h_pagenumber The horizoptal page number
8439 * @param v_pagenumber The vertical page number
8441 * The page number starts from 0. 0 is the first page.
8442 * This returns the last page number among the pages.
8444 * @see elm_gengrid_current_page_get()
8445 * @see elm_gengrid_page_show()
8446 * @see elm_gengrid_page_brint_in()
8448 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8451 * Show a specific virtual region within the gengrid content object by page number.
8453 * @param obj The gengrid object
8454 * @param h_pagenumber The horizoptal page number
8455 * @param v_pagenumber The vertical page number
8457 * 0, 0 of the indicated page is located at the top-left of the viewport.
8458 * This will jump to the page directly without animation.
8463 * sc = elm_gengrid_add(win);
8464 * elm_gengrid_content_set(sc, content);
8465 * elm_gengrid_page_relative_set(sc, 1, 0);
8466 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8467 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8470 * @see elm_gengrid_page_bring_in()
8472 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8475 * Show a specific virtual region within the gengrid content object by page number.
8477 * @param obj The gengrid object
8478 * @param h_pagenumber The horizoptal page number
8479 * @param v_pagenumber The vertical page number
8481 * 0, 0 of the indicated page is located at the top-left of the viewport.
8482 * This will slide to the page with animation.
8487 * sc = elm_gengrid_add(win);
8488 * elm_gengrid_content_set(sc, content);
8489 * elm_gengrid_page_relative_set(sc, 1, 0);
8490 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8491 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8494 * @see elm_gengrid_page_show()
8496 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8499 * Set for what direction a given gengrid widget will expand while
8500 * placing its items.
8502 * @param obj The gengrid object.
8503 * @param setting @c EINA_TRUE to make the gengrid expand
8504 * horizontally, @c EINA_FALSE to expand vertically.
8506 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8507 * in @b columns, from top to bottom and, when the space for a
8508 * column is filled, another one is started on the right, thus
8509 * expanding the grid horizontally. When in "vertical mode"
8510 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8511 * to right and, when the space for a row is filled, another one is
8512 * started below, thus expanding the grid vertically.
8514 * @see elm_gengrid_horizontal_get()
8518 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8521 * Get for what direction a given gengrid widget will expand while
8522 * placing its items.
8524 * @param obj The gengrid object.
8525 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8526 * @c EINA_FALSE if it's set to expand vertically.
8528 * @see elm_gengrid_horizontal_set() for more detais
8532 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8535 * Get the first item in a given gengrid widget
8537 * @param obj The gengrid object
8538 * @return The first item's handle or @c NULL, if there are no
8539 * items in @p obj (and on errors)
8541 * This returns the first item in the @p obj's internal list of
8544 * @see elm_gengrid_last_item_get()
8548 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8551 * Get the last item in a given gengrid widget
8553 * @param obj The gengrid object
8554 * @return The last item's handle or @c NULL, if there are no
8555 * items in @p obj (and on errors)
8557 * This returns the last item in the @p obj's internal list of
8560 * @see elm_gengrid_first_item_get()
8564 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8567 * Get the @b next item in a gengrid widget's internal list of items,
8568 * given a handle to one of those items.
8570 * @param item The gengrid item to fetch next from
8571 * @return The item after @p item, or @c NULL if there's none (and
8574 * This returns the item placed after the @p item, on the container
8577 * @see elm_gengrid_item_prev_get()
8581 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8584 * Get the @b previous item in a gengrid widget's internal list of items,
8585 * given a handle to one of those items.
8587 * @param item The gengrid item to fetch previous from
8588 * @return The item before @p item, or @c NULL if there's none (and
8591 * This returns the item placed before the @p item, on the container
8594 * @see elm_gengrid_item_next_get()
8598 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8601 * Get the gengrid object's handle which contains a given gengrid
8604 * @param item The item to fetch the container from
8605 * @return The gengrid (parent) object
8607 * This returns the gengrid object itself that an item belongs to.
8611 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8614 * Remove a gengrid item from the its parent, deleting it.
8616 * @param item The item to be removed.
8617 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8619 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8624 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8627 * Update the contents of a given gengrid item
8629 * @param item The gengrid item
8631 * This updates an item by calling all the item class functions
8632 * again to get the icons, labels and states. Use this when the
8633 * original item data has changed and you want thta changes to be
8638 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8639 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8640 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8643 * Return the data associated to a given gengrid item
8645 * @param item The gengrid item.
8646 * @return the data associated to this item.
8648 * This returns the @c data value passed on the
8649 * elm_gengrid_item_append() and related item addition calls.
8651 * @see elm_gengrid_item_append()
8652 * @see elm_gengrid_item_data_set()
8656 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8659 * Set the data associated to a given gengrid item
8661 * @param item The gengrid item
8662 * @param data The new data pointer to set on it
8664 * This @b overrides the @c data value passed on the
8665 * elm_gengrid_item_append() and related item addition calls. This
8666 * function @b won't call elm_gengrid_item_update() automatically,
8667 * so you'd issue it afterwards if you want to hove the item
8668 * updated to reflect the that new data.
8670 * @see elm_gengrid_item_data_get()
8674 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8677 * Get a given gengrid item's position, relative to the whole
8678 * gengrid's grid area.
8680 * @param item The Gengrid item.
8681 * @param x Pointer to variable where to store the item's <b>row
8683 * @param y Pointer to variable where to store the item's <b>column
8686 * This returns the "logical" position of the item whithin the
8687 * gengrid. For example, @c (0, 1) would stand for first row,
8692 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8695 * Set whether a given gengrid item is selected or not
8697 * @param item The gengrid item
8698 * @param selected Use @c EINA_TRUE, to make it selected, @c
8699 * EINA_FALSE to make it unselected
8701 * This sets the selected state of an item. If multi selection is
8702 * not enabled on the containing gengrid and @p selected is @c
8703 * EINA_TRUE, any other previously selected items will get
8704 * unselected in favor of this new one.
8706 * @see elm_gengrid_item_selected_get()
8710 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8713 * Get whether a given gengrid item is selected or not
8715 * @param item The gengrid item
8716 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8718 * @see elm_gengrid_item_selected_set() for more details
8722 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8725 * Get the real Evas object created to implement the view of a
8726 * given gengrid item
8728 * @param item The gengrid item.
8729 * @return the Evas object implementing this item's view.
8731 * This returns the actual Evas object used to implement the
8732 * specified gengrid item's view. This may be @c NULL, as it may
8733 * not have been created or may have been deleted, at any time, by
8734 * the gengrid. <b>Do not modify this object</b> (move, resize,
8735 * show, hide, etc.), as the gengrid is controlling it. This
8736 * function is for querying, emitting custom signals or hooking
8737 * lower level callbacks for events on that object. Do not delete
8738 * this object under any circumstances.
8740 * @see elm_gengrid_item_data_get()
8744 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8747 * Show the portion of a gengrid's internal grid containing a given
8748 * item, @b immediately.
8750 * @param item The item to display
8752 * This causes gengrid to @b redraw its viewport's contents to the
8753 * region contining the given @p item item, if it is not fully
8756 * @see elm_gengrid_item_bring_in()
8760 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8763 * Animatedly bring in, to the visible are of a gengrid, a given
8766 * @param item The gengrid item to display
8768 * This causes gengrig to jump to the given @p item item and show
8769 * it (by scrolling), if it is not fully visible. This will use
8770 * animation to do so and take a period of time to complete.
8772 * @see elm_gengrid_item_show()
8776 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8779 * Set whether a given gengrid item is disabled or not.
8781 * @param item The gengrid item
8782 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8783 * to enable it back.
8785 * A disabled item cannot be selected or unselected. It will also
8786 * change its appearance, to signal the user it's disabled.
8788 * @see elm_gengrid_item_disabled_get()
8792 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8795 * Get whether a given gengrid item is disabled or not.
8797 * @param item The gengrid item
8798 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8801 * @see elm_gengrid_item_disabled_set() for more details
8805 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8808 * Set the text to be shown in a given gengrid item's tooltips.
8810 * @param item The gengrid item
8811 * @param text The text to set in the content
8813 * This call will setup the text to be used as tooltip to that item
8814 * (analogous to elm_object_tooltip_text_set(), but being item
8815 * tooltips with higher precedence than object tooltips). It can
8816 * have only one tooltip at a time, so any previous tooltip data
8821 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8824 * Set the content to be shown in a given gengrid item's tooltips
8826 * @param item The gengrid item.
8827 * @param func The function returning the tooltip contents.
8828 * @param data What to provide to @a func as callback data/context.
8829 * @param del_cb Called when data is not needed anymore, either when
8830 * another callback replaces @p func, the tooltip is unset with
8831 * elm_gengrid_item_tooltip_unset() or the owner @p item
8832 * dies. This callback receives as its first parameter the
8833 * given @p data, being @c event_info the item handle.
8835 * This call will setup the tooltip's contents to @p item
8836 * (analogous to elm_object_tooltip_content_cb_set(), but being
8837 * item tooltips with higher precedence than object tooltips). It
8838 * can have only one tooltip at a time, so any previous tooltip
8839 * content will get removed. @p func (with @p data) will be called
8840 * every time Elementary needs to show the tooltip and it should
8841 * return a valid Evas object, which will be fully managed by the
8842 * tooltip system, getting deleted when the tooltip is gone.
8846 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);
8849 * Unset a tooltip from a given gengrid item
8851 * @param item gengrid item to remove a previously set tooltip from.
8853 * This call removes any tooltip set on @p item. The callback
8854 * provided as @c del_cb to
8855 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8856 * notify it is not used anymore (and have resources cleaned, if
8859 * @see elm_gengrid_item_tooltip_content_cb_set()
8863 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8866 * Set a different @b style for a given gengrid item's tooltip.
8868 * @param item gengrid item with tooltip set
8869 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8870 * "default", @c "transparent", etc)
8872 * Tooltips can have <b>alternate styles</b> to be displayed on,
8873 * which are defined by the theme set on Elementary. This function
8874 * works analogously as elm_object_tooltip_style_set(), but here
8875 * applied only to gengrid item objects. The default style for
8876 * tooltips is @c "default".
8878 * @note before you set a style you should define a tooltip with
8879 * elm_gengrid_item_tooltip_content_cb_set() or
8880 * elm_gengrid_item_tooltip_text_set()
8882 * @see elm_gengrid_item_tooltip_style_get()
8886 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8889 * Get the style set a given gengrid item's tooltip.
8891 * @param item gengrid item with tooltip already set on.
8892 * @return style the theme style in use, which defaults to
8893 * "default". If the object does not have a tooltip set,
8894 * then @c NULL is returned.
8896 * @see elm_gengrid_item_tooltip_style_set() for more details
8900 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8902 * @brief Disable size restrictions on an object's tooltip
8903 * @param item The tooltip's anchor object
8904 * @param disable If EINA_TRUE, size restrictions are disabled
8905 * @return EINA_FALSE on failure, EINA_TRUE on success
8907 * This function allows a tooltip to expand beyond its parant window's canvas.
8908 * It will instead be limited only by the size of the display.
8910 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8912 * @brief Retrieve size restriction state of an object's tooltip
8913 * @param item The tooltip's anchor object
8914 * @return If EINA_TRUE, size restrictions are disabled
8916 * This function returns whether a tooltip is allowed to expand beyond
8917 * its parant window's canvas.
8918 * It will instead be limited only by the size of the display.
8920 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8922 * Set the type of mouse pointer/cursor decoration to be shown,
8923 * when the mouse pointer is over the given gengrid widget item
8925 * @param item gengrid item to customize cursor on
8926 * @param cursor the cursor type's name
8928 * This function works analogously as elm_object_cursor_set(), but
8929 * here the cursor's changing area is restricted to the item's
8930 * area, and not the whole widget's. Note that that item cursors
8931 * have precedence over widget cursors, so that a mouse over @p
8932 * item will always show cursor @p type.
8934 * If this function is called twice for an object, a previously set
8935 * cursor will be unset on the second call.
8937 * @see elm_object_cursor_set()
8938 * @see elm_gengrid_item_cursor_get()
8939 * @see elm_gengrid_item_cursor_unset()
8943 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8946 * Get the type of mouse pointer/cursor decoration set to be shown,
8947 * when the mouse pointer is over the given gengrid widget item
8949 * @param item gengrid item with custom cursor set
8950 * @return the cursor type's name or @c NULL, if no custom cursors
8951 * were set to @p item (and on errors)
8953 * @see elm_object_cursor_get()
8954 * @see elm_gengrid_item_cursor_set() for more details
8955 * @see elm_gengrid_item_cursor_unset()
8959 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8962 * Unset any custom mouse pointer/cursor decoration set to be
8963 * shown, when the mouse pointer is over the given gengrid widget
8964 * item, thus making it show the @b default cursor again.
8966 * @param item a gengrid item
8968 * Use this call to undo any custom settings on this item's cursor
8969 * decoration, bringing it back to defaults (no custom style set).
8971 * @see elm_object_cursor_unset()
8972 * @see elm_gengrid_item_cursor_set() for more details
8976 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8979 * Set a different @b style for a given custom cursor set for a
8982 * @param item gengrid item with custom cursor set
8983 * @param style the <b>theme style</b> to use (e.g. @c "default",
8984 * @c "transparent", etc)
8986 * This function only makes sense when one is using custom mouse
8987 * cursor decorations <b>defined in a theme file</b> , which can
8988 * have, given a cursor name/type, <b>alternate styles</b> on
8989 * it. It works analogously as elm_object_cursor_style_set(), but
8990 * here applied only to gengrid item objects.
8992 * @warning Before you set a cursor style you should have defined a
8993 * custom cursor previously on the item, with
8994 * elm_gengrid_item_cursor_set()
8996 * @see elm_gengrid_item_cursor_engine_only_set()
8997 * @see elm_gengrid_item_cursor_style_get()
9001 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9004 * Get the current @b style set for a given gengrid item's custom
9007 * @param item gengrid item with custom cursor set.
9008 * @return style the cursor style in use. If the object does not
9009 * have a cursor set, then @c NULL is returned.
9011 * @see elm_gengrid_item_cursor_style_set() for more details
9015 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9018 * Set if the (custom) cursor for a given gengrid item should be
9019 * searched in its theme, also, or should only rely on the
9022 * @param item item with custom (custom) cursor already set on
9023 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9024 * only on those provided by the rendering engine, @c EINA_FALSE to
9025 * have them searched on the widget's theme, as well.
9027 * @note This call is of use only if you've set a custom cursor
9028 * for gengrid items, with elm_gengrid_item_cursor_set().
9030 * @note By default, cursors will only be looked for between those
9031 * provided by the rendering engine.
9035 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9038 * Get if the (custom) cursor for a given gengrid item is being
9039 * searched in its theme, also, or is only relying on the rendering
9042 * @param item a gengrid item
9043 * @return @c EINA_TRUE, if cursors are being looked for only on
9044 * those provided by the rendering engine, @c EINA_FALSE if they
9045 * are being searched on the widget's theme, as well.
9047 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9051 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9054 * Remove all items from a given gengrid widget
9056 * @param obj The gengrid object.
9058 * This removes (and deletes) all items in @p obj, leaving it
9061 * @see elm_gengrid_item_del(), to remove just one item.
9065 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9068 * Get the selected item in a given gengrid widget
9070 * @param obj The gengrid object.
9071 * @return The selected item's handleor @c NULL, if none is
9072 * selected at the moment (and on errors)
9074 * This returns the selected item in @p obj. If multi selection is
9075 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9076 * the first item in the list is selected, which might not be very
9077 * useful. For that case, see elm_gengrid_selected_items_get().
9081 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9084 * Get <b>a list</b> of selected items in a given gengrid
9086 * @param obj The gengrid object.
9087 * @return The list of selected items or @c NULL, if none is
9088 * selected at the moment (and on errors)
9090 * This returns a list of the selected items, in the order that
9091 * they appear in the grid. This list is only valid as long as no
9092 * more items are selected or unselected (or unselected implictly
9093 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9096 * @see elm_gengrid_selected_item_get()
9100 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9107 * @defgroup Clock Clock
9109 * @image html img/widget/clock/preview-00.png
9110 * @image latex img/widget/clock/preview-00.eps
9112 * This is a @b digital clock widget. In its default theme, it has a
9113 * vintage "flipping numbers clock" appearance, which will animate
9114 * sheets of individual algarisms individually as time goes by.
9116 * A newly created clock will fetch system's time (already
9117 * considering local time adjustments) to start with, and will tick
9118 * accondingly. It may or may not show seconds.
9120 * Clocks have an @b edition mode. When in it, the sheets will
9121 * display extra arrow indications on the top and bottom and the
9122 * user may click on them to raise or lower the time values. After
9123 * it's told to exit edition mode, it will keep ticking with that
9124 * new time set (it keeps the difference from local time).
9126 * Also, when under edition mode, user clicks on the cited arrows
9127 * which are @b held for some time will make the clock to flip the
9128 * sheet, thus editing the time, continuosly and automatically for
9129 * the user. The interval between sheet flips will keep growing in
9130 * time, so that it helps the user to reach a time which is distant
9133 * The time display is, by default, in military mode (24h), but an
9134 * am/pm indicator may be optionally shown, too, when it will
9137 * Smart callbacks one can register to:
9138 * - "changed" - the clock's user changed the time
9140 * Here is an example on its usage:
9141 * @li @ref clock_example
9150 * Identifiers for which clock digits should be editable, when a
9151 * clock widget is in edition mode. Values may be ORed together to
9152 * make a mask, naturally.
9154 * @see elm_clock_edit_set()
9155 * @see elm_clock_digit_edit_set()
9157 typedef enum _Elm_Clock_Digedit
9159 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9160 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9161 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9162 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9163 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9164 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9165 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9166 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9167 } Elm_Clock_Digedit;
9170 * Add a new clock widget to the given parent Elementary
9171 * (container) object
9173 * @param parent The parent object
9174 * @return a new clock widget handle or @c NULL, on errors
9176 * This function inserts a new clock widget on the canvas.
9180 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9183 * Set a clock widget's time, programmatically
9185 * @param obj The clock widget object
9186 * @param hrs The hours to set
9187 * @param min The minutes to set
9188 * @param sec The secondes to set
9190 * This function updates the time that is showed by the clock
9193 * Values @b must be set within the following ranges:
9194 * - 0 - 23, for hours
9195 * - 0 - 59, for minutes
9196 * - 0 - 59, for seconds,
9198 * even if the clock is not in "military" mode.
9200 * @warning The behavior for values set out of those ranges is @b
9205 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9208 * Get a clock widget's time values
9210 * @param obj The clock object
9211 * @param[out] hrs Pointer to the variable to get the hours value
9212 * @param[out] min Pointer to the variable to get the minutes value
9213 * @param[out] sec Pointer to the variable to get the seconds value
9215 * This function gets the time set for @p obj, returning
9216 * it on the variables passed as the arguments to function
9218 * @note Use @c NULL pointers on the time values you're not
9219 * interested in: they'll be ignored by the function.
9223 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9226 * Set whether a given clock widget is under <b>edition mode</b> or
9227 * under (default) displaying-only mode.
9229 * @param obj The clock object
9230 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9231 * put it back to "displaying only" mode
9233 * This function makes a clock's time to be editable or not <b>by
9234 * user interaction</b>. When in edition mode, clocks @b stop
9235 * ticking, until one brings them back to canonical mode. The
9236 * elm_clock_digit_edit_set() function will influence which digits
9237 * of the clock will be editable. By default, all of them will be
9238 * (#ELM_CLOCK_NONE).
9240 * @note am/pm sheets, if being shown, will @b always be editable
9241 * under edition mode.
9243 * @see elm_clock_edit_get()
9247 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9250 * Retrieve whether a given clock widget is under <b>edition
9251 * mode</b> or under (default) displaying-only mode.
9253 * @param obj The clock object
9254 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9257 * This function retrieves whether the clock's time can be edited
9258 * or not by user interaction.
9260 * @see elm_clock_edit_set() for more details
9264 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9267 * Set what digits of the given clock widget should be editable
9268 * when in edition mode.
9270 * @param obj The clock object
9271 * @param digedit Bit mask indicating the digits to be editable
9272 * (values in #Elm_Clock_Digedit).
9274 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9275 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9278 * @see elm_clock_digit_edit_get()
9282 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9285 * Retrieve what digits of the given clock widget should be
9286 * editable when in edition mode.
9288 * @param obj The clock object
9289 * @return Bit mask indicating the digits to be editable
9290 * (values in #Elm_Clock_Digedit).
9292 * @see elm_clock_digit_edit_set() for more details
9296 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9299 * Set if the given clock widget must show hours in military or
9302 * @param obj The clock object
9303 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9306 * This function sets if the clock must show hours in military or
9307 * am/pm mode. In some countries like Brazil the military mode
9308 * (00-24h-format) is used, in opposition to the USA, where the
9309 * am/pm mode is more commonly used.
9311 * @see elm_clock_show_am_pm_get()
9315 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9318 * Get if the given clock widget shows hours in military or am/pm
9321 * @param obj The clock object
9322 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9325 * This function gets if the clock shows hours in military or am/pm
9328 * @see elm_clock_show_am_pm_set() for more details
9332 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9335 * Set if the given clock widget must show time with seconds or not
9337 * @param obj The clock object
9338 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9340 * This function sets if the given clock must show or not elapsed
9341 * seconds. By default, they are @b not shown.
9343 * @see elm_clock_show_seconds_get()
9347 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9350 * Get whether the given clock widget is showing time with seconds
9353 * @param obj The clock object
9354 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9356 * This function gets whether @p obj is showing or not the elapsed
9359 * @see elm_clock_show_seconds_set()
9363 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9366 * Set the interval on time updates for an user mouse button hold
9367 * on clock widgets' time edition.
9369 * @param obj The clock object
9370 * @param interval The (first) interval value in seconds
9372 * This interval value is @b decreased while the user holds the
9373 * mouse pointer either incrementing or decrementing a given the
9374 * clock digit's value.
9376 * This helps the user to get to a given time distant from the
9377 * current one easier/faster, as it will start to flip quicker and
9378 * quicker on mouse button holds.
9380 * The calculation for the next flip interval value, starting from
9381 * the one set with this call, is the previous interval divided by
9382 * 1.05, so it decreases a little bit.
9384 * The default starting interval value for automatic flips is
9387 * @see elm_clock_interval_get()
9391 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9394 * Get the interval on time updates for an user mouse button hold
9395 * on clock widgets' time edition.
9397 * @param obj The clock object
9398 * @return The (first) interval value, in seconds, set on it
9400 * @see elm_clock_interval_set() for more details
9404 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9411 * @defgroup Layout Layout
9413 * @image html img/widget/layout/preview-00.png
9414 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9416 * @image html img/layout-predefined.png
9417 * @image latex img/layout-predefined.eps width=\textwidth
9419 * This is a container widget that takes a standard Edje design file and
9420 * wraps it very thinly in a widget.
9422 * An Edje design (theme) file has a very wide range of possibilities to
9423 * describe the behavior of elements added to the Layout. Check out the Edje
9424 * documentation and the EDC reference to get more information about what can
9425 * be done with Edje.
9427 * Just like @ref List, @ref Box, and other container widgets, any
9428 * object added to the Layout will become its child, meaning that it will be
9429 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9431 * The Layout widget can contain as many Contents, Boxes or Tables as
9432 * described in its theme file. For instance, objects can be added to
9433 * different Tables by specifying the respective Table part names. The same
9434 * is valid for Content and Box.
9436 * The objects added as child of the Layout will behave as described in the
9437 * part description where they were added. There are 3 possible types of
9438 * parts where a child can be added:
9440 * @section secContent Content (SWALLOW part)
9442 * Only one object can be added to the @c SWALLOW part (but you still can
9443 * have many @c SWALLOW parts and one object on each of them). Use the @c
9444 * elm_layout_content_* set of functions to set, retrieve and unset objects
9445 * as content of the @c SWALLOW. After being set to this part, the object
9446 * size, position, visibility, clipping and other description properties
9447 * will be totally controled by the description of the given part (inside
9448 * the Edje theme file).
9450 * One can use @c evas_object_size_hint_* functions on the child to have some
9451 * kind of control over its behavior, but the resulting behavior will still
9452 * depend heavily on the @c SWALLOW part description.
9454 * The Edje theme also can change the part description, based on signals or
9455 * scripts running inside the theme. This change can also be animated. All of
9456 * this will affect the child object set as content accordingly. The object
9457 * size will be changed if the part size is changed, it will animate move if
9458 * the part is moving, and so on.
9460 * The following picture demonstrates a Layout widget with a child object
9461 * added to its @c SWALLOW:
9463 * @image html layout_swallow.png
9464 * @image latex layout_swallow.eps width=\textwidth
9466 * @section secBox Box (BOX part)
9468 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9469 * allows one to add objects to the box and have them distributed along its
9470 * area, accordingly to the specified @a layout property (now by @a layout we
9471 * mean the chosen layouting design of the Box, not the Layout widget
9474 * A similar effect for having a box with its position, size and other things
9475 * controled by the Layout theme would be to create an Elementary @ref Box
9476 * widget and add it as a Content in the @c SWALLOW part.
9478 * The main difference of using the Layout Box is that its behavior, the box
9479 * properties like layouting format, padding, align, etc. will be all
9480 * controled by the theme. This means, for example, that a signal could be
9481 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9482 * handled the signal by changing the box padding, or align, or both. Using
9483 * the Elementary @ref Box widget is not necessarily harder or easier, it
9484 * just depends on the circunstances and requirements.
9486 * The Layout Box can be used through the @c elm_layout_box_* set of
9489 * The following picture demonstrates a Layout widget with many child objects
9490 * added to its @c BOX part:
9492 * @image html layout_box.png
9493 * @image latex layout_box.eps width=\textwidth
9495 * @section secTable Table (TABLE part)
9497 * Just like the @ref secBox, the Layout Table is very similar to the
9498 * Elementary @ref Table widget. It allows one to add objects to the Table
9499 * specifying the row and column where the object should be added, and any
9500 * column or row span if necessary.
9502 * Again, we could have this design by adding a @ref Table widget to the @c
9503 * SWALLOW part using elm_layout_content_set(). The same difference happens
9504 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9505 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9507 * The Layout Table can be used through the @c elm_layout_table_* set of
9510 * The following picture demonstrates a Layout widget with many child objects
9511 * added to its @c TABLE part:
9513 * @image html layout_table.png
9514 * @image latex layout_table.eps width=\textwidth
9516 * @section secPredef Predefined Layouts
9518 * Another interesting thing about the Layout widget is that it offers some
9519 * predefined themes that come with the default Elementary theme. These
9520 * themes can be set by the call elm_layout_theme_set(), and provide some
9521 * basic functionality depending on the theme used.
9523 * Most of them already send some signals, some already provide a toolbar or
9524 * back and next buttons.
9526 * These are available predefined theme layouts. All of them have class = @c
9527 * layout, group = @c application, and style = one of the following options:
9529 * @li @c toolbar-content - application with toolbar and main content area
9530 * @li @c toolbar-content-back - application with toolbar and main content
9531 * area with a back button and title area
9532 * @li @c toolbar-content-back-next - application with toolbar and main
9533 * content area with a back and next buttons and title area
9534 * @li @c content-back - application with a main content area with a back
9535 * button and title area
9536 * @li @c content-back-next - application with a main content area with a
9537 * back and next buttons and title area
9538 * @li @c toolbar-vbox - application with toolbar and main content area as a
9540 * @li @c toolbar-table - application with toolbar and main content area as a
9543 * @section secExamples Examples
9545 * Some examples of the Layout widget can be found here:
9546 * @li @ref layout_example_01
9547 * @li @ref layout_example_02
9548 * @li @ref layout_example_03
9549 * @li @ref layout_example_edc
9554 * Add a new layout to the parent
9556 * @param parent The parent object
9557 * @return The new object or NULL if it cannot be created
9559 * @see elm_layout_file_set()
9560 * @see elm_layout_theme_set()
9564 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9566 * Set the file that will be used as layout
9568 * @param obj The layout object
9569 * @param file The path to file (edj) that will be used as layout
9570 * @param group The group that the layout belongs in edje file
9572 * @return (1 = success, 0 = error)
9576 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9578 * Set the edje group from the elementary theme that will be used as layout
9580 * @param obj The layout object
9581 * @param clas the clas of the group
9582 * @param group the group
9583 * @param style the style to used
9585 * @return (1 = success, 0 = error)
9589 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9591 * Set the layout content.
9593 * @param obj The layout object
9594 * @param swallow The swallow part name in the edje file
9595 * @param content The child that will be added in this layout object
9597 * Once the content object is set, a previously set one will be deleted.
9598 * If you want to keep that old content object, use the
9599 * elm_layout_content_unset() function.
9601 * @note In an Edje theme, the part used as a content container is called @c
9602 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9603 * expected to be a part name just like the second parameter of
9604 * elm_layout_box_append().
9606 * @see elm_layout_box_append()
9607 * @see elm_layout_content_get()
9608 * @see elm_layout_content_unset()
9613 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9615 * Get the child object in the given content part.
9617 * @param obj The layout object
9618 * @param swallow The SWALLOW part to get its content
9620 * @return The swallowed object or NULL if none or an error occurred
9622 * @see elm_layout_content_set()
9626 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9628 * Unset the layout content.
9630 * @param obj The layout object
9631 * @param swallow The swallow part name in the edje file
9632 * @return The content that was being used
9634 * Unparent and return the content object which was set for this part.
9636 * @see elm_layout_content_set()
9640 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9642 * Set the text of the given part
9644 * @param obj The layout object
9645 * @param part The TEXT part where to set the text
9646 * @param text The text to set
9649 * @deprecated use elm_object_text_* instead.
9651 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9653 * Get the text set in the given part
9655 * @param obj The layout object
9656 * @param part The TEXT part to retrieve the text off
9658 * @return The text set in @p part
9661 * @deprecated use elm_object_text_* instead.
9663 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9665 * Append child to layout box part.
9667 * @param obj the layout object
9668 * @param part the box part to which the object will be appended.
9669 * @param child the child object to append to box.
9671 * Once the object is appended, it will become child of the layout. Its
9672 * lifetime will be bound to the layout, whenever the layout dies the child
9673 * will be deleted automatically. One should use elm_layout_box_remove() to
9674 * make this layout forget about the object.
9676 * @see elm_layout_box_prepend()
9677 * @see elm_layout_box_insert_before()
9678 * @see elm_layout_box_insert_at()
9679 * @see elm_layout_box_remove()
9683 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9685 * Prepend child to layout box part.
9687 * @param obj the layout object
9688 * @param part the box part to prepend.
9689 * @param child the child object to prepend to box.
9691 * Once the object is prepended, it will become child of the layout. Its
9692 * lifetime will be bound to the layout, whenever the layout dies the child
9693 * will be deleted automatically. One should use elm_layout_box_remove() to
9694 * make this layout forget about the object.
9696 * @see elm_layout_box_append()
9697 * @see elm_layout_box_insert_before()
9698 * @see elm_layout_box_insert_at()
9699 * @see elm_layout_box_remove()
9703 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9705 * Insert child to layout box part before a reference object.
9707 * @param obj the layout object
9708 * @param part the box part to insert.
9709 * @param child the child object to insert into box.
9710 * @param reference another reference object to insert before in box.
9712 * Once the object is inserted, it will become child of the layout. Its
9713 * lifetime will be bound to the layout, whenever the layout dies the child
9714 * will be deleted automatically. One should use elm_layout_box_remove() to
9715 * make this layout forget about the object.
9717 * @see elm_layout_box_append()
9718 * @see elm_layout_box_prepend()
9719 * @see elm_layout_box_insert_before()
9720 * @see elm_layout_box_remove()
9724 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9726 * Insert child to layout box part at a given position.
9728 * @param obj the layout object
9729 * @param part the box part to insert.
9730 * @param child the child object to insert into box.
9731 * @param pos the numeric position >=0 to insert the child.
9733 * Once the object is inserted, it will become child of the layout. Its
9734 * lifetime will be bound to the layout, whenever the layout dies the child
9735 * will be deleted automatically. One should use elm_layout_box_remove() to
9736 * make this layout forget about the object.
9738 * @see elm_layout_box_append()
9739 * @see elm_layout_box_prepend()
9740 * @see elm_layout_box_insert_before()
9741 * @see elm_layout_box_remove()
9745 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9747 * Remove a child of the given part box.
9749 * @param obj The layout object
9750 * @param part The box part name to remove child.
9751 * @param child The object to remove from box.
9752 * @return The object that was being used, or NULL if not found.
9754 * The object will be removed from the box part and its lifetime will
9755 * not be handled by the layout anymore. This is equivalent to
9756 * elm_layout_content_unset() for box.
9758 * @see elm_layout_box_append()
9759 * @see elm_layout_box_remove_all()
9763 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9765 * Remove all child of the given part box.
9767 * @param obj The layout object
9768 * @param part The box part name to remove child.
9769 * @param clear If EINA_TRUE, then all objects will be deleted as
9770 * well, otherwise they will just be removed and will be
9771 * dangling on the canvas.
9773 * The objects will be removed from the box part and their lifetime will
9774 * not be handled by the layout anymore. This is equivalent to
9775 * elm_layout_box_remove() for all box children.
9777 * @see elm_layout_box_append()
9778 * @see elm_layout_box_remove()
9782 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9784 * Insert child to layout table part.
9786 * @param obj the layout object
9787 * @param part the box part to pack child.
9788 * @param child_obj the child object to pack into table.
9789 * @param col the column to which the child should be added. (>= 0)
9790 * @param row the row to which the child should be added. (>= 0)
9791 * @param colspan how many columns should be used to store this object. (>=
9793 * @param rowspan how many rows should be used to store this object. (>= 1)
9795 * Once the object is inserted, it will become child of the table. Its
9796 * lifetime will be bound to the layout, and whenever the layout dies the
9797 * child will be deleted automatically. One should use
9798 * elm_layout_table_remove() to make this layout forget about the object.
9800 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9801 * more space than a single cell. For instance, the following code:
9803 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9806 * Would result in an object being added like the following picture:
9808 * @image html layout_colspan.png
9809 * @image latex layout_colspan.eps width=\textwidth
9811 * @see elm_layout_table_unpack()
9812 * @see elm_layout_table_clear()
9816 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);
9818 * Unpack (remove) a child of the given part table.
9820 * @param obj The layout object
9821 * @param part The table part name to remove child.
9822 * @param child_obj The object to remove from table.
9823 * @return The object that was being used, or NULL if not found.
9825 * The object will be unpacked from the table part and its lifetime
9826 * will not be handled by the layout anymore. This is equivalent to
9827 * elm_layout_content_unset() for table.
9829 * @see elm_layout_table_pack()
9830 * @see elm_layout_table_clear()
9834 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9836 * Remove all child of the given part table.
9838 * @param obj The layout object
9839 * @param part The table part name to remove child.
9840 * @param clear If EINA_TRUE, then all objects will be deleted as
9841 * well, otherwise they will just be removed and will be
9842 * dangling on the canvas.
9844 * The objects will be removed from the table part and their lifetime will
9845 * not be handled by the layout anymore. This is equivalent to
9846 * elm_layout_table_unpack() for all table children.
9848 * @see elm_layout_table_pack()
9849 * @see elm_layout_table_unpack()
9853 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9855 * Get the edje layout
9857 * @param obj The layout object
9859 * @return A Evas_Object with the edje layout settings loaded
9860 * with function elm_layout_file_set
9862 * This returns the edje object. It is not expected to be used to then
9863 * swallow objects via edje_object_part_swallow() for example. Use
9864 * elm_layout_content_set() instead so child object handling and sizing is
9867 * @note This function should only be used if you really need to call some
9868 * low level Edje function on this edje object. All the common stuff (setting
9869 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9870 * with proper elementary functions.
9872 * @see elm_object_signal_callback_add()
9873 * @see elm_object_signal_emit()
9874 * @see elm_object_text_part_set()
9875 * @see elm_layout_content_set()
9876 * @see elm_layout_box_append()
9877 * @see elm_layout_table_pack()
9878 * @see elm_layout_data_get()
9882 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9884 * Get the edje data from the given layout
9886 * @param obj The layout object
9887 * @param key The data key
9889 * @return The edje data string
9891 * This function fetches data specified inside the edje theme of this layout.
9892 * This function return NULL if data is not found.
9894 * In EDC this comes from a data block within the group block that @p
9895 * obj was loaded from. E.g.
9902 * item: "key1" "value1";
9903 * item: "key2" "value2";
9911 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9915 * @param obj The layout object
9917 * Manually forces a sizing re-evaluation. This is useful when the minimum
9918 * size required by the edje theme of this layout has changed. The change on
9919 * the minimum size required by the edje theme is not immediately reported to
9920 * the elementary layout, so one needs to call this function in order to tell
9921 * the widget (layout) that it needs to reevaluate its own size.
9923 * The minimum size of the theme is calculated based on minimum size of
9924 * parts, the size of elements inside containers like box and table, etc. All
9925 * of this can change due to state changes, and that's when this function
9928 * Also note that a standard signal of "size,eval" "elm" emitted from the
9929 * edje object will cause this to happen too.
9933 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9936 * Sets a specific cursor for an edje part.
9938 * @param obj The layout object.
9939 * @param part_name a part from loaded edje group.
9940 * @param cursor cursor name to use, see Elementary_Cursor.h
9942 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9943 * part not exists or it has "mouse_events: 0".
9947 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9950 * Get the cursor to be shown when mouse is over an edje part
9952 * @param obj The layout object.
9953 * @param part_name a part from loaded edje group.
9954 * @return the cursor name.
9958 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9961 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9963 * @param obj The layout object.
9964 * @param part_name a part from loaded edje group, that had a cursor set
9965 * with elm_layout_part_cursor_set().
9969 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9972 * Sets a specific cursor style for an edje part.
9974 * @param obj The layout object.
9975 * @param part_name a part from loaded edje group.
9976 * @param style the theme style to use (default, transparent, ...)
9978 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9979 * part not exists or it did not had a cursor set.
9983 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9986 * Gets a specific cursor style for an edje part.
9988 * @param obj The layout object.
9989 * @param part_name a part from loaded edje group.
9991 * @return the theme style in use, defaults to "default". If the
9992 * object does not have a cursor set, then NULL is returned.
9996 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9999 * Sets if the cursor set should be searched on the theme or should use
10000 * the provided by the engine, only.
10002 * @note before you set if should look on theme you should define a
10003 * cursor with elm_layout_part_cursor_set(). By default it will only
10004 * look for cursors provided by the engine.
10006 * @param obj The layout object.
10007 * @param part_name a part from loaded edje group.
10008 * @param engine_only if cursors should be just provided by the engine
10009 * or should also search on widget's theme as well
10011 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10012 * part not exists or it did not had a cursor set.
10016 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);
10019 * Gets a specific cursor engine_only for an edje part.
10021 * @param obj The layout object.
10022 * @param part_name a part from loaded edje group.
10024 * @return whenever the cursor is just provided by engine or also from theme.
10028 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10031 * @def elm_layout_icon_set
10032 * Convienience macro to set the icon object in a layout that follows the
10033 * Elementary naming convention for its parts.
10037 #define elm_layout_icon_set(_ly, _obj) \
10040 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10041 if ((_obj)) sig = "elm,state,icon,visible"; \
10042 else sig = "elm,state,icon,hidden"; \
10043 elm_object_signal_emit((_ly), sig, "elm"); \
10047 * @def elm_layout_icon_get
10048 * Convienience macro to get the icon object from a layout that follows the
10049 * Elementary naming convention for its parts.
10053 #define elm_layout_icon_get(_ly) \
10054 elm_layout_content_get((_ly), "elm.swallow.icon")
10057 * @def elm_layout_end_set
10058 * Convienience macro to set the end object in a layout that follows the
10059 * Elementary naming convention for its parts.
10063 #define elm_layout_end_set(_ly, _obj) \
10066 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10067 if ((_obj)) sig = "elm,state,end,visible"; \
10068 else sig = "elm,state,end,hidden"; \
10069 elm_object_signal_emit((_ly), sig, "elm"); \
10073 * @def elm_layout_end_get
10074 * Convienience macro to get the end object in a layout that follows the
10075 * Elementary naming convention for its parts.
10079 #define elm_layout_end_get(_ly) \
10080 elm_layout_content_get((_ly), "elm.swallow.end")
10083 * @def elm_layout_label_set
10084 * Convienience macro to set the label in a layout that follows the
10085 * Elementary naming convention for its parts.
10088 * @deprecated use elm_object_text_* instead.
10090 #define elm_layout_label_set(_ly, _txt) \
10091 elm_layout_text_set((_ly), "elm.text", (_txt))
10094 * @def elm_layout_label_get
10095 * Convienience macro to get the label in a layout that follows the
10096 * Elementary naming convention for its parts.
10099 * @deprecated use elm_object_text_* instead.
10101 #define elm_layout_label_get(_ly) \
10102 elm_layout_text_get((_ly), "elm.text")
10104 /* smart callbacks called:
10105 * "theme,changed" - when elm theme is changed.
10109 * @defgroup Notify Notify
10111 * @image html img/widget/notify/preview-00.png
10112 * @image latex img/widget/notify/preview-00.eps
10114 * Display a container in a particular region of the parent(top, bottom,
10115 * etc. A timeout can be set to automatically hide the notify. This is so
10116 * that, after an evas_object_show() on a notify object, if a timeout was set
10117 * on it, it will @b automatically get hidden after that time.
10119 * Signals that you can add callbacks for are:
10120 * @li "timeout" - when timeout happens on notify and it's hidden
10121 * @li "block,clicked" - when a click outside of the notify happens
10123 * @ref tutorial_notify show usage of the API.
10128 * @brief Possible orient values for notify.
10130 * This values should be used in conjunction to elm_notify_orient_set() to
10131 * set the position in which the notify should appear(relative to its parent)
10132 * and in conjunction with elm_notify_orient_get() to know where the notify
10135 typedef enum _Elm_Notify_Orient
10137 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10138 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10139 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10140 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10141 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10142 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10143 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10144 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10145 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10146 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10147 } Elm_Notify_Orient;
10149 * @brief Add a new notify to the parent
10151 * @param parent The parent object
10152 * @return The new object or NULL if it cannot be created
10154 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10156 * @brief Set the content of the notify widget
10158 * @param obj The notify object
10159 * @param content The content will be filled in this notify object
10161 * Once the content object is set, a previously set one will be deleted. If
10162 * you want to keep that old content object, use the
10163 * elm_notify_content_unset() function.
10165 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10167 * @brief Unset the content of the notify widget
10169 * @param obj The notify object
10170 * @return The content that was being used
10172 * Unparent and return the content object which was set for this widget
10174 * @see elm_notify_content_set()
10176 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10178 * @brief Return the content of the notify widget
10180 * @param obj The notify object
10181 * @return The content that is being used
10183 * @see elm_notify_content_set()
10185 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10187 * @brief Set the notify parent
10189 * @param obj The notify object
10190 * @param content The new parent
10192 * Once the parent object is set, a previously set one will be disconnected
10195 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10197 * @brief Get the notify parent
10199 * @param obj The notify object
10200 * @return The parent
10202 * @see elm_notify_parent_set()
10204 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10206 * @brief Set the orientation
10208 * @param obj The notify object
10209 * @param orient The new orientation
10211 * Sets the position in which the notify will appear in its parent.
10213 * @see @ref Elm_Notify_Orient for possible values.
10215 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10217 * @brief Return the orientation
10218 * @param obj The notify object
10219 * @return The orientation of the notification
10221 * @see elm_notify_orient_set()
10222 * @see Elm_Notify_Orient
10224 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10226 * @brief Set the time interval after which the notify window is going to be
10229 * @param obj The notify object
10230 * @param time The timeout in seconds
10232 * This function sets a timeout and starts the timer controlling when the
10233 * notify is hidden. Since calling evas_object_show() on a notify restarts
10234 * the timer controlling when the notify is hidden, setting this before the
10235 * notify is shown will in effect mean starting the timer when the notify is
10238 * @note Set a value <= 0.0 to disable a running timer.
10240 * @note If the value > 0.0 and the notify is previously visible, the
10241 * timer will be started with this value, canceling any running timer.
10243 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10245 * @brief Return the timeout value (in seconds)
10246 * @param obj the notify object
10248 * @see elm_notify_timeout_set()
10250 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10252 * @brief Sets whether events should be passed to by a click outside
10255 * @param obj The notify object
10256 * @param repeats EINA_TRUE Events are repeats, else no
10258 * When true if the user clicks outside the window the events will be caught
10259 * by the others widgets, else the events are blocked.
10261 * @note The default value is EINA_TRUE.
10263 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10265 * @brief Return true if events are repeat below the notify object
10266 * @param obj the notify object
10268 * @see elm_notify_repeat_events_set()
10270 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10276 * @defgroup Hover Hover
10278 * @image html img/widget/hover/preview-00.png
10279 * @image latex img/widget/hover/preview-00.eps
10281 * A Hover object will hover over its @p parent object at the @p target
10282 * location. Anything in the background will be given a darker coloring to
10283 * indicate that the hover object is on top (at the default theme). When the
10284 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10285 * clicked that @b doesn't cause the hover to be dismissed.
10287 * @note The hover object will take up the entire space of @p target
10290 * Elementary has the following styles for the hover widget:
10294 * @li hoversel_vertical
10296 * The following are the available position for content:
10308 * Signals that you can add callbacks for are:
10309 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10310 * @li "smart,changed" - a content object placed under the "smart"
10311 * policy was replaced to a new slot direction.
10313 * See @ref tutorial_hover for more information.
10317 typedef enum _Elm_Hover_Axis
10319 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10320 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10321 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10322 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10325 * @brief Adds a hover object to @p parent
10327 * @param parent The parent object
10328 * @return The hover object or NULL if one could not be created
10330 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10332 * @brief Sets the target object for the hover.
10334 * @param obj The hover object
10335 * @param target The object to center the hover onto. The hover
10337 * This function will cause the hover to be centered on the target object.
10339 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10341 * @brief Gets the target object for the hover.
10343 * @param obj The hover object
10344 * @param parent The object to locate the hover over.
10346 * @see elm_hover_target_set()
10348 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10350 * @brief Sets the parent object for the hover.
10352 * @param obj The hover object
10353 * @param parent The object to locate the hover over.
10355 * This function will cause the hover to take up the entire space that the
10356 * parent object fills.
10358 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10360 * @brief Gets the parent object for the hover.
10362 * @param obj The hover object
10363 * @return The parent object to locate the hover over.
10365 * @see elm_hover_parent_set()
10367 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10369 * @brief Sets the content of the hover object and the direction in which it
10372 * @param obj The hover object
10373 * @param swallow The direction that the object will be displayed
10374 * at. Accepted values are "left", "top-left", "top", "top-right",
10375 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10377 * @param content The content to place at @p swallow
10379 * Once the content object is set for a given direction, a previously
10380 * set one (on the same direction) will be deleted. If you want to
10381 * keep that old content object, use the elm_hover_content_unset()
10384 * All directions may have contents at the same time, except for
10385 * "smart". This is a special placement hint and its use case
10386 * independs of the calculations coming from
10387 * elm_hover_best_content_location_get(). Its use is for cases when
10388 * one desires only one hover content, but with a dinamic special
10389 * placement within the hover area. The content's geometry, whenever
10390 * it changes, will be used to decide on a best location not
10391 * extrapolating the hover's parent object view to show it in (still
10392 * being the hover's target determinant of its medium part -- move and
10393 * resize it to simulate finger sizes, for example). If one of the
10394 * directions other than "smart" are used, a previously content set
10395 * using it will be deleted, and vice-versa.
10397 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10399 * @brief Get the content of the hover object, in a given direction.
10401 * Return the content object which was set for this widget in the
10402 * @p swallow direction.
10404 * @param obj The hover object
10405 * @param swallow The direction that the object was display at.
10406 * @return The content that was being used
10408 * @see elm_hover_content_set()
10410 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10412 * @brief Unset the content of the hover object, in a given direction.
10414 * Unparent and return the content object set at @p swallow direction.
10416 * @param obj The hover object
10417 * @param swallow The direction that the object was display at.
10418 * @return The content that was being used.
10420 * @see elm_hover_content_set()
10422 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10424 * @brief Returns the best swallow location for content in the hover.
10426 * @param obj The hover object
10427 * @param pref_axis The preferred orientation axis for the hover object to use
10428 * @return The edje location to place content into the hover or @c
10431 * Best is defined here as the location at which there is the most available
10434 * @p pref_axis may be one of
10435 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10436 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10437 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10438 * - @c ELM_HOVER_AXIS_BOTH -- both
10440 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10441 * nescessarily be along the horizontal axis("left" or "right"). If
10442 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10443 * be along the vertical axis("top" or "bottom"). Chossing
10444 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10445 * returned position may be in either axis.
10447 * @see elm_hover_content_set()
10449 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10456 * @defgroup Entry Entry
10458 * @image html img/widget/entry/preview-00.png
10459 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10460 * @image html img/widget/entry/preview-01.png
10461 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10462 * @image html img/widget/entry/preview-02.png
10463 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10464 * @image html img/widget/entry/preview-03.png
10465 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10467 * An entry is a convenience widget which shows a box that the user can
10468 * enter text into. Entries by default don't scroll, so they grow to
10469 * accomodate the entire text, resizing the parent window as needed. This
10470 * can be changed with the elm_entry_scrollable_set() function.
10472 * They can also be single line or multi line (the default) and when set
10473 * to multi line mode they support text wrapping in any of the modes
10474 * indicated by #Elm_Wrap_Type.
10476 * Other features include password mode, filtering of inserted text with
10477 * elm_entry_text_filter_append() and related functions, inline "items" and
10478 * formatted markup text.
10480 * @section entry-markup Formatted text
10482 * The markup tags supported by the Entry are defined by the theme, but
10483 * even when writing new themes or extensions it's a good idea to stick to
10484 * a sane default, to maintain coherency and avoid application breakages.
10485 * Currently defined by the default theme are the following tags:
10486 * @li \<br\>: Inserts a line break.
10487 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10489 * @li \<tab\>: Inserts a tab.
10490 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10492 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10493 * @li \<link\>...\</link\>: Underlines the enclosed text.
10494 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10496 * @section entry-special Special markups
10498 * Besides those used to format text, entries support two special markup
10499 * tags used to insert clickable portions of text or items inlined within
10502 * @subsection entry-anchors Anchors
10504 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10505 * \</a\> tags and an event will be generated when this text is clicked,
10509 * This text is outside <a href=anc-01>but this one is an anchor</a>
10512 * The @c href attribute in the opening tag gives the name that will be
10513 * used to identify the anchor and it can be any valid utf8 string.
10515 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10516 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10517 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10518 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10521 * @subsection entry-items Items
10523 * Inlined in the text, any other @c Evas_Object can be inserted by using
10524 * \<item\> tags this way:
10527 * <item size=16x16 vsize=full href=emoticon/haha></item>
10530 * Just like with anchors, the @c href identifies each item, but these need,
10531 * in addition, to indicate their size, which is done using any one of
10532 * @c size, @c absize or @c relsize attributes. These attributes take their
10533 * value in the WxH format, where W is the width and H the height of the
10536 * @li absize: Absolute pixel size for the item. Whatever value is set will
10537 * be the item's size regardless of any scale value the object may have
10538 * been set to. The final line height will be adjusted to fit larger items.
10539 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10541 * @li relsize: Size is adjusted for the item to fit within the current
10544 * Besides their size, items are specificed a @c vsize value that affects
10545 * how their final size and position are calculated. The possible values
10547 * @li ascent: Item will be placed within the line's baseline and its
10548 * ascent. That is, the height between the line where all characters are
10549 * positioned and the highest point in the line. For @c size and @c absize
10550 * items, the descent value will be added to the total line height to make
10551 * them fit. @c relsize items will be adjusted to fit within this space.
10552 * @li full: Items will be placed between the descent and ascent, or the
10553 * lowest point in the line and its highest.
10555 * The next image shows different configurations of items and how they
10556 * are the previously mentioned options affect their sizes. In all cases,
10557 * the green line indicates the ascent, blue for the baseline and red for
10560 * @image html entry_item.png
10561 * @image latex entry_item.eps width=\textwidth
10563 * And another one to show how size differs from absize. In the first one,
10564 * the scale value is set to 1.0, while the second one is using one of 2.0.
10566 * @image html entry_item_scale.png
10567 * @image latex entry_item_scale.eps width=\textwidth
10569 * After the size for an item is calculated, the entry will request an
10570 * object to place in its space. For this, the functions set with
10571 * elm_entry_item_provider_append() and related functions will be called
10572 * in order until one of them returns a @c non-NULL value. If no providers
10573 * are available, or all of them return @c NULL, then the entry falls back
10574 * to one of the internal defaults, provided the name matches with one of
10577 * All of the following are currently supported:
10580 * - emoticon/angry-shout
10581 * - emoticon/crazy-laugh
10582 * - emoticon/evil-laugh
10584 * - emoticon/goggle-smile
10585 * - emoticon/grumpy
10586 * - emoticon/grumpy-smile
10587 * - emoticon/guilty
10588 * - emoticon/guilty-smile
10590 * - emoticon/half-smile
10591 * - emoticon/happy-panting
10593 * - emoticon/indifferent
10595 * - emoticon/knowing-grin
10597 * - emoticon/little-bit-sorry
10598 * - emoticon/love-lots
10600 * - emoticon/minimal-smile
10601 * - emoticon/not-happy
10602 * - emoticon/not-impressed
10604 * - emoticon/opensmile
10607 * - emoticon/squint-laugh
10608 * - emoticon/surprised
10609 * - emoticon/suspicious
10610 * - emoticon/tongue-dangling
10611 * - emoticon/tongue-poke
10613 * - emoticon/unhappy
10614 * - emoticon/very-sorry
10617 * - emoticon/worried
10620 * Alternatively, an item may reference an image by its path, using
10621 * the URI form @c file:///path/to/an/image.png and the entry will then
10622 * use that image for the item.
10624 * @section entry-files Loading and saving files
10626 * Entries have convinience functions to load text from a file and save
10627 * changes back to it after a short delay. The automatic saving is enabled
10628 * by default, but can be disabled with elm_entry_autosave_set() and files
10629 * can be loaded directly as plain text or have any markup in them
10630 * recognized. See elm_entry_file_set() for more details.
10632 * @section entry-signals Emitted signals
10634 * This widget emits the following signals:
10636 * @li "changed": The text within the entry was changed.
10637 * @li "changed,user": The text within the entry was changed because of user interaction.
10638 * @li "activated": The enter key was pressed on a single line entry.
10639 * @li "press": A mouse button has been pressed on the entry.
10640 * @li "longpressed": A mouse button has been pressed and held for a couple
10642 * @li "clicked": The entry has been clicked (mouse press and release).
10643 * @li "clicked,double": The entry has been double clicked.
10644 * @li "clicked,triple": The entry has been triple clicked.
10645 * @li "focused": The entry has received focus.
10646 * @li "unfocused": The entry has lost focus.
10647 * @li "selection,paste": A paste of the clipboard contents was requested.
10648 * @li "selection,copy": A copy of the selected text into the clipboard was
10650 * @li "selection,cut": A cut of the selected text into the clipboard was
10652 * @li "selection,start": A selection has begun and no previous selection
10654 * @li "selection,changed": The current selection has changed.
10655 * @li "selection,cleared": The current selection has been cleared.
10656 * @li "cursor,changed": The cursor has changed position.
10657 * @li "anchor,clicked": An anchor has been clicked. The event_info
10658 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10659 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10660 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10661 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10662 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10663 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10664 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10665 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10666 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10667 * @li "preedit,changed": The preedit string has changed.
10669 * @section entry-examples
10671 * An overview of the Entry API can be seen in @ref entry_example_01
10676 * @typedef Elm_Entry_Anchor_Info
10678 * The info sent in the callback for the "anchor,clicked" signals emitted
10681 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10683 * @struct _Elm_Entry_Anchor_Info
10685 * The info sent in the callback for the "anchor,clicked" signals emitted
10688 struct _Elm_Entry_Anchor_Info
10690 const char *name; /**< The name of the anchor, as stated in its href */
10691 int button; /**< The mouse button used to click on it */
10692 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10693 y, /**< Anchor geometry, relative to canvas */
10694 w, /**< Anchor geometry, relative to canvas */
10695 h; /**< Anchor geometry, relative to canvas */
10698 * @typedef Elm_Entry_Filter_Cb
10699 * This callback type is used by entry filters to modify text.
10700 * @param data The data specified as the last param when adding the filter
10701 * @param entry The entry object
10702 * @param text A pointer to the location of the text being filtered. This data can be modified,
10703 * but any additional allocations must be managed by the user.
10704 * @see elm_entry_text_filter_append
10705 * @see elm_entry_text_filter_prepend
10707 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10710 * This adds an entry to @p parent object.
10712 * By default, entries are:
10716 * @li autosave is enabled
10718 * @param parent The parent object
10719 * @return The new object or NULL if it cannot be created
10721 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10723 * Sets the entry to single line mode.
10725 * In single line mode, entries don't ever wrap when the text reaches the
10726 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10727 * key will generate an @c "activate" event instead of adding a new line.
10729 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10730 * and pressing enter will break the text into a different line
10731 * without generating any events.
10733 * @param obj The entry object
10734 * @param single_line If true, the text in the entry
10735 * will be on a single line.
10737 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10739 * Gets whether the entry is set to be single line.
10741 * @param obj The entry object
10742 * @return single_line If true, the text in the entry is set to display
10743 * on a single line.
10745 * @see elm_entry_single_line_set()
10747 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10749 * Sets the entry to password mode.
10751 * In password mode, entries are implicitly single line and the display of
10752 * any text in them is replaced with asterisks (*).
10754 * @param obj The entry object
10755 * @param password If true, password mode is enabled.
10757 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10759 * Gets whether the entry is set to password mode.
10761 * @param obj The entry object
10762 * @return If true, the entry is set to display all characters
10763 * as asterisks (*).
10765 * @see elm_entry_password_set()
10767 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10769 * This sets the text displayed within the entry to @p entry.
10771 * @param obj The entry object
10772 * @param entry The text to be displayed
10774 * @deprecated Use elm_object_text_set() instead.
10776 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10778 * This returns the text currently shown in object @p entry.
10779 * See also elm_entry_entry_set().
10781 * @param obj The entry object
10782 * @return The currently displayed text or NULL on failure
10784 * @deprecated Use elm_object_text_get() instead.
10786 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10788 * Appends @p entry to the text of the entry.
10790 * Adds the text in @p entry to the end of any text already present in the
10793 * The appended text is subject to any filters set for the widget.
10795 * @param obj The entry object
10796 * @param entry The text to be displayed
10798 * @see elm_entry_text_filter_append()
10800 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10802 * Gets whether the entry is empty.
10804 * Empty means no text at all. If there are any markup tags, like an item
10805 * tag for which no provider finds anything, and no text is displayed, this
10806 * function still returns EINA_FALSE.
10808 * @param obj The entry object
10809 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10811 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10813 * Gets any selected text within the entry.
10815 * If there's any selected text in the entry, this function returns it as
10816 * a string in markup format. NULL is returned if no selection exists or
10817 * if an error occurred.
10819 * The returned value points to an internal string and should not be freed
10820 * or modified in any way. If the @p entry object is deleted or its
10821 * contents are changed, the returned pointer should be considered invalid.
10823 * @param obj The entry object
10824 * @return The selected text within the entry or NULL on failure
10826 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10828 * Inserts the given text into the entry at the current cursor position.
10830 * This inserts text at the cursor position as if it was typed
10831 * by the user (note that this also allows markup which a user
10832 * can't just "type" as it would be converted to escaped text, so this
10833 * call can be used to insert things like emoticon items or bold push/pop
10834 * tags, other font and color change tags etc.)
10836 * If any selection exists, it will be replaced by the inserted text.
10838 * The inserted text is subject to any filters set for the widget.
10840 * @param obj The entry object
10841 * @param entry The text to insert
10843 * @see elm_entry_text_filter_append()
10845 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10847 * Set the line wrap type to use on multi-line entries.
10849 * Sets the wrap type used by the entry to any of the specified in
10850 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10851 * line (without inserting a line break or paragraph separator) when it
10852 * reaches the far edge of the widget.
10854 * Note that this only makes sense for multi-line entries. A widget set
10855 * to be single line will never wrap.
10857 * @param obj The entry object
10858 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10860 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10862 * Gets the wrap mode the entry was set to use.
10864 * @param obj The entry object
10865 * @return Wrap type
10867 * @see also elm_entry_line_wrap_set()
10869 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10871 * Sets if the entry is to be editable or not.
10873 * By default, entries are editable and when focused, any text input by the
10874 * user will be inserted at the current cursor position. But calling this
10875 * function with @p editable as EINA_FALSE will prevent the user from
10876 * inputting text into the entry.
10878 * The only way to change the text of a non-editable entry is to use
10879 * elm_object_text_set(), elm_entry_entry_insert() and other related
10882 * @param obj The entry object
10883 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10884 * if not, the entry is read-only and no user input is allowed.
10886 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10888 * Gets whether the entry is editable or not.
10890 * @param obj The entry object
10891 * @return If true, the entry is editable by the user.
10892 * If false, it is not editable by the user
10894 * @see elm_entry_editable_set()
10896 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10898 * This drops any existing text selection within the entry.
10900 * @param obj The entry object
10902 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10904 * This selects all text within the entry.
10906 * @param obj The entry object
10908 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10910 * This moves the cursor one place to the right within the entry.
10912 * @param obj The entry object
10913 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10915 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10917 * This moves the cursor one place to the left within the entry.
10919 * @param obj The entry object
10920 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10922 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10924 * This moves the cursor one line up within the entry.
10926 * @param obj The entry object
10927 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10929 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10931 * This moves the cursor one line down within the entry.
10933 * @param obj The entry object
10934 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10936 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10938 * This moves the cursor to the beginning of the entry.
10940 * @param obj The entry object
10942 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10944 * This moves the cursor to the end of the entry.
10946 * @param obj The entry object
10948 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10950 * This moves the cursor to the beginning of the current line.
10952 * @param obj The entry object
10954 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10956 * This moves the cursor to the end of the current line.
10958 * @param obj The entry object
10960 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10962 * This begins a selection within the entry as though
10963 * the user were holding down the mouse button to make a selection.
10965 * @param obj The entry object
10967 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10969 * This ends a selection within the entry as though
10970 * the user had just released the mouse button while making a selection.
10972 * @param obj The entry object
10974 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10976 * Gets whether a format node exists at the current cursor position.
10978 * A format node is anything that defines how the text is rendered. It can
10979 * be a visible format node, such as a line break or a paragraph separator,
10980 * or an invisible one, such as bold begin or end tag.
10981 * This function returns whether any format node exists at the current
10984 * @param obj The entry object
10985 * @return EINA_TRUE if the current cursor position contains a format node,
10986 * EINA_FALSE otherwise.
10988 * @see elm_entry_cursor_is_visible_format_get()
10990 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10992 * Gets if the current cursor position holds a visible format node.
10994 * @param obj The entry object
10995 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10996 * if it's an invisible one or no format exists.
10998 * @see elm_entry_cursor_is_format_get()
11000 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11002 * Gets the character pointed by the cursor at its current position.
11004 * This function returns a string with the utf8 character stored at the
11005 * current cursor position.
11006 * Only the text is returned, any format that may exist will not be part
11007 * of the return value.
11009 * @param obj The entry object
11010 * @return The text pointed by the cursors.
11012 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11014 * This function returns the geometry of the cursor.
11016 * It's useful if you want to draw something on the cursor (or where it is),
11017 * or for example in the case of scrolled entry where you want to show the
11020 * @param obj The entry object
11021 * @param x returned geometry
11022 * @param y returned geometry
11023 * @param w returned geometry
11024 * @param h returned geometry
11025 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11027 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);
11029 * Sets the cursor position in the entry to the given value
11031 * The value in @p pos is the index of the character position within the
11032 * contents of the string as returned by elm_entry_cursor_pos_get().
11034 * @param obj The entry object
11035 * @param pos The position of the cursor
11037 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11039 * Retrieves the current position of the cursor in the entry
11041 * @param obj The entry object
11042 * @return The cursor position
11044 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11046 * This executes a "cut" action on the selected text in the entry.
11048 * @param obj The entry object
11050 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11052 * This executes a "copy" action on the selected text in the entry.
11054 * @param obj The entry object
11056 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11058 * This executes a "paste" action in the entry.
11060 * @param obj The entry object
11062 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11064 * This clears and frees the items in a entry's contextual (longpress)
11067 * @param obj The entry object
11069 * @see elm_entry_context_menu_item_add()
11071 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11073 * This adds an item to the entry's contextual menu.
11075 * A longpress on an entry will make the contextual menu show up, if this
11076 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11077 * By default, this menu provides a few options like enabling selection mode,
11078 * which is useful on embedded devices that need to be explicit about it,
11079 * and when a selection exists it also shows the copy and cut actions.
11081 * With this function, developers can add other options to this menu to
11082 * perform any action they deem necessary.
11084 * @param obj The entry object
11085 * @param label The item's text label
11086 * @param icon_file The item's icon file
11087 * @param icon_type The item's icon type
11088 * @param func The callback to execute when the item is clicked
11089 * @param data The data to associate with the item for related functions
11091 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);
11093 * This disables the entry's contextual (longpress) menu.
11095 * @param obj The entry object
11096 * @param disabled If true, the menu is disabled
11098 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11100 * This returns whether the entry's contextual (longpress) menu is
11103 * @param obj The entry object
11104 * @return If true, the menu is disabled
11106 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11108 * This appends a custom item provider to the list for that entry
11110 * This appends the given callback. The list is walked from beginning to end
11111 * with each function called given the item href string in the text. If the
11112 * function returns an object handle other than NULL (it should create an
11113 * object to do this), then this object is used to replace that item. If
11114 * not the next provider is called until one provides an item object, or the
11115 * default provider in entry does.
11117 * @param obj The entry object
11118 * @param func The function called to provide the item object
11119 * @param data The data passed to @p func
11121 * @see @ref entry-items
11123 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);
11125 * This prepends a custom item provider to the list for that entry
11127 * This prepends the given callback. See elm_entry_item_provider_append() for
11130 * @param obj The entry object
11131 * @param func The function called to provide the item object
11132 * @param data The data passed to @p func
11134 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);
11136 * This removes a custom item provider to the list for that entry
11138 * This removes the given callback. See elm_entry_item_provider_append() for
11141 * @param obj The entry object
11142 * @param func The function called to provide the item object
11143 * @param data The data passed to @p func
11145 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);
11147 * Append a filter function for text inserted in the entry
11149 * Append the given callback to the list. This functions will be called
11150 * whenever any text is inserted into the entry, with the text to be inserted
11151 * as a parameter. The callback function is free to alter the text in any way
11152 * it wants, but it must remember to free the given pointer and update it.
11153 * If the new text is to be discarded, the function can free it and set its
11154 * text parameter to NULL. This will also prevent any following filters from
11157 * @param obj The entry object
11158 * @param func The function to use as text filter
11159 * @param data User data to pass to @p func
11161 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11163 * Prepend a filter function for text insdrted in the entry
11165 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11166 * for more information
11168 * @param obj The entry object
11169 * @param func The function to use as text filter
11170 * @param data User data to pass to @p func
11172 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11174 * Remove a filter from the list
11176 * Removes the given callback from the filter list. See
11177 * elm_entry_text_filter_append() for more information.
11179 * @param obj The entry object
11180 * @param func The filter function to remove
11181 * @param data The user data passed when adding the function
11183 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11185 * This converts a markup (HTML-like) string into UTF-8.
11187 * The returned string is a malloc'ed buffer and it should be freed when
11188 * not needed anymore.
11190 * @param s The string (in markup) to be converted
11191 * @return The converted string (in UTF-8). It should be freed.
11193 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11195 * This converts a UTF-8 string into markup (HTML-like).
11197 * The returned string is a malloc'ed buffer and it should be freed when
11198 * not needed anymore.
11200 * @param s The string (in UTF-8) to be converted
11201 * @return The converted string (in markup). It should be freed.
11203 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11205 * This sets the file (and implicitly loads it) for the text to display and
11206 * then edit. All changes are written back to the file after a short delay if
11207 * the entry object is set to autosave (which is the default).
11209 * If the entry had any other file set previously, any changes made to it
11210 * will be saved if the autosave feature is enabled, otherwise, the file
11211 * will be silently discarded and any non-saved changes will be lost.
11213 * @param obj The entry object
11214 * @param file The path to the file to load and save
11215 * @param format The file format
11217 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11219 * Gets the file being edited by the entry.
11221 * This function can be used to retrieve any file set on the entry for
11222 * edition, along with the format used to load and save it.
11224 * @param obj The entry object
11225 * @param file The path to the file to load and save
11226 * @param format The file format
11228 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11230 * This function writes any changes made to the file set with
11231 * elm_entry_file_set()
11233 * @param obj The entry object
11235 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11237 * This sets the entry object to 'autosave' the loaded text file or not.
11239 * @param obj The entry object
11240 * @param autosave Autosave the loaded file or not
11242 * @see elm_entry_file_set()
11244 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11246 * This gets the entry object's 'autosave' status.
11248 * @param obj The entry object
11249 * @return Autosave the loaded file or not
11251 * @see elm_entry_file_set()
11253 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11255 * Control pasting of text and images for the widget.
11257 * Normally the entry allows both text and images to be pasted. By setting
11258 * textonly to be true, this prevents images from being pasted.
11260 * Note this only changes the behaviour of text.
11262 * @param obj The entry object
11263 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11264 * text+image+other.
11266 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11268 * Getting elm_entry text paste/drop mode.
11270 * In textonly mode, only text may be pasted or dropped into the widget.
11272 * @param obj The entry object
11273 * @return If the widget only accepts text from pastes.
11275 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11277 * Enable or disable scrolling in entry
11279 * Normally the entry is not scrollable unless you enable it with this call.
11281 * @param obj The entry object
11282 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11284 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11286 * Get the scrollable state of the entry
11288 * Normally the entry is not scrollable. This gets the scrollable state
11289 * of the entry. See elm_entry_scrollable_set() for more information.
11291 * @param obj The entry object
11292 * @return The scrollable state
11294 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11296 * This sets a widget to be displayed to the left of a scrolled entry.
11298 * @param obj The scrolled entry object
11299 * @param icon The widget to display on the left side of the scrolled
11302 * @note A previously set widget will be destroyed.
11303 * @note If the object being set does not have minimum size hints set,
11304 * it won't get properly displayed.
11306 * @see elm_entry_end_set()
11308 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11310 * Gets the leftmost widget of the scrolled entry. This object is
11311 * owned by the scrolled entry and should not be modified.
11313 * @param obj The scrolled entry object
11314 * @return the left widget inside the scroller
11316 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11318 * Unset the leftmost widget of the scrolled entry, unparenting and
11321 * @param obj The scrolled entry object
11322 * @return the previously set icon sub-object of this entry, on
11325 * @see elm_entry_icon_set()
11327 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11329 * Sets the visibility of the left-side widget of the scrolled entry,
11330 * set by elm_entry_icon_set().
11332 * @param obj The scrolled entry object
11333 * @param setting EINA_TRUE if the object should be displayed,
11334 * EINA_FALSE if not.
11336 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11338 * This sets a widget to be displayed to the end of a scrolled entry.
11340 * @param obj The scrolled entry object
11341 * @param end The widget to display on the right side of the scrolled
11344 * @note A previously set widget will be destroyed.
11345 * @note If the object being set does not have minimum size hints set,
11346 * it won't get properly displayed.
11348 * @see elm_entry_icon_set
11350 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11352 * Gets the endmost widget of the scrolled entry. This object is owned
11353 * by the scrolled entry and should not be modified.
11355 * @param obj The scrolled entry object
11356 * @return the right widget inside the scroller
11358 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11360 * Unset the endmost widget of the scrolled entry, unparenting and
11363 * @param obj The scrolled entry object
11364 * @return the previously set icon sub-object of this entry, on
11367 * @see elm_entry_icon_set()
11369 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11371 * Sets the visibility of the end widget of the scrolled entry, set by
11372 * elm_entry_end_set().
11374 * @param obj The scrolled entry object
11375 * @param setting EINA_TRUE if the object should be displayed,
11376 * EINA_FALSE if not.
11378 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11380 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11383 * Setting an entry to single-line mode with elm_entry_single_line_set()
11384 * will automatically disable the display of scrollbars when the entry
11385 * moves inside its scroller.
11387 * @param obj The scrolled entry object
11388 * @param h The horizontal scrollbar policy to apply
11389 * @param v The vertical scrollbar policy to apply
11391 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11393 * This enables/disables bouncing within the entry.
11395 * This function sets whether the entry will bounce when scrolling reaches
11396 * the end of the contained entry.
11398 * @param obj The scrolled entry object
11399 * @param h The horizontal bounce state
11400 * @param v The vertical bounce state
11402 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11404 * Get the bounce mode
11406 * @param obj The Entry object
11407 * @param h_bounce Allow bounce horizontally
11408 * @param v_bounce Allow bounce vertically
11410 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11412 /* pre-made filters for entries */
11414 * @typedef Elm_Entry_Filter_Limit_Size
11416 * Data for the elm_entry_filter_limit_size() entry filter.
11418 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11420 * @struct _Elm_Entry_Filter_Limit_Size
11422 * Data for the elm_entry_filter_limit_size() entry filter.
11424 struct _Elm_Entry_Filter_Limit_Size
11426 int max_char_count; /**< The maximum number of characters allowed. */
11427 int max_byte_count; /**< The maximum number of bytes allowed*/
11430 * Filter inserted text based on user defined character and byte limits
11432 * Add this filter to an entry to limit the characters that it will accept
11433 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11434 * The funtion works on the UTF-8 representation of the string, converting
11435 * it from the set markup, thus not accounting for any format in it.
11437 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11438 * it as data when setting the filter. In it, it's possible to set limits
11439 * by character count or bytes (any of them is disabled if 0), and both can
11440 * be set at the same time. In that case, it first checks for characters,
11443 * The function will cut the inserted text in order to allow only the first
11444 * number of characters that are still allowed. The cut is made in
11445 * characters, even when limiting by bytes, in order to always contain
11446 * valid ones and avoid half unicode characters making it in.
11448 * This filter, like any others, does not apply when setting the entry text
11449 * directly with elm_object_text_set() (or the deprecated
11450 * elm_entry_entry_set()).
11452 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11454 * @typedef Elm_Entry_Filter_Accept_Set
11456 * Data for the elm_entry_filter_accept_set() entry filter.
11458 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11460 * @struct _Elm_Entry_Filter_Accept_Set
11462 * Data for the elm_entry_filter_accept_set() entry filter.
11464 struct _Elm_Entry_Filter_Accept_Set
11466 const char *accepted; /**< Set of characters accepted in the entry. */
11467 const char *rejected; /**< Set of characters rejected from the entry. */
11470 * Filter inserted text based on accepted or rejected sets of characters
11472 * Add this filter to an entry to restrict the set of accepted characters
11473 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11474 * This structure contains both accepted and rejected sets, but they are
11475 * mutually exclusive.
11477 * The @c accepted set takes preference, so if it is set, the filter will
11478 * only work based on the accepted characters, ignoring anything in the
11479 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11481 * In both cases, the function filters by matching utf8 characters to the
11482 * raw markup text, so it can be used to remove formatting tags.
11484 * This filter, like any others, does not apply when setting the entry text
11485 * directly with elm_object_text_set() (or the deprecated
11486 * elm_entry_entry_set()).
11488 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11490 * Set the input panel layout of the entry
11492 * @param obj The entry object
11493 * @param layout layout type
11495 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11497 * Get the input panel layout of the entry
11499 * @param obj The entry object
11500 * @return layout type
11502 * @see elm_entry_input_panel_layout_set
11504 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11509 /* composite widgets - these basically put together basic widgets above
11510 * in convenient packages that do more than basic stuff */
11514 * @defgroup Anchorview Anchorview
11516 * @image html img/widget/anchorview/preview-00.png
11517 * @image latex img/widget/anchorview/preview-00.eps
11519 * Anchorview is for displaying text that contains markup with anchors
11520 * like <c>\<a href=1234\>something\</\></c> in it.
11522 * Besides being styled differently, the anchorview widget provides the
11523 * necessary functionality so that clicking on these anchors brings up a
11524 * popup with user defined content such as "call", "add to contacts" or
11525 * "open web page". This popup is provided using the @ref Hover widget.
11527 * This widget is very similar to @ref Anchorblock, so refer to that
11528 * widget for an example. The only difference Anchorview has is that the
11529 * widget is already provided with scrolling functionality, so if the
11530 * text set to it is too large to fit in the given space, it will scroll,
11531 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11532 * text can be displayed.
11534 * This widget emits the following signals:
11535 * @li "anchor,clicked": will be called when an anchor is clicked. The
11536 * @p event_info parameter on the callback will be a pointer of type
11537 * ::Elm_Entry_Anchorview_Info.
11539 * See @ref Anchorblock for an example on how to use both of them.
11548 * @typedef Elm_Entry_Anchorview_Info
11550 * The info sent in the callback for "anchor,clicked" signals emitted by
11551 * the Anchorview widget.
11553 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11555 * @struct _Elm_Entry_Anchorview_Info
11557 * The info sent in the callback for "anchor,clicked" signals emitted by
11558 * the Anchorview widget.
11560 struct _Elm_Entry_Anchorview_Info
11562 const char *name; /**< Name of the anchor, as indicated in its href
11564 int button; /**< The mouse button used to click on it */
11565 Evas_Object *hover; /**< The hover object to use for the popup */
11567 Evas_Coord x, y, w, h;
11568 } anchor, /**< Geometry selection of text used as anchor */
11569 hover_parent; /**< Geometry of the object used as parent by the
11571 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11572 for content on the left side of
11573 the hover. Before calling the
11574 callback, the widget will make the
11575 necessary calculations to check
11576 which sides are fit to be set with
11577 content, based on the position the
11578 hover is activated and its distance
11579 to the edges of its parent object
11581 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11582 the right side of the hover.
11583 See @ref hover_left */
11584 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11585 of the hover. See @ref hover_left */
11586 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11587 below the hover. See @ref
11591 * Add a new Anchorview object
11593 * @param parent The parent object
11594 * @return The new object or NULL if it cannot be created
11596 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11598 * Set the text to show in the anchorview
11600 * Sets the text of the anchorview to @p text. This text can include markup
11601 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11602 * text that will be specially styled and react to click events, ended with
11603 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11604 * "anchor,clicked" signal that you can attach a callback to with
11605 * evas_object_smart_callback_add(). The name of the anchor given in the
11606 * event info struct will be the one set in the href attribute, in this
11607 * case, anchorname.
11609 * Other markup can be used to style the text in different ways, but it's
11610 * up to the style defined in the theme which tags do what.
11611 * @deprecated use elm_object_text_set() instead.
11613 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11615 * Get the markup text set for the anchorview
11617 * Retrieves the text set on the anchorview, with markup tags included.
11619 * @param obj The anchorview object
11620 * @return The markup text set or @c NULL if nothing was set or an error
11622 * @deprecated use elm_object_text_set() instead.
11624 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11626 * Set the parent of the hover popup
11628 * Sets the parent object to use by the hover created by the anchorview
11629 * when an anchor is clicked. See @ref Hover for more details on this.
11630 * If no parent is set, the same anchorview object will be used.
11632 * @param obj The anchorview object
11633 * @param parent The object to use as parent for the hover
11635 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11637 * Get the parent of the hover popup
11639 * Get the object used as parent for the hover created by the anchorview
11640 * widget. See @ref Hover for more details on this.
11642 * @param obj The anchorview object
11643 * @return The object used as parent for the hover, NULL if none is set.
11645 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11647 * Set the style that the hover should use
11649 * When creating the popup hover, anchorview will request that it's
11650 * themed according to @p style.
11652 * @param obj The anchorview object
11653 * @param style The style to use for the underlying hover
11655 * @see elm_object_style_set()
11657 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11659 * Get the style that the hover should use
11661 * Get the style the hover created by anchorview will use.
11663 * @param obj The anchorview object
11664 * @return The style to use by the hover. NULL means the default is used.
11666 * @see elm_object_style_set()
11668 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11670 * Ends the hover popup in the anchorview
11672 * When an anchor is clicked, the anchorview widget will create a hover
11673 * object to use as a popup with user provided content. This function
11674 * terminates this popup, returning the anchorview to its normal state.
11676 * @param obj The anchorview object
11678 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11680 * Set bouncing behaviour when the scrolled content reaches an edge
11682 * Tell the internal scroller object whether it should bounce or not
11683 * when it reaches the respective edges for each axis.
11685 * @param obj The anchorview object
11686 * @param h_bounce Whether to bounce or not in the horizontal axis
11687 * @param v_bounce Whether to bounce or not in the vertical axis
11689 * @see elm_scroller_bounce_set()
11691 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11693 * Get the set bouncing behaviour of the internal scroller
11695 * Get whether the internal scroller should bounce when the edge of each
11696 * axis is reached scrolling.
11698 * @param obj The anchorview object
11699 * @param h_bounce Pointer where to store the bounce state of the horizontal
11701 * @param v_bounce Pointer where to store the bounce state of the vertical
11704 * @see elm_scroller_bounce_get()
11706 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11708 * Appends a custom item provider to the given anchorview
11710 * Appends the given function to the list of items providers. This list is
11711 * called, one function at a time, with the given @p data pointer, the
11712 * anchorview object and, in the @p item parameter, the item name as
11713 * referenced in its href string. Following functions in the list will be
11714 * called in order until one of them returns something different to NULL,
11715 * which should be an Evas_Object which will be used in place of the item
11718 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11719 * href=item/name\>\</item\>
11721 * @param obj The anchorview object
11722 * @param func The function to add to the list of providers
11723 * @param data User data that will be passed to the callback function
11725 * @see elm_entry_item_provider_append()
11727 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);
11729 * Prepend a custom item provider to the given anchorview
11731 * Like elm_anchorview_item_provider_append(), but it adds the function
11732 * @p func to the beginning of the list, instead of the end.
11734 * @param obj The anchorview object
11735 * @param func The function to add to the list of providers
11736 * @param data User data that will be passed to the callback function
11738 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);
11740 * Remove a custom item provider from the list of the given anchorview
11742 * Removes the function and data pairing that matches @p func and @p data.
11743 * That is, unless the same function and same user data are given, the
11744 * function will not be removed from the list. This allows us to add the
11745 * same callback several times, with different @p data pointers and be
11746 * able to remove them later without conflicts.
11748 * @param obj The anchorview object
11749 * @param func The function to remove from the list
11750 * @param data The data matching the function to remove from the list
11752 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);
11759 * @defgroup Anchorblock Anchorblock
11761 * @image html img/widget/anchorblock/preview-00.png
11762 * @image latex img/widget/anchorblock/preview-00.eps
11764 * Anchorblock is for displaying text that contains markup with anchors
11765 * like <c>\<a href=1234\>something\</\></c> in it.
11767 * Besides being styled differently, the anchorblock widget provides the
11768 * necessary functionality so that clicking on these anchors brings up a
11769 * popup with user defined content such as "call", "add to contacts" or
11770 * "open web page". This popup is provided using the @ref Hover widget.
11772 * This widget emits the following signals:
11773 * @li "anchor,clicked": will be called when an anchor is clicked. The
11774 * @p event_info parameter on the callback will be a pointer of type
11775 * ::Elm_Entry_Anchorblock_Info.
11781 * Since examples are usually better than plain words, we might as well
11782 * try @ref tutorial_anchorblock_example "one".
11785 * @addtogroup Anchorblock
11789 * @typedef Elm_Entry_Anchorblock_Info
11791 * The info sent in the callback for "anchor,clicked" signals emitted by
11792 * the Anchorblock widget.
11794 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11796 * @struct _Elm_Entry_Anchorblock_Info
11798 * The info sent in the callback for "anchor,clicked" signals emitted by
11799 * the Anchorblock widget.
11801 struct _Elm_Entry_Anchorblock_Info
11803 const char *name; /**< Name of the anchor, as indicated in its href
11805 int button; /**< The mouse button used to click on it */
11806 Evas_Object *hover; /**< The hover object to use for the popup */
11808 Evas_Coord x, y, w, h;
11809 } anchor, /**< Geometry selection of text used as anchor */
11810 hover_parent; /**< Geometry of the object used as parent by the
11812 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11813 for content on the left side of
11814 the hover. Before calling the
11815 callback, the widget will make the
11816 necessary calculations to check
11817 which sides are fit to be set with
11818 content, based on the position the
11819 hover is activated and its distance
11820 to the edges of its parent object
11822 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11823 the right side of the hover.
11824 See @ref hover_left */
11825 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11826 of the hover. See @ref hover_left */
11827 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11828 below the hover. See @ref
11832 * Add a new Anchorblock object
11834 * @param parent The parent object
11835 * @return The new object or NULL if it cannot be created
11837 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11839 * Set the text to show in the anchorblock
11841 * Sets the text of the anchorblock to @p text. This text can include markup
11842 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11843 * of text that will be specially styled and react to click events, ended
11844 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11845 * "anchor,clicked" signal that you can attach a callback to with
11846 * evas_object_smart_callback_add(). The name of the anchor given in the
11847 * event info struct will be the one set in the href attribute, in this
11848 * case, anchorname.
11850 * Other markup can be used to style the text in different ways, but it's
11851 * up to the style defined in the theme which tags do what.
11852 * @deprecated use elm_object_text_set() instead.
11854 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11856 * Get the markup text set for the anchorblock
11858 * Retrieves the text set on the anchorblock, with markup tags included.
11860 * @param obj The anchorblock object
11861 * @return The markup text set or @c NULL if nothing was set or an error
11863 * @deprecated use elm_object_text_set() instead.
11865 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11867 * Set the parent of the hover popup
11869 * Sets the parent object to use by the hover created by the anchorblock
11870 * when an anchor is clicked. See @ref Hover for more details on this.
11872 * @param obj The anchorblock object
11873 * @param parent The object to use as parent for the hover
11875 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11877 * Get the parent of the hover popup
11879 * Get the object used as parent for the hover created by the anchorblock
11880 * widget. See @ref Hover for more details on this.
11881 * If no parent is set, the same anchorblock object will be used.
11883 * @param obj The anchorblock object
11884 * @return The object used as parent for the hover, NULL if none is set.
11886 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11888 * Set the style that the hover should use
11890 * When creating the popup hover, anchorblock will request that it's
11891 * themed according to @p style.
11893 * @param obj The anchorblock object
11894 * @param style The style to use for the underlying hover
11896 * @see elm_object_style_set()
11898 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11900 * Get the style that the hover should use
11902 * Get the style the hover created by anchorblock will use.
11904 * @param obj The anchorblock object
11905 * @return The style to use by the hover. NULL means the default is used.
11907 * @see elm_object_style_set()
11909 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11911 * Ends the hover popup in the anchorblock
11913 * When an anchor is clicked, the anchorblock widget will create a hover
11914 * object to use as a popup with user provided content. This function
11915 * terminates this popup, returning the anchorblock to its normal state.
11917 * @param obj The anchorblock object
11919 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11921 * Appends a custom item provider to the given anchorblock
11923 * Appends the given function to the list of items providers. This list is
11924 * called, one function at a time, with the given @p data pointer, the
11925 * anchorblock object and, in the @p item parameter, the item name as
11926 * referenced in its href string. Following functions in the list will be
11927 * called in order until one of them returns something different to NULL,
11928 * which should be an Evas_Object which will be used in place of the item
11931 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11932 * href=item/name\>\</item\>
11934 * @param obj The anchorblock object
11935 * @param func The function to add to the list of providers
11936 * @param data User data that will be passed to the callback function
11938 * @see elm_entry_item_provider_append()
11940 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);
11942 * Prepend a custom item provider to the given anchorblock
11944 * Like elm_anchorblock_item_provider_append(), but it adds the function
11945 * @p func to the beginning of the list, instead of the end.
11947 * @param obj The anchorblock object
11948 * @param func The function to add to the list of providers
11949 * @param data User data that will be passed to the callback function
11951 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);
11953 * Remove a custom item provider from the list of the given anchorblock
11955 * Removes the function and data pairing that matches @p func and @p data.
11956 * That is, unless the same function and same user data are given, the
11957 * function will not be removed from the list. This allows us to add the
11958 * same callback several times, with different @p data pointers and be
11959 * able to remove them later without conflicts.
11961 * @param obj The anchorblock object
11962 * @param func The function to remove from the list
11963 * @param data The data matching the function to remove from the list
11965 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);
11971 * @defgroup Bubble Bubble
11973 * @image html img/widget/bubble/preview-00.png
11974 * @image latex img/widget/bubble/preview-00.eps
11975 * @image html img/widget/bubble/preview-01.png
11976 * @image latex img/widget/bubble/preview-01.eps
11977 * @image html img/widget/bubble/preview-02.png
11978 * @image latex img/widget/bubble/preview-02.eps
11980 * @brief The Bubble is a widget to show text similarly to how speech is
11981 * represented in comics.
11983 * The bubble widget contains 5 important visual elements:
11984 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11985 * @li The @p icon is an image to which the frame's arrow points to.
11986 * @li The @p label is a text which appears to the right of the icon if the
11987 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11989 * @li The @p info is a text which appears to the right of the label. Info's
11990 * font is of a ligther color than label.
11991 * @li The @p content is an evas object that is shown inside the frame.
11993 * The position of the arrow, icon, label and info depends on which corner is
11994 * selected. The four available corners are:
11995 * @li "top_left" - Default
11997 * @li "bottom_left"
11998 * @li "bottom_right"
12000 * Signals that you can add callbacks for are:
12001 * @li "clicked" - This is called when a user has clicked the bubble.
12003 * For an example of using a buble see @ref bubble_01_example_page "this".
12008 * Add a new bubble to the parent
12010 * @param parent The parent object
12011 * @return The new object or NULL if it cannot be created
12013 * This function adds a text bubble to the given parent evas object.
12015 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12017 * Set the label of the bubble
12019 * @param obj The bubble object
12020 * @param label The string to set in the label
12022 * This function sets the title of the bubble. Where this appears depends on
12023 * the selected corner.
12024 * @deprecated use elm_object_text_set() instead.
12026 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12028 * Get the label of the bubble
12030 * @param obj The bubble object
12031 * @return The string of set in the label
12033 * This function gets the title of the bubble.
12034 * @deprecated use elm_object_text_get() instead.
12036 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12038 * Set the info of the bubble
12040 * @param obj The bubble object
12041 * @param info The given info about the bubble
12043 * This function sets the info of the bubble. Where this appears depends on
12044 * the selected corner.
12045 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12047 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12049 * Get the info of the bubble
12051 * @param obj The bubble object
12053 * @return The "info" string of the bubble
12055 * This function gets the info text.
12056 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12058 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12060 * Set the content to be shown in the bubble
12062 * Once the content object is set, a previously set one will be deleted.
12063 * If you want to keep the old content object, use the
12064 * elm_bubble_content_unset() function.
12066 * @param obj The bubble object
12067 * @param content The given content of the bubble
12069 * This function sets the content shown on the middle of the bubble.
12071 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12073 * Get the content shown in the bubble
12075 * Return the content object which is set for this widget.
12077 * @param obj The bubble object
12078 * @return The content that is being used
12080 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12082 * Unset the content shown in the bubble
12084 * Unparent and return the content object which was set for this widget.
12086 * @param obj The bubble object
12087 * @return The content that was being used
12089 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12091 * Set the icon of the bubble
12093 * Once the icon object is set, a previously set one will be deleted.
12094 * If you want to keep the old content object, use the
12095 * elm_icon_content_unset() function.
12097 * @param obj The bubble object
12098 * @param icon The given icon for the bubble
12100 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12102 * Get the icon of the bubble
12104 * @param obj The bubble object
12105 * @return The icon for the bubble
12107 * This function gets the icon shown on the top left of bubble.
12109 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12111 * Unset the icon of the bubble
12113 * Unparent and return the icon object which was set for this widget.
12115 * @param obj The bubble object
12116 * @return The icon that was being used
12118 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12120 * Set the corner of the bubble
12122 * @param obj The bubble object.
12123 * @param corner The given corner for the bubble.
12125 * This function sets the corner of the bubble. The corner will be used to
12126 * determine where the arrow in the frame points to and where label, icon and
12129 * Possible values for corner are:
12130 * @li "top_left" - Default
12132 * @li "bottom_left"
12133 * @li "bottom_right"
12135 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12137 * Get the corner of the bubble
12139 * @param obj The bubble object.
12140 * @return The given corner for the bubble.
12142 * This function gets the selected corner of the bubble.
12144 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12150 * @defgroup Photo Photo
12152 * For displaying the photo of a person (contact). Simple yet
12153 * with a very specific purpose.
12155 * Signals that you can add callbacks for are:
12157 * "clicked" - This is called when a user has clicked the photo
12158 * "drag,start" - Someone started dragging the image out of the object
12159 * "drag,end" - Dragged item was dropped (somewhere)
12165 * Add a new photo to the parent
12167 * @param parent The parent object
12168 * @return The new object or NULL if it cannot be created
12172 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12175 * Set the file that will be used as photo
12177 * @param obj The photo object
12178 * @param file The path to file that will be used as photo
12180 * @return (1 = success, 0 = error)
12184 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12187 * Set the file that will be used as thumbnail in the photo.
12189 * @param obj The photo object.
12190 * @param file The path to file that will be used as thumb.
12191 * @param group The key used in case of an EET file.
12195 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12198 * Set the size that will be used on the photo
12200 * @param obj The photo object
12201 * @param size The size that the photo will be
12205 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12208 * Set if the photo should be completely visible or not.
12210 * @param obj The photo object
12211 * @param fill if true the photo will be completely visible
12215 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12218 * Set editability of the photo.
12220 * An editable photo can be dragged to or from, and can be cut or
12221 * pasted too. Note that pasting an image or dropping an item on
12222 * the image will delete the existing content.
12224 * @param obj The photo object.
12225 * @param set To set of clear editablity.
12227 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12233 /* gesture layer */
12235 * @defgroup Elm_Gesture_Layer Gesture Layer
12236 * Gesture Layer Usage:
12238 * Use Gesture Layer to detect gestures.
12239 * The advantage is that you don't have to implement
12240 * gesture detection, just set callbacks of gesture state.
12241 * By using gesture layer we make standard interface.
12243 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12244 * with a parent object parameter.
12245 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12246 * call. Usually with same object as target (2nd parameter).
12248 * Now you need to tell gesture layer what gestures you follow.
12249 * This is done with @ref elm_gesture_layer_cb_set call.
12250 * By setting the callback you actually saying to gesture layer:
12251 * I would like to know when the gesture @ref Elm_Gesture_Types
12252 * switches to state @ref Elm_Gesture_State.
12254 * Next, you need to implement the actual action that follows the input
12255 * in your callback.
12257 * Note that if you like to stop being reported about a gesture, just set
12258 * all callbacks referring this gesture to NULL.
12259 * (again with @ref elm_gesture_layer_cb_set)
12261 * The information reported by gesture layer to your callback is depending
12262 * on @ref Elm_Gesture_Types:
12263 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12264 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12265 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12267 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12268 * @ref ELM_GESTURE_MOMENTUM.
12270 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12271 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12272 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12273 * Note that we consider a flick as a line-gesture that should be completed
12274 * in flick-time-limit as defined in @ref Config.
12276 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12278 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12281 * Gesture Layer Tweaks:
12283 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12284 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12286 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12287 * so gesture starts when user touches (a *DOWN event) touch-surface
12288 * and ends when no fingers touches surface (a *UP event).
12292 * @enum _Elm_Gesture_Types
12293 * Enum of supported gesture types.
12294 * @ingroup Elm_Gesture_Layer
12296 enum _Elm_Gesture_Types
12298 ELM_GESTURE_FIRST = 0,
12300 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12301 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12302 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12303 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12305 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12307 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12308 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12310 ELM_GESTURE_ZOOM, /**< Zoom */
12311 ELM_GESTURE_ROTATE, /**< Rotate */
12317 * @typedef Elm_Gesture_Types
12318 * gesture types enum
12319 * @ingroup Elm_Gesture_Layer
12321 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12324 * @enum _Elm_Gesture_State
12325 * Enum of gesture states.
12326 * @ingroup Elm_Gesture_Layer
12328 enum _Elm_Gesture_State
12330 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12331 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12332 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12333 ELM_GESTURE_STATE_END, /**< Gesture completed */
12334 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12338 * @typedef Elm_Gesture_State
12339 * gesture states enum
12340 * @ingroup Elm_Gesture_Layer
12342 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12345 * @struct _Elm_Gesture_Taps_Info
12346 * Struct holds taps info for user
12347 * @ingroup Elm_Gesture_Layer
12349 struct _Elm_Gesture_Taps_Info
12351 Evas_Coord x, y; /**< Holds center point between fingers */
12352 unsigned int n; /**< Number of fingers tapped */
12353 unsigned int timestamp; /**< event timestamp */
12357 * @typedef Elm_Gesture_Taps_Info
12358 * holds taps info for user
12359 * @ingroup Elm_Gesture_Layer
12361 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12364 * @struct _Elm_Gesture_Momentum_Info
12365 * Struct holds momentum info for user
12366 * x1 and y1 are not necessarily in sync
12367 * x1 holds x value of x direction starting point
12368 * and same holds for y1.
12369 * This is noticeable when doing V-shape movement
12370 * @ingroup Elm_Gesture_Layer
12372 struct _Elm_Gesture_Momentum_Info
12373 { /* Report line ends, timestamps, and momentum computed */
12374 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12375 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12376 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12377 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12379 unsigned int tx; /**< Timestamp of start of final x-swipe */
12380 unsigned int ty; /**< Timestamp of start of final y-swipe */
12382 Evas_Coord mx; /**< Momentum on X */
12383 Evas_Coord my; /**< Momentum on Y */
12387 * @typedef Elm_Gesture_Momentum_Info
12388 * holds momentum info for user
12389 * @ingroup Elm_Gesture_Layer
12391 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12394 * @struct _Elm_Gesture_Line_Info
12395 * Struct holds line info for user
12396 * @ingroup Elm_Gesture_Layer
12398 struct _Elm_Gesture_Line_Info
12399 { /* Report line ends, timestamps, and momentum computed */
12400 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12401 unsigned int n; /**< Number of fingers (lines) */
12402 /* FIXME should be radians, bot degrees */
12403 double angle; /**< Angle (direction) of lines */
12407 * @typedef Elm_Gesture_Line_Info
12408 * Holds line info for user
12409 * @ingroup Elm_Gesture_Layer
12411 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12414 * @struct _Elm_Gesture_Zoom_Info
12415 * Struct holds zoom info for user
12416 * @ingroup Elm_Gesture_Layer
12418 struct _Elm_Gesture_Zoom_Info
12420 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12421 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12422 double zoom; /**< Zoom value: 1.0 means no zoom */
12423 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12427 * @typedef Elm_Gesture_Zoom_Info
12428 * Holds zoom info for user
12429 * @ingroup Elm_Gesture_Layer
12431 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12434 * @struct _Elm_Gesture_Rotate_Info
12435 * Struct holds rotation info for user
12436 * @ingroup Elm_Gesture_Layer
12438 struct _Elm_Gesture_Rotate_Info
12440 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12441 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12442 double base_angle; /**< Holds start-angle */
12443 double angle; /**< Rotation value: 0.0 means no rotation */
12444 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12448 * @typedef Elm_Gesture_Rotate_Info
12449 * Holds rotation info for user
12450 * @ingroup Elm_Gesture_Layer
12452 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12455 * @typedef Elm_Gesture_Event_Cb
12456 * User callback used to stream gesture info from gesture layer
12457 * @param data user data
12458 * @param event_info gesture report info
12459 * Returns a flag field to be applied on the causing event.
12460 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12461 * upon the event, in an irreversible way.
12463 * @ingroup Elm_Gesture_Layer
12465 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12468 * Use function to set callbacks to be notified about
12469 * change of state of gesture.
12470 * When a user registers a callback with this function
12471 * this means this gesture has to be tested.
12473 * When ALL callbacks for a gesture are set to NULL
12474 * it means user isn't interested in gesture-state
12475 * and it will not be tested.
12477 * @param obj Pointer to gesture-layer.
12478 * @param idx The gesture you would like to track its state.
12479 * @param cb callback function pointer.
12480 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12481 * @param data user info to be sent to callback (usually, Smart Data)
12483 * @ingroup Elm_Gesture_Layer
12485 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);
12488 * Call this function to get repeat-events settings.
12490 * @param obj Pointer to gesture-layer.
12492 * @return repeat events settings.
12493 * @see elm_gesture_layer_hold_events_set()
12494 * @ingroup Elm_Gesture_Layer
12496 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12499 * This function called in order to make gesture-layer repeat events.
12500 * Set this of you like to get the raw events only if gestures were not detected.
12501 * Clear this if you like gesture layer to fwd events as testing gestures.
12503 * @param obj Pointer to gesture-layer.
12504 * @param r Repeat: TRUE/FALSE
12506 * @ingroup Elm_Gesture_Layer
12508 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12511 * This function sets step-value for zoom action.
12512 * Set step to any positive value.
12513 * Cancel step setting by setting to 0.0
12515 * @param obj Pointer to gesture-layer.
12516 * @param s new zoom step value.
12518 * @ingroup Elm_Gesture_Layer
12520 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12523 * This function sets step-value for rotate action.
12524 * Set step to any positive value.
12525 * Cancel step setting by setting to 0.0
12527 * @param obj Pointer to gesture-layer.
12528 * @param s new roatate step value.
12530 * @ingroup Elm_Gesture_Layer
12532 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12535 * This function called to attach gesture-layer to an Evas_Object.
12536 * @param obj Pointer to gesture-layer.
12537 * @param t Pointer to underlying object (AKA Target)
12539 * @return TRUE, FALSE on success, failure.
12541 * @ingroup Elm_Gesture_Layer
12543 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12546 * Call this function to construct a new gesture-layer object.
12547 * This does not activate the gesture layer. You have to
12548 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12550 * @param parent the parent object.
12552 * @return Pointer to new gesture-layer object.
12554 * @ingroup Elm_Gesture_Layer
12556 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12559 * @defgroup Thumb Thumb
12561 * @image html img/widget/thumb/preview-00.png
12562 * @image latex img/widget/thumb/preview-00.eps
12564 * A thumb object is used for displaying the thumbnail of an image or video.
12565 * You must have compiled Elementary with Ethumb_Client support and the DBus
12566 * service must be present and auto-activated in order to have thumbnails to
12569 * Once the thumbnail object becomes visible, it will check if there is a
12570 * previously generated thumbnail image for the file set on it. If not, it
12571 * will start generating this thumbnail.
12573 * Different config settings will cause different thumbnails to be generated
12574 * even on the same file.
12576 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12577 * Ethumb documentation to change this path, and to see other configuration
12580 * Signals that you can add callbacks for are:
12582 * - "clicked" - This is called when a user has clicked the thumb without dragging
12584 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12585 * - "press" - This is called when a user has pressed down the thumb.
12586 * - "generate,start" - The thumbnail generation started.
12587 * - "generate,stop" - The generation process stopped.
12588 * - "generate,error" - The generation failed.
12589 * - "load,error" - The thumbnail image loading failed.
12591 * available styles:
12595 * An example of use of thumbnail:
12597 * - @ref thumb_example_01
12601 * @addtogroup Thumb
12606 * @enum _Elm_Thumb_Animation_Setting
12607 * @typedef Elm_Thumb_Animation_Setting
12609 * Used to set if a video thumbnail is animating or not.
12613 typedef enum _Elm_Thumb_Animation_Setting
12615 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12616 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12617 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12618 ELM_THUMB_ANIMATION_LAST
12619 } Elm_Thumb_Animation_Setting;
12622 * Add a new thumb object to the parent.
12624 * @param parent The parent object.
12625 * @return The new object or NULL if it cannot be created.
12627 * @see elm_thumb_file_set()
12628 * @see elm_thumb_ethumb_client_get()
12632 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12634 * Reload thumbnail if it was generated before.
12636 * @param obj The thumb object to reload
12638 * This is useful if the ethumb client configuration changed, like its
12639 * size, aspect or any other property one set in the handle returned
12640 * by elm_thumb_ethumb_client_get().
12642 * If the options didn't change, the thumbnail won't be generated again, but
12643 * the old one will still be used.
12645 * @see elm_thumb_file_set()
12649 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12651 * Set the file that will be used as thumbnail.
12653 * @param obj The thumb object.
12654 * @param file The path to file that will be used as thumb.
12655 * @param key The key used in case of an EET file.
12657 * The file can be an image or a video (in that case, acceptable extensions are:
12658 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12659 * function elm_thumb_animate().
12661 * @see elm_thumb_file_get()
12662 * @see elm_thumb_reload()
12663 * @see elm_thumb_animate()
12667 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12669 * Get the image or video path and key used to generate the thumbnail.
12671 * @param obj The thumb object.
12672 * @param file Pointer to filename.
12673 * @param key Pointer to key.
12675 * @see elm_thumb_file_set()
12676 * @see elm_thumb_path_get()
12680 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12682 * Get the path and key to the image or video generated by ethumb.
12684 * One just need to make sure that the thumbnail was generated before getting
12685 * its path; otherwise, the path will be NULL. One way to do that is by asking
12686 * for the path when/after the "generate,stop" smart callback is called.
12688 * @param obj The thumb object.
12689 * @param file Pointer to thumb path.
12690 * @param key Pointer to thumb key.
12692 * @see elm_thumb_file_get()
12696 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12698 * Set the animation state for the thumb object. If its content is an animated
12699 * video, you may start/stop the animation or tell it to play continuously and
12702 * @param obj The thumb object.
12703 * @param setting The animation setting.
12705 * @see elm_thumb_file_set()
12709 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12711 * Get the animation state for the thumb object.
12713 * @param obj The thumb object.
12714 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12717 * @see elm_thumb_animate_set()
12721 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12723 * Get the ethumb_client handle so custom configuration can be made.
12725 * @return Ethumb_Client instance or NULL.
12727 * This must be called before the objects are created to be sure no object is
12728 * visible and no generation started.
12730 * Example of usage:
12733 * #include <Elementary.h>
12734 * #ifndef ELM_LIB_QUICKLAUNCH
12736 * elm_main(int argc, char **argv)
12738 * Ethumb_Client *client;
12740 * elm_need_ethumb();
12744 * client = elm_thumb_ethumb_client_get();
12747 * ERR("could not get ethumb_client");
12750 * ethumb_client_size_set(client, 100, 100);
12751 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12754 * // Create elm_thumb objects here
12764 * @note There's only one client handle for Ethumb, so once a configuration
12765 * change is done to it, any other request for thumbnails (for any thumbnail
12766 * object) will use that configuration. Thus, this configuration is global.
12770 EAPI void *elm_thumb_ethumb_client_get(void);
12772 * Get the ethumb_client connection state.
12774 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12777 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12779 * Make the thumbnail 'editable'.
12781 * @param obj Thumb object.
12782 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12784 * This means the thumbnail is a valid drag target for drag and drop, and can be
12785 * cut or pasted too.
12787 * @see elm_thumb_editable_get()
12791 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12793 * Make the thumbnail 'editable'.
12795 * @param obj Thumb object.
12796 * @return Editability.
12798 * This means the thumbnail is a valid drag target for drag and drop, and can be
12799 * cut or pasted too.
12801 * @see elm_thumb_editable_set()
12805 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12812 * @defgroup Hoversel Hoversel
12814 * @image html img/widget/hoversel/preview-00.png
12815 * @image latex img/widget/hoversel/preview-00.eps
12817 * A hoversel is a button that pops up a list of items (automatically
12818 * choosing the direction to display) that have a label and, optionally, an
12819 * icon to select from. It is a convenience widget to avoid the need to do
12820 * all the piecing together yourself. It is intended for a small number of
12821 * items in the hoversel menu (no more than 8), though is capable of many
12824 * Signals that you can add callbacks for are:
12825 * "clicked" - the user clicked the hoversel button and popped up the sel
12826 * "selected" - an item in the hoversel list is selected. event_info is the item
12827 * "dismissed" - the hover is dismissed
12829 * See @ref tutorial_hoversel for an example.
12832 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12834 * @brief Add a new Hoversel object
12836 * @param parent The parent object
12837 * @return The new object or NULL if it cannot be created
12839 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12841 * @brief This sets the hoversel to expand horizontally.
12843 * @param obj The hoversel object
12844 * @param horizontal If true, the hover will expand horizontally to the
12847 * @note The initial button will display horizontally regardless of this
12850 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12852 * @brief This returns whether the hoversel is set to expand horizontally.
12854 * @param obj The hoversel object
12855 * @return If true, the hover will expand horizontally to the right.
12857 * @see elm_hoversel_horizontal_set()
12859 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12861 * @brief Set the Hover parent
12863 * @param obj The hoversel object
12864 * @param parent The parent to use
12866 * Sets the hover parent object, the area that will be darkened when the
12867 * hoversel is clicked. Should probably be the window that the hoversel is
12868 * in. See @ref Hover objects for more information.
12870 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12872 * @brief Get the Hover parent
12874 * @param obj The hoversel object
12875 * @return The used parent
12877 * Gets the hover parent object.
12879 * @see elm_hoversel_hover_parent_set()
12881 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12883 * @brief Set the hoversel button label
12885 * @param obj The hoversel object
12886 * @param label The label text.
12888 * This sets the label of the button that is always visible (before it is
12889 * clicked and expanded).
12891 * @deprecated elm_object_text_set()
12893 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12895 * @brief Get the hoversel button label
12897 * @param obj The hoversel object
12898 * @return The label text.
12900 * @deprecated elm_object_text_get()
12902 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12904 * @brief Set the icon of the hoversel button
12906 * @param obj The hoversel object
12907 * @param icon The icon object
12909 * Sets the icon of the button that is always visible (before it is clicked
12910 * and expanded). Once the icon object is set, a previously set one will be
12911 * deleted, if you want to keep that old content object, use the
12912 * elm_hoversel_icon_unset() function.
12914 * @see elm_button_icon_set()
12916 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12918 * @brief Get the icon of the hoversel button
12920 * @param obj The hoversel object
12921 * @return The icon object
12923 * Get the icon of the button that is always visible (before it is clicked
12924 * and expanded). Also see elm_button_icon_get().
12926 * @see elm_hoversel_icon_set()
12928 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12930 * @brief Get and unparent the icon of the hoversel button
12932 * @param obj The hoversel object
12933 * @return The icon object that was being used
12935 * Unparent and return the icon of the button that is always visible
12936 * (before it is clicked and expanded).
12938 * @see elm_hoversel_icon_set()
12939 * @see elm_button_icon_unset()
12941 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12943 * @brief This triggers the hoversel popup from code, the same as if the user
12944 * had clicked the button.
12946 * @param obj The hoversel object
12948 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12950 * @brief This dismisses the hoversel popup as if the user had clicked
12951 * outside the hover.
12953 * @param obj The hoversel object
12955 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12957 * @brief Returns whether the hoversel is expanded.
12959 * @param obj The hoversel object
12960 * @return This will return EINA_TRUE if the hoversel is expanded or
12961 * EINA_FALSE if it is not expanded.
12963 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12965 * @brief This will remove all the children items from the hoversel.
12967 * @param obj The hoversel object
12969 * @warning Should @b not be called while the hoversel is active; use
12970 * elm_hoversel_expanded_get() to check first.
12972 * @see elm_hoversel_item_del_cb_set()
12973 * @see elm_hoversel_item_del()
12975 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12977 * @brief Get the list of items within the given hoversel.
12979 * @param obj The hoversel object
12980 * @return Returns a list of Elm_Hoversel_Item*
12982 * @see elm_hoversel_item_add()
12984 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12986 * @brief Add an item to the hoversel button
12988 * @param obj The hoversel object
12989 * @param label The text label to use for the item (NULL if not desired)
12990 * @param icon_file An image file path on disk to use for the icon or standard
12991 * icon name (NULL if not desired)
12992 * @param icon_type The icon type if relevant
12993 * @param func Convenience function to call when this item is selected
12994 * @param data Data to pass to item-related functions
12995 * @return A handle to the item added.
12997 * This adds an item to the hoversel to show when it is clicked. Note: if you
12998 * need to use an icon from an edje file then use
12999 * elm_hoversel_item_icon_set() right after the this function, and set
13000 * icon_file to NULL here.
13002 * For more information on what @p icon_file and @p icon_type are see the
13003 * @ref Icon "icon documentation".
13005 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);
13007 * @brief Delete an item from the hoversel
13009 * @param item The item to delete
13011 * This deletes the item from the hoversel (should not be called while the
13012 * hoversel is active; use elm_hoversel_expanded_get() to check first).
13014 * @see elm_hoversel_item_add()
13015 * @see elm_hoversel_item_del_cb_set()
13017 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13019 * @brief Set the function to be called when an item from the hoversel is
13022 * @param item The item to set the callback on
13023 * @param func The function called
13025 * That function will receive these parameters:
13026 * @li void *item_data
13027 * @li Evas_Object *the_item_object
13028 * @li Elm_Hoversel_Item *the_object_struct
13030 * @see elm_hoversel_item_add()
13032 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13034 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13035 * that will be passed to associated function callbacks.
13037 * @param item The item to get the data from
13038 * @return The data pointer set with elm_hoversel_item_add()
13040 * @see elm_hoversel_item_add()
13042 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13044 * @brief This returns the label text of the given hoversel item.
13046 * @param item The item to get the label
13047 * @return The label text of the hoversel item
13049 * @see elm_hoversel_item_add()
13051 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13053 * @brief This sets the icon for the given hoversel item.
13055 * @param item The item to set the icon
13056 * @param icon_file An image file path on disk to use for the icon or standard
13058 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13059 * to NULL if the icon is not an edje file
13060 * @param icon_type The icon type
13062 * The icon can be loaded from the standard set, from an image file, or from
13065 * @see elm_hoversel_item_add()
13067 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);
13069 * @brief Get the icon object of the hoversel item
13071 * @param item The item to get the icon from
13072 * @param icon_file The image file path on disk used for the icon or standard
13074 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13075 * if the icon is not an edje file
13076 * @param icon_type The icon type
13078 * @see elm_hoversel_item_icon_set()
13079 * @see elm_hoversel_item_add()
13081 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);
13087 * @defgroup Toolbar Toolbar
13088 * @ingroup Elementary
13090 * @image html img/widget/toolbar/preview-00.png
13091 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13093 * @image html img/toolbar.png
13094 * @image latex img/toolbar.eps width=\textwidth
13096 * A toolbar is a widget that displays a list of items inside
13097 * a box. It can be scrollable, show a menu with items that don't fit
13098 * to toolbar size or even crop them.
13100 * Only one item can be selected at a time.
13102 * Items can have multiple states, or show menus when selected by the user.
13104 * Smart callbacks one can listen to:
13105 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13107 * Available styles for it:
13109 * - @c "transparent" - no background or shadow, just show the content
13111 * List of examples:
13112 * @li @ref toolbar_example_01
13113 * @li @ref toolbar_example_02
13114 * @li @ref toolbar_example_03
13118 * @addtogroup Toolbar
13123 * @enum _Elm_Toolbar_Shrink_Mode
13124 * @typedef Elm_Toolbar_Shrink_Mode
13126 * Set toolbar's items display behavior, it can be scrollabel,
13127 * show a menu with exceeding items, or simply hide them.
13129 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13132 * Values <b> don't </b> work as bitmask, only one can be choosen.
13134 * @see elm_toolbar_mode_shrink_set()
13135 * @see elm_toolbar_mode_shrink_get()
13139 typedef enum _Elm_Toolbar_Shrink_Mode
13141 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
13142 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
13143 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13144 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
13145 } Elm_Toolbar_Shrink_Mode;
13147 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(). */
13149 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(). */
13152 * Add a new toolbar widget to the given parent Elementary
13153 * (container) object.
13155 * @param parent The parent object.
13156 * @return a new toolbar widget handle or @c NULL, on errors.
13158 * This function inserts a new toolbar widget on the canvas.
13162 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13165 * Set the icon size, in pixels, to be used by toolbar items.
13167 * @param obj The toolbar object
13168 * @param icon_size The icon size in pixels
13170 * @note Default value is @c 32. It reads value from elm config.
13172 * @see elm_toolbar_icon_size_get()
13176 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13179 * Get the icon size, in pixels, to be used by toolbar items.
13181 * @param obj The toolbar object.
13182 * @return The icon size in pixels.
13184 * @see elm_toolbar_icon_size_set() for details.
13188 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13191 * Sets icon lookup order, for toolbar items' icons.
13193 * @param obj The toolbar object.
13194 * @param order The icon lookup order.
13196 * Icons added before calling this function will not be affected.
13197 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13199 * @see elm_toolbar_icon_order_lookup_get()
13203 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13206 * Gets the icon lookup order.
13208 * @param obj The toolbar object.
13209 * @return The icon lookup order.
13211 * @see elm_toolbar_icon_order_lookup_set() for details.
13215 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13218 * Set whether the toolbar items' should be selected by the user or not.
13220 * @param obj The toolbar object.
13221 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13224 * This will turn off the ability to select items entirely and they will
13225 * neither appear selected nor emit selected signals. The clicked
13226 * callback function will still be called.
13228 * Selection is enabled by default.
13230 * @see elm_toolbar_no_select_mode_get().
13234 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13237 * Set whether the toolbar items' should be selected by the user or not.
13239 * @param obj The toolbar object.
13240 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13241 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13243 * @see elm_toolbar_no_select_mode_set() for details.
13247 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13250 * Append item to the toolbar.
13252 * @param obj The toolbar object.
13253 * @param icon A string with icon name or the absolute path of an image file.
13254 * @param label The label of the item.
13255 * @param func The function to call when the item is clicked.
13256 * @param data The data to associate with the item for related callbacks.
13257 * @return The created item or @c NULL upon failure.
13259 * A new item will be created and appended to the toolbar, i.e., will
13260 * be set as @b last item.
13262 * Items created with this method can be deleted with
13263 * elm_toolbar_item_del().
13265 * Associated @p data can be properly freed when item is deleted if a
13266 * callback function is set with elm_toolbar_item_del_cb_set().
13268 * If a function is passed as argument, it will be called everytime this item
13269 * is selected, i.e., the user clicks over an unselected item.
13270 * If such function isn't needed, just passing
13271 * @c NULL as @p func is enough. The same should be done for @p data.
13273 * Toolbar will load icon image from fdo or current theme.
13274 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13275 * If an absolute path is provided it will load it direct from a file.
13277 * @see elm_toolbar_item_icon_set()
13278 * @see elm_toolbar_item_del()
13279 * @see elm_toolbar_item_del_cb_set()
13283 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);
13286 * Prepend item to the toolbar.
13288 * @param obj The toolbar object.
13289 * @param icon A string with icon name or the absolute path of an image file.
13290 * @param label The label of the item.
13291 * @param func The function to call when the item is clicked.
13292 * @param data The data to associate with the item for related callbacks.
13293 * @return The created item or @c NULL upon failure.
13295 * A new item will be created and prepended to the toolbar, i.e., will
13296 * be set as @b first item.
13298 * Items created with this method can be deleted with
13299 * elm_toolbar_item_del().
13301 * Associated @p data can be properly freed when item is deleted if a
13302 * callback function is set with elm_toolbar_item_del_cb_set().
13304 * If a function is passed as argument, it will be called everytime this item
13305 * is selected, i.e., the user clicks over an unselected item.
13306 * If such function isn't needed, just passing
13307 * @c NULL as @p func is enough. The same should be done for @p data.
13309 * Toolbar will load icon image from fdo or current theme.
13310 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13311 * If an absolute path is provided it will load it direct from a file.
13313 * @see elm_toolbar_item_icon_set()
13314 * @see elm_toolbar_item_del()
13315 * @see elm_toolbar_item_del_cb_set()
13319 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);
13322 * Insert a new item into the toolbar object before item @p before.
13324 * @param obj The toolbar object.
13325 * @param before The toolbar item to insert before.
13326 * @param icon A string with icon name or the absolute path of an image file.
13327 * @param label The label of the item.
13328 * @param func The function to call when the item is clicked.
13329 * @param data The data to associate with the item for related callbacks.
13330 * @return The created item or @c NULL upon failure.
13332 * A new item will be created and added to the toolbar. Its position in
13333 * this toolbar will be just before item @p before.
13335 * Items created with this method can be deleted with
13336 * elm_toolbar_item_del().
13338 * Associated @p data can be properly freed when item is deleted if a
13339 * callback function is set with elm_toolbar_item_del_cb_set().
13341 * If a function is passed as argument, it will be called everytime this item
13342 * is selected, i.e., the user clicks over an unselected item.
13343 * If such function isn't needed, just passing
13344 * @c NULL as @p func is enough. The same should be done for @p data.
13346 * Toolbar will load icon image from fdo or current theme.
13347 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13348 * If an absolute path is provided it will load it direct from a file.
13350 * @see elm_toolbar_item_icon_set()
13351 * @see elm_toolbar_item_del()
13352 * @see elm_toolbar_item_del_cb_set()
13356 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);
13359 * Insert a new item into the toolbar object after item @p after.
13361 * @param obj The toolbar object.
13362 * @param before The toolbar item to insert before.
13363 * @param icon A string with icon name or the absolute path of an image file.
13364 * @param label The label of the item.
13365 * @param func The function to call when the item is clicked.
13366 * @param data The data to associate with the item for related callbacks.
13367 * @return The created item or @c NULL upon failure.
13369 * A new item will be created and added to the toolbar. Its position in
13370 * this toolbar will be just after item @p after.
13372 * Items created with this method can be deleted with
13373 * elm_toolbar_item_del().
13375 * Associated @p data can be properly freed when item is deleted if a
13376 * callback function is set with elm_toolbar_item_del_cb_set().
13378 * If a function is passed as argument, it will be called everytime this item
13379 * is selected, i.e., the user clicks over an unselected item.
13380 * If such function isn't needed, just passing
13381 * @c NULL as @p func is enough. The same should be done for @p data.
13383 * Toolbar will load icon image from fdo or current theme.
13384 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13385 * If an absolute path is provided it will load it direct from a file.
13387 * @see elm_toolbar_item_icon_set()
13388 * @see elm_toolbar_item_del()
13389 * @see elm_toolbar_item_del_cb_set()
13393 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);
13396 * Get the first item in the given toolbar widget's list of
13399 * @param obj The toolbar object
13400 * @return The first item or @c NULL, if it has no items (and on
13403 * @see elm_toolbar_item_append()
13404 * @see elm_toolbar_last_item_get()
13408 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13411 * Get the last item in the given toolbar widget's list of
13414 * @param obj The toolbar object
13415 * @return The last item or @c NULL, if it has no items (and on
13418 * @see elm_toolbar_item_prepend()
13419 * @see elm_toolbar_first_item_get()
13423 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13426 * Get the item after @p item in toolbar.
13428 * @param item The toolbar item.
13429 * @return The item after @p item, or @c NULL if none or on failure.
13431 * @note If it is the last item, @c NULL will be returned.
13433 * @see elm_toolbar_item_append()
13437 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13440 * Get the item before @p item in toolbar.
13442 * @param item The toolbar item.
13443 * @return The item before @p item, or @c NULL if none or on failure.
13445 * @note If it is the first item, @c NULL will be returned.
13447 * @see elm_toolbar_item_prepend()
13451 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13454 * Get the toolbar object from an item.
13456 * @param item The item.
13457 * @return The toolbar object.
13459 * This returns the toolbar object itself that an item belongs to.
13463 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13466 * Set the priority of a toolbar item.
13468 * @param item The toolbar item.
13469 * @param priority The item priority. The default is zero.
13471 * This is used only when the toolbar shrink mode is set to
13472 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13473 * When space is less than required, items with low priority
13474 * will be removed from the toolbar and added to a dynamically-created menu,
13475 * while items with higher priority will remain on the toolbar,
13476 * with the same order they were added.
13478 * @see elm_toolbar_item_priority_get()
13482 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13485 * Get the priority of a toolbar item.
13487 * @param item The toolbar item.
13488 * @return The @p item priority, or @c 0 on failure.
13490 * @see elm_toolbar_item_priority_set() for details.
13494 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13497 * Get the label of item.
13499 * @param item The item of toolbar.
13500 * @return The label of item.
13502 * The return value is a pointer to the label associated to @p item when
13503 * it was created, with function elm_toolbar_item_append() or similar,
13505 * with function elm_toolbar_item_label_set. If no label
13506 * was passed as argument, it will return @c NULL.
13508 * @see elm_toolbar_item_label_set() for more details.
13509 * @see elm_toolbar_item_append()
13513 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13516 * Set the label of item.
13518 * @param item The item of toolbar.
13519 * @param text The label of item.
13521 * The label to be displayed by the item.
13522 * Label will be placed at icons bottom (if set).
13524 * If a label was passed as argument on item creation, with function
13525 * elm_toolbar_item_append() or similar, it will be already
13526 * displayed by the item.
13528 * @see elm_toolbar_item_label_get()
13529 * @see elm_toolbar_item_append()
13533 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13536 * Return the data associated with a given toolbar widget item.
13538 * @param item The toolbar widget item handle.
13539 * @return The data associated with @p item.
13541 * @see elm_toolbar_item_data_set()
13545 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13548 * Set the data associated with a given toolbar widget item.
13550 * @param item The toolbar widget item handle.
13551 * @param data The new data pointer to set to @p item.
13553 * This sets new item data on @p item.
13555 * @warning The old data pointer won't be touched by this function, so
13556 * the user had better to free that old data himself/herself.
13560 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13563 * Returns a pointer to a toolbar item by its label.
13565 * @param obj The toolbar object.
13566 * @param label The label of the item to find.
13568 * @return The pointer to the toolbar item matching @p label or @c NULL
13573 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13576 * Get whether the @p item is selected or not.
13578 * @param item The toolbar item.
13579 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13580 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13582 * @see elm_toolbar_selected_item_set() for details.
13583 * @see elm_toolbar_item_selected_get()
13587 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13590 * Set the selected state of an item.
13592 * @param item The toolbar item
13593 * @param selected The selected state
13595 * This sets the selected state of the given item @p it.
13596 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13598 * If a new item is selected the previosly selected will be unselected.
13599 * Previoulsy selected item can be get with function
13600 * elm_toolbar_selected_item_get().
13602 * Selected items will be highlighted.
13604 * @see elm_toolbar_item_selected_get()
13605 * @see elm_toolbar_selected_item_get()
13609 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13612 * Get the selected item.
13614 * @param obj The toolbar object.
13615 * @return The selected toolbar item.
13617 * The selected item can be unselected with function
13618 * elm_toolbar_item_selected_set().
13620 * The selected item always will be highlighted on toolbar.
13622 * @see elm_toolbar_selected_items_get()
13626 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13629 * Set the icon associated with @p item.
13631 * @param obj The parent of this item.
13632 * @param item The toolbar item.
13633 * @param icon A string with icon name or the absolute path of an image file.
13635 * Toolbar will load icon image from fdo or current theme.
13636 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13637 * If an absolute path is provided it will load it direct from a file.
13639 * @see elm_toolbar_icon_order_lookup_set()
13640 * @see elm_toolbar_icon_order_lookup_get()
13644 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13647 * Get the string used to set the icon of @p item.
13649 * @param item The toolbar item.
13650 * @return The string associated with the icon object.
13652 * @see elm_toolbar_item_icon_set() for details.
13656 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13659 * Delete them item from the toolbar.
13661 * @param item The item of toolbar to be deleted.
13663 * @see elm_toolbar_item_append()
13664 * @see elm_toolbar_item_del_cb_set()
13668 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13671 * Set the function called when a toolbar item is freed.
13673 * @param item The item to set the callback on.
13674 * @param func The function called.
13676 * If there is a @p func, then it will be called prior item's memory release.
13677 * That will be called with the following arguments:
13679 * @li item's Evas object;
13682 * This way, a data associated to a toolbar item could be properly freed.
13686 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13689 * Get a value whether toolbar item is disabled or not.
13691 * @param item The item.
13692 * @return The disabled state.
13694 * @see elm_toolbar_item_disabled_set() for more details.
13698 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13701 * Sets the disabled/enabled state of a toolbar item.
13703 * @param item The item.
13704 * @param disabled The disabled state.
13706 * A disabled item cannot be selected or unselected. It will also
13707 * change its appearance (generally greyed out). This sets the
13708 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13713 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13716 * Set or unset item as a separator.
13718 * @param item The toolbar item.
13719 * @param setting @c EINA_TRUE to set item @p item as separator or
13720 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13722 * Items aren't set as separator by default.
13724 * If set as separator it will display separator theme, so won't display
13727 * @see elm_toolbar_item_separator_get()
13731 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13734 * Get a value whether item is a separator or not.
13736 * @param item The toolbar item.
13737 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13738 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13740 * @see elm_toolbar_item_separator_set() for details.
13744 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13747 * Set the shrink state of toolbar @p obj.
13749 * @param obj The toolbar object.
13750 * @param shrink_mode Toolbar's items display behavior.
13752 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13753 * but will enforce a minimun size so all the items will fit, won't scroll
13754 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13755 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13756 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13760 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13763 * Get the shrink mode of toolbar @p obj.
13765 * @param obj The toolbar object.
13766 * @return Toolbar's items display behavior.
13768 * @see elm_toolbar_mode_shrink_set() for details.
13772 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13775 * Enable/disable homogenous mode.
13777 * @param obj The toolbar object
13778 * @param homogeneous Assume the items within the toolbar are of the
13779 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13781 * This will enable the homogeneous mode where items are of the same size.
13782 * @see elm_toolbar_homogeneous_get()
13786 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13789 * Get whether the homogenous mode is enabled.
13791 * @param obj The toolbar object.
13792 * @return Assume the items within the toolbar are of the same height
13793 * and width (EINA_TRUE = on, EINA_FALSE = off).
13795 * @see elm_toolbar_homogeneous_set()
13799 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13802 * Enable/disable homogenous mode.
13804 * @param obj The toolbar object
13805 * @param homogeneous Assume the items within the toolbar are of the
13806 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13808 * This will enable the homogeneous mode where items are of the same size.
13809 * @see elm_toolbar_homogeneous_get()
13811 * @deprecated use elm_toolbar_homogeneous_set() instead.
13815 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13818 * Get whether the homogenous mode is enabled.
13820 * @param obj The toolbar object.
13821 * @return Assume the items within the toolbar are of the same height
13822 * and width (EINA_TRUE = on, EINA_FALSE = off).
13824 * @see elm_toolbar_homogeneous_set()
13825 * @deprecated use elm_toolbar_homogeneous_get() instead.
13829 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13832 * Set the parent object of the toolbar items' menus.
13834 * @param obj The toolbar object.
13835 * @param parent The parent of the menu objects.
13837 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13839 * For more details about setting the parent for toolbar menus, see
13840 * elm_menu_parent_set().
13842 * @see elm_menu_parent_set() for details.
13843 * @see elm_toolbar_item_menu_set() for details.
13847 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13850 * Get the parent object of the toolbar items' menus.
13852 * @param obj The toolbar object.
13853 * @return The parent of the menu objects.
13855 * @see elm_toolbar_menu_parent_set() for details.
13859 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13862 * Set the alignment of the items.
13864 * @param obj The toolbar object.
13865 * @param align The new alignment, a float between <tt> 0.0 </tt>
13866 * and <tt> 1.0 </tt>.
13868 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13869 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13872 * Centered items by default.
13874 * @see elm_toolbar_align_get()
13878 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13881 * Get the alignment of the items.
13883 * @param obj The toolbar object.
13884 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13887 * @see elm_toolbar_align_set() for details.
13891 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13894 * Set whether the toolbar item opens a menu.
13896 * @param item The toolbar item.
13897 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13899 * A toolbar item can be set to be a menu, using this function.
13901 * Once it is set to be a menu, it can be manipulated through the
13902 * menu-like function elm_toolbar_menu_parent_set() and the other
13903 * elm_menu functions, using the Evas_Object @c menu returned by
13904 * elm_toolbar_item_menu_get().
13906 * So, items to be displayed in this item's menu should be added with
13907 * elm_menu_item_add().
13909 * The following code exemplifies the most basic usage:
13911 * tb = elm_toolbar_add(win)
13912 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13913 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13914 * elm_toolbar_menu_parent_set(tb, win);
13915 * menu = elm_toolbar_item_menu_get(item);
13916 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13917 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13921 * @see elm_toolbar_item_menu_get()
13925 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13928 * Get toolbar item's menu.
13930 * @param item The toolbar item.
13931 * @return Item's menu object or @c NULL on failure.
13933 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13934 * this function will set it.
13936 * @see elm_toolbar_item_menu_set() for details.
13940 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13943 * Add a new state to @p item.
13945 * @param item The item.
13946 * @param icon A string with icon name or the absolute path of an image file.
13947 * @param label The label of the new state.
13948 * @param func The function to call when the item is clicked when this
13949 * state is selected.
13950 * @param data The data to associate with the state.
13951 * @return The toolbar item state, or @c NULL upon failure.
13953 * Toolbar will load icon image from fdo or current theme.
13954 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13955 * If an absolute path is provided it will load it direct from a file.
13957 * States created with this function can be removed with
13958 * elm_toolbar_item_state_del().
13960 * @see elm_toolbar_item_state_del()
13961 * @see elm_toolbar_item_state_sel()
13962 * @see elm_toolbar_item_state_get()
13966 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);
13969 * Delete a previoulsy added state to @p item.
13971 * @param item The toolbar item.
13972 * @param state The state to be deleted.
13973 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13975 * @see elm_toolbar_item_state_add()
13977 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13980 * Set @p state as the current state of @p it.
13982 * @param it The item.
13983 * @param state The state to use.
13984 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13986 * If @p state is @c NULL, it won't select any state and the default item's
13987 * icon and label will be used. It's the same behaviour than
13988 * elm_toolbar_item_state_unser().
13990 * @see elm_toolbar_item_state_unset()
13994 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13997 * Unset the state of @p it.
13999 * @param it The item.
14001 * The default icon and label from this item will be displayed.
14003 * @see elm_toolbar_item_state_set() for more details.
14007 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14010 * Get the current state of @p it.
14012 * @param item The item.
14013 * @return The selected state or @c NULL if none is selected or on failure.
14015 * @see elm_toolbar_item_state_set() for details.
14016 * @see elm_toolbar_item_state_unset()
14017 * @see elm_toolbar_item_state_add()
14021 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14024 * Get the state after selected state in toolbar's @p item.
14026 * @param it The toolbar item to change state.
14027 * @return The state after current state, or @c NULL on failure.
14029 * If last state is selected, this function will return first state.
14031 * @see elm_toolbar_item_state_set()
14032 * @see elm_toolbar_item_state_add()
14036 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14039 * Get the state before selected state in toolbar's @p item.
14041 * @param it The toolbar item to change state.
14042 * @return The state before current state, or @c NULL on failure.
14044 * If first state is selected, this function will return last state.
14046 * @see elm_toolbar_item_state_set()
14047 * @see elm_toolbar_item_state_add()
14051 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14054 * Set the text to be shown in a given toolbar item's tooltips.
14056 * @param item Target item.
14057 * @param text The text to set in the content.
14059 * Setup the text as tooltip to object. The item can have only one tooltip,
14060 * so any previous tooltip data - set with this function or
14061 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14063 * @see elm_object_tooltip_text_set() for more details.
14067 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14070 * Set the content to be shown in the tooltip item.
14072 * Setup the tooltip to item. The item can have only one tooltip,
14073 * so any previous tooltip data is removed. @p func(with @p data) will
14074 * be called every time that need show the tooltip and it should
14075 * return a valid Evas_Object. This object is then managed fully by
14076 * tooltip system and is deleted when the tooltip is gone.
14078 * @param item the toolbar item being attached a tooltip.
14079 * @param func the function used to create the tooltip contents.
14080 * @param data what to provide to @a func as callback data/context.
14081 * @param del_cb called when data is not needed anymore, either when
14082 * another callback replaces @a func, the tooltip is unset with
14083 * elm_toolbar_item_tooltip_unset() or the owner @a item
14084 * dies. This callback receives as the first parameter the
14085 * given @a data, and @c event_info is the item.
14087 * @see elm_object_tooltip_content_cb_set() for more details.
14091 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);
14094 * Unset tooltip from item.
14096 * @param item toolbar item to remove previously set tooltip.
14098 * Remove tooltip from item. The callback provided as del_cb to
14099 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14100 * it is not used anymore.
14102 * @see elm_object_tooltip_unset() for more details.
14103 * @see elm_toolbar_item_tooltip_content_cb_set()
14107 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14110 * Sets a different style for this item tooltip.
14112 * @note before you set a style you should define a tooltip with
14113 * elm_toolbar_item_tooltip_content_cb_set() or
14114 * elm_toolbar_item_tooltip_text_set()
14116 * @param item toolbar item with tooltip already set.
14117 * @param style the theme style to use (default, transparent, ...)
14119 * @see elm_object_tooltip_style_set() for more details.
14123 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14126 * Get the style for this item tooltip.
14128 * @param item toolbar item with tooltip already set.
14129 * @return style the theme style in use, defaults to "default". If the
14130 * object does not have a tooltip set, then NULL is returned.
14132 * @see elm_object_tooltip_style_get() for more details.
14133 * @see elm_toolbar_item_tooltip_style_set()
14137 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14140 * Set the type of mouse pointer/cursor decoration to be shown,
14141 * when the mouse pointer is over the given toolbar widget item
14143 * @param item toolbar item to customize cursor on
14144 * @param cursor the cursor type's name
14146 * This function works analogously as elm_object_cursor_set(), but
14147 * here the cursor's changing area is restricted to the item's
14148 * area, and not the whole widget's. Note that that item cursors
14149 * have precedence over widget cursors, so that a mouse over an
14150 * item with custom cursor set will always show @b that cursor.
14152 * If this function is called twice for an object, a previously set
14153 * cursor will be unset on the second call.
14155 * @see elm_object_cursor_set()
14156 * @see elm_toolbar_item_cursor_get()
14157 * @see elm_toolbar_item_cursor_unset()
14161 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14164 * Get the type of mouse pointer/cursor decoration set to be shown,
14165 * when the mouse pointer is over the given toolbar widget item
14167 * @param item toolbar item with custom cursor set
14168 * @return the cursor type's name or @c NULL, if no custom cursors
14169 * were set to @p item (and on errors)
14171 * @see elm_object_cursor_get()
14172 * @see elm_toolbar_item_cursor_set()
14173 * @see elm_toolbar_item_cursor_unset()
14177 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14180 * Unset any custom mouse pointer/cursor decoration set to be
14181 * shown, when the mouse pointer is over the given toolbar widget
14182 * item, thus making it show the @b default cursor again.
14184 * @param item a toolbar item
14186 * Use this call to undo any custom settings on this item's cursor
14187 * decoration, bringing it back to defaults (no custom style set).
14189 * @see elm_object_cursor_unset()
14190 * @see elm_toolbar_item_cursor_set()
14194 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14197 * Set a different @b style for a given custom cursor set for a
14200 * @param item toolbar item with custom cursor set
14201 * @param style the <b>theme style</b> to use (e.g. @c "default",
14202 * @c "transparent", etc)
14204 * This function only makes sense when one is using custom mouse
14205 * cursor decorations <b>defined in a theme file</b>, which can have,
14206 * given a cursor name/type, <b>alternate styles</b> on it. It
14207 * works analogously as elm_object_cursor_style_set(), but here
14208 * applyed only to toolbar item objects.
14210 * @warning Before you set a cursor style you should have definen a
14211 * custom cursor previously on the item, with
14212 * elm_toolbar_item_cursor_set()
14214 * @see elm_toolbar_item_cursor_engine_only_set()
14215 * @see elm_toolbar_item_cursor_style_get()
14219 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14222 * Get the current @b style set for a given toolbar item's custom
14225 * @param item toolbar item with custom cursor set.
14226 * @return style the cursor style in use. If the object does not
14227 * have a cursor set, then @c NULL is returned.
14229 * @see elm_toolbar_item_cursor_style_set() for more details
14233 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14236 * Set if the (custom)cursor for a given toolbar item should be
14237 * searched in its theme, also, or should only rely on the
14238 * rendering engine.
14240 * @param item item with custom (custom) cursor already set on
14241 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14242 * only on those provided by the rendering engine, @c EINA_FALSE to
14243 * have them searched on the widget's theme, as well.
14245 * @note This call is of use only if you've set a custom cursor
14246 * for toolbar items, with elm_toolbar_item_cursor_set().
14248 * @note By default, cursors will only be looked for between those
14249 * provided by the rendering engine.
14253 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14256 * Get if the (custom) cursor for a given toolbar item is being
14257 * searched in its theme, also, or is only relying on the rendering
14260 * @param item a toolbar item
14261 * @return @c EINA_TRUE, if cursors are being looked for only on
14262 * those provided by the rendering engine, @c EINA_FALSE if they
14263 * are being searched on the widget's theme, as well.
14265 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14269 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14272 * Change a toolbar's orientation
14273 * @param obj The toolbar object
14274 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14275 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14278 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14281 * Get a toolbar's orientation
14282 * @param obj The toolbar object
14283 * @return If @c EINA_TRUE, the toolbar is vertical
14284 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14287 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14294 * @defgroup Tooltips Tooltips
14296 * The Tooltip is an (internal, for now) smart object used to show a
14297 * content in a frame on mouse hover of objects(or widgets), with
14298 * tips/information about them.
14303 EAPI double elm_tooltip_delay_get(void);
14304 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14305 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14306 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14307 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14308 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);
14309 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14310 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14311 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14312 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14313 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14320 * @defgroup Cursors Cursors
14322 * The Elementary cursor is an internal smart object used to
14323 * customize the mouse cursor displayed over objects (or
14324 * widgets). In the most common scenario, the cursor decoration
14325 * comes from the graphical @b engine Elementary is running
14326 * on. Those engines may provide different decorations for cursors,
14327 * and Elementary provides functions to choose them (think of X11
14328 * cursors, as an example).
14330 * There's also the possibility of, besides using engine provided
14331 * cursors, also use ones coming from Edje theming files. Both
14332 * globally and per widget, Elementary makes it possible for one to
14333 * make the cursors lookup to be held on engines only or on
14334 * Elementary's theme file, too.
14340 * Set the cursor to be shown when mouse is over the object
14342 * Set the cursor that will be displayed when mouse is over the
14343 * object. The object can have only one cursor set to it, so if
14344 * this function is called twice for an object, the previous set
14346 * If using X cursors, a definition of all the valid cursor names
14347 * is listed on Elementary_Cursors.h. If an invalid name is set
14348 * the default cursor will be used.
14350 * @param obj the object being set a cursor.
14351 * @param cursor the cursor name to be used.
14355 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14358 * Get the cursor to be shown when mouse is over the object
14360 * @param obj an object with cursor already set.
14361 * @return the cursor name.
14365 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14368 * Unset cursor for object
14370 * Unset cursor for object, and set the cursor to default if the mouse
14371 * was over this object.
14373 * @param obj Target object
14374 * @see elm_object_cursor_set()
14378 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14381 * Sets a different style for this object cursor.
14383 * @note before you set a style you should define a cursor with
14384 * elm_object_cursor_set()
14386 * @param obj an object with cursor already set.
14387 * @param style the theme style to use (default, transparent, ...)
14391 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14394 * Get the style for this object cursor.
14396 * @param obj an object with cursor already set.
14397 * @return style the theme style in use, defaults to "default". If the
14398 * object does not have a cursor set, then NULL is returned.
14402 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14405 * Set if the cursor set should be searched on the theme or should use
14406 * the provided by the engine, only.
14408 * @note before you set if should look on theme you should define a cursor
14409 * with elm_object_cursor_set(). By default it will only look for cursors
14410 * provided by the engine.
14412 * @param obj an object with cursor already set.
14413 * @param engine_only boolean to define it cursors should be looked only
14414 * between the provided by the engine or searched on widget's theme as well.
14418 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14421 * Get the cursor engine only usage for this object cursor.
14423 * @param obj an object with cursor already set.
14424 * @return engine_only boolean to define it cursors should be
14425 * looked only between the provided by the engine or searched on
14426 * widget's theme as well. If the object does not have a cursor
14427 * set, then EINA_FALSE is returned.
14431 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14434 * Get the configured cursor engine only usage
14436 * This gets the globally configured exclusive usage of engine cursors.
14438 * @return 1 if only engine cursors should be used
14441 EAPI int elm_cursor_engine_only_get(void);
14444 * Set the configured cursor engine only usage
14446 * This sets the globally configured exclusive usage of engine cursors.
14447 * It won't affect cursors set before changing this value.
14449 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14450 * look for them on theme before.
14451 * @return EINA_TRUE if value is valid and setted (0 or 1)
14454 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14461 * @defgroup Menu Menu
14463 * @image html img/widget/menu/preview-00.png
14464 * @image latex img/widget/menu/preview-00.eps
14466 * A menu is a list of items displayed above its parent. When the menu is
14467 * showing its parent is darkened. Each item can have a sub-menu. The menu
14468 * object can be used to display a menu on a right click event, in a toolbar,
14471 * Signals that you can add callbacks for are:
14472 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14473 * event_info is NULL.
14475 * @see @ref tutorial_menu
14478 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14480 * @brief Add a new menu to the parent
14482 * @param parent The parent object.
14483 * @return The new object or NULL if it cannot be created.
14485 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14487 * @brief Set the parent for the given menu widget
14489 * @param obj The menu object.
14490 * @param parent The new parent.
14492 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14494 * @brief Get the parent for the given menu widget
14496 * @param obj The menu object.
14497 * @return The parent.
14499 * @see elm_menu_parent_set()
14501 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14503 * @brief Move the menu to a new position
14505 * @param obj The menu object.
14506 * @param x The new position.
14507 * @param y The new position.
14509 * Sets the top-left position of the menu to (@p x,@p y).
14511 * @note @p x and @p y coordinates are relative to parent.
14513 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14515 * @brief Close a opened menu
14517 * @param obj the menu object
14520 * Hides the menu and all it's sub-menus.
14522 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14524 * @brief Returns a list of @p item's items.
14526 * @param obj The menu object
14527 * @return An Eina_List* of @p item's items
14529 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14531 * @brief Get the Evas_Object of an Elm_Menu_Item
14533 * @param item The menu item object.
14534 * @return The edje object containing the swallowed content
14536 * @warning Don't manipulate this object!
14538 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14540 * @brief Add an item at the end of the given menu widget
14542 * @param obj The menu object.
14543 * @param parent The parent menu item (optional)
14544 * @param icon A icon display on the item. The icon will be destryed by the menu.
14545 * @param label The label of the item.
14546 * @param func Function called when the user select the item.
14547 * @param data Data sent by the callback.
14548 * @return Returns the new item.
14550 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);
14552 * @brief Add an object swallowed in an item at the end of the given menu
14555 * @param obj The menu object.
14556 * @param parent The parent menu item (optional)
14557 * @param subobj The object to swallow
14558 * @param func Function called when the user select the item.
14559 * @param data Data sent by the callback.
14560 * @return Returns the new item.
14562 * Add an evas object as an item to the menu.
14564 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);
14566 * @brief Set the label of a menu item
14568 * @param item The menu item object.
14569 * @param label The label to set for @p item
14571 * @warning Don't use this funcion on items created with
14572 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14574 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14576 * @brief Get the label of a menu item
14578 * @param item The menu item object.
14579 * @return The label of @p item
14581 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14583 * @brief Set the icon of a menu item to the standard icon with name @p icon
14585 * @param item The menu item object.
14586 * @param icon The icon object to set for the content of @p item
14588 * Once this icon is set, any previously set icon will be deleted.
14590 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14592 * @brief Get the string representation from the icon of a menu item
14594 * @param item The menu item object.
14595 * @return The string representation of @p item's icon or NULL
14597 * @see elm_menu_item_object_icon_name_set()
14599 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14601 * @brief Set the content object of a menu item
14603 * @param item The menu item object
14604 * @param The content object or NULL
14605 * @return EINA_TRUE on success, else EINA_FALSE
14607 * Use this function to change the object swallowed by a menu item, deleting
14608 * any previously swallowed object.
14610 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14612 * @brief Get the content object of a menu item
14614 * @param item The menu item object
14615 * @return The content object or NULL
14616 * @note If @p item was added with elm_menu_item_add_object, this
14617 * function will return the object passed, else it will return the
14620 * @see elm_menu_item_object_content_set()
14622 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14624 * @brief Set the selected state of @p item.
14626 * @param item The menu item object.
14627 * @param selected The selected/unselected state of the item
14629 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14631 * @brief Get the selected state of @p item.
14633 * @param item The menu item object.
14634 * @return The selected/unselected state of the item
14636 * @see elm_menu_item_selected_set()
14638 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14640 * @brief Set the disabled state of @p item.
14642 * @param item The menu item object.
14643 * @param disabled The enabled/disabled state of the item
14645 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14647 * @brief Get the disabled state of @p item.
14649 * @param item The menu item object.
14650 * @return The enabled/disabled state of the item
14652 * @see elm_menu_item_disabled_set()
14654 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14656 * @brief Add a separator item to menu @p obj under @p parent.
14658 * @param obj The menu object
14659 * @param parent The item to add the separator under
14660 * @return The created item or NULL on failure
14662 * This is item is a @ref Separator.
14664 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14666 * @brief Returns whether @p item is a separator.
14668 * @param item The item to check
14669 * @return If true, @p item is a separator
14671 * @see elm_menu_item_separator_add()
14673 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14675 * @brief Deletes an item from the menu.
14677 * @param item The item to delete.
14679 * @see elm_menu_item_add()
14681 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14683 * @brief Set the function called when a menu item is deleted.
14685 * @param item The item to set the callback on
14686 * @param func The function called
14688 * @see elm_menu_item_add()
14689 * @see elm_menu_item_del()
14691 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14693 * @brief Returns the data associated with menu item @p item.
14695 * @param item The item
14696 * @return The data associated with @p item or NULL if none was set.
14698 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14700 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14702 * @brief Sets the data to be associated with menu item @p item.
14704 * @param item The item
14705 * @param data The data to be associated with @p item
14707 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14709 * @brief Returns a list of @p item's subitems.
14711 * @param item The item
14712 * @return An Eina_List* of @p item's subitems
14714 * @see elm_menu_add()
14716 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14718 * @brief Get the position of a menu item
14720 * @param item The menu item
14721 * @return The item's index
14723 * This function returns the index position of a menu item in a menu.
14724 * For a sub-menu, this number is relative to the first item in the sub-menu.
14726 * @note Index values begin with 0
14728 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14730 * @brief @brief Return a menu item's owner menu
14732 * @param item The menu item
14733 * @return The menu object owning @p item, or NULL on failure
14735 * Use this function to get the menu object owning an item.
14737 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14739 * @brief Get the selected item in the menu
14741 * @param obj The menu object
14742 * @return The selected item, or NULL if none
14744 * @see elm_menu_item_selected_get()
14745 * @see elm_menu_item_selected_set()
14747 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14749 * @brief Get the last item in the menu
14751 * @param obj The menu object
14752 * @return The last item, or NULL if none
14754 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14756 * @brief Get the first item in the menu
14758 * @param obj The menu object
14759 * @return The first item, or NULL if none
14761 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14763 * @brief Get the next item in the menu.
14765 * @param item The menu item object.
14766 * @return The item after it, or NULL if none
14768 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14770 * @brief Get the previous item in the menu.
14772 * @param item The menu item object.
14773 * @return The item before it, or NULL if none
14775 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14781 * @defgroup List List
14782 * @ingroup Elementary
14784 * @image html img/widget/list/preview-00.png
14785 * @image latex img/widget/list/preview-00.eps width=\textwidth
14787 * @image html img/list.png
14788 * @image latex img/list.eps width=\textwidth
14790 * A list widget is a container whose children are displayed vertically or
14791 * horizontally, in order, and can be selected.
14792 * The list can accept only one or multiple items selection. Also has many
14793 * modes of items displaying.
14795 * A list is a very simple type of list widget. For more robust
14796 * lists, @ref Genlist should probably be used.
14798 * Smart callbacks one can listen to:
14799 * - @c "activated" - The user has double-clicked or pressed
14800 * (enter|return|spacebar) on an item. The @c event_info parameter
14801 * is the item that was activated.
14802 * - @c "clicked,double" - The user has double-clicked an item.
14803 * The @c event_info parameter is the item that was double-clicked.
14804 * - "selected" - when the user selected an item
14805 * - "unselected" - when the user unselected an item
14806 * - "longpressed" - an item in the list is long-pressed
14807 * - "scroll,edge,top" - the list is scrolled until the top edge
14808 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14809 * - "scroll,edge,left" - the list is scrolled until the left edge
14810 * - "scroll,edge,right" - the list is scrolled until the right edge
14812 * Available styles for it:
14815 * List of examples:
14816 * @li @ref list_example_01
14817 * @li @ref list_example_02
14818 * @li @ref list_example_03
14827 * @enum _Elm_List_Mode
14828 * @typedef Elm_List_Mode
14830 * Set list's resize behavior, transverse axis scroll and
14831 * items cropping. See each mode's description for more details.
14833 * @note Default value is #ELM_LIST_SCROLL.
14835 * Values <b> don't </b> work as bitmask, only one can be choosen.
14837 * @see elm_list_mode_set()
14838 * @see elm_list_mode_get()
14842 typedef enum _Elm_List_Mode
14844 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. */
14845 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). */
14846 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. */
14847 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. */
14848 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14851 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(). */
14854 * Add a new list widget to the given parent Elementary
14855 * (container) object.
14857 * @param parent The parent object.
14858 * @return a new list widget handle or @c NULL, on errors.
14860 * This function inserts a new list widget on the canvas.
14864 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14869 * @param obj The list object
14871 * @note Call before running show() on the list object.
14872 * @warning If not called, it won't display the list properly.
14875 * li = elm_list_add(win);
14876 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14877 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14879 * evas_object_show(li);
14884 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14887 * Enable or disable multiple items selection on the list object.
14889 * @param obj The list object
14890 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14893 * Disabled by default. If disabled, the user can select a single item of
14894 * the list each time. Selected items are highlighted on list.
14895 * If enabled, many items can be selected.
14897 * If a selected item is selected again, it will be unselected.
14899 * @see elm_list_multi_select_get()
14903 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14906 * Get a value whether multiple items selection is enabled or not.
14908 * @see elm_list_multi_select_set() for details.
14910 * @param obj The list object.
14911 * @return @c EINA_TRUE means multiple items selection is enabled.
14912 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14913 * @c EINA_FALSE is returned.
14917 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14920 * Set which mode to use for the list object.
14922 * @param obj The list object
14923 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14924 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14926 * Set list's resize behavior, transverse axis scroll and
14927 * items cropping. See each mode's description for more details.
14929 * @note Default value is #ELM_LIST_SCROLL.
14931 * Only one can be set, if a previous one was set, it will be changed
14932 * by the new mode set. Bitmask won't work as well.
14934 * @see elm_list_mode_get()
14938 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14941 * Get the mode the list is at.
14943 * @param obj The list object
14944 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14945 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14947 * @note see elm_list_mode_set() for more information.
14951 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14954 * Enable or disable horizontal mode on the list object.
14956 * @param obj The list object.
14957 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14958 * disable it, i.e., to enable vertical mode.
14960 * @note Vertical mode is set by default.
14962 * On horizontal mode items are displayed on list from left to right,
14963 * instead of from top to bottom. Also, the list will scroll horizontally.
14964 * Each item will presents left icon on top and right icon, or end, at
14967 * @see elm_list_horizontal_get()
14971 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14974 * Get a value whether horizontal mode is enabled or not.
14976 * @param obj The list object.
14977 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14978 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14979 * @c EINA_FALSE is returned.
14981 * @see elm_list_horizontal_set() for details.
14985 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14988 * Enable or disable always select mode on the list object.
14990 * @param obj The list object
14991 * @param always_select @c EINA_TRUE to enable always select mode or
14992 * @c EINA_FALSE to disable it.
14994 * @note Always select mode is disabled by default.
14996 * Default behavior of list items is to only call its callback function
14997 * the first time it's pressed, i.e., when it is selected. If a selected
14998 * item is pressed again, and multi-select is disabled, it won't call
14999 * this function (if multi-select is enabled it will unselect the item).
15001 * If always select is enabled, it will call the callback function
15002 * everytime a item is pressed, so it will call when the item is selected,
15003 * and again when a selected item is pressed.
15005 * @see elm_list_always_select_mode_get()
15006 * @see elm_list_multi_select_set()
15010 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15013 * Get a value whether always select mode is enabled or not, meaning that
15014 * an item will always call its callback function, even if already selected.
15016 * @param obj The list object
15017 * @return @c EINA_TRUE means horizontal mode selection is enabled.
15018 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15019 * @c EINA_FALSE is returned.
15021 * @see elm_list_always_select_mode_set() for details.
15025 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15028 * Set bouncing behaviour when the scrolled content reaches an edge.
15030 * Tell the internal scroller object whether it should bounce or not
15031 * when it reaches the respective edges for each axis.
15033 * @param obj The list object
15034 * @param h_bounce Whether to bounce or not in the horizontal axis.
15035 * @param v_bounce Whether to bounce or not in the vertical axis.
15037 * @see elm_scroller_bounce_set()
15041 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15044 * Get the bouncing behaviour of the internal scroller.
15046 * Get whether the internal scroller should bounce when the edge of each
15047 * axis is reached scrolling.
15049 * @param obj The list object.
15050 * @param h_bounce Pointer where to store the bounce state of the horizontal
15052 * @param v_bounce Pointer where to store the bounce state of the vertical
15055 * @see elm_scroller_bounce_get()
15056 * @see elm_list_bounce_set()
15060 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15063 * Set the scrollbar policy.
15065 * @param obj The list object
15066 * @param policy_h Horizontal scrollbar policy.
15067 * @param policy_v Vertical scrollbar policy.
15069 * This sets the scrollbar visibility policy for the given scroller.
15070 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15071 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15072 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15073 * This applies respectively for the horizontal and vertical scrollbars.
15075 * The both are disabled by default, i.e., are set to
15076 * #ELM_SCROLLER_POLICY_OFF.
15080 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15083 * Get the scrollbar policy.
15085 * @see elm_list_scroller_policy_get() for details.
15087 * @param obj The list object.
15088 * @param policy_h Pointer where to store horizontal scrollbar policy.
15089 * @param policy_v Pointer where to store vertical scrollbar policy.
15093 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);
15096 * Append a new item to the list object.
15098 * @param obj The list object.
15099 * @param label The label of the list item.
15100 * @param icon The icon object to use for the left side of the item. An
15101 * icon can be any Evas object, but usually it is an icon created
15102 * with elm_icon_add().
15103 * @param end The icon object to use for the right side of the item. An
15104 * icon can be any Evas object.
15105 * @param func The function to call when the item is clicked.
15106 * @param data The data to associate with the item for related callbacks.
15108 * @return The created item or @c NULL upon failure.
15110 * A new item will be created and appended to the list, i.e., will
15111 * be set as @b last item.
15113 * Items created with this method can be deleted with
15114 * elm_list_item_del().
15116 * Associated @p data can be properly freed when item is deleted if a
15117 * callback function is set with elm_list_item_del_cb_set().
15119 * If a function is passed as argument, it will be called everytime this item
15120 * is selected, i.e., the user clicks over an unselected item.
15121 * If always select is enabled it will call this function every time
15122 * user clicks over an item (already selected or not).
15123 * If such function isn't needed, just passing
15124 * @c NULL as @p func is enough. The same should be done for @p data.
15126 * Simple example (with no function callback or data associated):
15128 * li = elm_list_add(win);
15129 * ic = elm_icon_add(win);
15130 * elm_icon_file_set(ic, "path/to/image", NULL);
15131 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15132 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15134 * evas_object_show(li);
15137 * @see elm_list_always_select_mode_set()
15138 * @see elm_list_item_del()
15139 * @see elm_list_item_del_cb_set()
15140 * @see elm_list_clear()
15141 * @see elm_icon_add()
15145 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);
15148 * Prepend a new item to the list object.
15150 * @param obj The list object.
15151 * @param label The label of the list item.
15152 * @param icon The icon object to use for the left side of the item. An
15153 * icon can be any Evas object, but usually it is an icon created
15154 * with elm_icon_add().
15155 * @param end The icon object to use for the right side of the item. An
15156 * icon can be any Evas object.
15157 * @param func The function to call when the item is clicked.
15158 * @param data The data to associate with the item for related callbacks.
15160 * @return The created item or @c NULL upon failure.
15162 * A new item will be created and prepended to the list, i.e., will
15163 * be set as @b first item.
15165 * Items created with this method can be deleted with
15166 * elm_list_item_del().
15168 * Associated @p data can be properly freed when item is deleted if a
15169 * callback function is set with elm_list_item_del_cb_set().
15171 * If a function is passed as argument, it will be called everytime this item
15172 * is selected, i.e., the user clicks over an unselected item.
15173 * If always select is enabled it will call this function every time
15174 * user clicks over an item (already selected or not).
15175 * If such function isn't needed, just passing
15176 * @c NULL as @p func is enough. The same should be done for @p data.
15178 * @see elm_list_item_append() for a simple code example.
15179 * @see elm_list_always_select_mode_set()
15180 * @see elm_list_item_del()
15181 * @see elm_list_item_del_cb_set()
15182 * @see elm_list_clear()
15183 * @see elm_icon_add()
15187 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);
15190 * Insert a new item into the list object before item @p before.
15192 * @param obj The list object.
15193 * @param before The list item to insert before.
15194 * @param label The label of the list item.
15195 * @param icon The icon object to use for the left side of the item. An
15196 * icon can be any Evas object, but usually it is an icon created
15197 * with elm_icon_add().
15198 * @param end The icon object to use for the right side of the item. An
15199 * icon can be any Evas object.
15200 * @param func The function to call when the item is clicked.
15201 * @param data The data to associate with the item for related callbacks.
15203 * @return The created item or @c NULL upon failure.
15205 * A new item will be created and added to the list. Its position in
15206 * this list will be just before item @p before.
15208 * Items created with this method can be deleted with
15209 * elm_list_item_del().
15211 * Associated @p data can be properly freed when item is deleted if a
15212 * callback function is set with elm_list_item_del_cb_set().
15214 * If a function is passed as argument, it will be called everytime this item
15215 * is selected, i.e., the user clicks over an unselected item.
15216 * If always select is enabled it will call this function every time
15217 * user clicks over an item (already selected or not).
15218 * If such function isn't needed, just passing
15219 * @c NULL as @p func is enough. The same should be done for @p data.
15221 * @see elm_list_item_append() for a simple code example.
15222 * @see elm_list_always_select_mode_set()
15223 * @see elm_list_item_del()
15224 * @see elm_list_item_del_cb_set()
15225 * @see elm_list_clear()
15226 * @see elm_icon_add()
15230 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);
15233 * Insert a new item into the list object after item @p after.
15235 * @param obj The list object.
15236 * @param after The list item to insert after.
15237 * @param label The label of the list item.
15238 * @param icon The icon object to use for the left side of the item. An
15239 * icon can be any Evas object, but usually it is an icon created
15240 * with elm_icon_add().
15241 * @param end The icon object to use for the right side of the item. An
15242 * icon can be any Evas object.
15243 * @param func The function to call when the item is clicked.
15244 * @param data The data to associate with the item for related callbacks.
15246 * @return The created item or @c NULL upon failure.
15248 * A new item will be created and added to the list. Its position in
15249 * this list will be just after item @p after.
15251 * Items created with this method can be deleted with
15252 * elm_list_item_del().
15254 * Associated @p data can be properly freed when item is deleted if a
15255 * callback function is set with elm_list_item_del_cb_set().
15257 * If a function is passed as argument, it will be called everytime this item
15258 * is selected, i.e., the user clicks over an unselected item.
15259 * If always select is enabled it will call this function every time
15260 * user clicks over an item (already selected or not).
15261 * If such function isn't needed, just passing
15262 * @c NULL as @p func is enough. The same should be done for @p data.
15264 * @see elm_list_item_append() for a simple code example.
15265 * @see elm_list_always_select_mode_set()
15266 * @see elm_list_item_del()
15267 * @see elm_list_item_del_cb_set()
15268 * @see elm_list_clear()
15269 * @see elm_icon_add()
15273 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);
15276 * Insert a new item into the sorted list object.
15278 * @param obj The list object.
15279 * @param label The label of the list item.
15280 * @param icon The icon object to use for the left side of the item. An
15281 * icon can be any Evas object, but usually it is an icon created
15282 * with elm_icon_add().
15283 * @param end The icon object to use for the right side of the item. An
15284 * icon can be any Evas object.
15285 * @param func The function to call when the item is clicked.
15286 * @param data The data to associate with the item for related callbacks.
15287 * @param cmp_func The comparing function to be used to sort list
15288 * items <b>by #Elm_List_Item item handles</b>. This function will
15289 * receive two items and compare them, returning a non-negative integer
15290 * if the second item should be place after the first, or negative value
15291 * if should be placed before.
15293 * @return The created item or @c NULL upon failure.
15295 * @note This function inserts values into a list object assuming it was
15296 * sorted and the result will be sorted.
15298 * A new item will be created and added to the list. Its position in
15299 * this list will be found comparing the new item with previously inserted
15300 * items using function @p cmp_func.
15302 * Items created with this method can be deleted with
15303 * elm_list_item_del().
15305 * Associated @p data can be properly freed when item is deleted if a
15306 * callback function is set with elm_list_item_del_cb_set().
15308 * If a function is passed as argument, it will be called everytime this item
15309 * is selected, i.e., the user clicks over an unselected item.
15310 * If always select is enabled it will call this function every time
15311 * user clicks over an item (already selected or not).
15312 * If such function isn't needed, just passing
15313 * @c NULL as @p func is enough. The same should be done for @p data.
15315 * @see elm_list_item_append() for a simple code example.
15316 * @see elm_list_always_select_mode_set()
15317 * @see elm_list_item_del()
15318 * @see elm_list_item_del_cb_set()
15319 * @see elm_list_clear()
15320 * @see elm_icon_add()
15324 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);
15327 * Remove all list's items.
15329 * @param obj The list object
15331 * @see elm_list_item_del()
15332 * @see elm_list_item_append()
15336 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15339 * Get a list of all the list items.
15341 * @param obj The list object
15342 * @return An @c Eina_List of list items, #Elm_List_Item,
15343 * or @c NULL on failure.
15345 * @see elm_list_item_append()
15346 * @see elm_list_item_del()
15347 * @see elm_list_clear()
15351 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15354 * Get the selected item.
15356 * @param obj The list object.
15357 * @return The selected list item.
15359 * The selected item can be unselected with function
15360 * elm_list_item_selected_set().
15362 * The selected item always will be highlighted on list.
15364 * @see elm_list_selected_items_get()
15368 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15371 * Return a list of the currently selected list items.
15373 * @param obj The list object.
15374 * @return An @c Eina_List of list items, #Elm_List_Item,
15375 * or @c NULL on failure.
15377 * Multiple items can be selected if multi select is enabled. It can be
15378 * done with elm_list_multi_select_set().
15380 * @see elm_list_selected_item_get()
15381 * @see elm_list_multi_select_set()
15385 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15388 * Set the selected state of an item.
15390 * @param item The list item
15391 * @param selected The selected state
15393 * This sets the selected state of the given item @p it.
15394 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15396 * If a new item is selected the previosly selected will be unselected,
15397 * unless multiple selection is enabled with elm_list_multi_select_set().
15398 * Previoulsy selected item can be get with function
15399 * elm_list_selected_item_get().
15401 * Selected items will be highlighted.
15403 * @see elm_list_item_selected_get()
15404 * @see elm_list_selected_item_get()
15405 * @see elm_list_multi_select_set()
15409 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15412 * Get whether the @p item is selected or not.
15414 * @param item The list item.
15415 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15416 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15418 * @see elm_list_selected_item_set() for details.
15419 * @see elm_list_item_selected_get()
15423 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15426 * Set or unset item as a separator.
15428 * @param it The list item.
15429 * @param setting @c EINA_TRUE to set item @p it as separator or
15430 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15432 * Items aren't set as separator by default.
15434 * If set as separator it will display separator theme, so won't display
15437 * @see elm_list_item_separator_get()
15441 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15444 * Get a value whether item is a separator or not.
15446 * @see elm_list_item_separator_set() for details.
15448 * @param it The list item.
15449 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15450 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15454 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15457 * Show @p item in the list view.
15459 * @param item The list item to be shown.
15461 * It won't animate list until item is visible. If such behavior is wanted,
15462 * use elm_list_bring_in() intead.
15466 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15469 * Bring in the given item to list view.
15471 * @param item The item.
15473 * This causes list to jump to the given item @p item and show it
15474 * (by scrolling), if it is not fully visible.
15476 * This may use animation to do so and take a period of time.
15478 * If animation isn't wanted, elm_list_item_show() can be used.
15482 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15485 * Delete them item from the list.
15487 * @param item The item of list to be deleted.
15489 * If deleting all list items is required, elm_list_clear()
15490 * should be used instead of getting items list and deleting each one.
15492 * @see elm_list_clear()
15493 * @see elm_list_item_append()
15494 * @see elm_list_item_del_cb_set()
15498 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15501 * Set the function called when a list item is freed.
15503 * @param item The item to set the callback on
15504 * @param func The function called
15506 * If there is a @p func, then it will be called prior item's memory release.
15507 * That will be called with the following arguments:
15509 * @li item's Evas object;
15512 * This way, a data associated to a list item could be properly freed.
15516 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15519 * Get the data associated to the item.
15521 * @param item The list item
15522 * @return The data associated to @p item
15524 * The return value is a pointer to data associated to @p item when it was
15525 * created, with function elm_list_item_append() or similar. If no data
15526 * was passed as argument, it will return @c NULL.
15528 * @see elm_list_item_append()
15532 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15535 * Get the left side icon associated to the item.
15537 * @param item The list item
15538 * @return The left side icon associated to @p item
15540 * The return value is a pointer to the icon associated to @p item when
15542 * created, with function elm_list_item_append() or similar, or later
15543 * with function elm_list_item_icon_set(). If no icon
15544 * was passed as argument, it will return @c NULL.
15546 * @see elm_list_item_append()
15547 * @see elm_list_item_icon_set()
15551 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15554 * Set the left side icon associated to the item.
15556 * @param item The list item
15557 * @param icon The left side icon object to associate with @p item
15559 * The icon object to use at left side of the item. An
15560 * icon can be any Evas object, but usually it is an icon created
15561 * with elm_icon_add().
15563 * Once the icon object is set, a previously set one will be deleted.
15564 * @warning Setting the same icon for two items will cause the icon to
15565 * dissapear from the first item.
15567 * If an icon was passed as argument on item creation, with function
15568 * elm_list_item_append() or similar, it will be already
15569 * associated to the item.
15571 * @see elm_list_item_append()
15572 * @see elm_list_item_icon_get()
15576 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15579 * Get the right side icon associated to the item.
15581 * @param item The list item
15582 * @return The right side icon associated to @p item
15584 * The return value is a pointer to the icon associated to @p item when
15586 * created, with function elm_list_item_append() or similar, or later
15587 * with function elm_list_item_icon_set(). If no icon
15588 * was passed as argument, it will return @c NULL.
15590 * @see elm_list_item_append()
15591 * @see elm_list_item_icon_set()
15595 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15598 * Set the right side icon associated to the item.
15600 * @param item The list item
15601 * @param end The right side icon object to associate with @p item
15603 * The icon object to use at right side of the item. An
15604 * icon can be any Evas object, but usually it is an icon created
15605 * with elm_icon_add().
15607 * Once the icon object is set, a previously set one will be deleted.
15608 * @warning Setting the same icon for two items will cause the icon to
15609 * dissapear from the first item.
15611 * If an icon was passed as argument on item creation, with function
15612 * elm_list_item_append() or similar, it will be already
15613 * associated to the item.
15615 * @see elm_list_item_append()
15616 * @see elm_list_item_end_get()
15620 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15623 * Gets the base object of the item.
15625 * @param item The list item
15626 * @return The base object associated with @p item
15628 * Base object is the @c Evas_Object that represents that item.
15632 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15633 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15636 * Get the label of item.
15638 * @param item The item of list.
15639 * @return The label of item.
15641 * The return value is a pointer to the label associated to @p item when
15642 * it was created, with function elm_list_item_append(), or later
15643 * with function elm_list_item_label_set. If no label
15644 * was passed as argument, it will return @c NULL.
15646 * @see elm_list_item_label_set() for more details.
15647 * @see elm_list_item_append()
15651 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15654 * Set the label of item.
15656 * @param item The item of list.
15657 * @param text The label of item.
15659 * The label to be displayed by the item.
15660 * Label will be placed between left and right side icons (if set).
15662 * If a label was passed as argument on item creation, with function
15663 * elm_list_item_append() or similar, it will be already
15664 * displayed by the item.
15666 * @see elm_list_item_label_get()
15667 * @see elm_list_item_append()
15671 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15675 * Get the item before @p it in list.
15677 * @param it The list item.
15678 * @return The item before @p it, or @c NULL if none or on failure.
15680 * @note If it is the first item, @c NULL will be returned.
15682 * @see elm_list_item_append()
15683 * @see elm_list_items_get()
15687 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15690 * Get the item after @p it in list.
15692 * @param it The list item.
15693 * @return The item after @p it, or @c NULL if none or on failure.
15695 * @note If it is the last item, @c NULL will be returned.
15697 * @see elm_list_item_append()
15698 * @see elm_list_items_get()
15702 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15705 * Sets the disabled/enabled state of a list item.
15707 * @param it The item.
15708 * @param disabled The disabled state.
15710 * A disabled item cannot be selected or unselected. It will also
15711 * change its appearance (generally greyed out). This sets the
15712 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15717 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15720 * Get a value whether list item is disabled or not.
15722 * @param it The item.
15723 * @return The disabled state.
15725 * @see elm_list_item_disabled_set() for more details.
15729 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15732 * Set the text to be shown in a given list item's tooltips.
15734 * @param item Target item.
15735 * @param text The text to set in the content.
15737 * Setup the text as tooltip to object. The item can have only one tooltip,
15738 * so any previous tooltip data - set with this function or
15739 * elm_list_item_tooltip_content_cb_set() - is removed.
15741 * @see elm_object_tooltip_text_set() for more details.
15745 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15749 * @brief Disable size restrictions on an object's tooltip
15750 * @param item The tooltip's anchor object
15751 * @param disable If EINA_TRUE, size restrictions are disabled
15752 * @return EINA_FALSE on failure, EINA_TRUE on success
15754 * This function allows a tooltip to expand beyond its parant window's canvas.
15755 * It will instead be limited only by the size of the display.
15757 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15759 * @brief Retrieve size restriction state of an object's tooltip
15760 * @param obj The tooltip's anchor object
15761 * @return If EINA_TRUE, size restrictions are disabled
15763 * This function returns whether a tooltip is allowed to expand beyond
15764 * its parant window's canvas.
15765 * It will instead be limited only by the size of the display.
15767 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15770 * Set the content to be shown in the tooltip item.
15772 * Setup the tooltip to item. The item can have only one tooltip,
15773 * so any previous tooltip data is removed. @p func(with @p data) will
15774 * be called every time that need show the tooltip and it should
15775 * return a valid Evas_Object. This object is then managed fully by
15776 * tooltip system and is deleted when the tooltip is gone.
15778 * @param item the list item being attached a tooltip.
15779 * @param func the function used to create the tooltip contents.
15780 * @param data what to provide to @a func as callback data/context.
15781 * @param del_cb called when data is not needed anymore, either when
15782 * another callback replaces @a func, the tooltip is unset with
15783 * elm_list_item_tooltip_unset() or the owner @a item
15784 * dies. This callback receives as the first parameter the
15785 * given @a data, and @c event_info is the item.
15787 * @see elm_object_tooltip_content_cb_set() for more details.
15791 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);
15794 * Unset tooltip from item.
15796 * @param item list item to remove previously set tooltip.
15798 * Remove tooltip from item. The callback provided as del_cb to
15799 * elm_list_item_tooltip_content_cb_set() will be called to notify
15800 * it is not used anymore.
15802 * @see elm_object_tooltip_unset() for more details.
15803 * @see elm_list_item_tooltip_content_cb_set()
15807 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15810 * Sets a different style for this item tooltip.
15812 * @note before you set a style you should define a tooltip with
15813 * elm_list_item_tooltip_content_cb_set() or
15814 * elm_list_item_tooltip_text_set()
15816 * @param item list item with tooltip already set.
15817 * @param style the theme style to use (default, transparent, ...)
15819 * @see elm_object_tooltip_style_set() for more details.
15823 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15826 * Get the style for this item tooltip.
15828 * @param item list item with tooltip already set.
15829 * @return style the theme style in use, defaults to "default". If the
15830 * object does not have a tooltip set, then NULL is returned.
15832 * @see elm_object_tooltip_style_get() for more details.
15833 * @see elm_list_item_tooltip_style_set()
15837 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15840 * Set the type of mouse pointer/cursor decoration to be shown,
15841 * when the mouse pointer is over the given list widget item
15843 * @param item list item to customize cursor on
15844 * @param cursor the cursor type's name
15846 * This function works analogously as elm_object_cursor_set(), but
15847 * here the cursor's changing area is restricted to the item's
15848 * area, and not the whole widget's. Note that that item cursors
15849 * have precedence over widget cursors, so that a mouse over an
15850 * item with custom cursor set will always show @b that cursor.
15852 * If this function is called twice for an object, a previously set
15853 * cursor will be unset on the second call.
15855 * @see elm_object_cursor_set()
15856 * @see elm_list_item_cursor_get()
15857 * @see elm_list_item_cursor_unset()
15861 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15864 * Get the type of mouse pointer/cursor decoration set to be shown,
15865 * when the mouse pointer is over the given list widget item
15867 * @param item list item with custom cursor set
15868 * @return the cursor type's name or @c NULL, if no custom cursors
15869 * were set to @p item (and on errors)
15871 * @see elm_object_cursor_get()
15872 * @see elm_list_item_cursor_set()
15873 * @see elm_list_item_cursor_unset()
15877 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15880 * Unset any custom mouse pointer/cursor decoration set to be
15881 * shown, when the mouse pointer is over the given list widget
15882 * item, thus making it show the @b default cursor again.
15884 * @param item a list item
15886 * Use this call to undo any custom settings on this item's cursor
15887 * decoration, bringing it back to defaults (no custom style set).
15889 * @see elm_object_cursor_unset()
15890 * @see elm_list_item_cursor_set()
15894 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15897 * Set a different @b style for a given custom cursor set for a
15900 * @param item list item with custom cursor set
15901 * @param style the <b>theme style</b> to use (e.g. @c "default",
15902 * @c "transparent", etc)
15904 * This function only makes sense when one is using custom mouse
15905 * cursor decorations <b>defined in a theme file</b>, which can have,
15906 * given a cursor name/type, <b>alternate styles</b> on it. It
15907 * works analogously as elm_object_cursor_style_set(), but here
15908 * applyed only to list item objects.
15910 * @warning Before you set a cursor style you should have definen a
15911 * custom cursor previously on the item, with
15912 * elm_list_item_cursor_set()
15914 * @see elm_list_item_cursor_engine_only_set()
15915 * @see elm_list_item_cursor_style_get()
15919 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15922 * Get the current @b style set for a given list item's custom
15925 * @param item list item with custom cursor set.
15926 * @return style the cursor style in use. If the object does not
15927 * have a cursor set, then @c NULL is returned.
15929 * @see elm_list_item_cursor_style_set() for more details
15933 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15936 * Set if the (custom)cursor for a given list item should be
15937 * searched in its theme, also, or should only rely on the
15938 * rendering engine.
15940 * @param item item with custom (custom) cursor already set on
15941 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15942 * only on those provided by the rendering engine, @c EINA_FALSE to
15943 * have them searched on the widget's theme, as well.
15945 * @note This call is of use only if you've set a custom cursor
15946 * for list items, with elm_list_item_cursor_set().
15948 * @note By default, cursors will only be looked for between those
15949 * provided by the rendering engine.
15953 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15956 * Get if the (custom) cursor for a given list item is being
15957 * searched in its theme, also, or is only relying on the rendering
15960 * @param item a list item
15961 * @return @c EINA_TRUE, if cursors are being looked for only on
15962 * those provided by the rendering engine, @c EINA_FALSE if they
15963 * are being searched on the widget's theme, as well.
15965 * @see elm_list_item_cursor_engine_only_set(), for more details
15969 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15976 * @defgroup Slider Slider
15977 * @ingroup Elementary
15979 * @image html img/widget/slider/preview-00.png
15980 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15982 * The slider adds a dragable “slider” widget for selecting the value of
15983 * something within a range.
15985 * A slider can be horizontal or vertical. It can contain an Icon and has a
15986 * primary label as well as a units label (that is formatted with floating
15987 * point values and thus accepts a printf-style format string, like
15988 * “%1.2f units”. There is also an indicator string that may be somewhere
15989 * else (like on the slider itself) that also accepts a format string like
15990 * units. Label, Icon Unit and Indicator strings/objects are optional.
15992 * A slider may be inverted which means values invert, with high vales being
15993 * on the left or top and low values on the right or bottom (as opposed to
15994 * normally being low on the left or top and high on the bottom and right).
15996 * The slider should have its minimum and maximum values set by the
15997 * application with elm_slider_min_max_set() and value should also be set by
15998 * the application before use with elm_slider_value_set(). The span of the
15999 * slider is its length (horizontally or vertically). This will be scaled by
16000 * the object or applications scaling factor. At any point code can query the
16001 * slider for its value with elm_slider_value_get().
16003 * Smart callbacks one can listen to:
16004 * - "changed" - Whenever the slider value is changed by the user.
16005 * - "slider,drag,start" - dragging the slider indicator around has started.
16006 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16007 * - "delay,changed" - A short time after the value is changed by the user.
16008 * This will be called only when the user stops dragging for
16009 * a very short period or when they release their
16010 * finger/mouse, so it avoids possibly expensive reactions to
16011 * the value change.
16013 * Available styles for it:
16016 * Here is an example on its usage:
16017 * @li @ref slider_example
16021 * @addtogroup Slider
16026 * Add a new slider widget to the given parent Elementary
16027 * (container) object.
16029 * @param parent The parent object.
16030 * @return a new slider widget handle or @c NULL, on errors.
16032 * This function inserts a new slider widget on the canvas.
16036 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16039 * Set the label of a given slider widget
16041 * @param obj The progress bar object
16042 * @param label The text label string, in UTF-8
16045 * @deprecated use elm_object_text_set() instead.
16047 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16050 * Get the label of a given slider widget
16052 * @param obj The progressbar object
16053 * @return The text label string, in UTF-8
16056 * @deprecated use elm_object_text_get() instead.
16058 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16061 * Set the icon object of the slider object.
16063 * @param obj The slider object.
16064 * @param icon The icon object.
16066 * On horizontal mode, icon is placed at left, and on vertical mode,
16069 * @note Once the icon object is set, a previously set one will be deleted.
16070 * If you want to keep that old content object, use the
16071 * elm_slider_icon_unset() function.
16073 * @warning If the object being set does not have minimum size hints set,
16074 * it won't get properly displayed.
16078 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16081 * Unset an icon set on a given slider widget.
16083 * @param obj The slider object.
16084 * @return The icon object that was being used, if any was set, or
16085 * @c NULL, otherwise (and on errors).
16087 * On horizontal mode, icon is placed at left, and on vertical mode,
16090 * This call will unparent and return the icon object which was set
16091 * for this widget, previously, on success.
16093 * @see elm_slider_icon_set() for more details
16094 * @see elm_slider_icon_get()
16098 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16101 * Retrieve the icon object set for a given slider widget.
16103 * @param obj The slider object.
16104 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16105 * otherwise (and on errors).
16107 * On horizontal mode, icon is placed at left, and on vertical mode,
16110 * @see elm_slider_icon_set() for more details
16111 * @see elm_slider_icon_unset()
16115 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16118 * Set the end object of the slider object.
16120 * @param obj The slider object.
16121 * @param end The end object.
16123 * On horizontal mode, end is placed at left, and on vertical mode,
16124 * placed at bottom.
16126 * @note Once the icon object is set, a previously set one will be deleted.
16127 * If you want to keep that old content object, use the
16128 * elm_slider_end_unset() function.
16130 * @warning If the object being set does not have minimum size hints set,
16131 * it won't get properly displayed.
16135 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16138 * Unset an end object set on a given slider widget.
16140 * @param obj The slider object.
16141 * @return The end object that was being used, if any was set, or
16142 * @c NULL, otherwise (and on errors).
16144 * On horizontal mode, end is placed at left, and on vertical mode,
16145 * placed at bottom.
16147 * This call will unparent and return the icon object which was set
16148 * for this widget, previously, on success.
16150 * @see elm_slider_end_set() for more details.
16151 * @see elm_slider_end_get()
16155 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16158 * Retrieve the end object set for a given slider widget.
16160 * @param obj The slider object.
16161 * @return The end object's handle, if @p obj had one set, or @c NULL,
16162 * otherwise (and on errors).
16164 * On horizontal mode, icon is placed at right, and on vertical mode,
16165 * placed at bottom.
16167 * @see elm_slider_end_set() for more details.
16168 * @see elm_slider_end_unset()
16172 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16175 * Set the (exact) length of the bar region of a given slider widget.
16177 * @param obj The slider object.
16178 * @param size The length of the slider's bar region.
16180 * This sets the minimum width (when in horizontal mode) or height
16181 * (when in vertical mode) of the actual bar area of the slider
16182 * @p obj. This in turn affects the object's minimum size. Use
16183 * this when you're not setting other size hints expanding on the
16184 * given direction (like weight and alignment hints) and you would
16185 * like it to have a specific size.
16187 * @note Icon, end, label, indicator and unit text around @p obj
16188 * will require their
16189 * own space, which will make @p obj to require more the @p size,
16192 * @see elm_slider_span_size_get()
16196 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16199 * Get the length set for the bar region of a given slider widget
16201 * @param obj The slider object.
16202 * @return The length of the slider's bar region.
16204 * If that size was not set previously, with
16205 * elm_slider_span_size_set(), this call will return @c 0.
16209 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16212 * Set the format string for the unit label.
16214 * @param obj The slider object.
16215 * @param format The format string for the unit display.
16217 * Unit label is displayed all the time, if set, after slider's bar.
16218 * In horizontal mode, at right and in vertical mode, at bottom.
16220 * If @c NULL, unit label won't be visible. If not it sets the format
16221 * string for the label text. To the label text is provided a floating point
16222 * value, so the label text can display up to 1 floating point value.
16223 * Note that this is optional.
16225 * Use a format string such as "%1.2f meters" for example, and it will
16226 * display values like: "3.14 meters" for a value equal to 3.14159.
16228 * Default is unit label disabled.
16230 * @see elm_slider_indicator_format_get()
16234 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16237 * Get the unit label format of the slider.
16239 * @param obj The slider object.
16240 * @return The unit label format string in UTF-8.
16242 * Unit label is displayed all the time, if set, after slider's bar.
16243 * In horizontal mode, at right and in vertical mode, at bottom.
16245 * @see elm_slider_unit_format_set() for more
16246 * information on how this works.
16250 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16253 * Set the format string for the indicator label.
16255 * @param obj The slider object.
16256 * @param indicator The format string for the indicator display.
16258 * The slider may display its value somewhere else then unit label,
16259 * for example, above the slider knob that is dragged around. This function
16260 * sets the format string used for this.
16262 * If @c NULL, indicator label won't be visible. If not it sets the format
16263 * string for the label text. To the label text is provided a floating point
16264 * value, so the label text can display up to 1 floating point value.
16265 * Note that this is optional.
16267 * Use a format string such as "%1.2f meters" for example, and it will
16268 * display values like: "3.14 meters" for a value equal to 3.14159.
16270 * Default is indicator label disabled.
16272 * @see elm_slider_indicator_format_get()
16276 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16279 * Get the indicator label format of the slider.
16281 * @param obj The slider object.
16282 * @return The indicator label format string in UTF-8.
16284 * The slider may display its value somewhere else then unit label,
16285 * for example, above the slider knob that is dragged around. This function
16286 * gets the format string used for this.
16288 * @see elm_slider_indicator_format_set() for more
16289 * information on how this works.
16293 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16296 * Set the format function pointer for the indicator label
16298 * @param obj The slider object.
16299 * @param func The indicator format function.
16300 * @param free_func The freeing function for the format string.
16302 * Set the callback function to format the indicator string.
16304 * @see elm_slider_indicator_format_set() for more info on how this works.
16308 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);
16311 * Set the format function pointer for the units label
16313 * @param obj The slider object.
16314 * @param func The units format function.
16315 * @param free_func The freeing function for the format string.
16317 * Set the callback function to format the indicator string.
16319 * @see elm_slider_units_format_set() for more info on how this works.
16323 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);
16326 * Set the orientation of a given slider widget.
16328 * @param obj The slider object.
16329 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16330 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16332 * Use this function to change how your slider is to be
16333 * disposed: vertically or horizontally.
16335 * By default it's displayed horizontally.
16337 * @see elm_slider_horizontal_get()
16341 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16344 * Retrieve the orientation of a given slider widget
16346 * @param obj The slider object.
16347 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16348 * @c EINA_FALSE if it's @b vertical (and on errors).
16350 * @see elm_slider_horizontal_set() for more details.
16354 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16357 * Set the minimum and maximum values for the slider.
16359 * @param obj The slider object.
16360 * @param min The minimum value.
16361 * @param max The maximum value.
16363 * Define the allowed range of values to be selected by the user.
16365 * If actual value is less than @p min, it will be updated to @p min. If it
16366 * is bigger then @p max, will be updated to @p max. Actual value can be
16367 * get with elm_slider_value_get().
16369 * By default, min is equal to 0.0, and max is equal to 1.0.
16371 * @warning Maximum must be greater than minimum, otherwise behavior
16374 * @see elm_slider_min_max_get()
16378 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16381 * Get the minimum and maximum values of the slider.
16383 * @param obj The slider object.
16384 * @param min Pointer where to store the minimum value.
16385 * @param max Pointer where to store the maximum value.
16387 * @note If only one value is needed, the other pointer can be passed
16390 * @see elm_slider_min_max_set() for details.
16394 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16397 * Set the value the slider displays.
16399 * @param obj The slider object.
16400 * @param val The value to be displayed.
16402 * Value will be presented on the unit label following format specified with
16403 * elm_slider_unit_format_set() and on indicator with
16404 * elm_slider_indicator_format_set().
16406 * @warning The value must to be between min and max values. This values
16407 * are set by elm_slider_min_max_set().
16409 * @see elm_slider_value_get()
16410 * @see elm_slider_unit_format_set()
16411 * @see elm_slider_indicator_format_set()
16412 * @see elm_slider_min_max_set()
16416 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16419 * Get the value displayed by the spinner.
16421 * @param obj The spinner object.
16422 * @return The value displayed.
16424 * @see elm_spinner_value_set() for details.
16428 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16431 * Invert a given slider widget's displaying values order
16433 * @param obj The slider object.
16434 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16435 * @c EINA_FALSE to bring it back to default, non-inverted values.
16437 * A slider may be @b inverted, in which state it gets its
16438 * values inverted, with high vales being on the left or top and
16439 * low values on the right or bottom, as opposed to normally have
16440 * the low values on the former and high values on the latter,
16441 * respectively, for horizontal and vertical modes.
16443 * @see elm_slider_inverted_get()
16447 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16450 * Get whether a given slider widget's displaying values are
16453 * @param obj The slider object.
16454 * @return @c EINA_TRUE, if @p obj has inverted values,
16455 * @c EINA_FALSE otherwise (and on errors).
16457 * @see elm_slider_inverted_set() for more details.
16461 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16464 * Set whether to enlarge slider indicator (augmented knob) or not.
16466 * @param obj The slider object.
16467 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16468 * let the knob always at default size.
16470 * By default, indicator will be bigger while dragged by the user.
16472 * @warning It won't display values set with
16473 * elm_slider_indicator_format_set() if you disable indicator.
16477 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16480 * Get whether a given slider widget's enlarging indicator or not.
16482 * @param obj The slider object.
16483 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16484 * @c EINA_FALSE otherwise (and on errors).
16486 * @see elm_slider_indicator_show_set() for details.
16490 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16497 * @addtogroup Actionslider Actionslider
16499 * @image html img/widget/actionslider/preview-00.png
16500 * @image latex img/widget/actionslider/preview-00.eps
16502 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16503 * properties. The indicator is the element the user drags to choose a label.
16504 * When the position is set with magnet, when released the indicator will be
16505 * moved to it if it's nearest the magnetized position.
16507 * @note By default all positions are set as enabled.
16509 * Signals that you can add callbacks for are:
16511 * "selected" - when user selects an enabled position (the label is passed
16514 * "pos_changed" - when the indicator reaches any of the positions("left",
16515 * "right" or "center").
16517 * See an example of actionslider usage @ref actionslider_example_page "here"
16520 typedef enum _Elm_Actionslider_Pos
16522 ELM_ACTIONSLIDER_NONE = 0,
16523 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16524 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16525 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16526 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16527 } Elm_Actionslider_Pos;
16530 * Add a new actionslider to the parent.
16532 * @param parent The parent object
16533 * @return The new actionslider object or NULL if it cannot be created
16535 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16537 * Set actionslider labels.
16539 * @param obj The actionslider object
16540 * @param left_label The label to be set on the left.
16541 * @param center_label The label to be set on the center.
16542 * @param right_label The label to be set on the right.
16543 * @deprecated use elm_object_text_set() instead.
16545 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);
16547 * Get actionslider labels.
16549 * @param obj The actionslider object
16550 * @param left_label A char** to place the left_label of @p obj into.
16551 * @param center_label A char** to place the center_label of @p obj into.
16552 * @param right_label A char** to place the right_label of @p obj into.
16553 * @deprecated use elm_object_text_set() instead.
16555 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);
16557 * Get actionslider selected label.
16559 * @param obj The actionslider object
16560 * @return The selected label
16562 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16564 * Set actionslider indicator position.
16566 * @param obj The actionslider object.
16567 * @param pos The position of the indicator.
16569 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16571 * Get actionslider indicator position.
16573 * @param obj The actionslider object.
16574 * @return The position of the indicator.
16576 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16578 * Set actionslider magnet position. To make multiple positions magnets @c or
16579 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16581 * @param obj The actionslider object.
16582 * @param pos Bit mask indicating the magnet positions.
16584 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16586 * Get actionslider magnet position.
16588 * @param obj The actionslider object.
16589 * @return The positions with magnet property.
16591 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16593 * Set actionslider enabled position. To set multiple positions as enabled @c or
16594 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16596 * @note All the positions are enabled by default.
16598 * @param obj The actionslider object.
16599 * @param pos Bit mask indicating the enabled positions.
16601 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16603 * Get actionslider enabled position.
16605 * @param obj The actionslider object.
16606 * @return The enabled positions.
16608 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16610 * Set the label used on the indicator.
16612 * @param obj The actionslider object
16613 * @param label The label to be set on the indicator.
16614 * @deprecated use elm_object_text_set() instead.
16616 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16618 * Get the label used on the indicator object.
16620 * @param obj The actionslider object
16621 * @return The indicator label
16622 * @deprecated use elm_object_text_get() instead.
16624 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16630 * @defgroup Genlist Genlist
16632 * @image html img/widget/genlist/preview-00.png
16633 * @image latex img/widget/genlist/preview-00.eps
16634 * @image html img/genlist.png
16635 * @image latex img/genlist.eps
16637 * This widget aims to have more expansive list than the simple list in
16638 * Elementary that could have more flexible items and allow many more entries
16639 * while still being fast and low on memory usage. At the same time it was
16640 * also made to be able to do tree structures. But the price to pay is more
16641 * complexity when it comes to usage. If all you want is a simple list with
16642 * icons and a single label, use the normal @ref List object.
16644 * Genlist has a fairly large API, mostly because it's relatively complex,
16645 * trying to be both expansive, powerful and efficient. First we will begin
16646 * an overview on the theory behind genlist.
16648 * @section Genlist_Item_Class Genlist item classes - creating items
16650 * In order to have the ability to add and delete items on the fly, genlist
16651 * implements a class (callback) system where the application provides a
16652 * structure with information about that type of item (genlist may contain
16653 * multiple different items with different classes, states and styles).
16654 * Genlist will call the functions in this struct (methods) when an item is
16655 * "realized" (i.e., created dynamically, while the user is scrolling the
16656 * grid). All objects will simply be deleted when no longer needed with
16657 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16658 * following members:
16659 * - @c item_style - This is a constant string and simply defines the name
16660 * of the item style. It @b must be specified and the default should be @c
16662 * - @c mode_item_style - This is a constant string and simply defines the
16663 * name of the style that will be used for mode animations. It can be left
16664 * as @c NULL if you don't plan to use Genlist mode. See
16665 * elm_genlist_item_mode_set() for more info.
16667 * - @c func - A struct with pointers to functions that will be called when
16668 * an item is going to be actually created. All of them receive a @c data
16669 * parameter that will point to the same data passed to
16670 * elm_genlist_item_append() and related item creation functions, and a @c
16671 * obj parameter that points to the genlist object itself.
16673 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16674 * state_get and @c del. The 3 first functions also receive a @c part
16675 * parameter described below. A brief description of these functions follows:
16677 * - @c label_get - The @c part parameter is the name string of one of the
16678 * existing text parts in the Edje group implementing the item's theme.
16679 * This function @b must return a strdup'()ed string, as the caller will
16680 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16681 * - @c icon_get - The @c part parameter is the name string of one of the
16682 * existing (icon) swallow parts in the Edje group implementing the item's
16683 * theme. It must return @c NULL, when no icon is desired, or a valid
16684 * object handle, otherwise. The object will be deleted by the genlist on
16685 * its deletion or when the item is "unrealized". See
16686 * #Elm_Genlist_Item_Icon_Get_Cb.
16687 * - @c func.state_get - The @c part parameter is the name string of one of
16688 * the state parts in the Edje group implementing the item's theme. Return
16689 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16690 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16691 * and @c "elm" as "emission" and "source" arguments, respectively, when
16692 * the state is true (the default is false), where @c XXX is the name of
16693 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16694 * - @c func.del - This is intended for use when genlist items are deleted,
16695 * so any data attached to the item (e.g. its data parameter on creation)
16696 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16698 * available item styles:
16700 * - default_style - The text part is a textblock
16702 * @image html img/widget/genlist/preview-04.png
16703 * @image latex img/widget/genlist/preview-04.eps
16707 * @image html img/widget/genlist/preview-01.png
16708 * @image latex img/widget/genlist/preview-01.eps
16710 * - icon_top_text_bottom
16712 * @image html img/widget/genlist/preview-02.png
16713 * @image latex img/widget/genlist/preview-02.eps
16717 * @image html img/widget/genlist/preview-03.png
16718 * @image latex img/widget/genlist/preview-03.eps
16720 * @section Genlist_Items Structure of items
16722 * An item in a genlist can have 0 or more text labels (they can be regular
16723 * text or textblock Evas objects - that's up to the style to determine), 0
16724 * or more icons (which are simply objects swallowed into the genlist item's
16725 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16726 * behavior left to the user to define. The Edje part names for each of
16727 * these properties will be looked up, in the theme file for the genlist,
16728 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16729 * "states", respectively. For each of those properties, if more than one
16730 * part is provided, they must have names listed separated by spaces in the
16731 * data fields. For the default genlist item theme, we have @b one label
16732 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16733 * "elm.swallow.end") and @b no state parts.
16735 * A genlist item may be at one of several styles. Elementary provides one
16736 * by default - "default", but this can be extended by system or application
16737 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16740 * @section Genlist_Manipulation Editing and Navigating
16742 * Items can be added by several calls. All of them return a @ref
16743 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16744 * They all take a data parameter that is meant to be used for a handle to
16745 * the applications internal data (eg the struct with the original item
16746 * data). The parent parameter is the parent genlist item this belongs to if
16747 * it is a tree or an indexed group, and NULL if there is no parent. The
16748 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16749 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16750 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16751 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16752 * is set then this item is group index item that is displayed at the top
16753 * until the next group comes. The func parameter is a convenience callback
16754 * that is called when the item is selected and the data parameter will be
16755 * the func_data parameter, obj be the genlist object and event_info will be
16756 * the genlist item.
16758 * elm_genlist_item_append() adds an item to the end of the list, or if
16759 * there is a parent, to the end of all the child items of the parent.
16760 * elm_genlist_item_prepend() is the same but adds to the beginning of
16761 * the list or children list. elm_genlist_item_insert_before() inserts at
16762 * item before another item and elm_genlist_item_insert_after() inserts after
16763 * the indicated item.
16765 * The application can clear the list with elm_genlist_clear() which deletes
16766 * all the items in the list and elm_genlist_item_del() will delete a specific
16767 * item. elm_genlist_item_subitems_clear() will clear all items that are
16768 * children of the indicated parent item.
16770 * To help inspect list items you can jump to the item at the top of the list
16771 * with elm_genlist_first_item_get() which will return the item pointer, and
16772 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16773 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16774 * and previous items respectively relative to the indicated item. Using
16775 * these calls you can walk the entire item list/tree. Note that as a tree
16776 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16777 * let you know which item is the parent (and thus know how to skip them if
16780 * @section Genlist_Muti_Selection Multi-selection
16782 * If the application wants multiple items to be able to be selected,
16783 * elm_genlist_multi_select_set() can enable this. If the list is
16784 * single-selection only (the default), then elm_genlist_selected_item_get()
16785 * will return the selected item, if any, or NULL I none is selected. If the
16786 * list is multi-select then elm_genlist_selected_items_get() will return a
16787 * list (that is only valid as long as no items are modified (added, deleted,
16788 * selected or unselected)).
16790 * @section Genlist_Usage_Hints Usage hints
16792 * There are also convenience functions. elm_genlist_item_genlist_get() will
16793 * return the genlist object the item belongs to. elm_genlist_item_show()
16794 * will make the scroller scroll to show that specific item so its visible.
16795 * elm_genlist_item_data_get() returns the data pointer set by the item
16796 * creation functions.
16798 * If an item changes (state of boolean changes, label or icons change),
16799 * then use elm_genlist_item_update() to have genlist update the item with
16800 * the new state. Genlist will re-realize the item thus call the functions
16801 * in the _Elm_Genlist_Item_Class for that item.
16803 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16804 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16805 * to expand/contract an item and get its expanded state, use
16806 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16807 * again to make an item disabled (unable to be selected and appear
16808 * differently) use elm_genlist_item_disabled_set() to set this and
16809 * elm_genlist_item_disabled_get() to get the disabled state.
16811 * In general to indicate how the genlist should expand items horizontally to
16812 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16813 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16814 * mode means that if items are too wide to fit, the scroller will scroll
16815 * horizontally. Otherwise items are expanded to fill the width of the
16816 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16817 * to the viewport width and limited to that size. This can be combined with
16818 * a different style that uses edjes' ellipsis feature (cutting text off like
16821 * Items will only call their selection func and callback when first becoming
16822 * selected. Any further clicks will do nothing, unless you enable always
16823 * select with elm_genlist_always_select_mode_set(). This means even if
16824 * selected, every click will make the selected callbacks be called.
16825 * elm_genlist_no_select_mode_set() will turn off the ability to select
16826 * items entirely and they will neither appear selected nor call selected
16827 * callback functions.
16829 * Remember that you can create new styles and add your own theme augmentation
16830 * per application with elm_theme_extension_add(). If you absolutely must
16831 * have a specific style that overrides any theme the user or system sets up
16832 * you can use elm_theme_overlay_add() to add such a file.
16834 * @section Genlist_Implementation Implementation
16836 * Evas tracks every object you create. Every time it processes an event
16837 * (mouse move, down, up etc.) it needs to walk through objects and find out
16838 * what event that affects. Even worse every time it renders display updates,
16839 * in order to just calculate what to re-draw, it needs to walk through many
16840 * many many objects. Thus, the more objects you keep active, the more
16841 * overhead Evas has in just doing its work. It is advisable to keep your
16842 * active objects to the minimum working set you need. Also remember that
16843 * object creation and deletion carries an overhead, so there is a
16844 * middle-ground, which is not easily determined. But don't keep massive lists
16845 * of objects you can't see or use. Genlist does this with list objects. It
16846 * creates and destroys them dynamically as you scroll around. It groups them
16847 * into blocks so it can determine the visibility etc. of a whole block at
16848 * once as opposed to having to walk the whole list. This 2-level list allows
16849 * for very large numbers of items to be in the list (tests have used up to
16850 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16851 * may be different sizes, every item added needs to be calculated as to its
16852 * size and thus this presents a lot of overhead on populating the list, this
16853 * genlist employs a queue. Any item added is queued and spooled off over
16854 * time, actually appearing some time later, so if your list has many members
16855 * you may find it takes a while for them to all appear, with your process
16856 * consuming a lot of CPU while it is busy spooling.
16858 * Genlist also implements a tree structure, but it does so with callbacks to
16859 * the application, with the application filling in tree structures when
16860 * requested (allowing for efficient building of a very deep tree that could
16861 * even be used for file-management). See the above smart signal callbacks for
16864 * @section Genlist_Smart_Events Genlist smart events
16866 * Signals that you can add callbacks for are:
16867 * - @c "activated" - The user has double-clicked or pressed
16868 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16869 * item that was activated.
16870 * - @c "clicked,double" - The user has double-clicked an item. The @c
16871 * event_info parameter is the item that was double-clicked.
16872 * - @c "selected" - This is called when a user has made an item selected.
16873 * The event_info parameter is the genlist item that was selected.
16874 * - @c "unselected" - This is called when a user has made an item
16875 * unselected. The event_info parameter is the genlist item that was
16877 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16878 * called and the item is now meant to be expanded. The event_info
16879 * parameter is the genlist item that was indicated to expand. It is the
16880 * job of this callback to then fill in the child items.
16881 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16882 * called and the item is now meant to be contracted. The event_info
16883 * parameter is the genlist item that was indicated to contract. It is the
16884 * job of this callback to then delete the child items.
16885 * - @c "expand,request" - This is called when a user has indicated they want
16886 * to expand a tree branch item. The callback should decide if the item can
16887 * expand (has any children) and then call elm_genlist_item_expanded_set()
16888 * appropriately to set the state. The event_info parameter is the genlist
16889 * item that was indicated to expand.
16890 * - @c "contract,request" - This is called when a user has indicated they
16891 * want to contract a tree branch item. The callback should decide if the
16892 * item can contract (has any children) and then call
16893 * elm_genlist_item_expanded_set() appropriately to set the state. The
16894 * event_info parameter is the genlist item that was indicated to contract.
16895 * - @c "realized" - This is called when the item in the list is created as a
16896 * real evas object. event_info parameter is the genlist item that was
16897 * created. The object may be deleted at any time, so it is up to the
16898 * caller to not use the object pointer from elm_genlist_item_object_get()
16899 * in a way where it may point to freed objects.
16900 * - @c "unrealized" - This is called just before an item is unrealized.
16901 * After this call icon objects provided will be deleted and the item
16902 * object itself delete or be put into a floating cache.
16903 * - @c "drag,start,up" - This is called when the item in the list has been
16904 * dragged (not scrolled) up.
16905 * - @c "drag,start,down" - This is called when the item in the list has been
16906 * dragged (not scrolled) down.
16907 * - @c "drag,start,left" - This is called when the item in the list has been
16908 * dragged (not scrolled) left.
16909 * - @c "drag,start,right" - This is called when the item in the list has
16910 * been dragged (not scrolled) right.
16911 * - @c "drag,stop" - This is called when the item in the list has stopped
16913 * - @c "drag" - This is called when the item in the list is being dragged.
16914 * - @c "longpressed" - This is called when the item is pressed for a certain
16915 * amount of time. By default it's 1 second.
16916 * - @c "scroll,anim,start" - This is called when scrolling animation has
16918 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16920 * - @c "scroll,drag,start" - This is called when dragging the content has
16922 * - @c "scroll,drag,stop" - This is called when dragging the content has
16924 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16926 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16927 * until the bottom edge.
16928 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16929 * until the left edge.
16930 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16931 * until the right edge.
16932 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16934 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16936 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16938 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16940 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16941 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16942 * multi-touch pinched in.
16943 * - @c "swipe" - This is called when the genlist is swiped.
16945 * @section Genlist_Examples Examples
16947 * Here is a list of examples that use the genlist, trying to show some of
16948 * its capabilities:
16949 * - @ref genlist_example_01
16950 * - @ref genlist_example_02
16951 * - @ref genlist_example_03
16952 * - @ref genlist_example_04
16953 * - @ref genlist_example_05
16957 * @addtogroup Genlist
16962 * @enum _Elm_Genlist_Item_Flags
16963 * @typedef Elm_Genlist_Item_Flags
16965 * Defines if the item is of any special type (has subitems or it's the
16966 * index of a group), or is just a simple item.
16970 typedef enum _Elm_Genlist_Item_Flags
16972 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16973 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16974 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16975 } Elm_Genlist_Item_Flags;
16976 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16977 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16978 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16979 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16980 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. */
16981 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. */
16982 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16983 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16985 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16986 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16987 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16988 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16991 * @struct _Elm_Genlist_Item_Class
16993 * Genlist item class definition structs.
16995 * This struct contains the style and fetching functions that will define the
16996 * contents of each item.
16998 * @see @ref Genlist_Item_Class
17000 struct _Elm_Genlist_Item_Class
17002 const char *item_style; /**< style of this class. */
17005 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
17006 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
17007 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
17008 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
17009 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
17011 const char *mode_item_style;
17015 * Add a new genlist widget to the given parent Elementary
17016 * (container) object
17018 * @param parent The parent object
17019 * @return a new genlist widget handle or @c NULL, on errors
17021 * This function inserts a new genlist widget on the canvas.
17023 * @see elm_genlist_item_append()
17024 * @see elm_genlist_item_del()
17025 * @see elm_genlist_clear()
17029 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17031 * Remove all items from a given genlist widget.
17033 * @param obj The genlist object
17035 * This removes (and deletes) all items in @p obj, leaving it empty.
17037 * @see elm_genlist_item_del(), to remove just one item.
17041 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17043 * Enable or disable multi-selection in the genlist
17045 * @param obj The genlist object
17046 * @param multi Multi-select enable/disable. Default is disabled.
17048 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17049 * the list. This allows more than 1 item to be selected. To retrieve the list
17050 * of selected items, use elm_genlist_selected_items_get().
17052 * @see elm_genlist_selected_items_get()
17053 * @see elm_genlist_multi_select_get()
17057 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17059 * Gets if multi-selection in genlist is enabled or disabled.
17061 * @param obj The genlist object
17062 * @return Multi-select enabled/disabled
17063 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17065 * @see elm_genlist_multi_select_set()
17069 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17071 * This sets the horizontal stretching mode.
17073 * @param obj The genlist object
17074 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17076 * This sets the mode used for sizing items horizontally. Valid modes
17077 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17078 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17079 * the scroller will scroll horizontally. Otherwise items are expanded
17080 * to fill the width of the viewport of the scroller. If it is
17081 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17082 * limited to that size.
17084 * @see elm_genlist_horizontal_get()
17088 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17089 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17091 * Gets the horizontal stretching mode.
17093 * @param obj The genlist object
17094 * @return The mode to use
17095 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17097 * @see elm_genlist_horizontal_set()
17101 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17102 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17104 * Set the always select mode.
17106 * @param obj The genlist object
17107 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17108 * EINA_FALSE = off). Default is @c EINA_FALSE.
17110 * Items will only call their selection func and callback when first
17111 * becoming selected. Any further clicks will do nothing, unless you
17112 * enable always select with elm_genlist_always_select_mode_set().
17113 * This means that, even if selected, every click will make the selected
17114 * callbacks be called.
17116 * @see elm_genlist_always_select_mode_get()
17120 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17122 * Get the always select mode.
17124 * @param obj The genlist object
17125 * @return The always select mode
17126 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17128 * @see elm_genlist_always_select_mode_set()
17132 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17134 * Enable/disable the no select mode.
17136 * @param obj The genlist object
17137 * @param no_select The no select mode
17138 * (EINA_TRUE = on, EINA_FALSE = off)
17140 * This will turn off the ability to select items entirely and they
17141 * will neither appear selected nor call selected callback functions.
17143 * @see elm_genlist_no_select_mode_get()
17147 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17149 * Gets whether the no select mode is enabled.
17151 * @param obj The genlist object
17152 * @return The no select mode
17153 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17155 * @see elm_genlist_no_select_mode_set()
17159 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17161 * Enable/disable compress mode.
17163 * @param obj The genlist object
17164 * @param compress The compress mode
17165 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17167 * This will enable the compress mode where items are "compressed"
17168 * horizontally to fit the genlist scrollable viewport width. This is
17169 * special for genlist. Do not rely on
17170 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17171 * work as genlist needs to handle it specially.
17173 * @see elm_genlist_compress_mode_get()
17177 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17179 * Get whether the compress mode is enabled.
17181 * @param obj The genlist object
17182 * @return The compress mode
17183 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17185 * @see elm_genlist_compress_mode_set()
17189 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17191 * Enable/disable height-for-width mode.
17193 * @param obj The genlist object
17194 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17195 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17197 * With height-for-width mode the item width will be fixed (restricted
17198 * to a minimum of) to the list width when calculating its size in
17199 * order to allow the height to be calculated based on it. This allows,
17200 * for instance, text block to wrap lines if the Edje part is
17201 * configured with "text.min: 0 1".
17203 * @note This mode will make list resize slower as it will have to
17204 * recalculate every item height again whenever the list width
17207 * @note When height-for-width mode is enabled, it also enables
17208 * compress mode (see elm_genlist_compress_mode_set()) and
17209 * disables homogeneous (see elm_genlist_homogeneous_set()).
17213 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17215 * Get whether the height-for-width mode is enabled.
17217 * @param obj The genlist object
17218 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17223 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17225 * Enable/disable horizontal and vertical bouncing effect.
17227 * @param obj The genlist object
17228 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17229 * EINA_FALSE = off). Default is @c EINA_FALSE.
17230 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17231 * EINA_FALSE = off). Default is @c EINA_TRUE.
17233 * This will enable or disable the scroller bouncing effect for the
17234 * genlist. See elm_scroller_bounce_set() for details.
17236 * @see elm_scroller_bounce_set()
17237 * @see elm_genlist_bounce_get()
17241 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17243 * Get whether the horizontal and vertical bouncing effect is enabled.
17245 * @param obj The genlist object
17246 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17248 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17251 * @see elm_genlist_bounce_set()
17255 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17257 * Enable/disable homogenous mode.
17259 * @param obj The genlist object
17260 * @param homogeneous Assume the items within the genlist are of the
17261 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17264 * This will enable the homogeneous mode where items are of the same
17265 * height and width so that genlist may do the lazy-loading at its
17266 * maximum (which increases the performance for scrolling the list). This
17267 * implies 'compressed' mode.
17269 * @see elm_genlist_compress_mode_set()
17270 * @see elm_genlist_homogeneous_get()
17274 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17276 * Get whether the homogenous mode is enabled.
17278 * @param obj The genlist object
17279 * @return Assume the items within the genlist are of the same height
17280 * and width (EINA_TRUE = on, EINA_FALSE = off)
17282 * @see elm_genlist_homogeneous_set()
17286 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17288 * Set the maximum number of items within an item block
17290 * @param obj The genlist object
17291 * @param n Maximum number of items within an item block. Default is 32.
17293 * This will configure the block count to tune to the target with
17294 * particular performance matrix.
17296 * A block of objects will be used to reduce the number of operations due to
17297 * many objects in the screen. It can determine the visibility, or if the
17298 * object has changed, it theme needs to be updated, etc. doing this kind of
17299 * calculation to the entire block, instead of per object.
17301 * The default value for the block count is enough for most lists, so unless
17302 * you know you will have a lot of objects visible in the screen at the same
17303 * time, don't try to change this.
17305 * @see elm_genlist_block_count_get()
17306 * @see @ref Genlist_Implementation
17310 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17312 * Get the maximum number of items within an item block
17314 * @param obj The genlist object
17315 * @return Maximum number of items within an item block
17317 * @see elm_genlist_block_count_set()
17321 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17323 * Set the timeout in seconds for the longpress event.
17325 * @param obj The genlist object
17326 * @param timeout timeout in seconds. Default is 1.
17328 * This option will change how long it takes to send an event "longpressed"
17329 * after the mouse down signal is sent to the list. If this event occurs, no
17330 * "clicked" event will be sent.
17332 * @see elm_genlist_longpress_timeout_set()
17336 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17338 * Get the timeout in seconds for the longpress event.
17340 * @param obj The genlist object
17341 * @return timeout in seconds
17343 * @see elm_genlist_longpress_timeout_get()
17347 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17349 * Append a new item in a given genlist widget.
17351 * @param obj The genlist object
17352 * @param itc The item class for the item
17353 * @param data The item data
17354 * @param parent The parent item, or NULL if none
17355 * @param flags Item flags
17356 * @param func Convenience function called when the item is selected
17357 * @param func_data Data passed to @p func above.
17358 * @return A handle to the item added or @c NULL if not possible
17360 * This adds the given item to the end of the list or the end of
17361 * the children list if the @p parent is given.
17363 * @see elm_genlist_item_prepend()
17364 * @see elm_genlist_item_insert_before()
17365 * @see elm_genlist_item_insert_after()
17366 * @see elm_genlist_item_del()
17370 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);
17372 * Prepend a new item in a given genlist widget.
17374 * @param obj The genlist object
17375 * @param itc The item class for the item
17376 * @param data The item data
17377 * @param parent The parent item, or NULL if none
17378 * @param flags Item flags
17379 * @param func Convenience function called when the item is selected
17380 * @param func_data Data passed to @p func above.
17381 * @return A handle to the item added or NULL if not possible
17383 * This adds an item to the beginning of the list or beginning of the
17384 * children of the parent if given.
17386 * @see elm_genlist_item_append()
17387 * @see elm_genlist_item_insert_before()
17388 * @see elm_genlist_item_insert_after()
17389 * @see elm_genlist_item_del()
17393 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);
17395 * Insert an item before another in a genlist widget
17397 * @param obj The genlist object
17398 * @param itc The item class for the item
17399 * @param data The item data
17400 * @param before The item to place this new one before.
17401 * @param flags Item flags
17402 * @param func Convenience function called when the item is selected
17403 * @param func_data Data passed to @p func above.
17404 * @return A handle to the item added or @c NULL if not possible
17406 * This inserts an item before another in the list. It will be in the
17407 * same tree level or group as the item it is inserted before.
17409 * @see elm_genlist_item_append()
17410 * @see elm_genlist_item_prepend()
17411 * @see elm_genlist_item_insert_after()
17412 * @see elm_genlist_item_del()
17416 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);
17418 * Insert an item after another in a genlist widget
17420 * @param obj The genlist object
17421 * @param itc The item class for the item
17422 * @param data The item data
17423 * @param after The item to place this new one after.
17424 * @param flags Item flags
17425 * @param func Convenience function called when the item is selected
17426 * @param func_data Data passed to @p func above.
17427 * @return A handle to the item added or @c NULL if not possible
17429 * This inserts an item after another in the list. It will be in the
17430 * same tree level or group as the item it is inserted after.
17432 * @see elm_genlist_item_append()
17433 * @see elm_genlist_item_prepend()
17434 * @see elm_genlist_item_insert_before()
17435 * @see elm_genlist_item_del()
17439 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);
17441 * Insert a new item into the sorted genlist object
17443 * @param obj The genlist object
17444 * @param itc The item class for the item
17445 * @param data The item data
17446 * @param parent The parent item, or NULL if none
17447 * @param flags Item flags
17448 * @param comp The function called for the sort
17449 * @param func Convenience function called when item selected
17450 * @param func_data Data passed to @p func above.
17451 * @return A handle to the item added or NULL if not possible
17455 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);
17456 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);
17457 /* operations to retrieve existing items */
17459 * Get the selectd item in the genlist.
17461 * @param obj The genlist object
17462 * @return The selected item, or NULL if none is selected.
17464 * This gets the selected item in the list (if multi-selection is enabled, only
17465 * the item that was first selected in the list is returned - which is not very
17466 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17469 * If no item is selected, NULL is returned.
17471 * @see elm_genlist_selected_items_get()
17475 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17477 * Get a list of selected items in the genlist.
17479 * @param obj The genlist object
17480 * @return The list of selected items, or NULL if none are selected.
17482 * It returns a list of the selected items. This list pointer is only valid so
17483 * long as the selection doesn't change (no items are selected or unselected, or
17484 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17485 * pointers. The order of the items in this list is the order which they were
17486 * selected, i.e. the first item in this list is the first item that was
17487 * selected, and so on.
17489 * @note If not in multi-select mode, consider using function
17490 * elm_genlist_selected_item_get() instead.
17492 * @see elm_genlist_multi_select_set()
17493 * @see elm_genlist_selected_item_get()
17497 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17499 * Get a list of realized items in genlist
17501 * @param obj The genlist object
17502 * @return The list of realized items, nor NULL if none are realized.
17504 * This returns a list of the realized items in the genlist. The list
17505 * contains Elm_Genlist_Item pointers. The list must be freed by the
17506 * caller when done with eina_list_free(). The item pointers in the
17507 * list are only valid so long as those items are not deleted or the
17508 * genlist is not deleted.
17510 * @see elm_genlist_realized_items_update()
17514 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17516 * Get the item that is at the x, y canvas coords.
17518 * @param obj The gelinst object.
17519 * @param x The input x coordinate
17520 * @param y The input y coordinate
17521 * @param posret The position relative to the item returned here
17522 * @return The item at the coordinates or NULL if none
17524 * This returns the item at the given coordinates (which are canvas
17525 * relative, not object-relative). If an item is at that coordinate,
17526 * that item handle is returned, and if @p posret is not NULL, the
17527 * integer pointed to is set to a value of -1, 0 or 1, depending if
17528 * the coordinate is on the upper portion of that item (-1), on the
17529 * middle section (0) or on the lower part (1). If NULL is returned as
17530 * an item (no item found there), then posret may indicate -1 or 1
17531 * based if the coordinate is above or below all items respectively in
17536 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);
17538 * Get the first item in the genlist
17540 * This returns the first item in the list.
17542 * @param obj The genlist object
17543 * @return The first item, or NULL if none
17547 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17549 * Get the last item in the genlist
17551 * This returns the last item in the list.
17553 * @return The last item, or NULL if none
17557 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17559 * Set the scrollbar policy
17561 * @param obj The genlist object
17562 * @param policy_h Horizontal scrollbar policy.
17563 * @param policy_v Vertical scrollbar policy.
17565 * This sets the scrollbar visibility policy for the given genlist
17566 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17567 * made visible if it is needed, and otherwise kept hidden.
17568 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17569 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17570 * respectively for the horizontal and vertical scrollbars. Default is
17571 * #ELM_SMART_SCROLLER_POLICY_AUTO
17573 * @see elm_genlist_scroller_policy_get()
17577 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17579 * Get the scrollbar policy
17581 * @param obj The genlist object
17582 * @param policy_h Pointer to store the horizontal scrollbar policy.
17583 * @param policy_v Pointer to store the vertical scrollbar policy.
17585 * @see elm_genlist_scroller_policy_set()
17589 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);
17591 * Get the @b next item in a genlist widget's internal list of items,
17592 * given a handle to one of those items.
17594 * @param item The genlist item to fetch next from
17595 * @return The item after @p item, or @c NULL if there's none (and
17598 * This returns the item placed after the @p item, on the container
17601 * @see elm_genlist_item_prev_get()
17605 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17607 * Get the @b previous item in a genlist widget's internal list of items,
17608 * given a handle to one of those items.
17610 * @param item The genlist item to fetch previous from
17611 * @return The item before @p item, or @c NULL if there's none (and
17614 * This returns the item placed before the @p item, on the container
17617 * @see elm_genlist_item_next_get()
17621 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17623 * Get the genlist object's handle which contains a given genlist
17626 * @param item The item to fetch the container from
17627 * @return The genlist (parent) object
17629 * This returns the genlist object itself that an item belongs to.
17633 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17635 * Get the parent item of the given item
17637 * @param it The item
17638 * @return The parent of the item or @c NULL if it has no parent.
17640 * This returns the item that was specified as parent of the item @p it on
17641 * elm_genlist_item_append() and insertion related functions.
17645 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17647 * Remove all sub-items (children) of the given item
17649 * @param it The item
17651 * This removes all items that are children (and their descendants) of the
17652 * given item @p it.
17654 * @see elm_genlist_clear()
17655 * @see elm_genlist_item_del()
17659 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17661 * Set whether a given genlist item is selected or not
17663 * @param it The item
17664 * @param selected Use @c EINA_TRUE, to make it selected, @c
17665 * EINA_FALSE to make it unselected
17667 * This sets the selected state of an item. If multi selection is
17668 * not enabled on the containing genlist and @p selected is @c
17669 * EINA_TRUE, any other previously selected items will get
17670 * unselected in favor of this new one.
17672 * @see elm_genlist_item_selected_get()
17676 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17678 * Get whether a given genlist item is selected or not
17680 * @param it The item
17681 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17683 * @see elm_genlist_item_selected_set() for more details
17687 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17689 * Sets the expanded state of an item.
17691 * @param it The item
17692 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17694 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17697 * The theme will respond to this change visually, and a signal "expanded" or
17698 * "contracted" will be sent from the genlist with a pointer to the item that
17699 * has been expanded/contracted.
17701 * Calling this function won't show or hide any child of this item (if it is
17702 * a parent). You must manually delete and create them on the callbacks fo
17703 * the "expanded" or "contracted" signals.
17705 * @see elm_genlist_item_expanded_get()
17709 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17711 * Get the expanded state of an item
17713 * @param it The item
17714 * @return The expanded state
17716 * This gets the expanded state of an item.
17718 * @see elm_genlist_item_expanded_set()
17722 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17724 * Get the depth of expanded item
17726 * @param it The genlist item object
17727 * @return The depth of expanded item
17731 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17733 * Set whether a given genlist item is disabled or not.
17735 * @param it The item
17736 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17737 * to enable it back.
17739 * A disabled item cannot be selected or unselected. It will also
17740 * change its appearance, to signal the user it's disabled.
17742 * @see elm_genlist_item_disabled_get()
17746 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17748 * Get whether a given genlist item is disabled or not.
17750 * @param it The item
17751 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17754 * @see elm_genlist_item_disabled_set() for more details
17758 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17760 * Sets the display only state of an item.
17762 * @param it The item
17763 * @param display_only @c EINA_TRUE if the item is display only, @c
17764 * EINA_FALSE otherwise.
17766 * A display only item cannot be selected or unselected. It is for
17767 * display only and not selecting or otherwise clicking, dragging
17768 * etc. by the user, thus finger size rules will not be applied to
17771 * It's good to set group index items to display only state.
17773 * @see elm_genlist_item_display_only_get()
17777 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17779 * Get the display only state of an item
17781 * @param it The item
17782 * @return @c EINA_TRUE if the item is display only, @c
17783 * EINA_FALSE otherwise.
17785 * @see elm_genlist_item_display_only_set()
17789 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17791 * Show the portion of a genlist's internal list containing a given
17792 * item, immediately.
17794 * @param it The item to display
17796 * This causes genlist to jump to the given item @p it and show it (by
17797 * immediately scrolling to that position), if it is not fully visible.
17799 * @see elm_genlist_item_bring_in()
17800 * @see elm_genlist_item_top_show()
17801 * @see elm_genlist_item_middle_show()
17805 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17807 * Animatedly bring in, to the visible are of a genlist, a given
17810 * @param it The item to display
17812 * This causes genlist to jump to the given item @p it and show it (by
17813 * animatedly scrolling), if it is not fully visible. This may use animation
17814 * to do so and take a period of time
17816 * @see elm_genlist_item_show()
17817 * @see elm_genlist_item_top_bring_in()
17818 * @see elm_genlist_item_middle_bring_in()
17822 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17824 * Show the portion of a genlist's internal list containing a given
17825 * item, immediately.
17827 * @param it The item to display
17829 * This causes genlist to jump to the given item @p it and show it (by
17830 * immediately scrolling to that position), if it is not fully visible.
17832 * The item will be positioned at the top of the genlist viewport.
17834 * @see elm_genlist_item_show()
17835 * @see elm_genlist_item_top_bring_in()
17839 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17841 * Animatedly bring in, to the visible are of a genlist, a given
17844 * @param it The item
17846 * This causes genlist to jump to the given item @p it and show it (by
17847 * animatedly scrolling), if it is not fully visible. This may use animation
17848 * to do so and take a period of time
17850 * The item will be positioned at the top of the genlist viewport.
17852 * @see elm_genlist_item_bring_in()
17853 * @see elm_genlist_item_top_show()
17857 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17859 * Show the portion of a genlist's internal list containing a given
17860 * item, immediately.
17862 * @param it The item to display
17864 * This causes genlist to jump to the given item @p it and show it (by
17865 * immediately scrolling to that position), if it is not fully visible.
17867 * The item will be positioned at the middle of the genlist viewport.
17869 * @see elm_genlist_item_show()
17870 * @see elm_genlist_item_middle_bring_in()
17874 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17876 * Animatedly bring in, to the visible are of a genlist, a given
17879 * @param it The item
17881 * This causes genlist to jump to the given item @p it and show it (by
17882 * animatedly scrolling), if it is not fully visible. This may use animation
17883 * to do so and take a period of time
17885 * The item will be positioned at the middle of the genlist viewport.
17887 * @see elm_genlist_item_bring_in()
17888 * @see elm_genlist_item_middle_show()
17892 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17894 * Remove a genlist item from the its parent, deleting it.
17896 * @param item The item to be removed.
17897 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17899 * @see elm_genlist_clear(), to remove all items in a genlist at
17904 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17906 * Return the data associated to a given genlist item
17908 * @param item The genlist item.
17909 * @return the data associated to this item.
17911 * This returns the @c data value passed on the
17912 * elm_genlist_item_append() and related item addition calls.
17914 * @see elm_genlist_item_append()
17915 * @see elm_genlist_item_data_set()
17919 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17921 * Set the data associated to a given genlist item
17923 * @param item The genlist item
17924 * @param data The new data pointer to set on it
17926 * This @b overrides the @c data value passed on the
17927 * elm_genlist_item_append() and related item addition calls. This
17928 * function @b won't call elm_genlist_item_update() automatically,
17929 * so you'd issue it afterwards if you want to hove the item
17930 * updated to reflect the that new data.
17932 * @see elm_genlist_item_data_get()
17936 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17938 * Tells genlist to "orphan" icons fetchs by the item class
17940 * @param it The item
17942 * This instructs genlist to release references to icons in the item,
17943 * meaning that they will no longer be managed by genlist and are
17944 * floating "orphans" that can be re-used elsewhere if the user wants
17949 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17951 * Get the real Evas object created to implement the view of a
17952 * given genlist item
17954 * @param item The genlist item.
17955 * @return the Evas object implementing this item's view.
17957 * This returns the actual Evas object used to implement the
17958 * specified genlist item's view. This may be @c NULL, as it may
17959 * not have been created or may have been deleted, at any time, by
17960 * the genlist. <b>Do not modify this object</b> (move, resize,
17961 * show, hide, etc.), as the genlist is controlling it. This
17962 * function is for querying, emitting custom signals or hooking
17963 * lower level callbacks for events on that object. Do not delete
17964 * this object under any circumstances.
17966 * @see elm_genlist_item_data_get()
17970 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17972 * Update the contents of an item
17974 * @param it The item
17976 * This updates an item by calling all the item class functions again
17977 * to get the icons, labels and states. Use this when the original
17978 * item data has changed and the changes are desired to be reflected.
17980 * Use elm_genlist_realized_items_update() to update all already realized
17983 * @see elm_genlist_realized_items_update()
17987 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17989 * Update the item class of an item
17991 * @param it The item
17992 * @param itc The item class for the item
17994 * This sets another class fo the item, changing the way that it is
17995 * displayed. After changing the item class, elm_genlist_item_update() is
17996 * called on the item @p it.
18000 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18001 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18003 * Set the text to be shown in a given genlist item's tooltips.
18005 * @param item The genlist item
18006 * @param text The text to set in the content
18008 * This call will setup the text to be used as tooltip to that item
18009 * (analogous to elm_object_tooltip_text_set(), but being item
18010 * tooltips with higher precedence than object tooltips). It can
18011 * have only one tooltip at a time, so any previous tooltip data
18012 * will get removed.
18014 * In order to set an icon or something else as a tooltip, look at
18015 * elm_genlist_item_tooltip_content_cb_set().
18019 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18021 * Set the content to be shown in a given genlist item's tooltips
18023 * @param item The genlist item.
18024 * @param func The function returning the tooltip contents.
18025 * @param data What to provide to @a func as callback data/context.
18026 * @param del_cb Called when data is not needed anymore, either when
18027 * another callback replaces @p func, the tooltip is unset with
18028 * elm_genlist_item_tooltip_unset() or the owner @p item
18029 * dies. This callback receives as its first parameter the
18030 * given @p data, being @c event_info the item handle.
18032 * This call will setup the tooltip's contents to @p item
18033 * (analogous to elm_object_tooltip_content_cb_set(), but being
18034 * item tooltips with higher precedence than object tooltips). It
18035 * can have only one tooltip at a time, so any previous tooltip
18036 * content will get removed. @p func (with @p data) will be called
18037 * every time Elementary needs to show the tooltip and it should
18038 * return a valid Evas object, which will be fully managed by the
18039 * tooltip system, getting deleted when the tooltip is gone.
18041 * In order to set just a text as a tooltip, look at
18042 * elm_genlist_item_tooltip_text_set().
18046 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);
18048 * Unset a tooltip from a given genlist item
18050 * @param item genlist item to remove a previously set tooltip from.
18052 * This call removes any tooltip set on @p item. The callback
18053 * provided as @c del_cb to
18054 * elm_genlist_item_tooltip_content_cb_set() will be called to
18055 * notify it is not used anymore (and have resources cleaned, if
18058 * @see elm_genlist_item_tooltip_content_cb_set()
18062 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18064 * Set a different @b style for a given genlist item's tooltip.
18066 * @param item genlist item with tooltip set
18067 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18068 * "default", @c "transparent", etc)
18070 * Tooltips can have <b>alternate styles</b> to be displayed on,
18071 * which are defined by the theme set on Elementary. This function
18072 * works analogously as elm_object_tooltip_style_set(), but here
18073 * applied only to genlist item objects. The default style for
18074 * tooltips is @c "default".
18076 * @note before you set a style you should define a tooltip with
18077 * elm_genlist_item_tooltip_content_cb_set() or
18078 * elm_genlist_item_tooltip_text_set()
18080 * @see elm_genlist_item_tooltip_style_get()
18084 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18086 * Get the style set a given genlist item's tooltip.
18088 * @param item genlist item with tooltip already set on.
18089 * @return style the theme style in use, which defaults to
18090 * "default". If the object does not have a tooltip set,
18091 * then @c NULL is returned.
18093 * @see elm_genlist_item_tooltip_style_set() for more details
18097 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18099 * @brief Disable size restrictions on an object's tooltip
18100 * @param item The tooltip's anchor object
18101 * @param disable If EINA_TRUE, size restrictions are disabled
18102 * @return EINA_FALSE on failure, EINA_TRUE on success
18104 * This function allows a tooltip to expand beyond its parant window's canvas.
18105 * It will instead be limited only by the size of the display.
18107 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18109 * @brief Retrieve size restriction state of an object's tooltip
18110 * @param item The tooltip's anchor object
18111 * @return If EINA_TRUE, size restrictions are disabled
18113 * This function returns whether a tooltip is allowed to expand beyond
18114 * its parant window's canvas.
18115 * It will instead be limited only by the size of the display.
18117 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18119 * Set the type of mouse pointer/cursor decoration to be shown,
18120 * when the mouse pointer is over the given genlist widget item
18122 * @param item genlist item to customize cursor on
18123 * @param cursor the cursor type's name
18125 * This function works analogously as elm_object_cursor_set(), but
18126 * here the cursor's changing area is restricted to the item's
18127 * area, and not the whole widget's. Note that that item cursors
18128 * have precedence over widget cursors, so that a mouse over @p
18129 * item will always show cursor @p type.
18131 * If this function is called twice for an object, a previously set
18132 * cursor will be unset on the second call.
18134 * @see elm_object_cursor_set()
18135 * @see elm_genlist_item_cursor_get()
18136 * @see elm_genlist_item_cursor_unset()
18140 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18142 * Get the type of mouse pointer/cursor decoration set to be shown,
18143 * when the mouse pointer is over the given genlist widget item
18145 * @param item genlist item with custom cursor set
18146 * @return the cursor type's name or @c NULL, if no custom cursors
18147 * were set to @p item (and on errors)
18149 * @see elm_object_cursor_get()
18150 * @see elm_genlist_item_cursor_set() for more details
18151 * @see elm_genlist_item_cursor_unset()
18155 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18157 * Unset any custom mouse pointer/cursor decoration set to be
18158 * shown, when the mouse pointer is over the given genlist widget
18159 * item, thus making it show the @b default cursor again.
18161 * @param item a genlist item
18163 * Use this call to undo any custom settings on this item's cursor
18164 * decoration, bringing it back to defaults (no custom style set).
18166 * @see elm_object_cursor_unset()
18167 * @see elm_genlist_item_cursor_set() for more details
18171 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18173 * Set a different @b style for a given custom cursor set for a
18176 * @param item genlist item with custom cursor set
18177 * @param style the <b>theme style</b> to use (e.g. @c "default",
18178 * @c "transparent", etc)
18180 * This function only makes sense when one is using custom mouse
18181 * cursor decorations <b>defined in a theme file</b> , which can
18182 * have, given a cursor name/type, <b>alternate styles</b> on
18183 * it. It works analogously as elm_object_cursor_style_set(), but
18184 * here applied only to genlist item objects.
18186 * @warning Before you set a cursor style you should have defined a
18187 * custom cursor previously on the item, with
18188 * elm_genlist_item_cursor_set()
18190 * @see elm_genlist_item_cursor_engine_only_set()
18191 * @see elm_genlist_item_cursor_style_get()
18195 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18197 * Get the current @b style set for a given genlist item's custom
18200 * @param item genlist item with custom cursor set.
18201 * @return style the cursor style in use. If the object does not
18202 * have a cursor set, then @c NULL is returned.
18204 * @see elm_genlist_item_cursor_style_set() for more details
18208 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18210 * Set if the (custom) cursor for a given genlist item should be
18211 * searched in its theme, also, or should only rely on the
18212 * rendering engine.
18214 * @param item item with custom (custom) cursor already set on
18215 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18216 * only on those provided by the rendering engine, @c EINA_FALSE to
18217 * have them searched on the widget's theme, as well.
18219 * @note This call is of use only if you've set a custom cursor
18220 * for genlist items, with elm_genlist_item_cursor_set().
18222 * @note By default, cursors will only be looked for between those
18223 * provided by the rendering engine.
18227 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18229 * Get if the (custom) cursor for a given genlist item is being
18230 * searched in its theme, also, or is only relying on the rendering
18233 * @param item a genlist item
18234 * @return @c EINA_TRUE, if cursors are being looked for only on
18235 * those provided by the rendering engine, @c EINA_FALSE if they
18236 * are being searched on the widget's theme, as well.
18238 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18242 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18244 * Update the contents of all realized items.
18246 * @param obj The genlist object.
18248 * This updates all realized items by calling all the item class functions again
18249 * to get the icons, labels and states. Use this when the original
18250 * item data has changed and the changes are desired to be reflected.
18252 * To update just one item, use elm_genlist_item_update().
18254 * @see elm_genlist_realized_items_get()
18255 * @see elm_genlist_item_update()
18259 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18261 * Activate a genlist mode on an item
18263 * @param item The genlist item
18264 * @param mode Mode name
18265 * @param mode_set Boolean to define set or unset mode.
18267 * A genlist mode is a different way of selecting an item. Once a mode is
18268 * activated on an item, any other selected item is immediately unselected.
18269 * This feature provides an easy way of implementing a new kind of animation
18270 * for selecting an item, without having to entirely rewrite the item style
18271 * theme. However, the elm_genlist_selected_* API can't be used to get what
18272 * item is activate for a mode.
18274 * The current item style will still be used, but applying a genlist mode to
18275 * an item will select it using a different kind of animation.
18277 * The current active item for a mode can be found by
18278 * elm_genlist_mode_item_get().
18280 * The characteristics of genlist mode are:
18281 * - Only one mode can be active at any time, and for only one item.
18282 * - Genlist handles deactivating other items when one item is activated.
18283 * - A mode is defined in the genlist theme (edc), and more modes can easily
18285 * - A mode style and the genlist item style are different things. They
18286 * can be combined to provide a default style to the item, with some kind
18287 * of animation for that item when the mode is activated.
18289 * When a mode is activated on an item, a new view for that item is created.
18290 * The theme of this mode defines the animation that will be used to transit
18291 * the item from the old view to the new view. This second (new) view will be
18292 * active for that item while the mode is active on the item, and will be
18293 * destroyed after the mode is totally deactivated from that item.
18295 * @see elm_genlist_mode_get()
18296 * @see elm_genlist_mode_item_get()
18300 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18302 * Get the last (or current) genlist mode used.
18304 * @param obj The genlist object
18306 * This function just returns the name of the last used genlist mode. It will
18307 * be the current mode if it's still active.
18309 * @see elm_genlist_item_mode_set()
18310 * @see elm_genlist_mode_item_get()
18314 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18316 * Get active genlist mode item
18318 * @param obj The genlist object
18319 * @return The active item for that current mode. Or @c NULL if no item is
18320 * activated with any mode.
18322 * This function returns the item that was activated with a mode, by the
18323 * function elm_genlist_item_mode_set().
18325 * @see elm_genlist_item_mode_set()
18326 * @see elm_genlist_mode_get()
18330 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18335 * @param obj The genlist object
18336 * @param reorder_mode The reorder mode
18337 * (EINA_TRUE = on, EINA_FALSE = off)
18341 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18344 * Get the reorder mode
18346 * @param obj The genlist object
18347 * @return The reorder mode
18348 * (EINA_TRUE = on, EINA_FALSE = off)
18352 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18359 * @defgroup Check Check
18361 * @image html img/widget/check/preview-00.png
18362 * @image latex img/widget/check/preview-00.eps
18363 * @image html img/widget/check/preview-01.png
18364 * @image latex img/widget/check/preview-01.eps
18365 * @image html img/widget/check/preview-02.png
18366 * @image latex img/widget/check/preview-02.eps
18368 * @brief The check widget allows for toggling a value between true and
18371 * Check objects are a lot like radio objects in layout and functionality
18372 * except they do not work as a group, but independently and only toggle the
18373 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18374 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18375 * returns the current state. For convenience, like the radio objects, you
18376 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18377 * for it to modify.
18379 * Signals that you can add callbacks for are:
18380 * "changed" - This is called whenever the user changes the state of one of
18381 * the check object(event_info is NULL).
18383 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18387 * @brief Add a new Check object
18389 * @param parent The parent object
18390 * @return The new object or NULL if it cannot be created
18392 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18394 * @brief Set the text label of the check object
18396 * @param obj The check object
18397 * @param label The text label string in UTF-8
18399 * @deprecated use elm_object_text_set() instead.
18401 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18403 * @brief Get the text label of the check object
18405 * @param obj The check object
18406 * @return The text label string in UTF-8
18408 * @deprecated use elm_object_text_get() instead.
18410 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18412 * @brief Set the icon object of the check object
18414 * @param obj The check object
18415 * @param icon The icon object
18417 * Once the icon object is set, a previously set one will be deleted.
18418 * If you want to keep that old content object, use the
18419 * elm_check_icon_unset() function.
18421 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18423 * @brief Get the icon object of the check object
18425 * @param obj The check object
18426 * @return The icon object
18428 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18430 * @brief Unset the icon used for the check object
18432 * @param obj The check object
18433 * @return The icon object that was being used
18435 * Unparent and return the icon object which was set for this widget.
18437 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18439 * @brief Set the on/off state of the check object
18441 * @param obj The check object
18442 * @param state The state to use (1 == on, 0 == off)
18444 * This sets the state of the check. If set
18445 * with elm_check_state_pointer_set() the state of that variable is also
18446 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18448 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18450 * @brief Get the state of the check object
18452 * @param obj The check object
18453 * @return The boolean state
18455 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18457 * @brief Set a convenience pointer to a boolean to change
18459 * @param obj The check object
18460 * @param statep Pointer to the boolean to modify
18462 * This sets a pointer to a boolean, that, in addition to the check objects
18463 * state will also be modified directly. To stop setting the object pointed
18464 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18465 * then when this is called, the check objects state will also be modified to
18466 * reflect the value of the boolean @p statep points to, just like calling
18467 * elm_check_state_set().
18469 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18475 * @defgroup Radio Radio
18477 * @image html img/widget/radio/preview-00.png
18478 * @image latex img/widget/radio/preview-00.eps
18480 * @brief Radio is a widget that allows for 1 or more options to be displayed
18481 * and have the user choose only 1 of them.
18483 * A radio object contains an indicator, an optional Label and an optional
18484 * icon object. While it's possible to have a group of only one radio they,
18485 * are normally used in groups of 2 or more. To add a radio to a group use
18486 * elm_radio_group_add(). The radio object(s) will select from one of a set
18487 * of integer values, so any value they are configuring needs to be mapped to
18488 * a set of integers. To configure what value that radio object represents,
18489 * use elm_radio_state_value_set() to set the integer it represents. To set
18490 * the value the whole group(which one is currently selected) is to indicate
18491 * use elm_radio_value_set() on any group member, and to get the groups value
18492 * use elm_radio_value_get(). For convenience the radio objects are also able
18493 * to directly set an integer(int) to the value that is selected. To specify
18494 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18495 * The radio objects will modify this directly. That implies the pointer must
18496 * point to valid memory for as long as the radio objects exist.
18498 * Signals that you can add callbacks for are:
18499 * @li changed - This is called whenever the user changes the state of one of
18500 * the radio objects within the group of radio objects that work together.
18502 * @ref tutorial_radio show most of this API in action.
18506 * @brief Add a new radio to the parent
18508 * @param parent The parent object
18509 * @return The new object or NULL if it cannot be created
18511 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18513 * @brief Set the text label of the radio object
18515 * @param obj The radio object
18516 * @param label The text label string in UTF-8
18518 * @deprecated use elm_object_text_set() instead.
18520 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18522 * @brief Get the text label of the radio object
18524 * @param obj The radio object
18525 * @return The text label string in UTF-8
18527 * @deprecated use elm_object_text_set() instead.
18529 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18531 * @brief Set the icon object of the radio object
18533 * @param obj The radio object
18534 * @param icon The icon object
18536 * Once the icon object is set, a previously set one will be deleted. If you
18537 * want to keep that old content object, use the elm_radio_icon_unset()
18540 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18542 * @brief Get the icon object of the radio object
18544 * @param obj The radio object
18545 * @return The icon object
18547 * @see elm_radio_icon_set()
18549 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18551 * @brief Unset the icon used for the radio object
18553 * @param obj The radio object
18554 * @return The icon object that was being used
18556 * Unparent and return the icon object which was set for this widget.
18558 * @see elm_radio_icon_set()
18560 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18562 * @brief Add this radio to a group of other radio objects
18564 * @param obj The radio object
18565 * @param group Any object whose group the @p obj is to join.
18567 * Radio objects work in groups. Each member should have a different integer
18568 * value assigned. In order to have them work as a group, they need to know
18569 * about each other. This adds the given radio object to the group of which
18570 * the group object indicated is a member.
18572 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18574 * @brief Set the integer value that this radio object represents
18576 * @param obj The radio object
18577 * @param value The value to use if this radio object is selected
18579 * This sets the value of the radio.
18581 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18583 * @brief Get the integer value that this radio object represents
18585 * @param obj The radio object
18586 * @return The value used if this radio object is selected
18588 * This gets the value of the radio.
18590 * @see elm_radio_value_set()
18592 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18594 * @brief Set the value of the radio.
18596 * @param obj The radio object
18597 * @param value The value to use for the group
18599 * This sets the value of the radio group and will also set the value if
18600 * pointed to, to the value supplied, but will not call any callbacks.
18602 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18604 * @brief Get the state of the radio object
18606 * @param obj The radio object
18607 * @return The integer state
18609 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18611 * @brief Set a convenience pointer to a integer to change
18613 * @param obj The radio object
18614 * @param valuep Pointer to the integer to modify
18616 * This sets a pointer to a integer, that, in addition to the radio objects
18617 * state will also be modified directly. To stop setting the object pointed
18618 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18619 * when this is called, the radio objects state will also be modified to
18620 * reflect the value of the integer valuep points to, just like calling
18621 * elm_radio_value_set().
18623 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18629 * @defgroup Pager Pager
18631 * @image html img/widget/pager/preview-00.png
18632 * @image latex img/widget/pager/preview-00.eps
18634 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18636 * The flipping between “pages” of objects is animated. All content in pager
18637 * is kept in a stack, the last content to be added will be on the top of the
18638 * stack(be visible).
18640 * Objects can be pushed or popped from the stack or deleted as normal.
18641 * Pushes and pops will animate (and a pop will delete the object once the
18642 * animation is finished). Any object already in the pager can be promoted to
18643 * the top(from its current stacking position) through the use of
18644 * elm_pager_content_promote(). Objects are pushed to the top with
18645 * elm_pager_content_push() and when the top item is no longer wanted, simply
18646 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18647 * object is no longer needed and is not the top item, just delete it as
18648 * normal. You can query which objects are the top and bottom with
18649 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18651 * Signals that you can add callbacks for are:
18652 * "hide,finished" - when the previous page is hided
18654 * This widget has the following styles available:
18657 * @li fade_translucide
18658 * @li fade_invisible
18659 * @note This styles affect only the flipping animations, the appearance when
18660 * not animating is unaffected by styles.
18662 * @ref tutorial_pager gives a good overview of the usage of the API.
18666 * Add a new pager to the parent
18668 * @param parent The parent object
18669 * @return The new object or NULL if it cannot be created
18673 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18675 * @brief Push an object to the top of the pager stack (and show it).
18677 * @param obj The pager object
18678 * @param content The object to push
18680 * The object pushed becomes a child of the pager, it will be controlled and
18681 * deleted when the pager is deleted.
18683 * @note If the content is already in the stack use
18684 * elm_pager_content_promote().
18685 * @warning Using this function on @p content already in the stack results in
18686 * undefined behavior.
18688 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18690 * @brief Pop the object that is on top of the stack
18692 * @param obj The pager object
18694 * This pops the object that is on the top(visible) of the pager, makes it
18695 * disappear, then deletes the object. The object that was underneath it on
18696 * the stack will become visible.
18698 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18700 * @brief Moves an object already in the pager stack to the top of the stack.
18702 * @param obj The pager object
18703 * @param content The object to promote
18705 * This will take the @p content and move it to the top of the stack as
18706 * if it had been pushed there.
18708 * @note If the content isn't already in the stack use
18709 * elm_pager_content_push().
18710 * @warning Using this function on @p content not already in the stack
18711 * results in undefined behavior.
18713 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18715 * @brief Return the object at the bottom of the pager stack
18717 * @param obj The pager object
18718 * @return The bottom object or NULL if none
18720 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18722 * @brief Return the object at the top of the pager stack
18724 * @param obj The pager object
18725 * @return The top object or NULL if none
18727 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18733 * @defgroup Slideshow Slideshow
18735 * @image html img/widget/slideshow/preview-00.png
18736 * @image latex img/widget/slideshow/preview-00.eps
18738 * This widget, as the name indicates, is a pre-made image
18739 * slideshow panel, with API functions acting on (child) image
18740 * items presentation. Between those actions, are:
18741 * - advance to next/previous image
18742 * - select the style of image transition animation
18743 * - set the exhibition time for each image
18744 * - start/stop the slideshow
18746 * The transition animations are defined in the widget's theme,
18747 * consequently new animations can be added without having to
18748 * update the widget's code.
18750 * @section Slideshow_Items Slideshow items
18752 * For slideshow items, just like for @ref Genlist "genlist" ones,
18753 * the user defines a @b classes, specifying functions that will be
18754 * called on the item's creation and deletion times.
18756 * The #Elm_Slideshow_Item_Class structure contains the following
18759 * - @c func.get - When an item is displayed, this function is
18760 * called, and it's where one should create the item object, de
18761 * facto. For example, the object can be a pure Evas image object
18762 * or an Elementary @ref Photocam "photocam" widget. See
18763 * #SlideshowItemGetFunc.
18764 * - @c func.del - When an item is no more displayed, this function
18765 * is called, where the user must delete any data associated to
18766 * the item. See #SlideshowItemDelFunc.
18768 * @section Slideshow_Caching Slideshow caching
18770 * The slideshow provides facilities to have items adjacent to the
18771 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18772 * you, so that the system does not have to decode image data
18773 * anymore at the time it has to actually switch images on its
18774 * viewport. The user is able to set the numbers of items to be
18775 * cached @b before and @b after the current item, in the widget's
18778 * Smart events one can add callbacks for are:
18780 * - @c "changed" - when the slideshow switches its view to a new
18783 * List of examples for the slideshow widget:
18784 * @li @ref slideshow_example
18788 * @addtogroup Slideshow
18792 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18793 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18794 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18795 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18796 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18799 * @struct _Elm_Slideshow_Item_Class
18801 * Slideshow item class definition. See @ref Slideshow_Items for
18804 struct _Elm_Slideshow_Item_Class
18806 struct _Elm_Slideshow_Item_Class_Func
18808 SlideshowItemGetFunc get;
18809 SlideshowItemDelFunc del;
18811 }; /**< #Elm_Slideshow_Item_Class member definitions */
18814 * Add a new slideshow widget to the given parent Elementary
18815 * (container) object
18817 * @param parent The parent object
18818 * @return A new slideshow widget handle or @c NULL, on errors
18820 * This function inserts a new slideshow widget on the canvas.
18822 * @ingroup Slideshow
18824 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18827 * Add (append) a new item in a given slideshow widget.
18829 * @param obj The slideshow object
18830 * @param itc The item class for the item
18831 * @param data The item's data
18832 * @return A handle to the item added or @c NULL, on errors
18834 * Add a new item to @p obj's internal list of items, appending it.
18835 * The item's class must contain the function really fetching the
18836 * image object to show for this item, which could be an Evas image
18837 * object or an Elementary photo, for example. The @p data
18838 * parameter is going to be passed to both class functions of the
18841 * @see #Elm_Slideshow_Item_Class
18842 * @see elm_slideshow_item_sorted_insert()
18844 * @ingroup Slideshow
18846 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18849 * Insert a new item into the given slideshow widget, using the @p func
18850 * function to sort items (by item handles).
18852 * @param obj The slideshow object
18853 * @param itc The item class for the item
18854 * @param data The item's data
18855 * @param func The comparing function to be used to sort slideshow
18856 * items <b>by #Elm_Slideshow_Item item handles</b>
18857 * @return Returns The slideshow item handle, on success, or
18858 * @c NULL, on errors
18860 * Add a new item to @p obj's internal list of items, in a position
18861 * determined by the @p func comparing function. The item's class
18862 * must contain the function really fetching the image object to
18863 * show for this item, which could be an Evas image object or an
18864 * Elementary photo, for example. The @p data parameter is going to
18865 * be passed to both class functions of the item.
18867 * @see #Elm_Slideshow_Item_Class
18868 * @see elm_slideshow_item_add()
18870 * @ingroup Slideshow
18872 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);
18875 * Display a given slideshow widget's item, programmatically.
18877 * @param obj The slideshow object
18878 * @param item The item to display on @p obj's viewport
18880 * The change between the current item and @p item will use the
18881 * transition @p obj is set to use (@see
18882 * elm_slideshow_transition_set()).
18884 * @ingroup Slideshow
18886 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18889 * Slide to the @b next item, in a given slideshow widget
18891 * @param obj The slideshow object
18893 * The sliding animation @p obj is set to use will be the
18894 * transition effect used, after this call is issued.
18896 * @note If the end of the slideshow's internal list of items is
18897 * reached, it'll wrap around to the list's beginning, again.
18899 * @ingroup Slideshow
18901 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18904 * Slide to the @b previous item, in a given slideshow widget
18906 * @param obj The slideshow object
18908 * The sliding animation @p obj is set to use will be the
18909 * transition effect used, after this call is issued.
18911 * @note If the beginning of the slideshow's internal list of items
18912 * is reached, it'll wrap around to the list's end, again.
18914 * @ingroup Slideshow
18916 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18919 * Returns the list of sliding transition/effect names available, for a
18920 * given slideshow widget.
18922 * @param obj The slideshow object
18923 * @return The list of transitions (list of @b stringshared strings
18926 * The transitions, which come from @p obj's theme, must be an EDC
18927 * data item named @c "transitions" on the theme file, with (prefix)
18928 * names of EDC programs actually implementing them.
18930 * The available transitions for slideshows on the default theme are:
18931 * - @c "fade" - the current item fades out, while the new one
18932 * fades in to the slideshow's viewport.
18933 * - @c "black_fade" - the current item fades to black, and just
18934 * then, the new item will fade in.
18935 * - @c "horizontal" - the current item slides horizontally, until
18936 * it gets out of the slideshow's viewport, while the new item
18937 * comes from the left to take its place.
18938 * - @c "vertical" - the current item slides vertically, until it
18939 * gets out of the slideshow's viewport, while the new item comes
18940 * from the bottom to take its place.
18941 * - @c "square" - the new item starts to appear from the middle of
18942 * the current one, but with a tiny size, growing until its
18943 * target (full) size and covering the old one.
18945 * @warning The stringshared strings get no new references
18946 * exclusive to the user grabbing the list, here, so if you'd like
18947 * to use them out of this call's context, you'd better @c
18948 * eina_stringshare_ref() them.
18950 * @see elm_slideshow_transition_set()
18952 * @ingroup Slideshow
18954 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18957 * Set the current slide transition/effect in use for a given
18960 * @param obj The slideshow object
18961 * @param transition The new transition's name string
18963 * If @p transition is implemented in @p obj's theme (i.e., is
18964 * contained in the list returned by
18965 * elm_slideshow_transitions_get()), this new sliding effect will
18966 * be used on the widget.
18968 * @see elm_slideshow_transitions_get() for more details
18970 * @ingroup Slideshow
18972 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18975 * Get the current slide transition/effect in use for a given
18978 * @param obj The slideshow object
18979 * @return The current transition's name
18981 * @see elm_slideshow_transition_set() for more details
18983 * @ingroup Slideshow
18985 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18988 * Set the interval between each image transition on a given
18989 * slideshow widget, <b>and start the slideshow, itself</b>
18991 * @param obj The slideshow object
18992 * @param timeout The new displaying timeout for images
18994 * After this call, the slideshow widget will start cycling its
18995 * view, sequentially and automatically, with the images of the
18996 * items it has. The time between each new image displayed is going
18997 * to be @p timeout, in @b seconds. If a different timeout was set
18998 * previously and an slideshow was in progress, it will continue
18999 * with the new time between transitions, after this call.
19001 * @note A value less than or equal to 0 on @p timeout will disable
19002 * the widget's internal timer, thus halting any slideshow which
19003 * could be happening on @p obj.
19005 * @see elm_slideshow_timeout_get()
19007 * @ingroup Slideshow
19009 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19012 * Get the interval set for image transitions on a given slideshow
19015 * @param obj The slideshow object
19016 * @return Returns the timeout set on it
19018 * @see elm_slideshow_timeout_set() for more details
19020 * @ingroup Slideshow
19022 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19025 * Set if, after a slideshow is started, for a given slideshow
19026 * widget, its items should be displayed cyclically or not.
19028 * @param obj The slideshow object
19029 * @param loop Use @c EINA_TRUE to make it cycle through items or
19030 * @c EINA_FALSE for it to stop at the end of @p obj's internal
19033 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19034 * ignore what is set by this functions, i.e., they'll @b always
19035 * cycle through items. This affects only the "automatic"
19036 * slideshow, as set by elm_slideshow_timeout_set().
19038 * @see elm_slideshow_loop_get()
19040 * @ingroup Slideshow
19042 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19045 * Get if, after a slideshow is started, for a given slideshow
19046 * widget, its items are to be displayed cyclically or not.
19048 * @param obj The slideshow object
19049 * @return @c EINA_TRUE, if the items in @p obj will be cycled
19050 * through or @c EINA_FALSE, otherwise
19052 * @see elm_slideshow_loop_set() for more details
19054 * @ingroup Slideshow
19056 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19059 * Remove all items from a given slideshow widget
19061 * @param obj The slideshow object
19063 * This removes (and deletes) all items in @p obj, leaving it
19066 * @see elm_slideshow_item_del(), to remove just one item.
19068 * @ingroup Slideshow
19070 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19073 * Get the internal list of items in a given slideshow widget.
19075 * @param obj The slideshow object
19076 * @return The list of items (#Elm_Slideshow_Item as data) or
19077 * @c NULL on errors.
19079 * This list is @b not to be modified in any way and must not be
19080 * freed. Use the list members with functions like
19081 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19083 * @warning This list is only valid until @p obj object's internal
19084 * items list is changed. It should be fetched again with another
19085 * call to this function when changes happen.
19087 * @ingroup Slideshow
19089 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19092 * Delete a given item from a slideshow widget.
19094 * @param item The slideshow item
19096 * @ingroup Slideshow
19098 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19101 * Return the data associated with a given slideshow item
19103 * @param item The slideshow item
19104 * @return Returns the data associated to this item
19106 * @ingroup Slideshow
19108 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19111 * Returns the currently displayed item, in a given slideshow widget
19113 * @param obj The slideshow object
19114 * @return A handle to the item being displayed in @p obj or
19115 * @c NULL, if none is (and on errors)
19117 * @ingroup Slideshow
19119 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19122 * Get the real Evas object created to implement the view of a
19123 * given slideshow item
19125 * @param item The slideshow item.
19126 * @return the Evas object implementing this item's view.
19128 * This returns the actual Evas object used to implement the
19129 * specified slideshow item's view. This may be @c NULL, as it may
19130 * not have been created or may have been deleted, at any time, by
19131 * the slideshow. <b>Do not modify this object</b> (move, resize,
19132 * show, hide, etc.), as the slideshow is controlling it. This
19133 * function is for querying, emitting custom signals or hooking
19134 * lower level callbacks for events on that object. Do not delete
19135 * this object under any circumstances.
19137 * @see elm_slideshow_item_data_get()
19139 * @ingroup Slideshow
19141 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19144 * Get the the item, in a given slideshow widget, placed at
19145 * position @p nth, in its internal items list
19147 * @param obj The slideshow object
19148 * @param nth The number of the item to grab a handle to (0 being
19150 * @return The item stored in @p obj at position @p nth or @c NULL,
19151 * if there's no item with that index (and on errors)
19153 * @ingroup Slideshow
19155 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19158 * Set the current slide layout in use for a given slideshow widget
19160 * @param obj The slideshow object
19161 * @param layout The new layout's name string
19163 * If @p layout is implemented in @p obj's theme (i.e., is contained
19164 * in the list returned by elm_slideshow_layouts_get()), this new
19165 * images layout will be used on the widget.
19167 * @see elm_slideshow_layouts_get() for more details
19169 * @ingroup Slideshow
19171 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19174 * Get the current slide layout in use for a given slideshow widget
19176 * @param obj The slideshow object
19177 * @return The current layout's name
19179 * @see elm_slideshow_layout_set() for more details
19181 * @ingroup Slideshow
19183 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19186 * Returns the list of @b layout names available, for a given
19187 * slideshow widget.
19189 * @param obj The slideshow object
19190 * @return The list of layouts (list of @b stringshared strings
19193 * Slideshow layouts will change how the widget is to dispose each
19194 * image item in its viewport, with regard to cropping, scaling,
19197 * The layouts, which come from @p obj's theme, must be an EDC
19198 * data item name @c "layouts" on the theme file, with (prefix)
19199 * names of EDC programs actually implementing them.
19201 * The available layouts for slideshows on the default theme are:
19202 * - @c "fullscreen" - item images with original aspect, scaled to
19203 * touch top and down slideshow borders or, if the image's heigh
19204 * is not enough, left and right slideshow borders.
19205 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19206 * one, but always leaving 10% of the slideshow's dimensions of
19207 * distance between the item image's borders and the slideshow
19208 * borders, for each axis.
19210 * @warning The stringshared strings get no new references
19211 * exclusive to the user grabbing the list, here, so if you'd like
19212 * to use them out of this call's context, you'd better @c
19213 * eina_stringshare_ref() them.
19215 * @see elm_slideshow_layout_set()
19217 * @ingroup Slideshow
19219 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19222 * Set the number of items to cache, on a given slideshow widget,
19223 * <b>before the current item</b>
19225 * @param obj The slideshow object
19226 * @param count Number of items to cache before the current one
19228 * The default value for this property is @c 2. See
19229 * @ref Slideshow_Caching "slideshow caching" for more details.
19231 * @see elm_slideshow_cache_before_get()
19233 * @ingroup Slideshow
19235 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19238 * Retrieve the number of items to cache, on a given slideshow widget,
19239 * <b>before the current item</b>
19241 * @param obj The slideshow object
19242 * @return The number of items set to be cached before the current one
19244 * @see elm_slideshow_cache_before_set() for more details
19246 * @ingroup Slideshow
19248 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19251 * Set the number of items to cache, on a given slideshow widget,
19252 * <b>after the current item</b>
19254 * @param obj The slideshow object
19255 * @param count Number of items to cache after the current one
19257 * The default value for this property is @c 2. See
19258 * @ref Slideshow_Caching "slideshow caching" for more details.
19260 * @see elm_slideshow_cache_after_get()
19262 * @ingroup Slideshow
19264 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19267 * Retrieve the number of items to cache, on a given slideshow widget,
19268 * <b>after the current item</b>
19270 * @param obj The slideshow object
19271 * @return The number of items set to be cached after the current one
19273 * @see elm_slideshow_cache_after_set() for more details
19275 * @ingroup Slideshow
19277 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19280 * Get the number of items stored in a given slideshow widget
19282 * @param obj The slideshow object
19283 * @return The number of items on @p obj, at the moment of this call
19285 * @ingroup Slideshow
19287 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19294 * @defgroup Fileselector File Selector
19296 * @image html img/widget/fileselector/preview-00.png
19297 * @image latex img/widget/fileselector/preview-00.eps
19299 * A file selector is a widget that allows a user to navigate
19300 * through a file system, reporting file selections back via its
19303 * It contains shortcut buttons for home directory (@c ~) and to
19304 * jump one directory upwards (..), as well as cancel/ok buttons to
19305 * confirm/cancel a given selection. After either one of those two
19306 * former actions, the file selector will issue its @c "done" smart
19309 * There's a text entry on it, too, showing the name of the current
19310 * selection. There's the possibility of making it editable, so it
19311 * is useful on file saving dialogs on applications, where one
19312 * gives a file name to save contents to, in a given directory in
19313 * the system. This custom file name will be reported on the @c
19314 * "done" smart callback (explained in sequence).
19316 * Finally, it has a view to display file system items into in two
19321 * If Elementary is built with support of the Ethumb thumbnailing
19322 * library, the second form of view will display preview thumbnails
19323 * of files which it supports.
19325 * Smart callbacks one can register to:
19327 * - @c "selected" - the user has clicked on a file (when not in
19328 * folders-only mode) or directory (when in folders-only mode)
19329 * - @c "directory,open" - the list has been populated with new
19330 * content (@c event_info is a pointer to the directory's
19331 * path, a @b stringshared string)
19332 * - @c "done" - the user has clicked on the "ok" or "cancel"
19333 * buttons (@c event_info is a pointer to the selection's
19334 * path, a @b stringshared string)
19336 * Here is an example on its usage:
19337 * @li @ref fileselector_example
19341 * @addtogroup Fileselector
19346 * Defines how a file selector widget is to layout its contents
19347 * (file system entries).
19349 typedef enum _Elm_Fileselector_Mode
19351 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19352 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19353 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19354 } Elm_Fileselector_Mode;
19357 * Add a new file selector widget to the given parent Elementary
19358 * (container) object
19360 * @param parent The parent object
19361 * @return a new file selector widget handle or @c NULL, on errors
19363 * This function inserts a new file selector widget on the canvas.
19365 * @ingroup Fileselector
19367 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19370 * Enable/disable the file name entry box where the user can type
19371 * in a name for a file, in a given file selector widget
19373 * @param obj The file selector object
19374 * @param is_save @c EINA_TRUE to make the file selector a "saving
19375 * dialog", @c EINA_FALSE otherwise
19377 * Having the entry editable is useful on file saving dialogs on
19378 * applications, where one gives a file name to save contents to,
19379 * in a given directory in the system. This custom file name will
19380 * be reported on the @c "done" smart callback.
19382 * @see elm_fileselector_is_save_get()
19384 * @ingroup Fileselector
19386 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19389 * Get whether the given file selector is in "saving dialog" mode
19391 * @param obj The file selector object
19392 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19393 * mode, @c EINA_FALSE otherwise (and on errors)
19395 * @see elm_fileselector_is_save_set() for more details
19397 * @ingroup Fileselector
19399 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19402 * Enable/disable folder-only view for a given file selector widget
19404 * @param obj The file selector object
19405 * @param only @c EINA_TRUE to make @p obj only display
19406 * directories, @c EINA_FALSE to make files to be displayed in it
19409 * If enabled, the widget's view will only display folder items,
19412 * @see elm_fileselector_folder_only_get()
19414 * @ingroup Fileselector
19416 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19419 * Get whether folder-only view is set for a given file selector
19422 * @param obj The file selector object
19423 * @return only @c EINA_TRUE if @p obj is only displaying
19424 * directories, @c EINA_FALSE if files are being displayed in it
19425 * too (and on errors)
19427 * @see elm_fileselector_folder_only_get()
19429 * @ingroup Fileselector
19431 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19434 * Enable/disable the "ok" and "cancel" buttons on a given file
19437 * @param obj The file selector object
19438 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19440 * @note A file selector without those buttons will never emit the
19441 * @c "done" smart event, and is only usable if one is just hooking
19442 * to the other two events.
19444 * @see elm_fileselector_buttons_ok_cancel_get()
19446 * @ingroup Fileselector
19448 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19451 * Get whether the "ok" and "cancel" buttons on a given file
19452 * selector widget are being shown.
19454 * @param obj The file selector object
19455 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19456 * otherwise (and on errors)
19458 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19460 * @ingroup Fileselector
19462 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19465 * Enable/disable a tree view in the given file selector widget,
19466 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19468 * @param obj The file selector object
19469 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19472 * In a tree view, arrows are created on the sides of directories,
19473 * allowing them to expand in place.
19475 * @note If it's in other mode, the changes made by this function
19476 * will only be visible when one switches back to "list" mode.
19478 * @see elm_fileselector_expandable_get()
19480 * @ingroup Fileselector
19482 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19485 * Get whether tree view is enabled for the given file selector
19488 * @param obj The file selector object
19489 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19490 * otherwise (and or errors)
19492 * @see elm_fileselector_expandable_set() for more details
19494 * @ingroup Fileselector
19496 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19499 * Set, programmatically, the @b directory that a given file
19500 * selector widget will display contents from
19502 * @param obj The file selector object
19503 * @param path The path to display in @p obj
19505 * This will change the @b directory that @p obj is displaying. It
19506 * will also clear the text entry area on the @p obj object, which
19507 * displays select files' names.
19509 * @see elm_fileselector_path_get()
19511 * @ingroup Fileselector
19513 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19516 * Get the parent directory's path that a given file selector
19517 * widget is displaying
19519 * @param obj The file selector object
19520 * @return The (full) path of the directory the file selector is
19521 * displaying, a @b stringshared string
19523 * @see elm_fileselector_path_set()
19525 * @ingroup Fileselector
19527 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19530 * Set, programmatically, the currently selected file/directory in
19531 * the given file selector widget
19533 * @param obj The file selector object
19534 * @param path The (full) path to a file or directory
19535 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19536 * latter case occurs if the directory or file pointed to do not
19539 * @see elm_fileselector_selected_get()
19541 * @ingroup Fileselector
19543 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19546 * Get the currently selected item's (full) path, in the given file
19549 * @param obj The file selector object
19550 * @return The absolute path of the selected item, a @b
19551 * stringshared string
19553 * @note Custom editions on @p obj object's text entry, if made,
19554 * will appear on the return string of this function, naturally.
19556 * @see elm_fileselector_selected_set() for more details
19558 * @ingroup Fileselector
19560 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19563 * Set the mode in which a given file selector widget will display
19564 * (layout) file system entries in its view
19566 * @param obj The file selector object
19567 * @param mode The mode of the fileselector, being it one of
19568 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19569 * first one, naturally, will display the files in a list. The
19570 * latter will make the widget to display its entries in a grid
19573 * @note By using elm_fileselector_expandable_set(), the user may
19574 * trigger a tree view for that list.
19576 * @note If Elementary is built with support of the Ethumb
19577 * thumbnailing library, the second form of view will display
19578 * preview thumbnails of files which it supports. You must have
19579 * elm_need_ethumb() called in your Elementary for thumbnailing to
19582 * @see elm_fileselector_expandable_set().
19583 * @see elm_fileselector_mode_get().
19585 * @ingroup Fileselector
19587 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19590 * Get the mode in which a given file selector widget is displaying
19591 * (layouting) file system entries in its view
19593 * @param obj The fileselector object
19594 * @return The mode in which the fileselector is at
19596 * @see elm_fileselector_mode_set() for more details
19598 * @ingroup Fileselector
19600 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19607 * @defgroup Progressbar Progress bar
19609 * The progress bar is a widget for visually representing the
19610 * progress status of a given job/task.
19612 * A progress bar may be horizontal or vertical. It may display an
19613 * icon besides it, as well as primary and @b units labels. The
19614 * former is meant to label the widget as a whole, while the
19615 * latter, which is formatted with floating point values (and thus
19616 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19617 * units"</c>), is meant to label the widget's <b>progress
19618 * value</b>. Label, icon and unit strings/objects are @b optional
19619 * for progress bars.
19621 * A progress bar may be @b inverted, in which state it gets its
19622 * values inverted, with high values being on the left or top and
19623 * low values on the right or bottom, as opposed to normally have
19624 * the low values on the former and high values on the latter,
19625 * respectively, for horizontal and vertical modes.
19627 * The @b span of the progress, as set by
19628 * elm_progressbar_span_size_set(), is its length (horizontally or
19629 * vertically), unless one puts size hints on the widget to expand
19630 * on desired directions, by any container. That length will be
19631 * scaled by the object or applications scaling factor. At any
19632 * point code can query the progress bar for its value with
19633 * elm_progressbar_value_get().
19635 * Available widget styles for progress bars:
19637 * - @c "wheel" (simple style, no text, no progression, only
19638 * "pulse" effect is available)
19640 * Here is an example on its usage:
19641 * @li @ref progressbar_example
19645 * Add a new progress bar widget to the given parent Elementary
19646 * (container) object
19648 * @param parent The parent object
19649 * @return a new progress bar widget handle or @c NULL, on errors
19651 * This function inserts a new progress bar widget on the canvas.
19653 * @ingroup Progressbar
19655 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19658 * Set whether a given progress bar widget is at "pulsing mode" or
19661 * @param obj The progress bar object
19662 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19663 * @c EINA_FALSE to put it back to its default one
19665 * By default, progress bars will display values from the low to
19666 * high value boundaries. There are, though, contexts in which the
19667 * state of progression of a given task is @b unknown. For those,
19668 * one can set a progress bar widget to a "pulsing state", to give
19669 * the user an idea that some computation is being held, but
19670 * without exact progress values. In the default theme it will
19671 * animate its bar with the contents filling in constantly and back
19672 * to non-filled, in a loop. To start and stop this pulsing
19673 * animation, one has to explicitly call elm_progressbar_pulse().
19675 * @see elm_progressbar_pulse_get()
19676 * @see elm_progressbar_pulse()
19678 * @ingroup Progressbar
19680 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19683 * Get whether a given progress bar widget is at "pulsing mode" or
19686 * @param obj The progress bar object
19687 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19688 * if it's in the default one (and on errors)
19690 * @ingroup Progressbar
19692 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19695 * Start/stop a given progress bar "pulsing" animation, if its
19698 * @param obj The progress bar object
19699 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19700 * @c EINA_FALSE to @b stop it
19702 * @note This call won't do anything if @p obj is not under "pulsing mode".
19704 * @see elm_progressbar_pulse_set() for more details.
19706 * @ingroup Progressbar
19708 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19711 * Set the progress value (in percentage) on a given progress bar
19714 * @param obj The progress bar object
19715 * @param val The progress value (@b must be between @c 0.0 and @c
19718 * Use this call to set progress bar levels.
19720 * @note If you passes a value out of the specified range for @p
19721 * val, it will be interpreted as the @b closest of the @b boundary
19722 * values in the range.
19724 * @ingroup Progressbar
19726 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19729 * Get the progress value (in percentage) on a given progress bar
19732 * @param obj The progress bar object
19733 * @return The value of the progressbar
19735 * @see elm_progressbar_value_set() for more details
19737 * @ingroup Progressbar
19739 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19742 * Set the label of a given progress bar widget
19744 * @param obj The progress bar object
19745 * @param label The text label string, in UTF-8
19747 * @ingroup Progressbar
19748 * @deprecated use elm_object_text_set() instead.
19750 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19753 * Get the label of a given progress bar widget
19755 * @param obj The progressbar object
19756 * @return The text label string, in UTF-8
19758 * @ingroup Progressbar
19759 * @deprecated use elm_object_text_set() instead.
19761 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19764 * Set the icon object of a given progress bar widget
19766 * @param obj The progress bar object
19767 * @param icon The icon object
19769 * Use this call to decorate @p obj with an icon next to it.
19771 * @note Once the icon object is set, a previously set one will be
19772 * deleted. If you want to keep that old content object, use the
19773 * elm_progressbar_icon_unset() function.
19775 * @see elm_progressbar_icon_get()
19777 * @ingroup Progressbar
19779 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19782 * Retrieve the icon object set for a given progress bar widget
19784 * @param obj The progress bar object
19785 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19786 * otherwise (and on errors)
19788 * @see elm_progressbar_icon_set() for more details
19790 * @ingroup Progressbar
19792 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19795 * Unset an icon set on a given progress bar widget
19797 * @param obj The progress bar object
19798 * @return The icon object that was being used, if any was set, or
19799 * @c NULL, otherwise (and on errors)
19801 * This call will unparent and return the icon object which was set
19802 * for this widget, previously, on success.
19804 * @see elm_progressbar_icon_set() for more details
19806 * @ingroup Progressbar
19808 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19811 * Set the (exact) length of the bar region of a given progress bar
19814 * @param obj The progress bar object
19815 * @param size The length of the progress bar's bar region
19817 * This sets the minimum width (when in horizontal mode) or height
19818 * (when in vertical mode) of the actual bar area of the progress
19819 * bar @p obj. This in turn affects the object's minimum size. Use
19820 * this when you're not setting other size hints expanding on the
19821 * given direction (like weight and alignment hints) and you would
19822 * like it to have a specific size.
19824 * @note Icon, label and unit text around @p obj will require their
19825 * own space, which will make @p obj to require more the @p size,
19828 * @see elm_progressbar_span_size_get()
19830 * @ingroup Progressbar
19832 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19835 * Get the length set for the bar region of a given progress bar
19838 * @param obj The progress bar object
19839 * @return The length of the progress bar's bar region
19841 * If that size was not set previously, with
19842 * elm_progressbar_span_size_set(), this call will return @c 0.
19844 * @ingroup Progressbar
19846 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19849 * Set the format string for a given progress bar widget's units
19852 * @param obj The progress bar object
19853 * @param format The format string for @p obj's units label
19855 * If @c NULL is passed on @p format, it will make @p obj's units
19856 * area to be hidden completely. If not, it'll set the <b>format
19857 * string</b> for the units label's @b text. The units label is
19858 * provided a floating point value, so the units text is up display
19859 * at most one floating point falue. Note that the units label is
19860 * optional. Use a format string such as "%1.2f meters" for
19863 * @note The default format string for a progress bar is an integer
19864 * percentage, as in @c "%.0f %%".
19866 * @see elm_progressbar_unit_format_get()
19868 * @ingroup Progressbar
19870 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19873 * Retrieve the format string set for a given progress bar widget's
19876 * @param obj The progress bar object
19877 * @return The format set string for @p obj's units label or
19878 * @c NULL, if none was set (and on errors)
19880 * @see elm_progressbar_unit_format_set() for more details
19882 * @ingroup Progressbar
19884 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19887 * Set the orientation of a given progress bar widget
19889 * @param obj The progress bar object
19890 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19891 * @b horizontal, @c EINA_FALSE to make it @b vertical
19893 * Use this function to change how your progress bar is to be
19894 * disposed: vertically or horizontally.
19896 * @see elm_progressbar_horizontal_get()
19898 * @ingroup Progressbar
19900 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19903 * Retrieve the orientation of a given progress bar widget
19905 * @param obj The progress bar object
19906 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19907 * @c EINA_FALSE if it's @b vertical (and on errors)
19909 * @see elm_progressbar_horizontal_set() for more details
19911 * @ingroup Progressbar
19913 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19916 * Invert a given progress bar widget's displaying values order
19918 * @param obj The progress bar object
19919 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19920 * @c EINA_FALSE to bring it back to default, non-inverted values.
19922 * A progress bar may be @b inverted, in which state it gets its
19923 * values inverted, with high values being on the left or top and
19924 * low values on the right or bottom, as opposed to normally have
19925 * the low values on the former and high values on the latter,
19926 * respectively, for horizontal and vertical modes.
19928 * @see elm_progressbar_inverted_get()
19930 * @ingroup Progressbar
19932 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19935 * Get whether a given progress bar widget's displaying values are
19938 * @param obj The progress bar object
19939 * @return @c EINA_TRUE, if @p obj has inverted values,
19940 * @c EINA_FALSE otherwise (and on errors)
19942 * @see elm_progressbar_inverted_set() for more details
19944 * @ingroup Progressbar
19946 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19949 * @defgroup Separator Separator
19951 * @brief Separator is a very thin object used to separate other objects.
19953 * A separator can be vertical or horizontal.
19955 * @ref tutorial_separator is a good example of how to use a separator.
19959 * @brief Add a separator object to @p parent
19961 * @param parent The parent object
19963 * @return The separator object, or NULL upon failure
19965 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19967 * @brief Set the horizontal mode of a separator object
19969 * @param obj The separator object
19970 * @param horizontal If true, the separator is horizontal
19972 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19974 * @brief Get the horizontal mode of a separator object
19976 * @param obj The separator object
19977 * @return If true, the separator is horizontal
19979 * @see elm_separator_horizontal_set()
19981 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19987 * @defgroup Spinner Spinner
19988 * @ingroup Elementary
19990 * @image html img/widget/spinner/preview-00.png
19991 * @image latex img/widget/spinner/preview-00.eps
19993 * A spinner is a widget which allows the user to increase or decrease
19994 * numeric values using arrow buttons, or edit values directly, clicking
19995 * over it and typing the new value.
19997 * By default the spinner will not wrap and has a label
19998 * of "%.0f" (just showing the integer value of the double).
20000 * A spinner has a label that is formatted with floating
20001 * point values and thus accepts a printf-style format string, like
20004 * It also allows specific values to be replaced by pre-defined labels.
20006 * Smart callbacks one can register to:
20008 * - "changed" - Whenever the spinner value is changed.
20009 * - "delay,changed" - A short time after the value is changed by the user.
20010 * This will be called only when the user stops dragging for a very short
20011 * period or when they release their finger/mouse, so it avoids possibly
20012 * expensive reactions to the value change.
20014 * Available styles for it:
20016 * - @c "vertical": up/down buttons at the right side and text left aligned.
20018 * Here is an example on its usage:
20019 * @ref spinner_example
20023 * @addtogroup Spinner
20028 * Add a new spinner widget to the given parent Elementary
20029 * (container) object.
20031 * @param parent The parent object.
20032 * @return a new spinner widget handle or @c NULL, on errors.
20034 * This function inserts a new spinner widget on the canvas.
20039 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20042 * Set the format string of the displayed label.
20044 * @param obj The spinner object.
20045 * @param fmt The format string for the label display.
20047 * If @c NULL, this sets the format to "%.0f". If not it sets the format
20048 * string for the label text. The label text is provided a floating point
20049 * value, so the label text can display up to 1 floating point value.
20050 * Note that this is optional.
20052 * Use a format string such as "%1.2f meters" for example, and it will
20053 * display values like: "3.14 meters" for a value equal to 3.14159.
20055 * Default is "%0.f".
20057 * @see elm_spinner_label_format_get()
20061 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20064 * Get the label format of the spinner.
20066 * @param obj The spinner object.
20067 * @return The text label format string in UTF-8.
20069 * @see elm_spinner_label_format_set() for details.
20073 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20076 * Set the minimum and maximum values for the spinner.
20078 * @param obj The spinner object.
20079 * @param min The minimum value.
20080 * @param max The maximum value.
20082 * Define the allowed range of values to be selected by the user.
20084 * If actual value is less than @p min, it will be updated to @p min. If it
20085 * is bigger then @p max, will be updated to @p max. Actual value can be
20086 * get with elm_spinner_value_get().
20088 * By default, min is equal to 0, and max is equal to 100.
20090 * @warning Maximum must be greater than minimum.
20092 * @see elm_spinner_min_max_get()
20096 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20099 * Get the minimum and maximum values of the spinner.
20101 * @param obj The spinner object.
20102 * @param min Pointer where to store the minimum value.
20103 * @param max Pointer where to store the maximum value.
20105 * @note If only one value is needed, the other pointer can be passed
20108 * @see elm_spinner_min_max_set() for details.
20112 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20115 * Set the step used to increment or decrement the spinner value.
20117 * @param obj The spinner object.
20118 * @param step The step value.
20120 * This value will be incremented or decremented to the displayed value.
20121 * It will be incremented while the user keep right or top arrow pressed,
20122 * and will be decremented while the user keep left or bottom arrow pressed.
20124 * The interval to increment / decrement can be set with
20125 * elm_spinner_interval_set().
20127 * By default step value is equal to 1.
20129 * @see elm_spinner_step_get()
20133 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20136 * Get the step used to increment or decrement the spinner value.
20138 * @param obj The spinner object.
20139 * @return The step value.
20141 * @see elm_spinner_step_get() for more details.
20145 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20148 * Set the value the spinner displays.
20150 * @param obj The spinner object.
20151 * @param val The value to be displayed.
20153 * Value will be presented on the label following format specified with
20154 * elm_spinner_format_set().
20156 * @warning The value must to be between min and max values. This values
20157 * are set by elm_spinner_min_max_set().
20159 * @see elm_spinner_value_get().
20160 * @see elm_spinner_format_set().
20161 * @see elm_spinner_min_max_set().
20165 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20168 * Get the value displayed by the spinner.
20170 * @param obj The spinner object.
20171 * @return The value displayed.
20173 * @see elm_spinner_value_set() for details.
20177 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20180 * Set whether the spinner should wrap when it reaches its
20181 * minimum or maximum value.
20183 * @param obj The spinner object.
20184 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20187 * Disabled by default. If disabled, when the user tries to increment the
20189 * but displayed value plus step value is bigger than maximum value,
20191 * won't allow it. The same happens when the user tries to decrement it,
20192 * but the value less step is less than minimum value.
20194 * When wrap is enabled, in such situations it will allow these changes,
20195 * but will get the value that would be less than minimum and subtracts
20196 * from maximum. Or add the value that would be more than maximum to
20200 * @li min value = 10
20201 * @li max value = 50
20202 * @li step value = 20
20203 * @li displayed value = 20
20205 * When the user decrement value (using left or bottom arrow), it will
20206 * displays @c 40, because max - (min - (displayed - step)) is
20207 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20209 * @see elm_spinner_wrap_get().
20213 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20216 * Get whether the spinner should wrap when it reaches its
20217 * minimum or maximum value.
20219 * @param obj The spinner object
20220 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20221 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20223 * @see elm_spinner_wrap_set() for details.
20227 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20230 * Set whether the spinner can be directly edited by the user or not.
20232 * @param obj The spinner object.
20233 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20234 * don't allow users to edit it directly.
20236 * Spinner objects can have edition @b disabled, in which state they will
20237 * be changed only by arrows.
20238 * Useful for contexts
20239 * where you don't want your users to interact with it writting the value.
20241 * when using special values, the user can see real value instead
20242 * of special label on edition.
20244 * It's enabled by default.
20246 * @see elm_spinner_editable_get()
20250 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20253 * Get whether the spinner can be directly edited by the user or not.
20255 * @param obj The spinner object.
20256 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20257 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20259 * @see elm_spinner_editable_set() for details.
20263 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20266 * Set a special string to display in the place of the numerical value.
20268 * @param obj The spinner object.
20269 * @param value The value to be replaced.
20270 * @param label The label to be used.
20272 * It's useful for cases when a user should select an item that is
20273 * better indicated by a label than a value. For example, weekdays or months.
20277 * sp = elm_spinner_add(win);
20278 * elm_spinner_min_max_set(sp, 1, 3);
20279 * elm_spinner_special_value_add(sp, 1, "January");
20280 * elm_spinner_special_value_add(sp, 2, "February");
20281 * elm_spinner_special_value_add(sp, 3, "March");
20282 * evas_object_show(sp);
20287 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20290 * Set the interval on time updates for an user mouse button hold
20291 * on spinner widgets' arrows.
20293 * @param obj The spinner object.
20294 * @param interval The (first) interval value in seconds.
20296 * This interval value is @b decreased while the user holds the
20297 * mouse pointer either incrementing or decrementing spinner's value.
20299 * This helps the user to get to a given value distant from the
20300 * current one easier/faster, as it will start to change quicker and
20301 * quicker on mouse button holds.
20303 * The calculation for the next change interval value, starting from
20304 * the one set with this call, is the previous interval divided by
20305 * @c 1.05, so it decreases a little bit.
20307 * The default starting interval value for automatic changes is
20310 * @see elm_spinner_interval_get()
20314 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20317 * Get the interval on time updates for an user mouse button hold
20318 * on spinner widgets' arrows.
20320 * @param obj The spinner object.
20321 * @return The (first) interval value, in seconds, set on it.
20323 * @see elm_spinner_interval_set() for more details.
20327 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20334 * @defgroup Index Index
20336 * @image html img/widget/index/preview-00.png
20337 * @image latex img/widget/index/preview-00.eps
20339 * An index widget gives you an index for fast access to whichever
20340 * group of other UI items one might have. It's a list of text
20341 * items (usually letters, for alphabetically ordered access).
20343 * Index widgets are by default hidden and just appear when the
20344 * user clicks over it's reserved area in the canvas. In its
20345 * default theme, it's an area one @ref Fingers "finger" wide on
20346 * the right side of the index widget's container.
20348 * When items on the index are selected, smart callbacks get
20349 * called, so that its user can make other container objects to
20350 * show a given area or child object depending on the index item
20351 * selected. You'd probably be using an index together with @ref
20352 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20355 * Smart events one can add callbacks for are:
20356 * - @c "changed" - When the selected index item changes. @c
20357 * event_info is the selected item's data pointer.
20358 * - @c "delay,changed" - When the selected index item changes, but
20359 * after a small idling period. @c event_info is the selected
20360 * item's data pointer.
20361 * - @c "selected" - When the user releases a mouse button and
20362 * selects an item. @c event_info is the selected item's data
20364 * - @c "level,up" - when the user moves a finger from the first
20365 * level to the second level
20366 * - @c "level,down" - when the user moves a finger from the second
20367 * level to the first level
20369 * The @c "delay,changed" event is so that it'll wait a small time
20370 * before actually reporting those events and, moreover, just the
20371 * last event happening on those time frames will actually be
20374 * Here are some examples on its usage:
20375 * @li @ref index_example_01
20376 * @li @ref index_example_02
20380 * @addtogroup Index
20384 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20387 * Add a new index widget to the given parent Elementary
20388 * (container) object
20390 * @param parent The parent object
20391 * @return a new index widget handle or @c NULL, on errors
20393 * This function inserts a new index widget on the canvas.
20397 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20400 * Set whether a given index widget is or not visible,
20403 * @param obj The index object
20404 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20406 * Not to be confused with visible as in @c evas_object_show() --
20407 * visible with regard to the widget's auto hiding feature.
20409 * @see elm_index_active_get()
20413 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20416 * Get whether a given index widget is currently visible or not.
20418 * @param obj The index object
20419 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20421 * @see elm_index_active_set() for more details
20425 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20428 * Set the items level for a given index widget.
20430 * @param obj The index object.
20431 * @param level @c 0 or @c 1, the currently implemented levels.
20433 * @see elm_index_item_level_get()
20437 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20440 * Get the items level set for a given index widget.
20442 * @param obj The index object.
20443 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20445 * @see elm_index_item_level_set() for more information
20449 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20452 * Returns the last selected item's data, for a given index widget.
20454 * @param obj The index object.
20455 * @return The item @b data associated to the last selected item on
20456 * @p obj (or @c NULL, on errors).
20458 * @warning The returned value is @b not an #Elm_Index_Item item
20459 * handle, but the data associated to it (see the @c item parameter
20460 * in elm_index_item_append(), as an example).
20464 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20467 * Append a new item on a given index widget.
20469 * @param obj The index object.
20470 * @param letter Letter under which the item should be indexed
20471 * @param item The item data to set for the index's item
20473 * Despite the most common usage of the @p letter argument is for
20474 * single char strings, one could use arbitrary strings as index
20477 * @c item will be the pointer returned back on @c "changed", @c
20478 * "delay,changed" and @c "selected" smart events.
20482 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20485 * Prepend a new item on a given index widget.
20487 * @param obj The index object.
20488 * @param letter Letter under which the item should be indexed
20489 * @param item The item data to set for the index's item
20491 * Despite the most common usage of the @p letter argument is for
20492 * single char strings, one could use arbitrary strings as index
20495 * @c item will be the pointer returned back on @c "changed", @c
20496 * "delay,changed" and @c "selected" smart events.
20500 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20503 * Append a new item, on a given index widget, <b>after the item
20504 * having @p relative as data</b>.
20506 * @param obj The index object.
20507 * @param letter Letter under which the item should be indexed
20508 * @param item The item data to set for the index's item
20509 * @param relative The item data of the index item to be the
20510 * predecessor of this new one
20512 * Despite the most common usage of the @p letter argument is for
20513 * single char strings, one could use arbitrary strings as index
20516 * @c item will be the pointer returned back on @c "changed", @c
20517 * "delay,changed" and @c "selected" smart events.
20519 * @note If @p relative is @c NULL or if it's not found to be data
20520 * set on any previous item on @p obj, this function will behave as
20521 * elm_index_item_append().
20525 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20528 * Prepend a new item, on a given index widget, <b>after the item
20529 * having @p relative as data</b>.
20531 * @param obj The index object.
20532 * @param letter Letter under which the item should be indexed
20533 * @param item The item data to set for the index's item
20534 * @param relative The item data of the index item to be the
20535 * successor of this new one
20537 * Despite the most common usage of the @p letter argument is for
20538 * single char strings, one could use arbitrary strings as index
20541 * @c item will be the pointer returned back on @c "changed", @c
20542 * "delay,changed" and @c "selected" smart events.
20544 * @note If @p relative is @c NULL or if it's not found to be data
20545 * set on any previous item on @p obj, this function will behave as
20546 * elm_index_item_prepend().
20550 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20553 * Insert a new item into the given index widget, using @p cmp_func
20554 * function to sort items (by item handles).
20556 * @param obj The index object.
20557 * @param letter Letter under which the item should be indexed
20558 * @param item The item data to set for the index's item
20559 * @param cmp_func The comparing function to be used to sort index
20560 * items <b>by #Elm_Index_Item item handles</b>
20561 * @param cmp_data_func A @b fallback function to be called for the
20562 * sorting of index items <b>by item data</b>). It will be used
20563 * when @p cmp_func returns @c 0 (equality), which means an index
20564 * item with provided item data already exists. To decide which
20565 * data item should be pointed to by the index item in question, @p
20566 * cmp_data_func will be used. If @p cmp_data_func returns a
20567 * non-negative value, the previous index item data will be
20568 * replaced by the given @p item pointer. If the previous data need
20569 * to be freed, it should be done by the @p cmp_data_func function,
20570 * because all references to it will be lost. If this function is
20571 * not provided (@c NULL is given), index items will be @b
20572 * duplicated, if @p cmp_func returns @c 0.
20574 * Despite the most common usage of the @p letter argument is for
20575 * single char strings, one could use arbitrary strings as index
20578 * @c item will be the pointer returned back on @c "changed", @c
20579 * "delay,changed" and @c "selected" smart events.
20583 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);
20586 * Remove an item from a given index widget, <b>to be referenced by
20587 * it's data value</b>.
20589 * @param obj The index object
20590 * @param item The item's data pointer for the item to be removed
20593 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20594 * that callback function will be called by this one.
20596 * @warning The item to be removed from @p obj will be found via
20597 * its item data pointer, and not by an #Elm_Index_Item handle.
20601 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20604 * Find a given index widget's item, <b>using item data</b>.
20606 * @param obj The index object
20607 * @param item The item data pointed to by the desired index item
20608 * @return The index item handle, if found, or @c NULL otherwise
20612 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20615 * Removes @b all items from a given index widget.
20617 * @param obj The index object.
20619 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20620 * that callback function will be called for each item in @p obj.
20624 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20627 * Go to a given items level on a index widget
20629 * @param obj The index object
20630 * @param level The index level (one of @c 0 or @c 1)
20634 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20637 * Return the data associated with a given index widget item
20639 * @param it The index widget item handle
20640 * @return The data associated with @p it
20642 * @see elm_index_item_data_set()
20646 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20649 * Set the data associated with a given index widget item
20651 * @param it The index widget item handle
20652 * @param data The new data pointer to set to @p it
20654 * This sets new item data on @p it.
20656 * @warning The old data pointer won't be touched by this function, so
20657 * the user had better to free that old data himself/herself.
20661 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20664 * Set the function to be called when a given index widget item is freed.
20666 * @param it The item to set the callback on
20667 * @param func The function to call on the item's deletion
20669 * When called, @p func will have both @c data and @c event_info
20670 * arguments with the @p it item's data value and, naturally, the
20671 * @c obj argument with a handle to the parent index widget.
20675 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20678 * Get the letter (string) set on a given index widget item.
20680 * @param it The index item handle
20681 * @return The letter string set on @p it
20685 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20692 * @defgroup Photocam Photocam
20694 * @image html img/widget/photocam/preview-00.png
20695 * @image latex img/widget/photocam/preview-00.eps
20697 * This is a widget specifically for displaying high-resolution digital
20698 * camera photos giving speedy feedback (fast load), low memory footprint
20699 * and zooming and panning as well as fitting logic. It is entirely focused
20700 * on jpeg images, and takes advantage of properties of the jpeg format (via
20701 * evas loader features in the jpeg loader).
20703 * Signals that you can add callbacks for are:
20704 * @li "clicked" - This is called when a user has clicked the photo without
20706 * @li "press" - This is called when a user has pressed down on the photo.
20707 * @li "longpressed" - This is called when a user has pressed down on the
20708 * photo for a long time without dragging around.
20709 * @li "clicked,double" - This is called when a user has double-clicked the
20711 * @li "load" - Photo load begins.
20712 * @li "loaded" - This is called when the image file load is complete for the
20713 * first view (low resolution blurry version).
20714 * @li "load,detail" - Photo detailed data load begins.
20715 * @li "loaded,detail" - This is called when the image file load is complete
20716 * for the detailed image data (full resolution needed).
20717 * @li "zoom,start" - Zoom animation started.
20718 * @li "zoom,stop" - Zoom animation stopped.
20719 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20720 * @li "scroll" - the content has been scrolled (moved)
20721 * @li "scroll,anim,start" - scrolling animation has started
20722 * @li "scroll,anim,stop" - scrolling animation has stopped
20723 * @li "scroll,drag,start" - dragging the contents around has started
20724 * @li "scroll,drag,stop" - dragging the contents around has stopped
20726 * @ref tutorial_photocam shows the API in action.
20730 * @brief Types of zoom available.
20732 typedef enum _Elm_Photocam_Zoom_Mode
20734 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20735 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20736 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20737 ELM_PHOTOCAM_ZOOM_MODE_LAST
20738 } Elm_Photocam_Zoom_Mode;
20740 * @brief Add a new Photocam object
20742 * @param parent The parent object
20743 * @return The new object or NULL if it cannot be created
20745 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20747 * @brief Set the photo file to be shown
20749 * @param obj The photocam object
20750 * @param file The photo file
20751 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20753 * This sets (and shows) the specified file (with a relative or absolute
20754 * path) and will return a load error (same error that
20755 * evas_object_image_load_error_get() will return). The image will change and
20756 * adjust its size at this point and begin a background load process for this
20757 * photo that at some time in the future will be displayed at the full
20760 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20762 * @brief Returns the path of the current image file
20764 * @param obj The photocam object
20765 * @return Returns the path
20767 * @see elm_photocam_file_set()
20769 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20771 * @brief Set the zoom level of the photo
20773 * @param obj The photocam object
20774 * @param zoom The zoom level to set
20776 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20777 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20778 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20779 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20782 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20784 * @brief Get the zoom level of the photo
20786 * @param obj The photocam object
20787 * @return The current zoom level
20789 * This returns the current zoom level of the photocam object. Note that if
20790 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20791 * (which is the default), the zoom level may be changed at any time by the
20792 * photocam object itself to account for photo size and photocam viewpoer
20795 * @see elm_photocam_zoom_set()
20796 * @see elm_photocam_zoom_mode_set()
20798 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20800 * @brief Set the zoom mode
20802 * @param obj The photocam object
20803 * @param mode The desired mode
20805 * This sets the zoom mode to manual or one of several automatic levels.
20806 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20807 * elm_photocam_zoom_set() and will stay at that level until changed by code
20808 * or until zoom mode is changed. This is the default mode. The Automatic
20809 * modes will allow the photocam object to automatically adjust zoom mode
20810 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20811 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20812 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20813 * pixels within the frame are left unfilled.
20815 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20817 * @brief Get the zoom mode
20819 * @param obj The photocam object
20820 * @return The current zoom mode
20822 * This gets the current zoom mode of the photocam object.
20824 * @see elm_photocam_zoom_mode_set()
20826 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20828 * @brief Get the current image pixel width and height
20830 * @param obj The photocam object
20831 * @param w A pointer to the width return
20832 * @param h A pointer to the height return
20834 * This gets the current photo pixel width and height (for the original).
20835 * The size will be returned in the integers @p w and @p h that are pointed
20838 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20840 * @brief Get the area of the image that is currently shown
20843 * @param x A pointer to the X-coordinate of region
20844 * @param y A pointer to the Y-coordinate of region
20845 * @param w A pointer to the width
20846 * @param h A pointer to the height
20848 * @see elm_photocam_image_region_show()
20849 * @see elm_photocam_image_region_bring_in()
20851 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20853 * @brief Set the viewed portion of the image
20855 * @param obj The photocam object
20856 * @param x X-coordinate of region in image original pixels
20857 * @param y Y-coordinate of region in image original pixels
20858 * @param w Width of region in image original pixels
20859 * @param h Height of region in image original pixels
20861 * This shows the region of the image without using animation.
20863 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20865 * @brief Bring in the viewed portion of the image
20867 * @param obj The photocam object
20868 * @param x X-coordinate of region in image original pixels
20869 * @param y Y-coordinate of region in image original pixels
20870 * @param w Width of region in image original pixels
20871 * @param h Height of region in image original pixels
20873 * This shows the region of the image using animation.
20875 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20877 * @brief Set the paused state for photocam
20879 * @param obj The photocam object
20880 * @param paused The pause state to set
20882 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20883 * photocam. The default is off. This will stop zooming using animation on
20884 * zoom levels changes and change instantly. This will stop any existing
20885 * animations that are running.
20887 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20889 * @brief Get the paused state for photocam
20891 * @param obj The photocam object
20892 * @return The current paused state
20894 * This gets the current paused state for the photocam object.
20896 * @see elm_photocam_paused_set()
20898 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20900 * @brief Get the internal low-res image used for photocam
20902 * @param obj The photocam object
20903 * @return The internal image object handle, or NULL if none exists
20905 * This gets the internal image object inside photocam. Do not modify it. It
20906 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20907 * deleted at any time as well.
20909 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20911 * @brief Set the photocam scrolling bouncing.
20913 * @param obj The photocam object
20914 * @param h_bounce bouncing for horizontal
20915 * @param v_bounce bouncing for vertical
20917 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20919 * @brief Get the photocam scrolling bouncing.
20921 * @param obj The photocam object
20922 * @param h_bounce bouncing for horizontal
20923 * @param v_bounce bouncing for vertical
20925 * @see elm_photocam_bounce_set()
20927 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20933 * @defgroup Map Map
20934 * @ingroup Elementary
20936 * @image html img/widget/map/preview-00.png
20937 * @image latex img/widget/map/preview-00.eps
20939 * This is a widget specifically for displaying a map. It uses basically
20940 * OpenStreetMap provider http://www.openstreetmap.org/,
20941 * but custom providers can be added.
20943 * It supports some basic but yet nice features:
20944 * @li zoom and scroll
20945 * @li markers with content to be displayed when user clicks over it
20946 * @li group of markers
20949 * Smart callbacks one can listen to:
20951 * - "clicked" - This is called when a user has clicked the map without
20953 * - "press" - This is called when a user has pressed down on the map.
20954 * - "longpressed" - This is called when a user has pressed down on the map
20955 * for a long time without dragging around.
20956 * - "clicked,double" - This is called when a user has double-clicked
20958 * - "load,detail" - Map detailed data load begins.
20959 * - "loaded,detail" - This is called when all currently visible parts of
20960 * the map are loaded.
20961 * - "zoom,start" - Zoom animation started.
20962 * - "zoom,stop" - Zoom animation stopped.
20963 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20964 * - "scroll" - the content has been scrolled (moved).
20965 * - "scroll,anim,start" - scrolling animation has started.
20966 * - "scroll,anim,stop" - scrolling animation has stopped.
20967 * - "scroll,drag,start" - dragging the contents around has started.
20968 * - "scroll,drag,stop" - dragging the contents around has stopped.
20969 * - "downloaded" - This is called when all currently required map images
20971 * - "route,load" - This is called when route request begins.
20972 * - "route,loaded" - This is called when route request ends.
20973 * - "name,load" - This is called when name request begins.
20974 * - "name,loaded- This is called when name request ends.
20976 * Available style for map widget:
20979 * Available style for markers:
20984 * Available style for marker bubble:
20987 * List of examples:
20988 * @li @ref map_example_01
20989 * @li @ref map_example_02
20990 * @li @ref map_example_03
20999 * @enum _Elm_Map_Zoom_Mode
21000 * @typedef Elm_Map_Zoom_Mode
21002 * Set map's zoom behavior. It can be set to manual or automatic.
21004 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21006 * Values <b> don't </b> work as bitmask, only one can be choosen.
21008 * @note Valid sizes are 2^zoom, consequently the map may be smaller
21009 * than the scroller view.
21011 * @see elm_map_zoom_mode_set()
21012 * @see elm_map_zoom_mode_get()
21016 typedef enum _Elm_Map_Zoom_Mode
21018 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21019 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21020 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21021 ELM_MAP_ZOOM_MODE_LAST
21022 } Elm_Map_Zoom_Mode;
21025 * @enum _Elm_Map_Route_Sources
21026 * @typedef Elm_Map_Route_Sources
21028 * Set route service to be used. By default used source is
21029 * #ELM_MAP_ROUTE_SOURCE_YOURS.
21031 * @see elm_map_route_source_set()
21032 * @see elm_map_route_source_get()
21036 typedef enum _Elm_Map_Route_Sources
21038 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21039 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. */
21040 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21041 ELM_MAP_ROUTE_SOURCE_LAST
21042 } Elm_Map_Route_Sources;
21044 typedef enum _Elm_Map_Name_Sources
21046 ELM_MAP_NAME_SOURCE_NOMINATIM,
21047 ELM_MAP_NAME_SOURCE_LAST
21048 } Elm_Map_Name_Sources;
21051 * @enum _Elm_Map_Route_Type
21052 * @typedef Elm_Map_Route_Type
21054 * Set type of transport used on route.
21056 * @see elm_map_route_add()
21060 typedef enum _Elm_Map_Route_Type
21062 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21063 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21064 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21065 ELM_MAP_ROUTE_TYPE_LAST
21066 } Elm_Map_Route_Type;
21069 * @enum _Elm_Map_Route_Method
21070 * @typedef Elm_Map_Route_Method
21072 * Set the routing method, what should be priorized, time or distance.
21074 * @see elm_map_route_add()
21078 typedef enum _Elm_Map_Route_Method
21080 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21081 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21082 ELM_MAP_ROUTE_METHOD_LAST
21083 } Elm_Map_Route_Method;
21085 typedef enum _Elm_Map_Name_Method
21087 ELM_MAP_NAME_METHOD_SEARCH,
21088 ELM_MAP_NAME_METHOD_REVERSE,
21089 ELM_MAP_NAME_METHOD_LAST
21090 } Elm_Map_Name_Method;
21092 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(). */
21093 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(). */
21094 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(). */
21095 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(). */
21096 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
21097 typedef struct _Elm_Map_Track Elm_Map_Track;
21099 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. */
21100 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21101 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21102 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21104 typedef char *(*ElmMapModuleSourceFunc) (void);
21105 typedef int (*ElmMapModuleZoomMinFunc) (void);
21106 typedef int (*ElmMapModuleZoomMaxFunc) (void);
21107 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21108 typedef int (*ElmMapModuleRouteSourceFunc) (void);
21109 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21110 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21111 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21112 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21115 * Add a new map widget to the given parent Elementary (container) object.
21117 * @param parent The parent object.
21118 * @return a new map widget handle or @c NULL, on errors.
21120 * This function inserts a new map widget on the canvas.
21124 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21127 * Set the zoom level of the map.
21129 * @param obj The map object.
21130 * @param zoom The zoom level to set.
21132 * This sets the zoom level.
21134 * It will respect limits defined by elm_map_source_zoom_min_set() and
21135 * elm_map_source_zoom_max_set().
21137 * By default these values are 0 (world map) and 18 (maximum zoom).
21139 * This function should be used when zoom mode is set to
21140 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21141 * with elm_map_zoom_mode_set().
21143 * @see elm_map_zoom_mode_set().
21144 * @see elm_map_zoom_get().
21148 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21151 * Get the zoom level of the map.
21153 * @param obj The map object.
21154 * @return The current zoom level.
21156 * This returns the current zoom level of the map object.
21158 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21159 * (which is the default), the zoom level may be changed at any time by the
21160 * map object itself to account for map size and map viewport size.
21162 * @see elm_map_zoom_set() for details.
21166 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21169 * Set the zoom mode used by the map object.
21171 * @param obj The map object.
21172 * @param mode The zoom mode of the map, being it one of
21173 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21174 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21176 * This sets the zoom mode to manual or one of the automatic levels.
21177 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21178 * elm_map_zoom_set() and will stay at that level until changed by code
21179 * or until zoom mode is changed. This is the default mode.
21181 * The Automatic modes will allow the map object to automatically
21182 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21183 * adjust zoom so the map fits inside the scroll frame with no pixels
21184 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21185 * ensure no pixels within the frame are left unfilled. Do not forget that
21186 * the valid sizes are 2^zoom, consequently the map may be smaller than
21187 * the scroller view.
21189 * @see elm_map_zoom_set()
21193 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21196 * Get the zoom mode used by the map object.
21198 * @param obj The map object.
21199 * @return The zoom mode of the map, being it one of
21200 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21201 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21203 * This function returns the current zoom mode used by the map object.
21205 * @see elm_map_zoom_mode_set() for more details.
21209 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21212 * Get the current coordinates of the map.
21214 * @param obj The map object.
21215 * @param lon Pointer where to store longitude.
21216 * @param lat Pointer where to store latitude.
21218 * This gets the current center coordinates of the map object. It can be
21219 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21221 * @see elm_map_geo_region_bring_in()
21222 * @see elm_map_geo_region_show()
21226 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21229 * Animatedly bring in given coordinates to the center of the map.
21231 * @param obj The map object.
21232 * @param lon Longitude to center at.
21233 * @param lat Latitude to center at.
21235 * This causes map to jump to the given @p lat and @p lon coordinates
21236 * and show it (by scrolling) in the center of the viewport, if it is not
21237 * already centered. This will use animation to do so and take a period
21238 * of time to complete.
21240 * @see elm_map_geo_region_show() for a function to avoid animation.
21241 * @see elm_map_geo_region_get()
21245 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21248 * Show the given coordinates at the center of the map, @b immediately.
21250 * @param obj The map object.
21251 * @param lon Longitude to center at.
21252 * @param lat Latitude to center at.
21254 * This causes map to @b redraw its viewport's contents to the
21255 * region contining the given @p lat and @p lon, that will be moved to the
21256 * center of the map.
21258 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21259 * @see elm_map_geo_region_get()
21263 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21266 * Pause or unpause the map.
21268 * @param obj The map object.
21269 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21272 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21275 * The default is off.
21277 * This will stop zooming using animation, changing zoom levels will
21278 * change instantly. This will stop any existing animations that are running.
21280 * @see elm_map_paused_get()
21284 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21287 * Get a value whether map is paused or not.
21289 * @param obj The map object.
21290 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21291 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21293 * This gets the current paused state for the map object.
21295 * @see elm_map_paused_set() for details.
21299 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21302 * Set to show markers during zoom level changes or not.
21304 * @param obj The map object.
21305 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21308 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21311 * The default is off.
21313 * This will stop zooming using animation, changing zoom levels will
21314 * change instantly. This will stop any existing animations that are running.
21316 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21319 * The default is off.
21321 * Enabling it will force the map to stop displaying the markers during
21322 * zoom level changes. Set to on if you have a large number of markers.
21324 * @see elm_map_paused_markers_get()
21328 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21331 * Get a value whether markers will be displayed on zoom level changes or not
21333 * @param obj The map object.
21334 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21335 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21337 * This gets the current markers paused state for the map object.
21339 * @see elm_map_paused_markers_set() for details.
21343 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21346 * Get the information of downloading status.
21348 * @param obj The map object.
21349 * @param try_num Pointer where to store number of tiles being downloaded.
21350 * @param finish_num Pointer where to store number of tiles successfully
21353 * This gets the current downloading status for the map object, the number
21354 * of tiles being downloaded and the number of tiles already downloaded.
21358 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21361 * Convert a pixel coordinate (x,y) into a geographic coordinate
21362 * (longitude, latitude).
21364 * @param obj The map object.
21365 * @param x the coordinate.
21366 * @param y the coordinate.
21367 * @param size the size in pixels of the map.
21368 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21369 * @param lon Pointer where to store the longitude that correspond to x.
21370 * @param lat Pointer where to store the latitude that correspond to y.
21372 * @note Origin pixel point is the top left corner of the viewport.
21373 * Map zoom and size are taken on account.
21375 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21379 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);
21382 * Convert a geographic coordinate (longitude, latitude) into a pixel
21383 * coordinate (x, y).
21385 * @param obj The map object.
21386 * @param lon the longitude.
21387 * @param lat the latitude.
21388 * @param size the size in pixels of the map. The map is a square
21389 * and generally his size is : pow(2.0, zoom)*256.
21390 * @param x Pointer where to store the horizontal pixel coordinate that
21391 * correspond to the longitude.
21392 * @param y Pointer where to store the vertical pixel coordinate that
21393 * correspond to the latitude.
21395 * @note Origin pixel point is the top left corner of the viewport.
21396 * Map zoom and size are taken on account.
21398 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21402 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);
21405 * Convert a geographic coordinate (longitude, latitude) into a name
21408 * @param obj The map object.
21409 * @param lon the longitude.
21410 * @param lat the latitude.
21411 * @return name A #Elm_Map_Name handle for this coordinate.
21413 * To get the string for this address, elm_map_name_address_get()
21416 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21420 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21423 * Convert a name (address) into a geographic coordinate
21424 * (longitude, latitude).
21426 * @param obj The map object.
21427 * @param name The address.
21428 * @return name A #Elm_Map_Name handle for this address.
21430 * To get the longitude and latitude, elm_map_name_region_get()
21433 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21437 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21440 * Convert a pixel coordinate into a rotated pixel coordinate.
21442 * @param obj The map object.
21443 * @param x horizontal coordinate of the point to rotate.
21444 * @param y vertical coordinate of the point to rotate.
21445 * @param cx rotation's center horizontal position.
21446 * @param cy rotation's center vertical position.
21447 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21448 * @param xx Pointer where to store rotated x.
21449 * @param yy Pointer where to store rotated y.
21453 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);
21456 * Add a new marker to the map object.
21458 * @param obj The map object.
21459 * @param lon The longitude of the marker.
21460 * @param lat The latitude of the marker.
21461 * @param clas The class, to use when marker @b isn't grouped to others.
21462 * @param clas_group The class group, to use when marker is grouped to others
21463 * @param data The data passed to the callbacks.
21465 * @return The created marker or @c NULL upon failure.
21467 * A marker will be created and shown in a specific point of the map, defined
21468 * by @p lon and @p lat.
21470 * It will be displayed using style defined by @p class when this marker
21471 * is displayed alone (not grouped). A new class can be created with
21472 * elm_map_marker_class_new().
21474 * If the marker is grouped to other markers, it will be displayed with
21475 * style defined by @p class_group. Markers with the same group are grouped
21476 * if they are close. A new group class can be created with
21477 * elm_map_marker_group_class_new().
21479 * Markers created with this method can be deleted with
21480 * elm_map_marker_remove().
21482 * A marker can have associated content to be displayed by a bubble,
21483 * when a user click over it, as well as an icon. These objects will
21484 * be fetch using class' callback functions.
21486 * @see elm_map_marker_class_new()
21487 * @see elm_map_marker_group_class_new()
21488 * @see elm_map_marker_remove()
21492 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);
21495 * Set the maximum numbers of markers' content to be displayed in a group.
21497 * @param obj The map object.
21498 * @param max The maximum numbers of items displayed in a bubble.
21500 * A bubble will be displayed when the user clicks over the group,
21501 * and will place the content of markers that belong to this group
21504 * A group can have a long list of markers, consequently the creation
21505 * of the content of the bubble can be very slow.
21507 * In order to avoid this, a maximum number of items is displayed
21510 * By default this number is 30.
21512 * Marker with the same group class are grouped if they are close.
21514 * @see elm_map_marker_add()
21518 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21521 * Remove a marker from the map.
21523 * @param marker The marker to remove.
21525 * @see elm_map_marker_add()
21529 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21532 * Get the current coordinates of the marker.
21534 * @param marker marker.
21535 * @param lat Pointer where to store the marker's latitude.
21536 * @param lon Pointer where to store the marker's longitude.
21538 * These values are set when adding markers, with function
21539 * elm_map_marker_add().
21541 * @see elm_map_marker_add()
21545 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21548 * Animatedly bring in given marker to the center of the map.
21550 * @param marker The marker to center at.
21552 * This causes map to jump to the given @p marker's coordinates
21553 * and show it (by scrolling) in the center of the viewport, if it is not
21554 * already centered. This will use animation to do so and take a period
21555 * of time to complete.
21557 * @see elm_map_marker_show() for a function to avoid animation.
21558 * @see elm_map_marker_region_get()
21562 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21565 * Show the given marker at the center of the map, @b immediately.
21567 * @param marker The marker to center at.
21569 * This causes map to @b redraw its viewport's contents to the
21570 * region contining the given @p marker's coordinates, that will be
21571 * moved to the center of the map.
21573 * @see elm_map_marker_bring_in() for a function to move with animation.
21574 * @see elm_map_markers_list_show() if more than one marker need to be
21576 * @see elm_map_marker_region_get()
21580 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21583 * Move and zoom the map to display a list of markers.
21585 * @param markers A list of #Elm_Map_Marker handles.
21587 * The map will be centered on the center point of the markers in the list.
21588 * Then the map will be zoomed in order to fit the markers using the maximum
21589 * zoom which allows display of all the markers.
21591 * @warning All the markers should belong to the same map object.
21593 * @see elm_map_marker_show() to show a single marker.
21594 * @see elm_map_marker_bring_in()
21598 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21601 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21603 * @param marker The marker wich content should be returned.
21604 * @return Return the evas object if it exists, else @c NULL.
21606 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21607 * elm_map_marker_class_get_cb_set() should be used.
21609 * This content is what will be inside the bubble that will be displayed
21610 * when an user clicks over the marker.
21612 * This returns the actual Evas object used to be placed inside
21613 * the bubble. This may be @c NULL, as it may
21614 * not have been created or may have been deleted, at any time, by
21615 * the map. <b>Do not modify this object</b> (move, resize,
21616 * show, hide, etc.), as the map is controlling it. This
21617 * function is for querying, emitting custom signals or hooking
21618 * lower level callbacks for events on that object. Do not delete
21619 * this object under any circumstances.
21623 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21626 * Update the marker
21628 * @param marker The marker to be updated.
21630 * If a content is set to this marker, it will call function to delete it,
21631 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21632 * #ElmMapMarkerGetFunc.
21634 * These functions are set for the marker class with
21635 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21639 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21642 * Close all the bubbles opened by the user.
21644 * @param obj The map object.
21646 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21647 * when the user clicks on a marker.
21649 * This functions is set for the marker class with
21650 * elm_map_marker_class_get_cb_set().
21654 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21657 * Create a new group class.
21659 * @param obj The map object.
21660 * @return Returns the new group class.
21662 * Each marker must be associated to a group class. Markers in the same
21663 * group are grouped if they are close.
21665 * The group class defines the style of the marker when a marker is grouped
21666 * to others markers. When it is alone, another class will be used.
21668 * A group class will need to be provided when creating a marker with
21669 * elm_map_marker_add().
21671 * Some properties and functions can be set by class, as:
21672 * - style, with elm_map_group_class_style_set()
21673 * - data - to be associated to the group class. It can be set using
21674 * elm_map_group_class_data_set().
21675 * - min zoom to display markers, set with
21676 * elm_map_group_class_zoom_displayed_set().
21677 * - max zoom to group markers, set using
21678 * elm_map_group_class_zoom_grouped_set().
21679 * - visibility - set if markers will be visible or not, set with
21680 * elm_map_group_class_hide_set().
21681 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21682 * It can be set using elm_map_group_class_icon_cb_set().
21684 * @see elm_map_marker_add()
21685 * @see elm_map_group_class_style_set()
21686 * @see elm_map_group_class_data_set()
21687 * @see elm_map_group_class_zoom_displayed_set()
21688 * @see elm_map_group_class_zoom_grouped_set()
21689 * @see elm_map_group_class_hide_set()
21690 * @see elm_map_group_class_icon_cb_set()
21694 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21697 * Set the marker's style of a group class.
21699 * @param clas The group class.
21700 * @param style The style to be used by markers.
21702 * Each marker must be associated to a group class, and will use the style
21703 * defined by such class when grouped to other markers.
21705 * The following styles are provided by default theme:
21706 * @li @c radio - blue circle
21707 * @li @c radio2 - green circle
21710 * @see elm_map_group_class_new() for more details.
21711 * @see elm_map_marker_add()
21715 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21718 * Set the icon callback function of a group class.
21720 * @param clas The group class.
21721 * @param icon_get The callback function that will return the icon.
21723 * Each marker must be associated to a group class, and it can display a
21724 * custom icon. The function @p icon_get must return this icon.
21726 * @see elm_map_group_class_new() for more details.
21727 * @see elm_map_marker_add()
21731 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21734 * Set the data associated to the group class.
21736 * @param clas The group class.
21737 * @param data The new user data.
21739 * This data will be passed for callback functions, like icon get callback,
21740 * that can be set with elm_map_group_class_icon_cb_set().
21742 * If a data was previously set, the object will lose the pointer for it,
21743 * so if needs to be freed, you must do it yourself.
21745 * @see elm_map_group_class_new() for more details.
21746 * @see elm_map_group_class_icon_cb_set()
21747 * @see elm_map_marker_add()
21751 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21754 * Set the minimum zoom from where the markers are displayed.
21756 * @param clas The group class.
21757 * @param zoom The minimum zoom.
21759 * Markers only will be displayed when the map is displayed at @p zoom
21762 * @see elm_map_group_class_new() for more details.
21763 * @see elm_map_marker_add()
21767 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21770 * Set the zoom from where the markers are no more grouped.
21772 * @param clas The group class.
21773 * @param zoom The maximum zoom.
21775 * Markers only will be grouped when the map is displayed at
21776 * less than @p zoom.
21778 * @see elm_map_group_class_new() for more details.
21779 * @see elm_map_marker_add()
21783 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21786 * Set if the markers associated to the group class @clas are hidden or not.
21788 * @param clas The group class.
21789 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21792 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21797 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21800 * Create a new marker class.
21802 * @param obj The map object.
21803 * @return Returns the new group class.
21805 * Each marker must be associated to a class.
21807 * The marker class defines the style of the marker when a marker is
21808 * displayed alone, i.e., not grouped to to others markers. When grouped
21809 * it will use group class style.
21811 * A marker class will need to be provided when creating a marker with
21812 * elm_map_marker_add().
21814 * Some properties and functions can be set by class, as:
21815 * - style, with elm_map_marker_class_style_set()
21816 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21817 * It can be set using elm_map_marker_class_icon_cb_set().
21818 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21819 * Set using elm_map_marker_class_get_cb_set().
21820 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21821 * Set using elm_map_marker_class_del_cb_set().
21823 * @see elm_map_marker_add()
21824 * @see elm_map_marker_class_style_set()
21825 * @see elm_map_marker_class_icon_cb_set()
21826 * @see elm_map_marker_class_get_cb_set()
21827 * @see elm_map_marker_class_del_cb_set()
21831 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21834 * Set the marker's style of a marker class.
21836 * @param clas The marker class.
21837 * @param style The style to be used by markers.
21839 * Each marker must be associated to a marker class, and will use the style
21840 * defined by such class when alone, i.e., @b not grouped to other markers.
21842 * The following styles are provided by default theme:
21847 * @see elm_map_marker_class_new() for more details.
21848 * @see elm_map_marker_add()
21852 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21855 * Set the icon callback function of a marker class.
21857 * @param clas The marker class.
21858 * @param icon_get The callback function that will return the icon.
21860 * Each marker must be associated to a marker class, and it can display a
21861 * custom icon. The function @p icon_get must return this icon.
21863 * @see elm_map_marker_class_new() for more details.
21864 * @see elm_map_marker_add()
21868 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21871 * Set the bubble content callback function of a marker class.
21873 * @param clas The marker class.
21874 * @param get The callback function that will return the content.
21876 * Each marker must be associated to a marker class, and it can display a
21877 * a content on a bubble that opens when the user click over the marker.
21878 * The function @p get must return this content object.
21880 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21883 * @see elm_map_marker_class_new() for more details.
21884 * @see elm_map_marker_class_del_cb_set()
21885 * @see elm_map_marker_add()
21889 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21892 * Set the callback function used to delete bubble content of a marker class.
21894 * @param clas The marker class.
21895 * @param del The callback function that will delete the content.
21897 * Each marker must be associated to a marker class, and it can display a
21898 * a content on a bubble that opens when the user click over the marker.
21899 * The function to return such content can be set with
21900 * elm_map_marker_class_get_cb_set().
21902 * If this content must be freed, a callback function need to be
21903 * set for that task with this function.
21905 * If this callback is defined it will have to delete (or not) the
21906 * object inside, but if the callback is not defined the object will be
21907 * destroyed with evas_object_del().
21909 * @see elm_map_marker_class_new() for more details.
21910 * @see elm_map_marker_class_get_cb_set()
21911 * @see elm_map_marker_add()
21915 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21918 * Get the list of available sources.
21920 * @param obj The map object.
21921 * @return The source names list.
21923 * It will provide a list with all available sources, that can be set as
21924 * current source with elm_map_source_name_set(), or get with
21925 * elm_map_source_name_get().
21927 * Available sources:
21933 * @see elm_map_source_name_set() for more details.
21934 * @see elm_map_source_name_get()
21938 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21941 * Set the source of the map.
21943 * @param obj The map object.
21944 * @param source The source to be used.
21946 * Map widget retrieves images that composes the map from a web service.
21947 * This web service can be set with this method.
21949 * A different service can return a different maps with different
21950 * information and it can use different zoom values.
21952 * The @p source_name need to match one of the names provided by
21953 * elm_map_source_names_get().
21955 * The current source can be get using elm_map_source_name_get().
21957 * @see elm_map_source_names_get()
21958 * @see elm_map_source_name_get()
21963 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21966 * Get the name of currently used source.
21968 * @param obj The map object.
21969 * @return Returns the name of the source in use.
21971 * @see elm_map_source_name_set() for more details.
21975 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21978 * Set the source of the route service to be used by the map.
21980 * @param obj The map object.
21981 * @param source The route service to be used, being it one of
21982 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21983 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21985 * Each one has its own algorithm, so the route retrieved may
21986 * differ depending on the source route. Now, only the default is working.
21988 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21989 * http://www.yournavigation.org/.
21991 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21992 * assumptions. Its routing core is based on Contraction Hierarchies.
21994 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21996 * @see elm_map_route_source_get().
22000 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22003 * Get the current route source.
22005 * @param obj The map object.
22006 * @return The source of the route service used by the map.
22008 * @see elm_map_route_source_set() for details.
22012 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22015 * Set the minimum zoom of the source.
22017 * @param obj The map object.
22018 * @param zoom New minimum zoom value to be used.
22020 * By default, it's 0.
22024 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22027 * Get the minimum zoom of the source.
22029 * @param obj The map object.
22030 * @return Returns the minimum zoom of the source.
22032 * @see elm_map_source_zoom_min_set() for details.
22036 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22039 * Set the maximum zoom of the source.
22041 * @param obj The map object.
22042 * @param zoom New maximum zoom value to be used.
22044 * By default, it's 18.
22048 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22051 * Get the maximum zoom of the source.
22053 * @param obj The map object.
22054 * @return Returns the maximum zoom of the source.
22056 * @see elm_map_source_zoom_min_set() for details.
22060 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22063 * Set the user agent used by the map object to access routing services.
22065 * @param obj The map object.
22066 * @param user_agent The user agent to be used by the map.
22068 * User agent is a client application implementing a network protocol used
22069 * in communications within a client–server distributed computing system
22071 * The @p user_agent identification string will transmitted in a header
22072 * field @c User-Agent.
22074 * @see elm_map_user_agent_get()
22078 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22081 * Get the user agent used by the map object.
22083 * @param obj The map object.
22084 * @return The user agent identification string used by the map.
22086 * @see elm_map_user_agent_set() for details.
22090 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22093 * Add a new route to the map object.
22095 * @param obj The map object.
22096 * @param type The type of transport to be considered when tracing a route.
22097 * @param method The routing method, what should be priorized.
22098 * @param flon The start longitude.
22099 * @param flat The start latitude.
22100 * @param tlon The destination longitude.
22101 * @param tlat The destination latitude.
22103 * @return The created route or @c NULL upon failure.
22105 * A route will be traced by point on coordinates (@p flat, @p flon)
22106 * to point on coordinates (@p tlat, @p tlon), using the route service
22107 * set with elm_map_route_source_set().
22109 * It will take @p type on consideration to define the route,
22110 * depending if the user will be walking or driving, the route may vary.
22111 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22112 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22114 * Another parameter is what the route should priorize, the minor distance
22115 * or the less time to be spend on the route. So @p method should be one
22116 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22118 * Routes created with this method can be deleted with
22119 * elm_map_route_remove(), colored with elm_map_route_color_set(),
22120 * and distance can be get with elm_map_route_distance_get().
22122 * @see elm_map_route_remove()
22123 * @see elm_map_route_color_set()
22124 * @see elm_map_route_distance_get()
22125 * @see elm_map_route_source_set()
22129 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);
22132 * Remove a route from the map.
22134 * @param route The route to remove.
22136 * @see elm_map_route_add()
22140 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22143 * Set the route color.
22145 * @param route The route object.
22146 * @param r Red channel value, from 0 to 255.
22147 * @param g Green channel value, from 0 to 255.
22148 * @param b Blue channel value, from 0 to 255.
22149 * @param a Alpha channel value, from 0 to 255.
22151 * It uses an additive color model, so each color channel represents
22152 * how much of each primary colors must to be used. 0 represents
22153 * ausence of this color, so if all of the three are set to 0,
22154 * the color will be black.
22156 * These component values should be integers in the range 0 to 255,
22157 * (single 8-bit byte).
22159 * This sets the color used for the route. By default, it is set to
22160 * solid red (r = 255, g = 0, b = 0, a = 255).
22162 * For alpha channel, 0 represents completely transparent, and 255, opaque.
22164 * @see elm_map_route_color_get()
22168 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22171 * Get the route color.
22173 * @param route The route object.
22174 * @param r Pointer where to store the red channel value.
22175 * @param g Pointer where to store the green channel value.
22176 * @param b Pointer where to store the blue channel value.
22177 * @param a Pointer where to store the alpha channel value.
22179 * @see elm_map_route_color_set() for details.
22183 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22186 * Get the route distance in kilometers.
22188 * @param route The route object.
22189 * @return The distance of route (unit : km).
22193 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22196 * Get the information of route nodes.
22198 * @param route The route object.
22199 * @return Returns a string with the nodes of route.
22203 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22206 * Get the information of route waypoint.
22208 * @param route the route object.
22209 * @return Returns a string with information about waypoint of route.
22213 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22216 * Get the address of the name.
22218 * @param name The name handle.
22219 * @return Returns the address string of @p name.
22221 * This gets the coordinates of the @p name, created with one of the
22222 * conversion functions.
22224 * @see elm_map_utils_convert_name_into_coord()
22225 * @see elm_map_utils_convert_coord_into_name()
22229 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22232 * Get the current coordinates of the name.
22234 * @param name The name handle.
22235 * @param lat Pointer where to store the latitude.
22236 * @param lon Pointer where to store The longitude.
22238 * This gets the coordinates of the @p name, created with one of the
22239 * conversion functions.
22241 * @see elm_map_utils_convert_name_into_coord()
22242 * @see elm_map_utils_convert_coord_into_name()
22246 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22249 * Remove a name from the map.
22251 * @param name The name to remove.
22253 * Basically the struct handled by @p name will be freed, so convertions
22254 * between address and coordinates will be lost.
22256 * @see elm_map_utils_convert_name_into_coord()
22257 * @see elm_map_utils_convert_coord_into_name()
22261 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22266 * @param obj The map object.
22267 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22268 * @param cx Rotation's center horizontal position.
22269 * @param cy Rotation's center vertical position.
22271 * @see elm_map_rotate_get()
22275 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22278 * Get the rotate degree of the map
22280 * @param obj The map object
22281 * @param degree Pointer where to store degrees from 0.0 to 360.0
22282 * to rotate arount Z axis.
22283 * @param cx Pointer where to store rotation's center horizontal position.
22284 * @param cy Pointer where to store rotation's center vertical position.
22286 * @see elm_map_rotate_set() to set map rotation.
22290 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);
22293 * Enable or disable mouse wheel to be used to zoom in / out the map.
22295 * @param obj The map object.
22296 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22299 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22301 * It's disabled by default.
22303 * @see elm_map_wheel_disabled_get()
22307 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22310 * Get a value whether mouse wheel is enabled or not.
22312 * @param obj The map object.
22313 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22314 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22316 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22318 * @see elm_map_wheel_disabled_set() for details.
22322 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22326 * Add a track on the map
22328 * @param obj The map object.
22329 * @param emap The emap route object.
22330 * @return The route object. This is an elm object of type Route.
22332 * @see elm_route_add() for details.
22336 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22340 * Remove a track from the map
22342 * @param obj The map object.
22343 * @param route The track to remove.
22347 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22354 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22356 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22358 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22359 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22360 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22361 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22365 * @defgroup Panel Panel
22367 * @image html img/widget/panel/preview-00.png
22368 * @image latex img/widget/panel/preview-00.eps
22370 * @brief A panel is a type of animated container that contains subobjects.
22371 * It can be expanded or contracted by clicking the button on it's edge.
22373 * Orientations are as follows:
22374 * @li ELM_PANEL_ORIENT_TOP
22375 * @li ELM_PANEL_ORIENT_LEFT
22376 * @li ELM_PANEL_ORIENT_RIGHT
22378 * @ref tutorial_panel shows one way to use this widget.
22381 typedef enum _Elm_Panel_Orient
22383 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22384 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22385 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22386 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22387 } Elm_Panel_Orient;
22389 * @brief Adds a panel object
22391 * @param parent The parent object
22393 * @return The panel object, or NULL on failure
22395 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22397 * @brief Sets the orientation of the panel
22399 * @param parent The parent object
22400 * @param orient The panel orientation. Can be one of the following:
22401 * @li ELM_PANEL_ORIENT_TOP
22402 * @li ELM_PANEL_ORIENT_LEFT
22403 * @li ELM_PANEL_ORIENT_RIGHT
22405 * Sets from where the panel will (dis)appear.
22407 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22409 * @brief Get the orientation of the panel.
22411 * @param obj The panel object
22412 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22414 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22416 * @brief Set the content of the panel.
22418 * @param obj The panel object
22419 * @param content The panel content
22421 * Once the content object is set, a previously set one will be deleted.
22422 * If you want to keep that old content object, use the
22423 * elm_panel_content_unset() function.
22425 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22427 * @brief Get the content of the panel.
22429 * @param obj The panel object
22430 * @return The content that is being used
22432 * Return the content object which is set for this widget.
22434 * @see elm_panel_content_set()
22436 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22438 * @brief Unset the content of the panel.
22440 * @param obj The panel object
22441 * @return The content that was being used
22443 * Unparent and return the content object which was set for this widget.
22445 * @see elm_panel_content_set()
22447 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22449 * @brief Set the state of the panel.
22451 * @param obj The panel object
22452 * @param hidden If true, the panel will run the animation to contract
22454 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22456 * @brief Get the state of the panel.
22458 * @param obj The panel object
22459 * @param hidden If true, the panel is in the "hide" state
22461 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22463 * @brief Toggle the hidden state of the panel from code
22465 * @param obj The panel object
22467 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22473 * @defgroup Panes Panes
22474 * @ingroup Elementary
22476 * @image html img/widget/panes/preview-00.png
22477 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22479 * @image html img/panes.png
22480 * @image latex img/panes.eps width=\textwidth
22482 * The panes adds a dragable bar between two contents. When dragged
22483 * this bar will resize contents size.
22485 * Panes can be displayed vertically or horizontally, and contents
22486 * size proportion can be customized (homogeneous by default).
22488 * Smart callbacks one can listen to:
22489 * - "press" - The panes has been pressed (button wasn't released yet).
22490 * - "unpressed" - The panes was released after being pressed.
22491 * - "clicked" - The panes has been clicked>
22492 * - "clicked,double" - The panes has been double clicked
22494 * Available styles for it:
22497 * Here is an example on its usage:
22498 * @li @ref panes_example
22502 * @addtogroup Panes
22507 * Add a new panes widget to the given parent Elementary
22508 * (container) object.
22510 * @param parent The parent object.
22511 * @return a new panes widget handle or @c NULL, on errors.
22513 * This function inserts a new panes widget on the canvas.
22517 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22520 * Set the left content of the panes widget.
22522 * @param obj The panes object.
22523 * @param content The new left content object.
22525 * Once the content object is set, a previously set one will be deleted.
22526 * If you want to keep that old content object, use the
22527 * elm_panes_content_left_unset() function.
22529 * If panes is displayed vertically, left content will be displayed at
22532 * @see elm_panes_content_left_get()
22533 * @see elm_panes_content_right_set() to set content on the other side.
22537 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22540 * Set the right content of the panes widget.
22542 * @param obj The panes object.
22543 * @param content The new right content object.
22545 * Once the content object is set, a previously set one will be deleted.
22546 * If you want to keep that old content object, use the
22547 * elm_panes_content_right_unset() function.
22549 * If panes is displayed vertically, left content will be displayed at
22552 * @see elm_panes_content_right_get()
22553 * @see elm_panes_content_left_set() to set content on the other side.
22557 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22560 * Get the left content of the panes.
22562 * @param obj The panes object.
22563 * @return The left content object that is being used.
22565 * Return the left content object which is set for this widget.
22567 * @see elm_panes_content_left_set() for details.
22571 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22574 * Get the right content of the panes.
22576 * @param obj The panes object
22577 * @return The right content object that is being used
22579 * Return the right content object which is set for this widget.
22581 * @see elm_panes_content_right_set() for details.
22585 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22588 * Unset the left content used for the panes.
22590 * @param obj The panes object.
22591 * @return The left content object that was being used.
22593 * Unparent and return the left content object which was set for this widget.
22595 * @see elm_panes_content_left_set() for details.
22596 * @see elm_panes_content_left_get().
22600 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22603 * Unset the right content used for the panes.
22605 * @param obj The panes object.
22606 * @return The right content object that was being used.
22608 * Unparent and return the right content object which was set for this
22611 * @see elm_panes_content_right_set() for details.
22612 * @see elm_panes_content_right_get().
22616 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22619 * Get the size proportion of panes widget's left side.
22621 * @param obj The panes object.
22622 * @return float value between 0.0 and 1.0 representing size proportion
22625 * @see elm_panes_content_left_size_set() for more details.
22629 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22632 * Set the size proportion of panes widget's left side.
22634 * @param obj The panes object.
22635 * @param size Value between 0.0 and 1.0 representing size proportion
22638 * By default it's homogeneous, i.e., both sides have the same size.
22640 * If something different is required, it can be set with this function.
22641 * For example, if the left content should be displayed over
22642 * 75% of the panes size, @p size should be passed as @c 0.75.
22643 * This way, right content will be resized to 25% of panes size.
22645 * If displayed vertically, left content is displayed at top, and
22646 * right content at bottom.
22648 * @note This proportion will change when user drags the panes bar.
22650 * @see elm_panes_content_left_size_get()
22654 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22657 * Set the orientation of a given panes widget.
22659 * @param obj The panes object.
22660 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22661 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22663 * Use this function to change how your panes is to be
22664 * disposed: vertically or horizontally.
22666 * By default it's displayed horizontally.
22668 * @see elm_panes_horizontal_get()
22672 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22675 * Retrieve the orientation of a given panes widget.
22677 * @param obj The panes object.
22678 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22679 * @c EINA_FALSE if it's @b vertical (and on errors).
22681 * @see elm_panes_horizontal_set() for more details.
22685 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22692 * @defgroup Flip Flip
22694 * @image html img/widget/flip/preview-00.png
22695 * @image latex img/widget/flip/preview-00.eps
22697 * This widget holds 2 content objects(Evas_Object): one on the front and one
22698 * on the back. It allows you to flip from front to back and vice-versa using
22699 * various animations.
22701 * If either the front or back contents are not set the flip will treat that
22702 * as transparent. So if you wore to set the front content but not the back,
22703 * and then call elm_flip_go() you would see whatever is below the flip.
22705 * For a list of supported animations see elm_flip_go().
22707 * Signals that you can add callbacks for are:
22708 * "animate,begin" - when a flip animation was started
22709 * "animate,done" - when a flip animation is finished
22711 * @ref tutorial_flip show how to use most of the API.
22715 typedef enum _Elm_Flip_Mode
22717 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22718 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22719 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22720 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22721 ELM_FLIP_CUBE_LEFT,
22722 ELM_FLIP_CUBE_RIGHT,
22724 ELM_FLIP_CUBE_DOWN,
22725 ELM_FLIP_PAGE_LEFT,
22726 ELM_FLIP_PAGE_RIGHT,
22730 typedef enum _Elm_Flip_Interaction
22732 ELM_FLIP_INTERACTION_NONE,
22733 ELM_FLIP_INTERACTION_ROTATE,
22734 ELM_FLIP_INTERACTION_CUBE,
22735 ELM_FLIP_INTERACTION_PAGE
22736 } Elm_Flip_Interaction;
22737 typedef enum _Elm_Flip_Direction
22739 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22740 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22741 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22742 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22743 } Elm_Flip_Direction;
22745 * @brief Add a new flip to the parent
22747 * @param parent The parent object
22748 * @return The new object or NULL if it cannot be created
22750 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22752 * @brief Set the front content of the flip widget.
22754 * @param obj The flip object
22755 * @param content The new front content object
22757 * Once the content object is set, a previously set one will be deleted.
22758 * If you want to keep that old content object, use the
22759 * elm_flip_content_front_unset() function.
22761 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22763 * @brief Set the back content of the flip widget.
22765 * @param obj The flip object
22766 * @param content The new back content object
22768 * Once the content object is set, a previously set one will be deleted.
22769 * If you want to keep that old content object, use the
22770 * elm_flip_content_back_unset() function.
22772 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22774 * @brief Get the front content used for the flip
22776 * @param obj The flip object
22777 * @return The front content object that is being used
22779 * Return the front content object which is set for this widget.
22781 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22783 * @brief Get the back content used for the flip
22785 * @param obj The flip object
22786 * @return The back content object that is being used
22788 * Return the back content object which is set for this widget.
22790 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22792 * @brief Unset the front content used for the flip
22794 * @param obj The flip object
22795 * @return The front content object that was being used
22797 * Unparent and return the front content object which was set for this widget.
22799 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22801 * @brief Unset the back content used for the flip
22803 * @param obj The flip object
22804 * @return The back content object that was being used
22806 * Unparent and return the back content object which was set for this widget.
22808 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22810 * @brief Get flip front visibility state
22812 * @param obj The flip objct
22813 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22816 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22818 * @brief Set flip perspective
22820 * @param obj The flip object
22821 * @param foc The coordinate to set the focus on
22822 * @param x The X coordinate
22823 * @param y The Y coordinate
22825 * @warning This function currently does nothing.
22827 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22829 * @brief Runs the flip animation
22831 * @param obj The flip object
22832 * @param mode The mode type
22834 * Flips the front and back contents using the @p mode animation. This
22835 * efectively hides the currently visible content and shows the hidden one.
22837 * There a number of possible animations to use for the flipping:
22838 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22839 * around a horizontal axis in the middle of its height, the other content
22840 * is shown as the other side of the flip.
22841 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22842 * around a vertical axis in the middle of its width, the other content is
22843 * shown as the other side of the flip.
22844 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22845 * around a diagonal axis in the middle of its width, the other content is
22846 * shown as the other side of the flip.
22847 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22848 * around a diagonal axis in the middle of its height, the other content is
22849 * shown as the other side of the flip.
22850 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22851 * as if the flip was a cube, the other content is show as the right face of
22853 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22854 * right as if the flip was a cube, the other content is show as the left
22855 * face of the cube.
22856 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22857 * flip was a cube, the other content is show as the bottom face of the cube.
22858 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22859 * the flip was a cube, the other content is show as the upper face of the
22861 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22862 * if the flip was a book, the other content is shown as the page below that.
22863 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22864 * as if the flip was a book, the other content is shown as the page below
22866 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22867 * flip was a book, the other content is shown as the page below that.
22868 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22869 * flip was a book, the other content is shown as the page below that.
22871 * @image html elm_flip.png
22872 * @image latex elm_flip.eps width=\textwidth
22874 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22876 * @brief Set the interactive flip mode
22878 * @param obj The flip object
22879 * @param mode The interactive flip mode to use
22881 * This sets if the flip should be interactive (allow user to click and
22882 * drag a side of the flip to reveal the back page and cause it to flip).
22883 * By default a flip is not interactive. You may also need to set which
22884 * sides of the flip are "active" for flipping and how much space they use
22885 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22886 * and elm_flip_interacton_direction_hitsize_set()
22888 * The four avilable mode of interaction are:
22889 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22890 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22891 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22892 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22894 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22895 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22896 * happen, those can only be acheived with elm_flip_go();
22898 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22900 * @brief Get the interactive flip mode
22902 * @param obj The flip object
22903 * @return The interactive flip mode
22905 * Returns the interactive flip mode set by elm_flip_interaction_set()
22907 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22909 * @brief Set which directions of the flip respond to interactive flip
22911 * @param obj The flip object
22912 * @param dir The direction to change
22913 * @param enabled If that direction is enabled or not
22915 * By default all directions are disabled, so you may want to enable the
22916 * desired directions for flipping if you need interactive flipping. You must
22917 * call this function once for each direction that should be enabled.
22919 * @see elm_flip_interaction_set()
22921 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22923 * @brief Get the enabled state of that flip direction
22925 * @param obj The flip object
22926 * @param dir The direction to check
22927 * @return If that direction is enabled or not
22929 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22931 * @see elm_flip_interaction_set()
22933 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22935 * @brief Set the amount of the flip that is sensitive to interactive flip
22937 * @param obj The flip object
22938 * @param dir The direction to modify
22939 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22941 * Set the amount of the flip that is sensitive to interactive flip, with 0
22942 * representing no area in the flip and 1 representing the entire flip. There
22943 * is however a consideration to be made in that the area will never be
22944 * smaller than the finger size set(as set in your Elementary configuration).
22946 * @see elm_flip_interaction_set()
22948 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22950 * @brief Get the amount of the flip that is sensitive to interactive flip
22952 * @param obj The flip object
22953 * @param dir The direction to check
22954 * @return The size set for that direction
22956 * Returns the amount os sensitive area set by
22957 * elm_flip_interacton_direction_hitsize_set().
22959 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22964 /* scrolledentry */
22965 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22966 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22967 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22968 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22969 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22970 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22971 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22972 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22973 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22974 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22975 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22976 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22977 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22978 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22979 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22980 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22981 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22982 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22983 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22984 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22985 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22986 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22987 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22988 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22989 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22990 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22991 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22992 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22993 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22994 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22995 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22996 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22997 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22998 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22999 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23000 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);
23001 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23002 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23003 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);
23004 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23005 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);
23006 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23007 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23008 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23009 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23010 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23011 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23012 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23013 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23014 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);
23015 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);
23016 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);
23017 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);
23018 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);
23019 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);
23020 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23021 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23022 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23023 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23024 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23025 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23026 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23029 * @defgroup Conformant Conformant
23030 * @ingroup Elementary
23032 * @image html img/widget/conformant/preview-00.png
23033 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23035 * @image html img/conformant.png
23036 * @image latex img/conformant.eps width=\textwidth
23038 * The aim is to provide a widget that can be used in elementary apps to
23039 * account for space taken up by the indicator, virtual keypad & softkey
23040 * windows when running the illume2 module of E17.
23042 * So conformant content will be sized and positioned considering the
23043 * space required for such stuff, and when they popup, as a keyboard
23044 * shows when an entry is selected, conformant content won't change.
23046 * Available styles for it:
23049 * See how to use this widget in this example:
23050 * @ref conformant_example
23054 * @addtogroup Conformant
23059 * Add a new conformant widget to the given parent Elementary
23060 * (container) object.
23062 * @param parent The parent object.
23063 * @return A new conformant widget handle or @c NULL, on errors.
23065 * This function inserts a new conformant widget on the canvas.
23067 * @ingroup Conformant
23069 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23072 * Set the content of the conformant widget.
23074 * @param obj The conformant object.
23075 * @param content The content to be displayed by the conformant.
23077 * Content will be sized and positioned considering the space required
23078 * to display a virtual keyboard. So it won't fill all the conformant
23079 * size. This way is possible to be sure that content won't resize
23080 * or be re-positioned after the keyboard is displayed.
23082 * Once the content object is set, a previously set one will be deleted.
23083 * If you want to keep that old content object, use the
23084 * elm_conformat_content_unset() function.
23086 * @see elm_conformant_content_unset()
23087 * @see elm_conformant_content_get()
23089 * @ingroup Conformant
23091 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23094 * Get the content of the conformant widget.
23096 * @param obj The conformant object.
23097 * @return The content that is being used.
23099 * Return the content object which is set for this widget.
23100 * It won't be unparent from conformant. For that, use
23101 * elm_conformant_content_unset().
23103 * @see elm_conformant_content_set() for more details.
23104 * @see elm_conformant_content_unset()
23106 * @ingroup Conformant
23108 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23111 * Unset the content of the conformant widget.
23113 * @param obj The conformant object.
23114 * @return The content that was being used.
23116 * Unparent and return the content object which was set for this widget.
23118 * @see elm_conformant_content_set() for more details.
23120 * @ingroup Conformant
23122 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23125 * Returns the Evas_Object that represents the content area.
23127 * @param obj The conformant object.
23128 * @return The content area of the widget.
23130 * @ingroup Conformant
23132 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23139 * @defgroup Mapbuf Mapbuf
23140 * @ingroup Elementary
23142 * @image html img/widget/mapbuf/preview-00.png
23143 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23145 * This holds one content object and uses an Evas Map of transformation
23146 * points to be later used with this content. So the content will be
23147 * moved, resized, etc as a single image. So it will improve performance
23148 * when you have a complex interafce, with a lot of elements, and will
23149 * need to resize or move it frequently (the content object and its
23152 * See how to use this widget in this example:
23153 * @ref mapbuf_example
23157 * @addtogroup Mapbuf
23162 * Add a new mapbuf widget to the given parent Elementary
23163 * (container) object.
23165 * @param parent The parent object.
23166 * @return A new mapbuf widget handle or @c NULL, on errors.
23168 * This function inserts a new mapbuf widget on the canvas.
23172 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23175 * Set the content of the mapbuf.
23177 * @param obj The mapbuf object.
23178 * @param content The content that will be filled in this mapbuf object.
23180 * Once the content object is set, a previously set one will be deleted.
23181 * If you want to keep that old content object, use the
23182 * elm_mapbuf_content_unset() function.
23184 * To enable map, elm_mapbuf_enabled_set() should be used.
23188 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23191 * Get the content of the mapbuf.
23193 * @param obj The mapbuf object.
23194 * @return The content that is being used.
23196 * Return the content object which is set for this widget.
23198 * @see elm_mapbuf_content_set() for details.
23202 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23205 * Unset the content of the mapbuf.
23207 * @param obj The mapbuf object.
23208 * @return The content that was being used.
23210 * Unparent and return the content object which was set for this widget.
23212 * @see elm_mapbuf_content_set() for details.
23216 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23219 * Enable or disable the map.
23221 * @param obj The mapbuf object.
23222 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23224 * This enables the map that is set or disables it. On enable, the object
23225 * geometry will be saved, and the new geometry will change (position and
23226 * size) to reflect the map geometry set.
23228 * Also, when enabled, alpha and smooth states will be used, so if the
23229 * content isn't solid, alpha should be enabled, for example, otherwise
23230 * a black retangle will fill the content.
23232 * When disabled, the stored map will be freed and geometry prior to
23233 * enabling the map will be restored.
23235 * It's disabled by default.
23237 * @see elm_mapbuf_alpha_set()
23238 * @see elm_mapbuf_smooth_set()
23242 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23245 * Get a value whether map is enabled or not.
23247 * @param obj The mapbuf object.
23248 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23249 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23251 * @see elm_mapbuf_enabled_set() for details.
23255 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23258 * Enable or disable smooth map rendering.
23260 * @param obj The mapbuf object.
23261 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23264 * This sets smoothing for map rendering. If the object is a type that has
23265 * its own smoothing settings, then both the smooth settings for this object
23266 * and the map must be turned off.
23268 * By default smooth maps are enabled.
23272 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23275 * Get a value whether smooth map rendering is enabled or not.
23277 * @param obj The mapbuf object.
23278 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23279 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23281 * @see elm_mapbuf_smooth_set() for details.
23285 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23288 * Set or unset alpha flag for map rendering.
23290 * @param obj The mapbuf object.
23291 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23294 * This sets alpha flag for map rendering. If the object is a type that has
23295 * its own alpha settings, then this will take precedence. Only image objects
23296 * have this currently. It stops alpha blending of the map area, and is
23297 * useful if you know the object and/or all sub-objects is 100% solid.
23299 * Alpha is enabled by default.
23303 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23306 * Get a value whether alpha blending is enabled or not.
23308 * @param obj The mapbuf object.
23309 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23310 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23312 * @see elm_mapbuf_alpha_set() for details.
23316 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23323 * @defgroup Flipselector Flip Selector
23325 * @image html img/widget/flipselector/preview-00.png
23326 * @image latex img/widget/flipselector/preview-00.eps
23328 * A flip selector is a widget to show a set of @b text items, one
23329 * at a time, with the same sheet switching style as the @ref Clock
23330 * "clock" widget, when one changes the current displaying sheet
23331 * (thus, the "flip" in the name).
23333 * User clicks to flip sheets which are @b held for some time will
23334 * make the flip selector to flip continuosly and automatically for
23335 * the user. The interval between flips will keep growing in time,
23336 * so that it helps the user to reach an item which is distant from
23337 * the current selection.
23339 * Smart callbacks one can register to:
23340 * - @c "selected" - when the widget's selected text item is changed
23341 * - @c "overflowed" - when the widget's current selection is changed
23342 * from the first item in its list to the last
23343 * - @c "underflowed" - when the widget's current selection is changed
23344 * from the last item in its list to the first
23346 * Available styles for it:
23349 * Here is an example on its usage:
23350 * @li @ref flipselector_example
23354 * @addtogroup Flipselector
23358 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23361 * Add a new flip selector widget to the given parent Elementary
23362 * (container) widget
23364 * @param parent The parent object
23365 * @return a new flip selector widget handle or @c NULL, on errors
23367 * This function inserts a new flip selector widget on the canvas.
23369 * @ingroup Flipselector
23371 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23374 * Programmatically select the next item of a flip selector widget
23376 * @param obj The flipselector object
23378 * @note The selection will be animated. Also, if it reaches the
23379 * end of its list of member items, it will continue with the first
23382 * @ingroup Flipselector
23384 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23387 * Programmatically select the previous item of a flip selector
23390 * @param obj The flipselector object
23392 * @note The selection will be animated. Also, if it reaches the
23393 * beginning of its list of member items, it will continue with the
23394 * last one backwards.
23396 * @ingroup Flipselector
23398 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23401 * Append a (text) item to a flip selector widget
23403 * @param obj The flipselector object
23404 * @param label The (text) label of the new item
23405 * @param func Convenience callback function to take place when
23407 * @param data Data passed to @p func, above
23408 * @return A handle to the item added or @c NULL, on errors
23410 * The widget's list of labels to show will be appended with the
23411 * given value. If the user wishes so, a callback function pointer
23412 * can be passed, which will get called when this same item is
23415 * @note The current selection @b won't be modified by appending an
23416 * element to the list.
23418 * @note The maximum length of the text label is going to be
23419 * determined <b>by the widget's theme</b>. Strings larger than
23420 * that value are going to be @b truncated.
23422 * @ingroup Flipselector
23424 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23427 * Prepend a (text) item to a flip selector widget
23429 * @param obj The flipselector object
23430 * @param label The (text) label of the new item
23431 * @param func Convenience callback function to take place when
23433 * @param data Data passed to @p func, above
23434 * @return A handle to the item added or @c NULL, on errors
23436 * The widget's list of labels to show will be prepended with the
23437 * given value. If the user wishes so, a callback function pointer
23438 * can be passed, which will get called when this same item is
23441 * @note The current selection @b won't be modified by prepending
23442 * an element to the list.
23444 * @note The maximum length of the text label is going to be
23445 * determined <b>by the widget's theme</b>. Strings larger than
23446 * that value are going to be @b truncated.
23448 * @ingroup Flipselector
23450 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23453 * Get the internal list of items in a given flip selector widget.
23455 * @param obj The flipselector object
23456 * @return The list of items (#Elm_Flipselector_Item as data) or
23457 * @c NULL on errors.
23459 * This list is @b not to be modified in any way and must not be
23460 * freed. Use the list members with functions like
23461 * elm_flipselector_item_label_set(),
23462 * elm_flipselector_item_label_get(),
23463 * elm_flipselector_item_del(),
23464 * elm_flipselector_item_selected_get(),
23465 * elm_flipselector_item_selected_set().
23467 * @warning This list is only valid until @p obj object's internal
23468 * items list is changed. It should be fetched again with another
23469 * call to this function when changes happen.
23471 * @ingroup Flipselector
23473 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23476 * Get the first item in the given flip selector widget's list of
23479 * @param obj The flipselector object
23480 * @return The first item or @c NULL, if it has no items (and on
23483 * @see elm_flipselector_item_append()
23484 * @see elm_flipselector_last_item_get()
23486 * @ingroup Flipselector
23488 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23491 * Get the last item in the given flip selector widget's list of
23494 * @param obj The flipselector object
23495 * @return The last item or @c NULL, if it has no items (and on
23498 * @see elm_flipselector_item_prepend()
23499 * @see elm_flipselector_first_item_get()
23501 * @ingroup Flipselector
23503 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23506 * Get the currently selected item in a flip selector widget.
23508 * @param obj The flipselector object
23509 * @return The selected item or @c NULL, if the widget has no items
23512 * @ingroup Flipselector
23514 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23517 * Set whether a given flip selector widget's item should be the
23518 * currently selected one.
23520 * @param item The flip selector item
23521 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23523 * This sets whether @p item is or not the selected (thus, under
23524 * display) one. If @p item is different than one under display,
23525 * the latter will be unselected. If the @p item is set to be
23526 * unselected, on the other hand, the @b first item in the widget's
23527 * internal members list will be the new selected one.
23529 * @see elm_flipselector_item_selected_get()
23531 * @ingroup Flipselector
23533 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23536 * Get whether a given flip selector widget's item is the currently
23539 * @param item The flip selector item
23540 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23543 * @see elm_flipselector_item_selected_set()
23545 * @ingroup Flipselector
23547 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23550 * Delete a given item from a flip selector widget.
23552 * @param item The item to delete
23554 * @ingroup Flipselector
23556 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23559 * Get the label of a given flip selector widget's item.
23561 * @param item The item to get label from
23562 * @return The text label of @p item or @c NULL, on errors
23564 * @see elm_flipselector_item_label_set()
23566 * @ingroup Flipselector
23568 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23571 * Set the label of a given flip selector widget's item.
23573 * @param item The item to set label on
23574 * @param label The text label string, in UTF-8 encoding
23576 * @see elm_flipselector_item_label_get()
23578 * @ingroup Flipselector
23580 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23583 * Gets the item before @p item in a flip selector widget's
23584 * internal list of items.
23586 * @param item The item to fetch previous from
23587 * @return The item before the @p item, in its parent's list. If
23588 * there is no previous item for @p item or there's an
23589 * error, @c NULL is returned.
23591 * @see elm_flipselector_item_next_get()
23593 * @ingroup Flipselector
23595 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23598 * Gets the item after @p item in a flip selector widget's
23599 * internal list of items.
23601 * @param item The item to fetch next from
23602 * @return The item after the @p item, in its parent's list. If
23603 * there is no next item for @p item or there's an
23604 * error, @c NULL is returned.
23606 * @see elm_flipselector_item_next_get()
23608 * @ingroup Flipselector
23610 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23613 * Set the interval on time updates for an user mouse button hold
23614 * on a flip selector widget.
23616 * @param obj The flip selector object
23617 * @param interval The (first) interval value in seconds
23619 * This interval value is @b decreased while the user holds the
23620 * mouse pointer either flipping up or flipping doww a given flip
23623 * This helps the user to get to a given item distant from the
23624 * current one easier/faster, as it will start to flip quicker and
23625 * quicker on mouse button holds.
23627 * The calculation for the next flip interval value, starting from
23628 * the one set with this call, is the previous interval divided by
23629 * 1.05, so it decreases a little bit.
23631 * The default starting interval value for automatic flips is
23634 * @see elm_flipselector_interval_get()
23636 * @ingroup Flipselector
23638 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23641 * Get the interval on time updates for an user mouse button hold
23642 * on a flip selector widget.
23644 * @param obj The flip selector object
23645 * @return The (first) interval value, in seconds, set on it
23647 * @see elm_flipselector_interval_set() for more details
23649 * @ingroup Flipselector
23651 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23657 * @addtogroup Calendar
23662 * @enum _Elm_Calendar_Mark_Repeat
23663 * @typedef Elm_Calendar_Mark_Repeat
23665 * Event periodicity, used to define if a mark should be repeated
23666 * @b beyond event's day. It's set when a mark is added.
23668 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23669 * there will be marks every week after this date. Marks will be displayed
23670 * at 13th, 20th, 27th, 3rd June ...
23672 * Values don't work as bitmask, only one can be choosen.
23674 * @see elm_calendar_mark_add()
23676 * @ingroup Calendar
23678 typedef enum _Elm_Calendar_Mark_Repeat
23680 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23681 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23682 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23683 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*/
23684 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. */
23685 } Elm_Calendar_Mark_Repeat;
23687 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(). */
23690 * Add a new calendar widget to the given parent Elementary
23691 * (container) object.
23693 * @param parent The parent object.
23694 * @return a new calendar widget handle or @c NULL, on errors.
23696 * This function inserts a new calendar widget on the canvas.
23698 * @ref calendar_example_01
23700 * @ingroup Calendar
23702 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23705 * Get weekdays names displayed by the calendar.
23707 * @param obj The calendar object.
23708 * @return Array of seven strings to be used as weekday names.
23710 * By default, weekdays abbreviations get from system are displayed:
23711 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23712 * The first string is related to Sunday, the second to Monday...
23714 * @see elm_calendar_weekdays_name_set()
23716 * @ref calendar_example_05
23718 * @ingroup Calendar
23720 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23723 * Set weekdays names to be displayed by the calendar.
23725 * @param obj The calendar object.
23726 * @param weekdays Array of seven strings to be used as weekday names.
23727 * @warning It must have 7 elements, or it will access invalid memory.
23728 * @warning The strings must be NULL terminated ('@\0').
23730 * By default, weekdays abbreviations get from system are displayed:
23731 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23733 * The first string should be related to Sunday, the second to Monday...
23735 * The usage should be like this:
23737 * const char *weekdays[] =
23739 * "Sunday", "Monday", "Tuesday", "Wednesday",
23740 * "Thursday", "Friday", "Saturday"
23742 * elm_calendar_weekdays_names_set(calendar, weekdays);
23745 * @see elm_calendar_weekdays_name_get()
23747 * @ref calendar_example_02
23749 * @ingroup Calendar
23751 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23754 * Set the minimum and maximum values for the year
23756 * @param obj The calendar object
23757 * @param min The minimum year, greater than 1901;
23758 * @param max The maximum year;
23760 * Maximum must be greater than minimum, except if you don't wan't to set
23762 * Default values are 1902 and -1.
23764 * If the maximum year is a negative value, it will be limited depending
23765 * on the platform architecture (year 2037 for 32 bits);
23767 * @see elm_calendar_min_max_year_get()
23769 * @ref calendar_example_03
23771 * @ingroup Calendar
23773 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23776 * Get the minimum and maximum values for the year
23778 * @param obj The calendar object.
23779 * @param min The minimum year.
23780 * @param max The maximum year.
23782 * Default values are 1902 and -1.
23784 * @see elm_calendar_min_max_year_get() for more details.
23786 * @ref calendar_example_05
23788 * @ingroup Calendar
23790 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23793 * Enable or disable day selection
23795 * @param obj The calendar object.
23796 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23799 * Enabled by default. If disabled, the user still can select months,
23800 * but not days. Selected days are highlighted on calendar.
23801 * It should be used if you won't need such selection for the widget usage.
23803 * When a day is selected, or month is changed, smart callbacks for
23804 * signal "changed" will be called.
23806 * @see elm_calendar_day_selection_enable_get()
23808 * @ref calendar_example_04
23810 * @ingroup Calendar
23812 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23815 * Get a value whether day selection is enabled or not.
23817 * @see elm_calendar_day_selection_enable_set() for details.
23819 * @param obj The calendar object.
23820 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23821 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23823 * @ref calendar_example_05
23825 * @ingroup Calendar
23827 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23831 * Set selected date to be highlighted on calendar.
23833 * @param obj The calendar object.
23834 * @param selected_time A @b tm struct to represent the selected date.
23836 * Set the selected date, changing the displayed month if needed.
23837 * Selected date changes when the user goes to next/previous month or
23838 * select a day pressing over it on calendar.
23840 * @see elm_calendar_selected_time_get()
23842 * @ref calendar_example_04
23844 * @ingroup Calendar
23846 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23849 * Get selected date.
23851 * @param obj The calendar object
23852 * @param selected_time A @b tm struct to point to selected date
23853 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23856 * Get date selected by the user or set by function
23857 * elm_calendar_selected_time_set().
23858 * Selected date changes when the user goes to next/previous month or
23859 * select a day pressing over it on calendar.
23861 * @see elm_calendar_selected_time_get()
23863 * @ref calendar_example_05
23865 * @ingroup Calendar
23867 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23870 * Set a function to format the string that will be used to display
23873 * @param obj The calendar object
23874 * @param format_function Function to set the month-year string given
23875 * the selected date
23877 * By default it uses strftime with "%B %Y" format string.
23878 * It should allocate the memory that will be used by the string,
23879 * that will be freed by the widget after usage.
23880 * A pointer to the string and a pointer to the time struct will be provided.
23885 * _format_month_year(struct tm *selected_time)
23888 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23889 * return strdup(buf);
23892 * elm_calendar_format_function_set(calendar, _format_month_year);
23895 * @ref calendar_example_02
23897 * @ingroup Calendar
23899 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23902 * Add a new mark to the calendar
23904 * @param obj The calendar object
23905 * @param mark_type A string used to define the type of mark. It will be
23906 * emitted to the theme, that should display a related modification on these
23907 * days representation.
23908 * @param mark_time A time struct to represent the date of inclusion of the
23909 * mark. For marks that repeats it will just be displayed after the inclusion
23910 * date in the calendar.
23911 * @param repeat Repeat the event following this periodicity. Can be a unique
23912 * mark (that don't repeat), daily, weekly, monthly or annually.
23913 * @return The created mark or @p NULL upon failure.
23915 * Add a mark that will be drawn in the calendar respecting the insertion
23916 * time and periodicity. It will emit the type as signal to the widget theme.
23917 * Default theme supports "holiday" and "checked", but it can be extended.
23919 * It won't immediately update the calendar, drawing the marks.
23920 * For this, call elm_calendar_marks_draw(). However, when user selects
23921 * next or previous month calendar forces marks drawn.
23923 * Marks created with this method can be deleted with
23924 * elm_calendar_mark_del().
23928 * struct tm selected_time;
23929 * time_t current_time;
23931 * current_time = time(NULL) + 5 * 84600;
23932 * localtime_r(¤t_time, &selected_time);
23933 * elm_calendar_mark_add(cal, "holiday", selected_time,
23934 * ELM_CALENDAR_ANNUALLY);
23936 * current_time = time(NULL) + 1 * 84600;
23937 * localtime_r(¤t_time, &selected_time);
23938 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23940 * elm_calendar_marks_draw(cal);
23943 * @see elm_calendar_marks_draw()
23944 * @see elm_calendar_mark_del()
23946 * @ref calendar_example_06
23948 * @ingroup Calendar
23950 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);
23953 * Delete mark from the calendar.
23955 * @param mark The mark to be deleted.
23957 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23958 * should be used instead of getting marks list and deleting each one.
23960 * @see elm_calendar_mark_add()
23962 * @ref calendar_example_06
23964 * @ingroup Calendar
23966 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23969 * Remove all calendar's marks
23971 * @param obj The calendar object.
23973 * @see elm_calendar_mark_add()
23974 * @see elm_calendar_mark_del()
23976 * @ingroup Calendar
23978 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23982 * Get a list of all the calendar marks.
23984 * @param obj The calendar object.
23985 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23987 * @see elm_calendar_mark_add()
23988 * @see elm_calendar_mark_del()
23989 * @see elm_calendar_marks_clear()
23991 * @ingroup Calendar
23993 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23996 * Draw calendar marks.
23998 * @param obj The calendar object.
24000 * Should be used after adding, removing or clearing marks.
24001 * It will go through the entire marks list updating the calendar.
24002 * If lots of marks will be added, add all the marks and then call
24005 * When the month is changed, i.e. user selects next or previous month,
24006 * marks will be drawed.
24008 * @see elm_calendar_mark_add()
24009 * @see elm_calendar_mark_del()
24010 * @see elm_calendar_marks_clear()
24012 * @ref calendar_example_06
24014 * @ingroup Calendar
24016 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24019 * Set a day text color to the same that represents Saturdays.
24021 * @param obj The calendar object.
24022 * @param pos The text position. Position is the cell counter, from left
24023 * to right, up to down. It starts on 0 and ends on 41.
24025 * @deprecated use elm_calendar_mark_add() instead like:
24028 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24029 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24032 * @see elm_calendar_mark_add()
24034 * @ingroup Calendar
24036 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24039 * Set a day text color to the same that represents Sundays.
24041 * @param obj The calendar object.
24042 * @param pos The text position. Position is the cell counter, from left
24043 * to right, up to down. It starts on 0 and ends on 41.
24045 * @deprecated use elm_calendar_mark_add() instead like:
24048 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24049 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24052 * @see elm_calendar_mark_add()
24054 * @ingroup Calendar
24056 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24059 * Set a day text color to the same that represents Weekdays.
24061 * @param obj The calendar object
24062 * @param pos The text position. Position is the cell counter, from left
24063 * to right, up to down. It starts on 0 and ends on 41.
24065 * @deprecated use elm_calendar_mark_add() instead like:
24068 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24070 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24071 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24072 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24073 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24074 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24075 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24076 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24077 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24078 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24081 * @see elm_calendar_mark_add()
24083 * @ingroup Calendar
24085 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24088 * Set the interval on time updates for an user mouse button hold
24089 * on calendar widgets' month selection.
24091 * @param obj The calendar object
24092 * @param interval The (first) interval value in seconds
24094 * This interval value is @b decreased while the user holds the
24095 * mouse pointer either selecting next or previous month.
24097 * This helps the user to get to a given month distant from the
24098 * current one easier/faster, as it will start to change quicker and
24099 * quicker on mouse button holds.
24101 * The calculation for the next change interval value, starting from
24102 * the one set with this call, is the previous interval divided by
24103 * 1.05, so it decreases a little bit.
24105 * The default starting interval value for automatic changes is
24108 * @see elm_calendar_interval_get()
24110 * @ingroup Calendar
24112 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24115 * Get the interval on time updates for an user mouse button hold
24116 * on calendar widgets' month selection.
24118 * @param obj The calendar object
24119 * @return The (first) interval value, in seconds, set on it
24121 * @see elm_calendar_interval_set() for more details
24123 * @ingroup Calendar
24125 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24132 * @defgroup Diskselector Diskselector
24133 * @ingroup Elementary
24135 * @image html img/widget/diskselector/preview-00.png
24136 * @image latex img/widget/diskselector/preview-00.eps
24138 * A diskselector is a kind of list widget. It scrolls horizontally,
24139 * and can contain label and icon objects. Three items are displayed
24140 * with the selected one in the middle.
24142 * It can act like a circular list with round mode and labels can be
24143 * reduced for a defined length for side items.
24145 * Smart callbacks one can listen to:
24146 * - "selected" - when item is selected, i.e. scroller stops.
24148 * Available styles for it:
24151 * List of examples:
24152 * @li @ref diskselector_example_01
24153 * @li @ref diskselector_example_02
24157 * @addtogroup Diskselector
24161 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(). */
24164 * Add a new diskselector widget to the given parent Elementary
24165 * (container) object.
24167 * @param parent The parent object.
24168 * @return a new diskselector widget handle or @c NULL, on errors.
24170 * This function inserts a new diskselector widget on the canvas.
24172 * @ingroup Diskselector
24174 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24177 * Enable or disable round mode.
24179 * @param obj The diskselector object.
24180 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24183 * Disabled by default. If round mode is enabled the items list will
24184 * work like a circle list, so when the user reaches the last item,
24185 * the first one will popup.
24187 * @see elm_diskselector_round_get()
24189 * @ingroup Diskselector
24191 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24194 * Get a value whether round mode is enabled or not.
24196 * @see elm_diskselector_round_set() for details.
24198 * @param obj The diskselector object.
24199 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24200 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24202 * @ingroup Diskselector
24204 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24207 * Get the side labels max length.
24209 * @deprecated use elm_diskselector_side_label_length_get() instead:
24211 * @param obj The diskselector object.
24212 * @return The max length defined for side labels, or 0 if not a valid
24215 * @ingroup Diskselector
24217 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24220 * Set the side labels max length.
24222 * @deprecated use elm_diskselector_side_label_length_set() instead:
24224 * @param obj The diskselector object.
24225 * @param len The max length defined for side labels.
24227 * @ingroup Diskselector
24229 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24232 * Get the side labels max length.
24234 * @see elm_diskselector_side_label_length_set() for details.
24236 * @param obj The diskselector object.
24237 * @return The max length defined for side labels, or 0 if not a valid
24240 * @ingroup Diskselector
24242 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24245 * Set the side labels max length.
24247 * @param obj The diskselector object.
24248 * @param len The max length defined for side labels.
24250 * Length is the number of characters of items' label that will be
24251 * visible when it's set on side positions. It will just crop
24252 * the string after defined size. E.g.:
24254 * An item with label "January" would be displayed on side position as
24255 * "Jan" if max length is set to 3, or "Janu", if this property
24258 * When it's selected, the entire label will be displayed, except for
24259 * width restrictions. In this case label will be cropped and "..."
24260 * will be concatenated.
24262 * Default side label max length is 3.
24264 * This property will be applyed over all items, included before or
24265 * later this function call.
24267 * @ingroup Diskselector
24269 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24272 * Set the number of items to be displayed.
24274 * @param obj The diskselector object.
24275 * @param num The number of items the diskselector will display.
24277 * Default value is 3, and also it's the minimun. If @p num is less
24278 * than 3, it will be set to 3.
24280 * Also, it can be set on theme, using data item @c display_item_num
24281 * on group "elm/diskselector/item/X", where X is style set.
24284 * group { name: "elm/diskselector/item/X";
24286 * item: "display_item_num" "5";
24289 * @ingroup Diskselector
24291 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24294 * Get the number of items in the diskselector object.
24296 * @param obj The diskselector object.
24298 * @ingroup Diskselector
24300 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24303 * Set bouncing behaviour when the scrolled content reaches an edge.
24305 * Tell the internal scroller object whether it should bounce or not
24306 * when it reaches the respective edges for each axis.
24308 * @param obj The diskselector object.
24309 * @param h_bounce Whether to bounce or not in the horizontal axis.
24310 * @param v_bounce Whether to bounce or not in the vertical axis.
24312 * @see elm_scroller_bounce_set()
24314 * @ingroup Diskselector
24316 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24319 * Get the bouncing behaviour of the internal scroller.
24321 * Get whether the internal scroller should bounce when the edge of each
24322 * axis is reached scrolling.
24324 * @param obj The diskselector object.
24325 * @param h_bounce Pointer where to store the bounce state of the horizontal
24327 * @param v_bounce Pointer where to store the bounce state of the vertical
24330 * @see elm_scroller_bounce_get()
24331 * @see elm_diskselector_bounce_set()
24333 * @ingroup Diskselector
24335 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24338 * Get the scrollbar policy.
24340 * @see elm_diskselector_scroller_policy_get() for details.
24342 * @param obj The diskselector object.
24343 * @param policy_h Pointer where to store horizontal scrollbar policy.
24344 * @param policy_v Pointer where to store vertical scrollbar policy.
24346 * @ingroup Diskselector
24348 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);
24351 * Set the scrollbar policy.
24353 * @param obj The diskselector object.
24354 * @param policy_h Horizontal scrollbar policy.
24355 * @param policy_v Vertical scrollbar policy.
24357 * This sets the scrollbar visibility policy for the given scroller.
24358 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24359 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24360 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24361 * This applies respectively for the horizontal and vertical scrollbars.
24363 * The both are disabled by default, i.e., are set to
24364 * #ELM_SCROLLER_POLICY_OFF.
24366 * @ingroup Diskselector
24368 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24371 * Remove all diskselector's items.
24373 * @param obj The diskselector object.
24375 * @see elm_diskselector_item_del()
24376 * @see elm_diskselector_item_append()
24378 * @ingroup Diskselector
24380 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24383 * Get a list of all the diskselector items.
24385 * @param obj The diskselector object.
24386 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24387 * or @c NULL on failure.
24389 * @see elm_diskselector_item_append()
24390 * @see elm_diskselector_item_del()
24391 * @see elm_diskselector_clear()
24393 * @ingroup Diskselector
24395 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24398 * Appends a new item to the diskselector object.
24400 * @param obj The diskselector object.
24401 * @param label The label of the diskselector item.
24402 * @param icon The icon object to use at left side of the item. An
24403 * icon can be any Evas object, but usually it is an icon created
24404 * with elm_icon_add().
24405 * @param func The function to call when the item is selected.
24406 * @param data The data to associate with the item for related callbacks.
24408 * @return The created item or @c NULL upon failure.
24410 * A new item will be created and appended to the diskselector, i.e., will
24411 * be set as last item. Also, if there is no selected item, it will
24412 * be selected. This will always happens for the first appended item.
24414 * If no icon is set, label will be centered on item position, otherwise
24415 * the icon will be placed at left of the label, that will be shifted
24418 * Items created with this method can be deleted with
24419 * elm_diskselector_item_del().
24421 * Associated @p data can be properly freed when item is deleted if a
24422 * callback function is set with elm_diskselector_item_del_cb_set().
24424 * If a function is passed as argument, it will be called everytime this item
24425 * is selected, i.e., the user stops the diskselector with this
24426 * item on center position. If such function isn't needed, just passing
24427 * @c NULL as @p func is enough. The same should be done for @p data.
24429 * Simple example (with no function callback or data associated):
24431 * disk = elm_diskselector_add(win);
24432 * ic = elm_icon_add(win);
24433 * elm_icon_file_set(ic, "path/to/image", NULL);
24434 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24435 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24438 * @see elm_diskselector_item_del()
24439 * @see elm_diskselector_item_del_cb_set()
24440 * @see elm_diskselector_clear()
24441 * @see elm_icon_add()
24443 * @ingroup Diskselector
24445 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);
24449 * Delete them item from the diskselector.
24451 * @param it The item of diskselector to be deleted.
24453 * If deleting all diskselector items is required, elm_diskselector_clear()
24454 * should be used instead of getting items list and deleting each one.
24456 * @see elm_diskselector_clear()
24457 * @see elm_diskselector_item_append()
24458 * @see elm_diskselector_item_del_cb_set()
24460 * @ingroup Diskselector
24462 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24465 * Set the function called when a diskselector item is freed.
24467 * @param it The item to set the callback on
24468 * @param func The function called
24470 * If there is a @p func, then it will be called prior item's memory release.
24471 * That will be called with the following arguments:
24473 * @li item's Evas object;
24476 * This way, a data associated to a diskselector item could be properly
24479 * @ingroup Diskselector
24481 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24484 * Get the data associated to the item.
24486 * @param it The diskselector item
24487 * @return The data associated to @p it
24489 * The return value is a pointer to data associated to @p item when it was
24490 * created, with function elm_diskselector_item_append(). If no data
24491 * was passed as argument, it will return @c NULL.
24493 * @see elm_diskselector_item_append()
24495 * @ingroup Diskselector
24497 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24500 * Set the icon associated to the item.
24502 * @param it The diskselector item
24503 * @param icon The icon object to associate with @p it
24505 * The icon object to use at left side of the item. An
24506 * icon can be any Evas object, but usually it is an icon created
24507 * with elm_icon_add().
24509 * Once the icon object is set, a previously set one will be deleted.
24510 * @warning Setting the same icon for two items will cause the icon to
24511 * dissapear from the first item.
24513 * If an icon was passed as argument on item creation, with function
24514 * elm_diskselector_item_append(), it will be already
24515 * associated to the item.
24517 * @see elm_diskselector_item_append()
24518 * @see elm_diskselector_item_icon_get()
24520 * @ingroup Diskselector
24522 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24525 * Get the icon associated to the item.
24527 * @param it The diskselector item
24528 * @return The icon associated to @p it
24530 * The return value is a pointer to the icon associated to @p item when it was
24531 * created, with function elm_diskselector_item_append(), or later
24532 * with function elm_diskselector_item_icon_set. If no icon
24533 * was passed as argument, it will return @c NULL.
24535 * @see elm_diskselector_item_append()
24536 * @see elm_diskselector_item_icon_set()
24538 * @ingroup Diskselector
24540 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24543 * Set the label of item.
24545 * @param it The item of diskselector.
24546 * @param label The label of item.
24548 * The label to be displayed by the item.
24550 * If no icon is set, label will be centered on item position, otherwise
24551 * the icon will be placed at left of the label, that will be shifted
24554 * An item with label "January" would be displayed on side position as
24555 * "Jan" if max length is set to 3 with function
24556 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24559 * When this @p item is selected, the entire label will be displayed,
24560 * except for width restrictions.
24561 * In this case label will be cropped and "..." will be concatenated,
24562 * but only for display purposes. It will keep the entire string, so
24563 * if diskselector is resized the remaining characters will be displayed.
24565 * If a label was passed as argument on item creation, with function
24566 * elm_diskselector_item_append(), it will be already
24567 * displayed by the item.
24569 * @see elm_diskselector_side_label_lenght_set()
24570 * @see elm_diskselector_item_label_get()
24571 * @see elm_diskselector_item_append()
24573 * @ingroup Diskselector
24575 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24578 * Get the label of item.
24580 * @param it The item of diskselector.
24581 * @return The label of item.
24583 * The return value is a pointer to the label associated to @p item when it was
24584 * created, with function elm_diskselector_item_append(), or later
24585 * with function elm_diskselector_item_label_set. If no label
24586 * was passed as argument, it will return @c NULL.
24588 * @see elm_diskselector_item_label_set() for more details.
24589 * @see elm_diskselector_item_append()
24591 * @ingroup Diskselector
24593 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24596 * Get the selected item.
24598 * @param obj The diskselector object.
24599 * @return The selected diskselector item.
24601 * The selected item can be unselected with function
24602 * elm_diskselector_item_selected_set(), and the first item of
24603 * diskselector will be selected.
24605 * The selected item always will be centered on diskselector, with
24606 * full label displayed, i.e., max lenght set to side labels won't
24607 * apply on the selected item. More details on
24608 * elm_diskselector_side_label_length_set().
24610 * @ingroup Diskselector
24612 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24615 * Set the selected state of an item.
24617 * @param it The diskselector item
24618 * @param selected The selected state
24620 * This sets the selected state of the given item @p it.
24621 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24623 * If a new item is selected the previosly selected will be unselected.
24624 * Previoulsy selected item can be get with function
24625 * elm_diskselector_selected_item_get().
24627 * If the item @p it is unselected, the first item of diskselector will
24630 * Selected items will be visible on center position of diskselector.
24631 * So if it was on another position before selected, or was invisible,
24632 * diskselector will animate items until the selected item reaches center
24635 * @see elm_diskselector_item_selected_get()
24636 * @see elm_diskselector_selected_item_get()
24638 * @ingroup Diskselector
24640 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24643 * Get whether the @p item is selected or not.
24645 * @param it The diskselector item.
24646 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24647 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24649 * @see elm_diskselector_selected_item_set() for details.
24650 * @see elm_diskselector_item_selected_get()
24652 * @ingroup Diskselector
24654 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24657 * Get the first item of the diskselector.
24659 * @param obj The diskselector object.
24660 * @return The first item, or @c NULL if none.
24662 * The list of items follows append order. So it will return the first
24663 * item appended to the widget that wasn't deleted.
24665 * @see elm_diskselector_item_append()
24666 * @see elm_diskselector_items_get()
24668 * @ingroup Diskselector
24670 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24673 * Get the last item of the diskselector.
24675 * @param obj The diskselector object.
24676 * @return The last item, or @c NULL if none.
24678 * The list of items follows append order. So it will return last first
24679 * item appended to the widget that wasn't deleted.
24681 * @see elm_diskselector_item_append()
24682 * @see elm_diskselector_items_get()
24684 * @ingroup Diskselector
24686 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24689 * Get the item before @p item in diskselector.
24691 * @param it The diskselector item.
24692 * @return The item before @p item, or @c NULL if none or on failure.
24694 * The list of items follows append order. So it will return item appended
24695 * just before @p item and that wasn't deleted.
24697 * If it is the first item, @c NULL will be returned.
24698 * First item can be get by elm_diskselector_first_item_get().
24700 * @see elm_diskselector_item_append()
24701 * @see elm_diskselector_items_get()
24703 * @ingroup Diskselector
24705 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24708 * Get the item after @p item in diskselector.
24710 * @param it The diskselector item.
24711 * @return The item after @p item, or @c NULL if none or on failure.
24713 * The list of items follows append order. So it will return item appended
24714 * just after @p item and that wasn't deleted.
24716 * If it is the last item, @c NULL will be returned.
24717 * Last item can be get by elm_diskselector_last_item_get().
24719 * @see elm_diskselector_item_append()
24720 * @see elm_diskselector_items_get()
24722 * @ingroup Diskselector
24724 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24727 * Set the text to be shown in the diskselector item.
24729 * @param item Target item
24730 * @param text The text to set in the content
24732 * Setup the text as tooltip to object. The item can have only one tooltip,
24733 * so any previous tooltip data is removed.
24735 * @see elm_object_tooltip_text_set() for more details.
24737 * @ingroup Diskselector
24739 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24742 * Set the content to be shown in the tooltip item.
24744 * Setup the tooltip to item. The item can have only one tooltip,
24745 * so any previous tooltip data is removed. @p func(with @p data) will
24746 * be called every time that need show the tooltip and it should
24747 * return a valid Evas_Object. This object is then managed fully by
24748 * tooltip system and is deleted when the tooltip is gone.
24750 * @param item the diskselector item being attached a tooltip.
24751 * @param func the function used to create the tooltip contents.
24752 * @param data what to provide to @a func as callback data/context.
24753 * @param del_cb called when data is not needed anymore, either when
24754 * another callback replaces @p func, the tooltip is unset with
24755 * elm_diskselector_item_tooltip_unset() or the owner @a item
24756 * dies. This callback receives as the first parameter the
24757 * given @a data, and @c event_info is the item.
24759 * @see elm_object_tooltip_content_cb_set() for more details.
24761 * @ingroup Diskselector
24763 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);
24766 * Unset tooltip from item.
24768 * @param item diskselector item to remove previously set tooltip.
24770 * Remove tooltip from item. The callback provided as del_cb to
24771 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24772 * it is not used anymore.
24774 * @see elm_object_tooltip_unset() for more details.
24775 * @see elm_diskselector_item_tooltip_content_cb_set()
24777 * @ingroup Diskselector
24779 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24783 * Sets a different style for this item tooltip.
24785 * @note before you set a style you should define a tooltip with
24786 * elm_diskselector_item_tooltip_content_cb_set() or
24787 * elm_diskselector_item_tooltip_text_set()
24789 * @param item diskselector item with tooltip already set.
24790 * @param style the theme style to use (default, transparent, ...)
24792 * @see elm_object_tooltip_style_set() for more details.
24794 * @ingroup Diskselector
24796 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24799 * Get the style for this item tooltip.
24801 * @param item diskselector item with tooltip already set.
24802 * @return style the theme style in use, defaults to "default". If the
24803 * object does not have a tooltip set, then NULL is returned.
24805 * @see elm_object_tooltip_style_get() for more details.
24806 * @see elm_diskselector_item_tooltip_style_set()
24808 * @ingroup Diskselector
24810 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24813 * Set the cursor to be shown when mouse is over the diskselector item
24815 * @param item Target item
24816 * @param cursor the cursor name to be used.
24818 * @see elm_object_cursor_set() for more details.
24820 * @ingroup Diskselector
24822 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24825 * Get the cursor to be shown when mouse is over the diskselector item
24827 * @param item diskselector item with cursor already set.
24828 * @return the cursor name.
24830 * @see elm_object_cursor_get() for more details.
24831 * @see elm_diskselector_cursor_set()
24833 * @ingroup Diskselector
24835 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24839 * Unset the cursor to be shown when mouse is over the diskselector item
24841 * @param item Target item
24843 * @see elm_object_cursor_unset() for more details.
24844 * @see elm_diskselector_cursor_set()
24846 * @ingroup Diskselector
24848 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24851 * Sets a different style for this item cursor.
24853 * @note before you set a style you should define a cursor with
24854 * elm_diskselector_item_cursor_set()
24856 * @param item diskselector item with cursor already set.
24857 * @param style the theme style to use (default, transparent, ...)
24859 * @see elm_object_cursor_style_set() for more details.
24861 * @ingroup Diskselector
24863 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24867 * Get the style for this item cursor.
24869 * @param item diskselector item with cursor already set.
24870 * @return style the theme style in use, defaults to "default". If the
24871 * object does not have a cursor set, then @c NULL is returned.
24873 * @see elm_object_cursor_style_get() for more details.
24874 * @see elm_diskselector_item_cursor_style_set()
24876 * @ingroup Diskselector
24878 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24882 * Set if the cursor set should be searched on the theme or should use
24883 * the provided by the engine, only.
24885 * @note before you set if should look on theme you should define a cursor
24886 * with elm_diskselector_item_cursor_set().
24887 * By default it will only look for cursors provided by the engine.
24889 * @param item widget item with cursor already set.
24890 * @param engine_only boolean to define if cursors set with
24891 * elm_diskselector_item_cursor_set() should be searched only
24892 * between cursors provided by the engine or searched on widget's
24895 * @see elm_object_cursor_engine_only_set() for more details.
24897 * @ingroup Diskselector
24899 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24902 * Get the cursor engine only usage for this item cursor.
24904 * @param item widget item with cursor already set.
24905 * @return engine_only boolean to define it cursors should be looked only
24906 * between the provided by the engine or searched on widget's theme as well.
24907 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24909 * @see elm_object_cursor_engine_only_get() for more details.
24910 * @see elm_diskselector_item_cursor_engine_only_set()
24912 * @ingroup Diskselector
24914 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24921 * @defgroup Colorselector Colorselector
24925 * @image html img/widget/colorselector/preview-00.png
24926 * @image latex img/widget/colorselector/preview-00.eps
24928 * @brief Widget for user to select a color.
24930 * Signals that you can add callbacks for are:
24931 * "changed" - When the color value changes(event_info is NULL).
24933 * See @ref tutorial_colorselector.
24936 * @brief Add a new colorselector to the parent
24938 * @param parent The parent object
24939 * @return The new object or NULL if it cannot be created
24941 * @ingroup Colorselector
24943 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24945 * Set a color for the colorselector
24947 * @param obj Colorselector object
24948 * @param r r-value of color
24949 * @param g g-value of color
24950 * @param b b-value of color
24951 * @param a a-value of color
24953 * @ingroup Colorselector
24955 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24957 * Get a color from the colorselector
24959 * @param obj Colorselector object
24960 * @param r integer pointer for r-value of color
24961 * @param g integer pointer for g-value of color
24962 * @param b integer pointer for b-value of color
24963 * @param a integer pointer for a-value of color
24965 * @ingroup Colorselector
24967 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24973 * @defgroup Ctxpopup Ctxpopup
24975 * @image html img/widget/ctxpopup/preview-00.png
24976 * @image latex img/widget/ctxpopup/preview-00.eps
24978 * @brief Context popup widet.
24980 * A ctxpopup is a widget that, when shown, pops up a list of items.
24981 * It automatically chooses an area inside its parent object's view
24982 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24983 * optimally fit into it. In the default theme, it will also point an
24984 * arrow to it's top left position at the time one shows it. Ctxpopup
24985 * items have a label and/or an icon. It is intended for a small
24986 * number of items (hence the use of list, not genlist).
24988 * @note Ctxpopup is a especialization of @ref Hover.
24990 * Signals that you can add callbacks for are:
24991 * "dismissed" - the ctxpopup was dismissed
24993 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24996 typedef enum _Elm_Ctxpopup_Direction
24998 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25000 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25001 the clicked area */
25002 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25003 the clicked area */
25004 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25006 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25007 } Elm_Ctxpopup_Direction;
25010 * @brief Add a new Ctxpopup object to the parent.
25012 * @param parent Parent object
25013 * @return New object or @c NULL, if it cannot be created
25015 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25017 * @brief Set the Ctxpopup's parent
25019 * @param obj The ctxpopup object
25020 * @param area The parent to use
25022 * Set the parent object.
25024 * @note elm_ctxpopup_add() will automatically call this function
25025 * with its @c parent argument.
25027 * @see elm_ctxpopup_add()
25028 * @see elm_hover_parent_set()
25030 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25032 * @brief Get the Ctxpopup's parent
25034 * @param obj The ctxpopup object
25036 * @see elm_ctxpopup_hover_parent_set() for more information
25038 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25040 * @brief Clear all items in the given ctxpopup object.
25042 * @param obj Ctxpopup object
25044 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25046 * @brief Change the ctxpopup's orientation to horizontal or vertical.
25048 * @param obj Ctxpopup object
25049 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25051 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25053 * @brief Get the value of current ctxpopup object's orientation.
25055 * @param obj Ctxpopup object
25056 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25058 * @see elm_ctxpopup_horizontal_set()
25060 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25062 * @brief Add a new item to a ctxpopup object.
25064 * @param obj Ctxpopup object
25065 * @param icon Icon to be set on new item
25066 * @param label The Label of the new item
25067 * @param func Convenience function called when item selected
25068 * @param data Data passed to @p func
25069 * @return A handle to the item added or @c NULL, on errors
25071 * @warning Ctxpopup can't hold both an item list and a content at the same
25072 * time. When an item is added, any previous content will be removed.
25074 * @see elm_ctxpopup_content_set()
25076 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);
25078 * @brief Delete the given item in a ctxpopup object.
25080 * @param it Ctxpopup item to be deleted
25082 * @see elm_ctxpopup_item_append()
25084 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25086 * @brief Set the ctxpopup item's state as disabled or enabled.
25088 * @param it Ctxpopup item to be enabled/disabled
25089 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25091 * When disabled the item is greyed out to indicate it's state.
25093 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25095 * @brief Get the ctxpopup item's disabled/enabled state.
25097 * @param it Ctxpopup item to be enabled/disabled
25098 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25100 * @see elm_ctxpopup_item_disabled_set()
25102 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25104 * @brief Get the icon object for the given ctxpopup item.
25106 * @param it Ctxpopup item
25107 * @return icon object or @c NULL, if the item does not have icon or an error
25110 * @see elm_ctxpopup_item_append()
25111 * @see elm_ctxpopup_item_icon_set()
25113 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25115 * @brief Sets the side icon associated with the ctxpopup item
25117 * @param it Ctxpopup item
25118 * @param icon Icon object to be set
25120 * Once the icon object is set, a previously set one will be deleted.
25121 * @warning Setting the same icon for two items will cause the icon to
25122 * dissapear from the first item.
25124 * @see elm_ctxpopup_item_append()
25126 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25128 * @brief Get the label for the given ctxpopup item.
25130 * @param it Ctxpopup item
25131 * @return label string or @c NULL, if the item does not have label or an
25134 * @see elm_ctxpopup_item_append()
25135 * @see elm_ctxpopup_item_label_set()
25137 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25139 * @brief (Re)set the label on the given ctxpopup item.
25141 * @param it Ctxpopup item
25142 * @param label String to set as label
25144 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25146 * @brief Set an elm widget as the content of the ctxpopup.
25148 * @param obj Ctxpopup object
25149 * @param content Content to be swallowed
25151 * If the content object is already set, a previous one will bedeleted. If
25152 * you want to keep that old content object, use the
25153 * elm_ctxpopup_content_unset() function.
25155 * @deprecated use elm_object_content_set()
25157 * @warning Ctxpopup can't hold both a item list and a content at the same
25158 * time. When a content is set, any previous items will be removed.
25160 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25162 * @brief Unset the ctxpopup content
25164 * @param obj Ctxpopup object
25165 * @return The content that was being used
25167 * Unparent and return the content object which was set for this widget.
25169 * @deprecated use elm_object_content_unset()
25171 * @see elm_ctxpopup_content_set()
25173 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25175 * @brief Set the direction priority of a ctxpopup.
25177 * @param obj Ctxpopup object
25178 * @param first 1st priority of direction
25179 * @param second 2nd priority of direction
25180 * @param third 3th priority of direction
25181 * @param fourth 4th priority of direction
25183 * This functions gives a chance to user to set the priority of ctxpopup
25184 * showing direction. This doesn't guarantee the ctxpopup will appear in the
25185 * requested direction.
25187 * @see Elm_Ctxpopup_Direction
25189 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);
25191 * @brief Get the direction priority of a ctxpopup.
25193 * @param obj Ctxpopup object
25194 * @param first 1st priority of direction to be returned
25195 * @param second 2nd priority of direction to be returned
25196 * @param third 3th priority of direction to be returned
25197 * @param fourth 4th priority of direction to be returned
25199 * @see elm_ctxpopup_direction_priority_set() for more information.
25201 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);
25204 * @brief Get the current direction of a ctxpopup.
25206 * @param obj Ctxpopup object
25207 * @return current direction of a ctxpopup
25209 * @warning Once the ctxpopup showed up, the direction would be determined
25211 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25220 * @defgroup Transit Transit
25221 * @ingroup Elementary
25223 * Transit is designed to apply various animated transition effects to @c
25224 * Evas_Object, such like translation, rotation, etc. For using these
25225 * effects, create an @ref Elm_Transit and add the desired transition effects.
25227 * Once the effects are added into transit, they will be automatically
25228 * managed (their callback will be called until the duration is ended, and
25229 * they will be deleted on completion).
25233 * Elm_Transit *trans = elm_transit_add();
25234 * elm_transit_object_add(trans, obj);
25235 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25236 * elm_transit_duration_set(transit, 1);
25237 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25238 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25239 * elm_transit_repeat_times_set(transit, 3);
25242 * Some transition effects are used to change the properties of objects. They
25244 * @li @ref elm_transit_effect_translation_add
25245 * @li @ref elm_transit_effect_color_add
25246 * @li @ref elm_transit_effect_rotation_add
25247 * @li @ref elm_transit_effect_wipe_add
25248 * @li @ref elm_transit_effect_zoom_add
25249 * @li @ref elm_transit_effect_resizing_add
25251 * Other transition effects are used to make one object disappear and another
25252 * object appear on its old place. These effects are:
25254 * @li @ref elm_transit_effect_flip_add
25255 * @li @ref elm_transit_effect_resizable_flip_add
25256 * @li @ref elm_transit_effect_fade_add
25257 * @li @ref elm_transit_effect_blend_add
25259 * It's also possible to make a transition chain with @ref
25260 * elm_transit_chain_transit_add.
25262 * @warning We strongly recommend to use elm_transit just when edje can not do
25263 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25264 * animations can be manipulated inside the theme.
25266 * List of examples:
25267 * @li @ref transit_example_01_explained
25268 * @li @ref transit_example_02_explained
25269 * @li @ref transit_example_03_c
25270 * @li @ref transit_example_04_c
25276 * @enum Elm_Transit_Tween_Mode
25278 * The type of acceleration used in the transition.
25282 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25283 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25284 over time, then decrease again
25286 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25288 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25290 } Elm_Transit_Tween_Mode;
25293 * @enum Elm_Transit_Effect_Flip_Axis
25295 * The axis where flip effect should be applied.
25299 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25300 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25301 } Elm_Transit_Effect_Flip_Axis;
25303 * @enum Elm_Transit_Effect_Wipe_Dir
25305 * The direction where the wipe effect should occur.
25309 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25310 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25311 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25312 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25313 } Elm_Transit_Effect_Wipe_Dir;
25314 /** @enum Elm_Transit_Effect_Wipe_Type
25316 * Whether the wipe effect should show or hide the object.
25320 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25322 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25324 } Elm_Transit_Effect_Wipe_Type;
25327 * @typedef Elm_Transit
25329 * The Transit created with elm_transit_add(). This type has the information
25330 * about the objects which the transition will be applied, and the
25331 * transition effects that will be used. It also contains info about
25332 * duration, number of repetitions, auto-reverse, etc.
25334 typedef struct _Elm_Transit Elm_Transit;
25335 typedef void Elm_Transit_Effect;
25337 * @typedef Elm_Transit_Effect_Transition_Cb
25339 * Transition callback called for this effect on each transition iteration.
25341 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25343 * Elm_Transit_Effect_End_Cb
25345 * Transition callback called for this effect when the transition is over.
25347 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25350 * Elm_Transit_Del_Cb
25352 * A callback called when the transit is deleted.
25354 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25359 * @note Is not necessary to delete the transit object, it will be deleted at
25360 * the end of its operation.
25361 * @note The transit will start playing when the program enter in the main loop, is not
25362 * necessary to give a start to the transit.
25364 * @return The transit object.
25368 EAPI Elm_Transit *elm_transit_add(void);
25371 * Stops the animation and delete the @p transit object.
25373 * Call this function if you wants to stop the animation before the duration
25374 * time. Make sure the @p transit object is still alive with
25375 * elm_transit_del_cb_set() function.
25376 * All added effects will be deleted, calling its repective data_free_cb
25377 * functions. The function setted by elm_transit_del_cb_set() will be called.
25379 * @see elm_transit_del_cb_set()
25381 * @param transit The transit object to be deleted.
25384 * @warning Just call this function if you are sure the transit is alive.
25386 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25389 * Add a new effect to the transit.
25391 * @note The cb function and the data are the key to the effect. If you try to
25392 * add an already added effect, nothing is done.
25393 * @note After the first addition of an effect in @p transit, if its
25394 * effect list become empty again, the @p transit will be killed by
25395 * elm_transit_del(transit) function.
25399 * Elm_Transit *transit = elm_transit_add();
25400 * elm_transit_effect_add(transit,
25401 * elm_transit_effect_blend_op,
25402 * elm_transit_effect_blend_context_new(),
25403 * elm_transit_effect_blend_context_free);
25406 * @param transit The transit object.
25407 * @param transition_cb The operation function. It is called when the
25408 * animation begins, it is the function that actually performs the animation.
25409 * It is called with the @p data, @p transit and the time progression of the
25410 * animation (a double value between 0.0 and 1.0).
25411 * @param effect The context data of the effect.
25412 * @param end_cb The function to free the context data, it will be called
25413 * at the end of the effect, it must finalize the animation and free the
25417 * @warning The transit free the context data at the and of the transition with
25418 * the data_free_cb function, do not use the context data in another transit.
25420 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);
25423 * Delete an added effect.
25425 * This function will remove the effect from the @p transit, calling the
25426 * data_free_cb to free the @p data.
25428 * @see elm_transit_effect_add()
25430 * @note If the effect is not found, nothing is done.
25431 * @note If the effect list become empty, this function will call
25432 * elm_transit_del(transit), that is, it will kill the @p transit.
25434 * @param transit The transit object.
25435 * @param transition_cb The operation function.
25436 * @param effect The context data of the effect.
25440 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);
25443 * Add new object to apply the effects.
25445 * @note After the first addition of an object in @p transit, if its
25446 * object list become empty again, the @p transit will be killed by
25447 * elm_transit_del(transit) function.
25448 * @note If the @p obj belongs to another transit, the @p obj will be
25449 * removed from it and it will only belong to the @p transit. If the old
25450 * transit stays without objects, it will die.
25451 * @note When you add an object into the @p transit, its state from
25452 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25453 * transit ends, if you change this state whith evas_object_pass_events_set()
25454 * after add the object, this state will change again when @p transit stops to
25457 * @param transit The transit object.
25458 * @param obj Object to be animated.
25461 * @warning It is not allowed to add a new object after transit begins to go.
25463 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25466 * Removes an added object from the transit.
25468 * @note If the @p obj is not in the @p transit, nothing is done.
25469 * @note If the list become empty, this function will call
25470 * elm_transit_del(transit), that is, it will kill the @p transit.
25472 * @param transit The transit object.
25473 * @param obj Object to be removed from @p transit.
25476 * @warning It is not allowed to remove objects after transit begins to go.
25478 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25481 * Get the objects of the transit.
25483 * @param transit The transit object.
25484 * @return a Eina_List with the objects from the transit.
25488 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25491 * Enable/disable keeping up the objects states.
25492 * If it is not kept, the objects states will be reset when transition ends.
25494 * @note @p transit can not be NULL.
25495 * @note One state includes geometry, color, map data.
25497 * @param transit The transit object.
25498 * @param state_keep Keeping or Non Keeping.
25502 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25505 * Get a value whether the objects states will be reset or not.
25507 * @note @p transit can not be NULL
25509 * @see elm_transit_objects_final_state_keep_set()
25511 * @param transit The transit object.
25512 * @return EINA_TRUE means the states of the objects will be reset.
25513 * If @p transit is NULL, EINA_FALSE is returned
25517 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25520 * Set the event enabled when transit is operating.
25522 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25523 * events from mouse and keyboard during the animation.
25524 * @note When you add an object with elm_transit_object_add(), its state from
25525 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25526 * transit ends, if you change this state with evas_object_pass_events_set()
25527 * after adding the object, this state will change again when @p transit stops
25530 * @param transit The transit object.
25531 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25532 * ignored otherwise.
25536 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25539 * Get the value of event enabled status.
25541 * @see elm_transit_event_enabled_set()
25543 * @param transit The Transit object
25544 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25545 * EINA_FALSE is returned
25549 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25552 * Set the user-callback function when the transit is deleted.
25554 * @note Using this function twice will overwrite the first function setted.
25555 * @note the @p transit object will be deleted after call @p cb function.
25557 * @param transit The transit object.
25558 * @param cb Callback function pointer. This function will be called before
25559 * the deletion of the transit.
25560 * @param data Callback funtion user data. It is the @p op parameter.
25564 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25567 * Set reverse effect automatically.
25569 * If auto reverse is setted, after running the effects with the progress
25570 * parameter from 0 to 1, it will call the effecs again with the progress
25571 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25572 * where the duration was setted with the function elm_transit_add and
25573 * the repeat with the function elm_transit_repeat_times_set().
25575 * @param transit The transit object.
25576 * @param reverse EINA_TRUE means the auto_reverse is on.
25580 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25583 * Get if the auto reverse is on.
25585 * @see elm_transit_auto_reverse_set()
25587 * @param transit The transit object.
25588 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25589 * EINA_FALSE is returned
25593 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25596 * Set the transit repeat count. Effect will be repeated by repeat count.
25598 * This function sets the number of repetition the transit will run after
25599 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25600 * If the @p repeat is a negative number, it will repeat infinite times.
25602 * @note If this function is called during the transit execution, the transit
25603 * will run @p repeat times, ignoring the times it already performed.
25605 * @param transit The transit object
25606 * @param repeat Repeat count
25610 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25613 * Get the transit repeat count.
25615 * @see elm_transit_repeat_times_set()
25617 * @param transit The Transit object.
25618 * @return The repeat count. If @p transit is NULL
25623 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25626 * Set the transit animation acceleration type.
25628 * This function sets the tween mode of the transit that can be:
25629 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25630 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25631 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25632 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25634 * @param transit The transit object.
25635 * @param tween_mode The tween type.
25639 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25642 * Get the transit animation acceleration type.
25644 * @note @p transit can not be NULL
25646 * @param transit The transit object.
25647 * @return The tween type. If @p transit is NULL
25648 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25652 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25655 * Set the transit animation time
25657 * @note @p transit can not be NULL
25659 * @param transit The transit object.
25660 * @param duration The animation time.
25664 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25667 * Get the transit animation time
25669 * @note @p transit can not be NULL
25671 * @param transit The transit object.
25673 * @return The transit animation time.
25677 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25680 * Starts the transition.
25681 * Once this API is called, the transit begins to measure the time.
25683 * @note @p transit can not be NULL
25685 * @param transit The transit object.
25689 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25692 * Pause/Resume the transition.
25694 * If you call elm_transit_go again, the transit will be started from the
25695 * beginning, and will be unpaused.
25697 * @note @p transit can not be NULL
25699 * @param transit The transit object.
25700 * @param paused Whether the transition should be paused or not.
25704 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25707 * Get the value of paused status.
25709 * @see elm_transit_paused_set()
25711 * @note @p transit can not be NULL
25713 * @param transit The transit object.
25714 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25715 * EINA_FALSE is returned
25719 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25722 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25724 * The value returned is a fraction (current time / total time). It
25725 * represents the progression position relative to the total.
25727 * @note @p transit can not be NULL
25729 * @param transit The transit object.
25731 * @return The time progression value. If @p transit is NULL
25736 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25739 * Makes the chain relationship between two transits.
25741 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25742 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25744 * @param transit The transit object.
25745 * @param chain_transit The chain transit object. This transit will be operated
25746 * after transit is done.
25748 * This function adds @p chain_transit transition to a chain after the @p
25749 * transit, and will be started as soon as @p transit ends. See @ref
25750 * transit_example_02_explained for a full example.
25754 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25757 * Cut off the chain relationship between two transits.
25759 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25760 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25762 * @param transit The transit object.
25763 * @param chain_transit The chain transit object.
25765 * This function remove the @p chain_transit transition from the @p transit.
25769 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25772 * Get the current chain transit list.
25774 * @note @p transit can not be NULL.
25776 * @param transit The transit object.
25777 * @return chain transit list.
25781 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25784 * Add the Resizing Effect to Elm_Transit.
25786 * @note This API is one of the facades. It creates resizing effect context
25787 * and add it's required APIs to elm_transit_effect_add.
25789 * @see elm_transit_effect_add()
25791 * @param transit Transit object.
25792 * @param from_w Object width size when effect begins.
25793 * @param from_h Object height size when effect begins.
25794 * @param to_w Object width size when effect ends.
25795 * @param to_h Object height size when effect ends.
25796 * @return Resizing effect context data.
25800 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);
25803 * Add the Translation Effect to Elm_Transit.
25805 * @note This API is one of the facades. It creates translation effect context
25806 * and add it's required APIs to elm_transit_effect_add.
25808 * @see elm_transit_effect_add()
25810 * @param transit Transit object.
25811 * @param from_dx X Position variation when effect begins.
25812 * @param from_dy Y Position variation when effect begins.
25813 * @param to_dx X Position variation when effect ends.
25814 * @param to_dy Y Position variation when effect ends.
25815 * @return Translation effect context data.
25818 * @warning It is highly recommended just create a transit with this effect when
25819 * the window that the objects of the transit belongs has already been created.
25820 * This is because this effect needs the geometry information about the objects,
25821 * and if the window was not created yet, it can get a wrong information.
25823 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);
25826 * Add the Zoom Effect to Elm_Transit.
25828 * @note This API is one of the facades. It creates zoom effect context
25829 * and add it's required APIs to elm_transit_effect_add.
25831 * @see elm_transit_effect_add()
25833 * @param transit Transit object.
25834 * @param from_rate Scale rate when effect begins (1 is current rate).
25835 * @param to_rate Scale rate when effect ends.
25836 * @return Zoom effect context data.
25839 * @warning It is highly recommended just create a transit with this effect when
25840 * the window that the objects of the transit belongs has already been created.
25841 * This is because this effect needs the geometry information about the objects,
25842 * and if the window was not created yet, it can get a wrong information.
25844 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25847 * Add the Flip Effect to Elm_Transit.
25849 * @note This API is one of the facades. It creates flip effect context
25850 * and add it's required APIs to elm_transit_effect_add.
25851 * @note This effect is applied to each pair of objects in the order they are listed
25852 * in the transit list of objects. The first object in the pair will be the
25853 * "front" object and the second will be the "back" object.
25855 * @see elm_transit_effect_add()
25857 * @param transit Transit object.
25858 * @param axis Flipping Axis(X or Y).
25859 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25860 * @return Flip effect context data.
25863 * @warning It is highly recommended just create a transit with this effect when
25864 * the window that the objects of the transit belongs has already been created.
25865 * This is because this effect needs the geometry information about the objects,
25866 * and if the window was not created yet, it can get a wrong information.
25868 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25871 * Add the Resizable Flip Effect to Elm_Transit.
25873 * @note This API is one of the facades. It creates resizable flip effect context
25874 * and add it's required APIs to elm_transit_effect_add.
25875 * @note This effect is applied to each pair of objects in the order they are listed
25876 * in the transit list of objects. The first object in the pair will be the
25877 * "front" object and the second will be the "back" object.
25879 * @see elm_transit_effect_add()
25881 * @param transit Transit object.
25882 * @param axis Flipping Axis(X or Y).
25883 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25884 * @return Resizable flip effect context data.
25887 * @warning It is highly recommended just create a transit with this effect when
25888 * the window that the objects of the transit belongs has already been created.
25889 * This is because this effect needs the geometry information about the objects,
25890 * and if the window was not created yet, it can get a wrong information.
25892 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25895 * Add the Wipe Effect to Elm_Transit.
25897 * @note This API is one of the facades. It creates wipe effect context
25898 * and add it's required APIs to elm_transit_effect_add.
25900 * @see elm_transit_effect_add()
25902 * @param transit Transit object.
25903 * @param type Wipe type. Hide or show.
25904 * @param dir Wipe Direction.
25905 * @return Wipe effect context data.
25908 * @warning It is highly recommended just create a transit with this effect when
25909 * the window that the objects of the transit belongs has already been created.
25910 * This is because this effect needs the geometry information about the objects,
25911 * and if the window was not created yet, it can get a wrong information.
25913 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25916 * Add the Color Effect to Elm_Transit.
25918 * @note This API is one of the facades. It creates color effect context
25919 * and add it's required APIs to elm_transit_effect_add.
25921 * @see elm_transit_effect_add()
25923 * @param transit Transit object.
25924 * @param from_r RGB R when effect begins.
25925 * @param from_g RGB G when effect begins.
25926 * @param from_b RGB B when effect begins.
25927 * @param from_a RGB A when effect begins.
25928 * @param to_r RGB R when effect ends.
25929 * @param to_g RGB G when effect ends.
25930 * @param to_b RGB B when effect ends.
25931 * @param to_a RGB A when effect ends.
25932 * @return Color effect context data.
25936 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);
25939 * Add the Fade Effect to Elm_Transit.
25941 * @note This API is one of the facades. It creates fade effect context
25942 * and add it's required APIs to elm_transit_effect_add.
25943 * @note This effect is applied to each pair of objects in the order they are listed
25944 * in the transit list of objects. The first object in the pair will be the
25945 * "before" object and the second will be the "after" object.
25947 * @see elm_transit_effect_add()
25949 * @param transit Transit object.
25950 * @return Fade effect context data.
25953 * @warning It is highly recommended just create a transit with this effect when
25954 * the window that the objects of the transit belongs has already been created.
25955 * This is because this effect needs the color information about the objects,
25956 * and if the window was not created yet, it can get a wrong information.
25958 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25961 * Add the Blend Effect to Elm_Transit.
25963 * @note This API is one of the facades. It creates blend effect context
25964 * and add it's required APIs to elm_transit_effect_add.
25965 * @note This effect is applied to each pair of objects in the order they are listed
25966 * in the transit list of objects. The first object in the pair will be the
25967 * "before" object and the second will be the "after" object.
25969 * @see elm_transit_effect_add()
25971 * @param transit Transit object.
25972 * @return Blend effect context data.
25975 * @warning It is highly recommended just create a transit with this effect when
25976 * the window that the objects of the transit belongs has already been created.
25977 * This is because this effect needs the color information about the objects,
25978 * and if the window was not created yet, it can get a wrong information.
25980 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25983 * Add the Rotation Effect to Elm_Transit.
25985 * @note This API is one of the facades. It creates rotation effect context
25986 * and add it's required APIs to elm_transit_effect_add.
25988 * @see elm_transit_effect_add()
25990 * @param transit Transit object.
25991 * @param from_degree Degree when effect begins.
25992 * @param to_degree Degree when effect is ends.
25993 * @return Rotation effect context data.
25996 * @warning It is highly recommended just create a transit with this effect when
25997 * the window that the objects of the transit belongs has already been created.
25998 * This is because this effect needs the geometry information about the objects,
25999 * and if the window was not created yet, it can get a wrong information.
26001 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26004 * Add the ImageAnimation Effect to Elm_Transit.
26006 * @note This API is one of the facades. It creates image animation effect context
26007 * and add it's required APIs to elm_transit_effect_add.
26008 * The @p images parameter is a list images paths. This list and
26009 * its contents will be deleted at the end of the effect by
26010 * elm_transit_effect_image_animation_context_free() function.
26014 * char buf[PATH_MAX];
26015 * Eina_List *images = NULL;
26016 * Elm_Transit *transi = elm_transit_add();
26018 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26019 * images = eina_list_append(images, eina_stringshare_add(buf));
26021 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26022 * images = eina_list_append(images, eina_stringshare_add(buf));
26023 * elm_transit_effect_image_animation_add(transi, images);
26027 * @see elm_transit_effect_add()
26029 * @param transit Transit object.
26030 * @param images Eina_List of images file paths. This list and
26031 * its contents will be deleted at the end of the effect by
26032 * elm_transit_effect_image_animation_context_free() function.
26033 * @return Image Animation effect context data.
26037 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26042 typedef struct _Elm_Store Elm_Store;
26043 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
26044 typedef struct _Elm_Store_Item Elm_Store_Item;
26045 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
26046 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
26047 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26048 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
26049 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
26050 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
26051 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
26052 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
26054 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26055 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26056 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26057 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26061 ELM_STORE_ITEM_MAPPING_NONE = 0,
26062 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26063 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26064 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26065 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26066 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26067 // can add more here as needed by common apps
26068 ELM_STORE_ITEM_MAPPING_LAST
26069 } Elm_Store_Item_Mapping_Type;
26071 struct _Elm_Store_Item_Mapping_Icon
26073 // FIXME: allow edje file icons
26075 Elm_Icon_Lookup_Order lookup_order;
26076 Eina_Bool standard_name : 1;
26077 Eina_Bool no_scale : 1;
26078 Eina_Bool smooth : 1;
26079 Eina_Bool scale_up : 1;
26080 Eina_Bool scale_down : 1;
26083 struct _Elm_Store_Item_Mapping_Empty
26088 struct _Elm_Store_Item_Mapping_Photo
26093 struct _Elm_Store_Item_Mapping_Custom
26095 Elm_Store_Item_Mapping_Cb func;
26098 struct _Elm_Store_Item_Mapping
26100 Elm_Store_Item_Mapping_Type type;
26105 Elm_Store_Item_Mapping_Empty empty;
26106 Elm_Store_Item_Mapping_Icon icon;
26107 Elm_Store_Item_Mapping_Photo photo;
26108 Elm_Store_Item_Mapping_Custom custom;
26109 // add more types here
26113 struct _Elm_Store_Item_Info
26115 Elm_Genlist_Item_Class *item_class;
26116 const Elm_Store_Item_Mapping *mapping;
26121 struct _Elm_Store_Item_Info_Filesystem
26123 Elm_Store_Item_Info base;
26127 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26128 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26130 EAPI void elm_store_free(Elm_Store *st);
26132 EAPI Elm_Store *elm_store_filesystem_new(void);
26133 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26134 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26135 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26137 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26139 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26140 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26141 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26142 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26143 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26144 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26146 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26147 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26148 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26149 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26150 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26151 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26152 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26155 * @defgroup SegmentControl SegmentControl
26156 * @ingroup Elementary
26158 * @image html img/widget/segment_control/preview-00.png
26159 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26161 * @image html img/segment_control.png
26162 * @image latex img/segment_control.eps width=\textwidth
26164 * Segment control widget is a horizontal control made of multiple segment
26165 * items, each segment item functioning similar to discrete two state button.
26166 * A segment control groups the items together and provides compact
26167 * single button with multiple equal size segments.
26169 * Segment item size is determined by base widget
26170 * size and the number of items added.
26171 * Only one segment item can be at selected state. A segment item can display
26172 * combination of Text and any Evas_Object like Images or other widget.
26174 * Smart callbacks one can listen to:
26175 * - "changed" - When the user clicks on a segment item which is not
26176 * previously selected and get selected. The event_info parameter is the
26177 * segment item index.
26179 * Available styles for it:
26182 * Here is an example on its usage:
26183 * @li @ref segment_control_example
26187 * @addtogroup SegmentControl
26191 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26194 * Add a new segment control widget to the given parent Elementary
26195 * (container) object.
26197 * @param parent The parent object.
26198 * @return a new segment control widget handle or @c NULL, on errors.
26200 * This function inserts a new segment control widget on the canvas.
26202 * @ingroup SegmentControl
26204 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26207 * Append a new item to the segment control object.
26209 * @param obj The segment control object.
26210 * @param icon The icon object to use for the left side of the item. An
26211 * icon can be any Evas object, but usually it is an icon created
26212 * with elm_icon_add().
26213 * @param label The label of the item.
26214 * Note that, NULL is different from empty string "".
26215 * @return The created item or @c NULL upon failure.
26217 * A new item will be created and appended to the segment control, i.e., will
26218 * be set as @b last item.
26220 * If it should be inserted at another position,
26221 * elm_segment_control_item_insert_at() should be used instead.
26223 * Items created with this function can be deleted with function
26224 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26226 * @note @p label set to @c NULL is different from empty string "".
26228 * only has icon, it will be displayed bigger and centered. If it has
26229 * icon and label, even that an empty string, icon will be smaller and
26230 * positioned at left.
26234 * sc = elm_segment_control_add(win);
26235 * ic = elm_icon_add(win);
26236 * elm_icon_file_set(ic, "path/to/image", NULL);
26237 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26238 * elm_segment_control_item_add(sc, ic, "label");
26239 * evas_object_show(sc);
26242 * @see elm_segment_control_item_insert_at()
26243 * @see elm_segment_control_item_del()
26245 * @ingroup SegmentControl
26247 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26250 * Insert a new item to the segment control object at specified position.
26252 * @param obj The segment control object.
26253 * @param icon The icon object to use for the left side of the item. An
26254 * icon can be any Evas object, but usually it is an icon created
26255 * with elm_icon_add().
26256 * @param label The label of the item.
26257 * @param index Item position. Value should be between 0 and items count.
26258 * @return The created item or @c NULL upon failure.
26260 * Index values must be between @c 0, when item will be prepended to
26261 * segment control, and items count, that can be get with
26262 * elm_segment_control_item_count_get(), case when item will be appended
26263 * to segment control, just like elm_segment_control_item_add().
26265 * Items created with this function can be deleted with function
26266 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26268 * @note @p label set to @c NULL is different from empty string "".
26270 * only has icon, it will be displayed bigger and centered. If it has
26271 * icon and label, even that an empty string, icon will be smaller and
26272 * positioned at left.
26274 * @see elm_segment_control_item_add()
26275 * @see elm_segment_control_item_count_get()
26276 * @see elm_segment_control_item_del()
26278 * @ingroup SegmentControl
26280 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);
26283 * Remove a segment control item from its parent, deleting it.
26285 * @param it The item to be removed.
26287 * Items can be added with elm_segment_control_item_add() or
26288 * elm_segment_control_item_insert_at().
26290 * @ingroup SegmentControl
26292 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26295 * Remove a segment control item at given index from its parent,
26298 * @param obj The segment control object.
26299 * @param index The position of the segment control item to be deleted.
26301 * Items can be added with elm_segment_control_item_add() or
26302 * elm_segment_control_item_insert_at().
26304 * @ingroup SegmentControl
26306 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26309 * Get the Segment items count from segment control.
26311 * @param obj The segment control object.
26312 * @return Segment items count.
26314 * It will just return the number of items added to segment control @p obj.
26316 * @ingroup SegmentControl
26318 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26321 * Get the item placed at specified index.
26323 * @param obj The segment control object.
26324 * @param index The index of the segment item.
26325 * @return The segment control item or @c NULL on failure.
26327 * Index is the position of an item in segment control widget. Its
26328 * range is from @c 0 to <tt> count - 1 </tt>.
26329 * Count is the number of items, that can be get with
26330 * elm_segment_control_item_count_get().
26332 * @ingroup SegmentControl
26334 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26337 * Get the label of item.
26339 * @param obj The segment control object.
26340 * @param index The index of the segment item.
26341 * @return The label of the item at @p index.
26343 * The return value is a pointer to the label associated to the item when
26344 * it was created, with function elm_segment_control_item_add(), or later
26345 * with function elm_segment_control_item_label_set. If no label
26346 * was passed as argument, it will return @c NULL.
26348 * @see elm_segment_control_item_label_set() for more details.
26349 * @see elm_segment_control_item_add()
26351 * @ingroup SegmentControl
26353 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26356 * Set the label of item.
26358 * @param it The item of segment control.
26359 * @param text The label of item.
26361 * The label to be displayed by the item.
26362 * Label will be at right of the icon (if set).
26364 * If a label was passed as argument on item creation, with function
26365 * elm_control_segment_item_add(), it will be already
26366 * displayed by the item.
26368 * @see elm_segment_control_item_label_get()
26369 * @see elm_segment_control_item_add()
26371 * @ingroup SegmentControl
26373 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26376 * Get the icon associated to the item.
26378 * @param obj The segment control object.
26379 * @param index The index of the segment item.
26380 * @return The left side icon associated to the item at @p index.
26382 * The return value is a pointer to the icon associated to the item when
26383 * it was created, with function elm_segment_control_item_add(), or later
26384 * with function elm_segment_control_item_icon_set(). If no icon
26385 * was passed as argument, it will return @c NULL.
26387 * @see elm_segment_control_item_add()
26388 * @see elm_segment_control_item_icon_set()
26390 * @ingroup SegmentControl
26392 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26395 * Set the icon associated to the item.
26397 * @param it The segment control item.
26398 * @param icon The icon object to associate with @p it.
26400 * The icon object to use at left side of the item. An
26401 * icon can be any Evas object, but usually it is an icon created
26402 * with elm_icon_add().
26404 * Once the icon object is set, a previously set one will be deleted.
26405 * @warning Setting the same icon for two items will cause the icon to
26406 * dissapear from the first item.
26408 * If an icon was passed as argument on item creation, with function
26409 * elm_segment_control_item_add(), it will be already
26410 * associated to the item.
26412 * @see elm_segment_control_item_add()
26413 * @see elm_segment_control_item_icon_get()
26415 * @ingroup SegmentControl
26417 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26420 * Get the index of an item.
26422 * @param it The segment control item.
26423 * @return The position of item in segment control widget.
26425 * Index is the position of an item in segment control widget. Its
26426 * range is from @c 0 to <tt> count - 1 </tt>.
26427 * Count is the number of items, that can be get with
26428 * elm_segment_control_item_count_get().
26430 * @ingroup SegmentControl
26432 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26435 * Get the base object of the item.
26437 * @param it The segment control item.
26438 * @return The base object associated with @p it.
26440 * Base object is the @c Evas_Object that represents that item.
26442 * @ingroup SegmentControl
26444 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26447 * Get the selected item.
26449 * @param obj The segment control object.
26450 * @return The selected item or @c NULL if none of segment items is
26453 * The selected item can be unselected with function
26454 * elm_segment_control_item_selected_set().
26456 * The selected item always will be highlighted on segment control.
26458 * @ingroup SegmentControl
26460 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26463 * Set the selected state of an item.
26465 * @param it The segment control item
26466 * @param select The selected state
26468 * This sets the selected state of the given item @p it.
26469 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26471 * If a new item is selected the previosly selected will be unselected.
26472 * Previoulsy selected item can be get with function
26473 * elm_segment_control_item_selected_get().
26475 * The selected item always will be highlighted on segment control.
26477 * @see elm_segment_control_item_selected_get()
26479 * @ingroup SegmentControl
26481 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26488 * @defgroup Grid Grid
26490 * The grid is a grid layout widget that lays out a series of children as a
26491 * fixed "grid" of widgets using a given percentage of the grid width and
26492 * height each using the child object.
26494 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26495 * widgets size itself. The default is 100 x 100, so that means the
26496 * position and sizes of children will effectively be percentages (0 to 100)
26497 * of the width or height of the grid widget
26503 * Add a new grid to the parent
26505 * @param parent The parent object
26506 * @return The new object or NULL if it cannot be created
26510 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26513 * Set the virtual size of the grid
26515 * @param obj The grid object
26516 * @param w The virtual width of the grid
26517 * @param h The virtual height of the grid
26521 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26524 * Get the virtual size of the grid
26526 * @param obj The grid object
26527 * @param w Pointer to integer to store the virtual width of the grid
26528 * @param h Pointer to integer to store the virtual height of the grid
26532 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26535 * Pack child at given position and size
26537 * @param obj The grid object
26538 * @param subobj The child to pack
26539 * @param x The virtual x coord at which to pack it
26540 * @param y The virtual y coord at which to pack it
26541 * @param w The virtual width at which to pack it
26542 * @param h The virtual height at which to pack it
26546 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26549 * Unpack a child from a grid object
26551 * @param obj The grid object
26552 * @param subobj The child to unpack
26556 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26559 * Faster way to remove all child objects from a grid object.
26561 * @param obj The grid object
26562 * @param clear If true, it will delete just removed children
26566 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26569 * Set packing of an existing child at to position and size
26571 * @param subobj The child to set packing of
26572 * @param x The virtual x coord at which to pack it
26573 * @param y The virtual y coord at which to pack it
26574 * @param w The virtual width at which to pack it
26575 * @param h The virtual height at which to pack it
26579 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26582 * get packing of a child
26584 * @param subobj The child to query
26585 * @param x Pointer to integer to store the virtual x coord
26586 * @param y Pointer to integer to store the virtual y coord
26587 * @param w Pointer to integer to store the virtual width
26588 * @param h Pointer to integer to store the virtual height
26592 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26598 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26599 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26600 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26601 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26602 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
26603 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
26606 * @defgroup Video Video
26608 * This object display an player that let you control an Elm_Video
26609 * object. It take care of updating it's content according to what is
26610 * going on inside the Emotion object. It does activate the remember
26611 * function on the linked Elm_Video object.
26613 * Signals that you cann add callback for are :
26615 * "forward,clicked" - the user clicked the forward button.
26616 * "info,clicked" - the user clicked the info button.
26617 * "next,clicked" - the user clicked the next button.
26618 * "pause,clicked" - the user clicked the pause button.
26619 * "play,clicked" - the user clicked the play button.
26620 * "prev,clicked" - the user clicked the prev button.
26621 * "rewind,clicked" - the user clicked the rewind button.
26622 * "stop,clicked" - the user clicked the stop button.
26624 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26625 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26626 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26627 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26628 EAPI void elm_video_play(Evas_Object *video);
26629 EAPI void elm_video_pause(Evas_Object *video);
26630 EAPI void elm_video_stop(Evas_Object *video);
26631 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26632 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26633 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26634 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26635 EAPI double elm_video_audio_level_get(Evas_Object *video);
26636 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26637 EAPI double elm_video_play_position_get(Evas_Object *video);
26638 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26639 EAPI double elm_video_play_length_get(Evas_Object *video);
26640 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26641 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26642 EAPI const char *elm_video_title_get(Evas_Object *video);
26644 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26645 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26648 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26649 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);
26650 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26651 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26652 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26653 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26654 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26655 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26656 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26657 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26658 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);