3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to build it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
310 * @brief Elementary's API
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
390 # include <Ethumb_Client.h>
402 # ifdef ELEMENTARY_BUILD
404 # define EAPI __declspec(dllexport)
407 # endif /* ! DLL_EXPORT */
409 # define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
414 # define EAPI __attribute__ ((visibility("default")))
421 #endif /* ! _WIN32 */
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when any Elementary's policy value is changed.
488 EAPI extern int ELM_EVENT_POLICY_CHANGED;
491 * @typedef Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498 * @struct _Elm_Event_Policy_Changed
500 * Data on the event when an Elementary policy has changed
502 struct _Elm_Event_Policy_Changed
504 unsigned int policy; /**< the policy identifier */
505 int new_value; /**< value the policy had before the change */
506 int old_value; /**< new value the policy got */
510 * Policy identifiers.
512 typedef enum _Elm_Policy
514 ELM_POLICY_QUIT, /**< under which circumstances the application
515 * should quit automatically. @see
519 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
522 typedef enum _Elm_Policy_Quit
524 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
526 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
528 * window is closed */
529 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
531 typedef enum _Elm_Focus_Direction
535 } Elm_Focus_Direction;
537 typedef enum _Elm_Text_Format
539 ELM_TEXT_FORMAT_PLAIN_UTF8,
540 ELM_TEXT_FORMAT_MARKUP_UTF8
544 * Line wrapping types.
546 typedef enum _Elm_Wrap_Type
548 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
558 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
559 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
560 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
561 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
562 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
563 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
565 ELM_INPUT_PANEL_LAYOUT_INVALID
566 } Elm_Input_Panel_Layout;
569 * @typedef Elm_Object_Item
570 * An Elementary Object item handle.
573 typedef struct _Elm_Object_Item Elm_Object_Item;
577 * Called back when a widget's tooltip is activated and needs content.
578 * @param data user-data given to elm_object_tooltip_content_cb_set()
579 * @param obj owner widget.
580 * @param tooltip The tooltip object (affix content to this!)
582 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
585 * Called back when a widget's item tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
588 * @param tooltip The tooltip object (affix content to this!)
589 * @param item context dependent item. As an example, if tooltip was
590 * set on Elm_List_Item, then it is of this type.
592 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
594 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. */
596 #ifndef ELM_LIB_QUICKLAUNCH
597 #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 */
599 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
602 /**************************************************************************/
606 * Initialize Elementary
608 * @param[in] argc System's argument count value
609 * @param[in] argv System's pointer to array of argument strings
610 * @return The init counter value.
612 * This function initializes Elementary and increments a counter of
613 * the number of calls to it. It returns the new counter's value.
615 * @warning This call is exported only for use by the @c ELM_MAIN()
616 * macro. There is no need to use this if you use this macro (which
617 * is highly advisable). An elm_main() should contain the entry
618 * point code for your application, having the same prototype as
619 * elm_init(), and @b not being static (putting the @c EAPI symbol
620 * in front of its type declaration is advisable). The @c
621 * ELM_MAIN() call should be placed just after it.
624 * @dontinclude bg_example_01.c
628 * See the full @ref bg_example_01_c "example".
630 * @see elm_shutdown().
633 EAPI int elm_init(int argc, char **argv);
636 * Shut down Elementary
638 * @return The init counter value.
640 * This should be called at the end of your application, just
641 * before it ceases to do any more processing. This will clean up
642 * any permanent resources your application may have allocated via
643 * Elementary that would otherwise persist.
645 * @see elm_init() for an example
649 EAPI int elm_shutdown(void);
652 * Run Elementary's main loop
654 * This call should be issued just after all initialization is
655 * completed. This function will not return until elm_exit() is
656 * called. It will keep looping, running the main
657 * (event/processing) loop for Elementary.
659 * @see elm_init() for an example
663 EAPI void elm_run(void);
666 * Exit Elementary's main loop
668 * If this call is issued, it will flag the main loop to cease
669 * processing and return back to its parent function (usually your
670 * elm_main() function).
672 * @see elm_init() for an example. There, just after a request to
673 * close the window comes, the main loop will be left.
675 * @note By using the #ELM_POLICY_QUIT on your Elementary
676 * applications, you'll this function called automatically for you.
680 EAPI void elm_exit(void);
683 * Provide information in order to make Elementary determine the @b
684 * run time location of the software in question, so other data files
685 * such as images, sound files, executable utilities, libraries,
686 * modules and locale files can be found.
688 * @param mainfunc This is your application's main function name,
689 * whose binary's location is to be found. Providing @c NULL
690 * will make Elementary not to use it
691 * @param dom This will be used as the application's "domain", in the
692 * form of a prefix to any environment variables that may
693 * override prefix detection and the directory name, inside the
694 * standard share or data directories, where the software's
695 * data files will be looked for.
696 * @param checkfile This is an (optional) magic file's path to check
697 * for existence (and it must be located in the data directory,
698 * under the share directory provided above). Its presence will
699 * help determine the prefix found was correct. Pass @c NULL if
700 * the check is not to be done.
702 * This function allows one to re-locate the application somewhere
703 * else after compilation, if the developer wishes for easier
704 * distribution of pre-compiled binaries.
706 * The prefix system is designed to locate where the given software is
707 * installed (under a common path prefix) at run time and then report
708 * specific locations of this prefix and common directories inside
709 * this prefix like the binary, library, data and locale directories,
710 * through the @c elm_app_*_get() family of functions.
712 * Call elm_app_info_set() early on before you change working
713 * directory or anything about @c argv[0], so it gets accurate
716 * It will then try and trace back which file @p mainfunc comes from,
717 * if provided, to determine the application's prefix directory.
719 * The @p dom parameter provides a string prefix to prepend before
720 * environment variables, allowing a fallback to @b specific
721 * environment variables to locate the software. You would most
722 * probably provide a lowercase string there, because it will also
723 * serve as directory domain, explained next. For environment
724 * variables purposes, this string is made uppercase. For example if
725 * @c "myapp" is provided as the prefix, then the program would expect
726 * @c "MYAPP_PREFIX" as a master environment variable to specify the
727 * exact install prefix for the software, or more specific environment
728 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
729 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
730 * the user or scripts before launching. If not provided (@c NULL),
731 * environment variables will not be used to override compiled-in
732 * defaults or auto detections.
734 * The @p dom string also provides a subdirectory inside the system
735 * shared data directory for data files. For example, if the system
736 * directory is @c /usr/local/share, then this directory name is
737 * appended, creating @c /usr/local/share/myapp, if it @p was @c
738 * "myapp". It is expected the application installs data files in
741 * The @p checkfile is a file name or path of something inside the
742 * share or data directory to be used to test that the prefix
743 * detection worked. For example, your app will install a wallpaper
744 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
745 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
748 * @see elm_app_compile_bin_dir_set()
749 * @see elm_app_compile_lib_dir_set()
750 * @see elm_app_compile_data_dir_set()
751 * @see elm_app_compile_locale_set()
752 * @see elm_app_prefix_dir_get()
753 * @see elm_app_bin_dir_get()
754 * @see elm_app_lib_dir_get()
755 * @see elm_app_data_dir_get()
756 * @see elm_app_locale_dir_get()
758 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
761 * Provide information on the @b fallback application's binaries
762 * directory, on scenarios where they get overriden by
763 * elm_app_info_set().
765 * @param dir The path to the default binaries directory (compile time
768 * @note Elementary will as well use this path to determine actual
769 * names of binaries' directory paths, maybe changing it to be @c
770 * something/local/bin instead of @c something/bin, only, for
773 * @warning You should call this function @b before
774 * elm_app_info_set().
776 EAPI void elm_app_compile_bin_dir_set(const char *dir);
779 * Provide information on the @b fallback application's libraries
780 * directory, on scenarios where they get overriden by
781 * elm_app_info_set().
783 * @param dir The path to the default libraries directory (compile
786 * @note Elementary will as well use this path to determine actual
787 * names of libraries' directory paths, maybe changing it to be @c
788 * something/lib32 or @c something/lib64 instead of @c something/lib,
791 * @warning You should call this function @b before
792 * elm_app_info_set().
794 EAPI void elm_app_compile_lib_dir_set(const char *dir);
797 * Provide information on the @b fallback application's data
798 * directory, on scenarios where they get overriden by
799 * elm_app_info_set().
801 * @param dir The path to the default data directory (compile time
804 * @note Elementary will as well use this path to determine actual
805 * names of data directory paths, maybe changing it to be @c
806 * something/local/share instead of @c something/share, only, for
809 * @warning You should call this function @b before
810 * elm_app_info_set().
812 EAPI void elm_app_compile_data_dir_set(const char *dir);
815 * Provide information on the @b fallback application's locale
816 * directory, on scenarios where they get overriden by
817 * elm_app_info_set().
819 * @param dir The path to the default locale directory (compile time
822 * @warning You should call this function @b before
823 * elm_app_info_set().
825 EAPI void elm_app_compile_locale_set(const char *dir);
828 * Retrieve the application's run time prefix directory, as set by
829 * elm_app_info_set() and the way (environment) the application was
832 * @return The directory prefix the application is actually using
834 EAPI const char *elm_app_prefix_dir_get(void);
837 * Retrieve the application's run time binaries prefix directory, as
838 * set by elm_app_info_set() and the way (environment) the application
841 * @return The binaries directory prefix the application is actually
844 EAPI const char *elm_app_bin_dir_get(void);
847 * Retrieve the application's run time libraries prefix directory, as
848 * set by elm_app_info_set() and the way (environment) the application
851 * @return The libraries directory prefix the application is actually
854 EAPI const char *elm_app_lib_dir_get(void);
857 * Retrieve the application's run time data prefix directory, as
858 * set by elm_app_info_set() and the way (environment) the application
861 * @return The data directory prefix the application is actually
864 EAPI const char *elm_app_data_dir_get(void);
867 * Retrieve the application's run time locale prefix directory, as
868 * set by elm_app_info_set() and the way (environment) the application
871 * @return The locale directory prefix the application is actually
874 EAPI const char *elm_app_locale_dir_get(void);
876 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
877 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
878 EAPI int elm_quicklaunch_init(int argc, char **argv);
879 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
880 EAPI int elm_quicklaunch_sub_shutdown(void);
881 EAPI int elm_quicklaunch_shutdown(void);
882 EAPI void elm_quicklaunch_seed(void);
883 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
884 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
885 EAPI void elm_quicklaunch_cleanup(void);
886 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
887 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
889 EAPI Eina_Bool elm_need_efreet(void);
890 EAPI Eina_Bool elm_need_e_dbus(void);
893 * This must be called before any other function that handle with
894 * elm_thumb objects or ethumb_client instances.
898 EAPI Eina_Bool elm_need_ethumb(void);
901 * Set a new policy's value (for a given policy group/identifier).
903 * @param policy policy identifier, as in @ref Elm_Policy.
904 * @param value policy value, which depends on the identifier
906 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
908 * Elementary policies define applications' behavior,
909 * somehow. These behaviors are divided in policy groups (see
910 * #Elm_Policy enumeration). This call will emit the Ecore event
911 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
912 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
915 * @note Currently, we have only one policy identifier/group
916 * (#ELM_POLICY_QUIT), which has two possible values.
920 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
923 * Gets the policy value set for given policy identifier.
925 * @param policy policy identifier, as in #Elm_Policy.
926 * @return The currently set policy value, for that
927 * identifier. Will be @c 0 if @p policy passed is invalid.
931 EAPI int elm_policy_get(unsigned int policy);
934 * Set a label of an object
936 * @param obj The Elementary object
937 * @param part The text part name to set (NULL for the default label)
938 * @param label The new text of the label
940 * @note Elementary objects may have many labels (e.g. Action Slider)
944 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
946 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
949 * Get a label of an object
951 * @param obj The Elementary object
952 * @param part The text part name to get (NULL for the default label)
953 * @return text of the label or NULL for any error
955 * @note Elementary objects may have many labels (e.g. Action Slider)
959 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
961 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
964 * Set a content of an object
966 * @param obj The Elementary object
967 * @param part The content part name to set (NULL for the default content)
968 * @param content The new content of the object
970 * @note Elementary objects may have many contents
974 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
976 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
979 * Get a content of an object
981 * @param obj The Elementary object
982 * @param item The content part name to get (NULL for the default content)
983 * @return content of the object or NULL for any error
985 * @note Elementary objects may have many contents
989 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
991 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
994 * Unset a content of an object
996 * @param obj The Elementary object
997 * @param item The content part name to unset (NULL for the default content)
999 * @note Elementary objects may have many contents
1003 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1005 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1008 * Set a content of an object item
1010 * @param it The Elementary object item
1011 * @param part The content part name to unset (NULL for the default content)
1012 * @param content The new content of the object item
1014 * @note Elementary object items may have many contents
1018 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1020 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1023 * Get a content of an object item
1025 * @param it The Elementary object item
1026 * @param part The content part name to unset (NULL for the default content)
1027 * @return content of the object item or NULL for any error
1029 * @note Elementary object items may have many contents
1033 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1035 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1038 * Unset a content of an object item
1040 * @param it The Elementary object item
1041 * @param part The content part name to unset (NULL for the default content)
1043 * @note Elementary object items may have many contents
1047 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1049 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1052 * Set a label of an objec itemt
1054 * @param it The Elementary object item
1055 * @param part The text part name to set (NULL for the default label)
1056 * @param label The new text of the label
1058 * @note Elementary object items may have many labels
1062 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1064 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1067 * Get a label of an object
1069 * @param it The Elementary object item
1070 * @param part The text part name to get (NULL for the default label)
1071 * @return text of the label or NULL for any error
1073 * @note Elementary object items may have many labels
1077 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1080 * Set the text to read out when in accessibility mode
1082 * @param obj The object which is to be described
1083 * @param txt The text that describes the widget to people with poor or no vision
1087 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1090 * Set the text to read out when in accessibility mode
1092 * @param it The object item which is to be described
1093 * @param txt The text that describes the widget to people with poor or no vision
1097 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1100 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1107 * @defgroup Caches Caches
1109 * These are functions which let one fine-tune some cache values for
1110 * Elementary applications, thus allowing for performance adjustments.
1116 * @brief Flush all caches.
1118 * Frees all data that was in cache and is not currently being used to reduce
1119 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1120 * to calling all of the following functions:
1121 * @li edje_file_cache_flush()
1122 * @li edje_collection_cache_flush()
1123 * @li eet_clearcache()
1124 * @li evas_image_cache_flush()
1125 * @li evas_font_cache_flush()
1126 * @li evas_render_dump()
1127 * @note Evas caches are flushed for every canvas associated with a window.
1131 EAPI void elm_all_flush(void);
1134 * Get the configured cache flush interval time
1136 * This gets the globally configured cache flush interval time, in
1139 * @return The cache flush interval time
1142 * @see elm_all_flush()
1144 EAPI int elm_cache_flush_interval_get(void);
1147 * Set the configured cache flush interval time
1149 * This sets the globally configured cache flush interval time, in ticks
1151 * @param size The cache flush interval time
1154 * @see elm_all_flush()
1156 EAPI void elm_cache_flush_interval_set(int size);
1159 * Set the configured cache flush interval time for all applications on the
1162 * This sets the globally configured cache flush interval time -- in ticks
1163 * -- for all applications on the display.
1165 * @param size The cache flush interval time
1168 EAPI void elm_cache_flush_interval_all_set(int size);
1171 * Get the configured cache flush enabled state
1173 * This gets the globally configured cache flush state - if it is enabled
1174 * or not. When cache flushing is enabled, elementary will regularly
1175 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1176 * memory and allow usage to re-seed caches and data in memory where it
1177 * can do so. An idle application will thus minimise its memory usage as
1178 * data will be freed from memory and not be re-loaded as it is idle and
1179 * not rendering or doing anything graphically right now.
1181 * @return The cache flush state
1184 * @see elm_all_flush()
1186 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1189 * Set the configured cache flush enabled state
1191 * This sets the globally configured cache flush enabled state
1193 * @param size The cache flush enabled state
1196 * @see elm_all_flush()
1198 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1201 * Set the configured cache flush enabled state for all applications on the
1204 * This sets the globally configured cache flush enabled state for all
1205 * applications on the display.
1207 * @param size The cache flush enabled state
1210 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1213 * Get the configured font cache size
1215 * This gets the globally configured font cache size, in bytes
1217 * @return The font cache size
1220 EAPI int elm_font_cache_get(void);
1223 * Set the configured font cache size
1225 * This sets the globally configured font cache size, in bytes
1227 * @param size The font cache size
1230 EAPI void elm_font_cache_set(int size);
1233 * Set the configured font cache size for all applications on the
1236 * This sets the globally configured font cache size -- in bytes
1237 * -- for all applications on the display.
1239 * @param size The font cache size
1242 EAPI void elm_font_cache_all_set(int size);
1245 * Get the configured image cache size
1247 * This gets the globally configured image cache size, in bytes
1249 * @return The image cache size
1252 EAPI int elm_image_cache_get(void);
1255 * Set the configured image cache size
1257 * This sets the globally configured image cache size, in bytes
1259 * @param size The image cache size
1262 EAPI void elm_image_cache_set(int size);
1265 * Set the configured image cache size for all applications on the
1268 * This sets the globally configured image cache size -- in bytes
1269 * -- for all applications on the display.
1271 * @param size The image cache size
1274 EAPI void elm_image_cache_all_set(int size);
1277 * Get the configured edje file cache size.
1279 * This gets the globally configured edje file cache size, in number
1282 * @return The edje file cache size
1285 EAPI int elm_edje_file_cache_get(void);
1288 * Set the configured edje file cache size
1290 * This sets the globally configured edje file cache size, in number
1293 * @param size The edje file cache size
1296 EAPI void elm_edje_file_cache_set(int size);
1299 * Set the configured edje file cache size for all applications on the
1302 * This sets the globally configured edje file cache size -- in number
1303 * of files -- for all applications on the display.
1305 * @param size The edje file cache size
1308 EAPI void elm_edje_file_cache_all_set(int size);
1311 * Get the configured edje collections (groups) cache size.
1313 * This gets the globally configured edje collections cache size, in
1314 * number of collections.
1316 * @return The edje collections cache size
1319 EAPI int elm_edje_collection_cache_get(void);
1322 * Set the configured edje collections (groups) cache size
1324 * This sets the globally configured edje collections cache size, in
1325 * number of collections.
1327 * @param size The edje collections cache size
1330 EAPI void elm_edje_collection_cache_set(int size);
1333 * Set the configured edje collections (groups) cache size for all
1334 * applications on the display
1336 * This sets the globally configured edje collections cache size -- in
1337 * number of collections -- for all applications on the display.
1339 * @param size The edje collections cache size
1342 EAPI void elm_edje_collection_cache_all_set(int size);
1349 * @defgroup Scaling Widget Scaling
1351 * Different widgets can be scaled independently. These functions
1352 * allow you to manipulate this scaling on a per-widget basis. The
1353 * object and all its children get their scaling factors multiplied
1354 * by the scale factor set. This is multiplicative, in that if a
1355 * child also has a scale size set it is in turn multiplied by its
1356 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1357 * double size, @c 0.5 is half, etc.
1359 * @ref general_functions_example_page "This" example contemplates
1360 * some of these functions.
1364 * Get the global scaling factor
1366 * This gets the globally configured scaling factor that is applied to all
1369 * @return The scaling factor
1372 EAPI double elm_scale_get(void);
1375 * Set the global scaling factor
1377 * This sets the globally configured scaling factor that is applied to all
1380 * @param scale The scaling factor to set
1383 EAPI void elm_scale_set(double scale);
1386 * Set the global scaling factor for all applications on the display
1388 * This sets the globally configured scaling factor that is applied to all
1389 * objects for all applications.
1390 * @param scale The scaling factor to set
1393 EAPI void elm_scale_all_set(double scale);
1396 * Set the scaling factor for a given Elementary object
1398 * @param obj The Elementary to operate on
1399 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1404 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1407 * Get the scaling factor for a given Elementary object
1409 * @param obj The object
1410 * @return The scaling factor set by elm_object_scale_set()
1414 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1417 * @defgroup Password_last_show Password last input show
1419 * Last show feature of password mode enables user to view
1420 * the last input entered for few seconds before masking it.
1421 * These functions allow to set this feature in password mode
1422 * of entry widget and also allow to manipulate the duration
1423 * for which the input has to be visible.
1429 * Get show last setting of password mode.
1431 * This gets the show last input setting of password mode which might be
1432 * enabled or disabled.
1434 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1436 * @ingroup Password_last_show
1438 EAPI Eina_Bool elm_password_show_last_get(void);
1441 * Set show last setting in password mode.
1443 * This enables or disables show last setting of password mode.
1445 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1446 * @see elm_password_show_last_timeout_set()
1447 * @ingroup Password_last_show
1449 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1452 * Get's the timeout value in last show password mode.
1454 * This gets the time out value for which the last input entered in password
1455 * mode will be visible.
1457 * @return The timeout value of last show password mode.
1458 * @ingroup Password_last_show
1460 EAPI double elm_password_show_last_timeout_get(void);
1463 * Set's the timeout value in last show password mode.
1465 * This sets the time out value for which the last input entered in password
1466 * mode will be visible.
1468 * @param password_show_last_timeout The timeout value.
1469 * @see elm_password_show_last_set()
1470 * @ingroup Password_last_show
1472 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1475 * @defgroup UI-Mirroring Selective Widget mirroring
1477 * These functions allow you to set ui-mirroring on specific
1478 * widgets or the whole interface. Widgets can be in one of two
1479 * modes, automatic and manual. Automatic means they'll be changed
1480 * according to the system mirroring mode and manual means only
1481 * explicit changes will matter. You are not supposed to change
1482 * mirroring state of a widget set to automatic, will mostly work,
1483 * but the behavior is not really defined.
1488 EAPI Eina_Bool elm_mirrored_get(void);
1489 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1492 * Get the system mirrored mode. This determines the default mirrored mode
1495 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1497 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1500 * Set the system mirrored mode. This determines the default mirrored mode
1503 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1505 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1508 * Returns the widget's mirrored mode setting.
1510 * @param obj The widget.
1511 * @return mirrored mode setting of the object.
1514 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1517 * Sets the widget's mirrored mode setting.
1518 * When widget in automatic mode, it follows the system mirrored mode set by
1519 * elm_mirrored_set().
1520 * @param obj The widget.
1521 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1523 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1530 * Set the style to use by a widget
1532 * Sets the style name that will define the appearance of a widget. Styles
1533 * vary from widget to widget and may also be defined by other themes
1534 * by means of extensions and overlays.
1536 * @param obj The Elementary widget to style
1537 * @param style The style name to use
1539 * @see elm_theme_extension_add()
1540 * @see elm_theme_extension_del()
1541 * @see elm_theme_overlay_add()
1542 * @see elm_theme_overlay_del()
1546 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1548 * Get the style used by the widget
1550 * This gets the style being used for that widget. Note that the string
1551 * pointer is only valid as longas the object is valid and the style doesn't
1554 * @param obj The Elementary widget to query for its style
1555 * @return The style name used
1557 * @see elm_object_style_set()
1561 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1564 * @defgroup Styles Styles
1566 * Widgets can have different styles of look. These generic API's
1567 * set styles of widgets, if they support them (and if the theme(s)
1570 * @ref general_functions_example_page "This" example contemplates
1571 * some of these functions.
1575 * Set the disabled state of an Elementary object.
1577 * @param obj The Elementary object to operate on
1578 * @param disabled The state to put in in: @c EINA_TRUE for
1579 * disabled, @c EINA_FALSE for enabled
1581 * Elementary objects can be @b disabled, in which state they won't
1582 * receive input and, in general, will be themed differently from
1583 * their normal state, usually greyed out. Useful for contexts
1584 * where you don't want your users to interact with some of the
1585 * parts of you interface.
1587 * This sets the state for the widget, either disabling it or
1592 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1595 * Get the disabled state of an Elementary object.
1597 * @param obj The Elementary object to operate on
1598 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1599 * if it's enabled (or on errors)
1601 * This gets the state of the widget, which might be enabled or disabled.
1605 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1608 * @defgroup WidgetNavigation Widget Tree Navigation.
1610 * How to check if an Evas Object is an Elementary widget? How to
1611 * get the first elementary widget that is parent of the given
1612 * object? These are all covered in widget tree navigation.
1614 * @ref general_functions_example_page "This" example contemplates
1615 * some of these functions.
1619 * Check if the given Evas Object is an Elementary widget.
1621 * @param obj the object to query.
1622 * @return @c EINA_TRUE if it is an elementary widget variant,
1623 * @c EINA_FALSE otherwise
1624 * @ingroup WidgetNavigation
1626 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1629 * Get the first parent of the given object that is an Elementary
1632 * @param obj the Elementary object to query parent from.
1633 * @return the parent object that is an Elementary widget, or @c
1634 * NULL, if it was not found.
1636 * Use this to query for an object's parent widget.
1638 * @note Most of Elementary users wouldn't be mixing non-Elementary
1639 * smart objects in the objects tree of an application, as this is
1640 * an advanced usage of Elementary with Evas. So, except for the
1641 * application's window, which is the root of that tree, all other
1642 * objects would have valid Elementary widget parents.
1644 * @ingroup WidgetNavigation
1646 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1649 * Get the top level parent of an Elementary widget.
1651 * @param obj The object to query.
1652 * @return The top level Elementary widget, or @c NULL if parent cannot be
1654 * @ingroup WidgetNavigation
1656 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1659 * Get the string that represents this Elementary widget.
1661 * @note Elementary is weird and exposes itself as a single
1662 * Evas_Object_Smart_Class of type "elm_widget", so
1663 * evas_object_type_get() always return that, making debug and
1664 * language bindings hard. This function tries to mitigate this
1665 * problem, but the solution is to change Elementary to use
1666 * proper inheritance.
1668 * @param obj the object to query.
1669 * @return Elementary widget name, or @c NULL if not a valid widget.
1670 * @ingroup WidgetNavigation
1672 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1675 * @defgroup Config Elementary Config
1677 * Elementary configuration is formed by a set options bounded to a
1678 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1679 * "finger size", etc. These are functions with which one syncronizes
1680 * changes made to those values to the configuration storing files, de
1681 * facto. You most probably don't want to use the functions in this
1682 * group unlees you're writing an elementary configuration manager.
1688 * Save back Elementary's configuration, so that it will persist on
1691 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1694 * This function will take effect -- thus, do I/O -- immediately. Use
1695 * it when you want to apply all configuration changes at once. The
1696 * current configuration set will get saved onto the current profile
1697 * configuration file.
1700 EAPI Eina_Bool elm_config_save(void);
1703 * Reload Elementary's configuration, bounded to current selected
1706 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1709 * Useful when you want to force reloading of configuration values for
1710 * a profile. If one removes user custom configuration directories,
1711 * for example, it will force a reload with system values insted.
1714 EAPI void elm_config_reload(void);
1721 * @defgroup Profile Elementary Profile
1723 * Profiles are pre-set options that affect the whole look-and-feel of
1724 * Elementary-based applications. There are, for example, profiles
1725 * aimed at desktop computer applications and others aimed at mobile,
1726 * touchscreen-based ones. You most probably don't want to use the
1727 * functions in this group unlees you're writing an elementary
1728 * configuration manager.
1734 * Get Elementary's profile in use.
1736 * This gets the global profile that is applied to all Elementary
1739 * @return The profile's name
1742 EAPI const char *elm_profile_current_get(void);
1745 * Get an Elementary's profile directory path in the filesystem. One
1746 * may want to fetch a system profile's dir or an user one (fetched
1749 * @param profile The profile's name
1750 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1751 * or a system one (@c EINA_FALSE)
1752 * @return The profile's directory path.
1755 * @note You must free it with elm_profile_dir_free().
1757 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1760 * Free an Elementary's profile directory path, as returned by
1761 * elm_profile_dir_get().
1763 * @param p_dir The profile's path
1767 EAPI void elm_profile_dir_free(const char *p_dir);
1770 * Get Elementary's list of available profiles.
1772 * @return The profiles list. List node data are the profile name
1776 * @note One must free this list, after usage, with the function
1777 * elm_profile_list_free().
1779 EAPI Eina_List *elm_profile_list_get(void);
1782 * Free Elementary's list of available profiles.
1784 * @param l The profiles list, as returned by elm_profile_list_get().
1788 EAPI void elm_profile_list_free(Eina_List *l);
1791 * Set Elementary's profile.
1793 * This sets the global profile that is applied to Elementary
1794 * applications. Just the process the call comes from will be
1797 * @param profile The profile's name
1801 EAPI void elm_profile_set(const char *profile);
1804 * Set Elementary's profile.
1806 * This sets the global profile that is applied to all Elementary
1807 * applications. All running Elementary windows will be affected.
1809 * @param profile The profile's name
1813 EAPI void elm_profile_all_set(const char *profile);
1820 * @defgroup Engine Elementary Engine
1822 * These are functions setting and querying which rendering engine
1823 * Elementary will use for drawing its windows' pixels.
1825 * The following are the available engines:
1826 * @li "software_x11"
1829 * @li "software_16_x11"
1830 * @li "software_8_x11"
1833 * @li "software_gdi"
1834 * @li "software_16_wince_gdi"
1836 * @li "software_16_sdl"
1844 * @brief Get Elementary's rendering engine in use.
1846 * @return The rendering engine's name
1847 * @note there's no need to free the returned string, here.
1849 * This gets the global rendering engine that is applied to all Elementary
1852 * @see elm_engine_set()
1854 EAPI const char *elm_engine_current_get(void);
1857 * @brief Set Elementary's rendering engine for use.
1859 * @param engine The rendering engine's name
1861 * This sets global rendering engine that is applied to all Elementary
1862 * applications. Note that it will take effect only to Elementary windows
1863 * created after this is called.
1865 * @see elm_win_add()
1867 EAPI void elm_engine_set(const char *engine);
1874 * @defgroup Fonts Elementary Fonts
1876 * These are functions dealing with font rendering, selection and the
1877 * like for Elementary applications. One might fetch which system
1878 * fonts are there to use and set custom fonts for individual classes
1879 * of UI items containing text (text classes).
1884 typedef struct _Elm_Text_Class
1890 typedef struct _Elm_Font_Overlay
1892 const char *text_class;
1894 Evas_Font_Size size;
1897 typedef struct _Elm_Font_Properties
1901 } Elm_Font_Properties;
1904 * Get Elementary's list of supported text classes.
1906 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1909 * Release the list with elm_text_classes_list_free().
1911 EAPI const Eina_List *elm_text_classes_list_get(void);
1914 * Free Elementary's list of supported text classes.
1918 * @see elm_text_classes_list_get().
1920 EAPI void elm_text_classes_list_free(const Eina_List *list);
1923 * Get Elementary's list of font overlays, set with
1924 * elm_font_overlay_set().
1926 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1931 * For each text class, one can set a <b>font overlay</b> for it,
1932 * overriding the default font properties for that class coming from
1933 * the theme in use. There is no need to free this list.
1935 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1937 EAPI const Eina_List *elm_font_overlay_list_get(void);
1940 * Set a font overlay for a given Elementary text class.
1942 * @param text_class Text class name
1943 * @param font Font name and style string
1944 * @param size Font size
1948 * @p font has to be in the format returned by
1949 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1950 * and elm_font_overlay_unset().
1952 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1955 * Unset a font overlay for a given Elementary text class.
1957 * @param text_class Text class name
1961 * This will bring back text elements belonging to text class
1962 * @p text_class back to their default font settings.
1964 EAPI void elm_font_overlay_unset(const char *text_class);
1967 * Apply the changes made with elm_font_overlay_set() and
1968 * elm_font_overlay_unset() on the current Elementary window.
1972 * This applies all font overlays set to all objects in the UI.
1974 EAPI void elm_font_overlay_apply(void);
1977 * Apply the changes made with elm_font_overlay_set() and
1978 * elm_font_overlay_unset() on all Elementary application windows.
1982 * This applies all font overlays set to all objects in the UI.
1984 EAPI void elm_font_overlay_all_apply(void);
1987 * Translate a font (family) name string in fontconfig's font names
1988 * syntax into an @c Elm_Font_Properties struct.
1990 * @param font The font name and styles string
1991 * @return the font properties struct
1995 * @note The reverse translation can be achived with
1996 * elm_font_fontconfig_name_get(), for one style only (single font
1997 * instance, not family).
1999 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2002 * Free font properties return by elm_font_properties_get().
2004 * @param efp the font properties struct
2008 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2011 * Translate a font name, bound to a style, into fontconfig's font names
2014 * @param name The font (family) name
2015 * @param style The given style (may be @c NULL)
2017 * @return the font name and style string
2021 * @note The reverse translation can be achived with
2022 * elm_font_properties_get(), for one style only (single font
2023 * instance, not family).
2025 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2028 * Free the font string return by elm_font_fontconfig_name_get().
2030 * @param efp the font properties struct
2034 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2037 * Create a font hash table of available system fonts.
2039 * One must call it with @p list being the return value of
2040 * evas_font_available_list(). The hash will be indexed by font
2041 * (family) names, being its values @c Elm_Font_Properties blobs.
2043 * @param list The list of available system fonts, as returned by
2044 * evas_font_available_list().
2045 * @return the font hash.
2049 * @note The user is supposed to get it populated at least with 3
2050 * default font families (Sans, Serif, Monospace), which should be
2051 * present on most systems.
2053 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2056 * Free the hash return by elm_font_available_hash_add().
2058 * @param hash the hash to be freed.
2062 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2069 * @defgroup Fingers Fingers
2071 * Elementary is designed to be finger-friendly for touchscreens,
2072 * and so in addition to scaling for display resolution, it can
2073 * also scale based on finger "resolution" (or size). You can then
2074 * customize the granularity of the areas meant to receive clicks
2077 * Different profiles may have pre-set values for finger sizes.
2079 * @ref general_functions_example_page "This" example contemplates
2080 * some of these functions.
2086 * Get the configured "finger size"
2088 * @return The finger size
2090 * This gets the globally configured finger size, <b>in pixels</b>
2094 EAPI Evas_Coord elm_finger_size_get(void);
2097 * Set the configured finger size
2099 * This sets the globally configured finger size in pixels
2101 * @param size The finger size
2104 EAPI void elm_finger_size_set(Evas_Coord size);
2107 * Set the configured finger size for all applications on the display
2109 * This sets the globally configured finger size in pixels for all
2110 * applications on the display
2112 * @param size The finger size
2115 EAPI void elm_finger_size_all_set(Evas_Coord size);
2122 * @defgroup Focus Focus
2124 * An Elementary application has, at all times, one (and only one)
2125 * @b focused object. This is what determines where the input
2126 * events go to within the application's window. Also, focused
2127 * objects can be decorated differently, in order to signal to the
2128 * user where the input is, at a given moment.
2130 * Elementary applications also have the concept of <b>focus
2131 * chain</b>: one can cycle through all the windows' focusable
2132 * objects by input (tab key) or programmatically. The default
2133 * focus chain for an application is the one define by the order in
2134 * which the widgets where added in code. One will cycle through
2135 * top level widgets, and, for each one containg sub-objects, cycle
2136 * through them all, before returning to the level
2137 * above. Elementary also allows one to set @b custom focus chains
2138 * for their applications.
2140 * Besides the focused decoration a widget may exhibit, when it
2141 * gets focus, Elementary has a @b global focus highlight object
2142 * that can be enabled for a window. If one chooses to do so, this
2143 * extra highlight effect will surround the current focused object,
2146 * @note Some Elementary widgets are @b unfocusable, after
2147 * creation, by their very nature: they are not meant to be
2148 * interacted with input events, but are there just for visual
2151 * @ref general_functions_example_page "This" example contemplates
2152 * some of these functions.
2156 * Get the enable status of the focus highlight
2158 * This gets whether the highlight on focused objects is enabled or not
2161 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2164 * Set the enable status of the focus highlight
2166 * Set whether to show or not the highlight on focused objects
2167 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2170 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2173 * Get the enable status of the highlight animation
2175 * Get whether the focus highlight, if enabled, will animate its switch from
2176 * one object to the next
2179 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2182 * Set the enable status of the highlight animation
2184 * Set whether the focus highlight, if enabled, will animate its switch from
2185 * one object to the next
2186 * @param animate Enable animation if EINA_TRUE, disable otherwise
2189 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2192 * Get the whether an Elementary object has the focus or not.
2194 * @param obj The Elementary object to get the information from
2195 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2196 * not (and on errors).
2198 * @see elm_object_focus_set()
2202 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2205 * Set/unset focus to a given Elementary object.
2207 * @param obj The Elementary object to operate on.
2208 * @param enable @c EINA_TRUE Set focus to a given object,
2209 * @c EINA_FALSE Unset focus to a given object.
2211 * @note When you set focus to this object, if it can handle focus, will
2212 * take the focus away from the one who had it previously and will, for
2213 * now on, be the one receiving input events. Unsetting focus will remove
2214 * the focus from @p obj, passing it back to the previous element in the
2217 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2221 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2224 * Make a given Elementary object the focused one.
2226 * @param obj The Elementary object to make focused.
2228 * @note This object, if it can handle focus, will take the focus
2229 * away from the one who had it previously and will, for now on, be
2230 * the one receiving input events.
2232 * @see elm_object_focus_get()
2233 * @deprecated use elm_object_focus_set() instead.
2237 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2240 * Remove the focus from an Elementary object
2242 * @param obj The Elementary to take focus from
2244 * This removes the focus from @p obj, passing it back to the
2245 * previous element in the focus chain list.
2247 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2248 * @deprecated use elm_object_focus_set() instead.
2252 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2255 * Set the ability for an Element object to be focused
2257 * @param obj The Elementary object to operate on
2258 * @param enable @c EINA_TRUE if the object can be focused, @c
2259 * EINA_FALSE if not (and on errors)
2261 * This sets whether the object @p obj is able to take focus or
2262 * not. Unfocusable objects do nothing when programmatically
2263 * focused, being the nearest focusable parent object the one
2264 * really getting focus. Also, when they receive mouse input, they
2265 * will get the event, but not take away the focus from where it
2270 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2273 * Get whether an Elementary object is focusable or not
2275 * @param obj The Elementary object to operate on
2276 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2277 * EINA_FALSE if not (and on errors)
2279 * @note Objects which are meant to be interacted with by input
2280 * events are created able to be focused, by default. All the
2285 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2288 * Set custom focus chain.
2290 * This function overwrites any previous custom focus chain within
2291 * the list of objects. The previous list will be deleted and this list
2292 * will be managed by elementary. After it is set, don't modify it.
2294 * @note On focus cycle, only will be evaluated children of this container.
2296 * @param obj The container object
2297 * @param objs Chain of objects to pass focus
2300 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2303 * Unset a custom focus chain on a given Elementary widget
2305 * @param obj The container object to remove focus chain from
2307 * Any focus chain previously set on @p obj (for its child objects)
2308 * is removed entirely after this call.
2312 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2315 * Get custom focus chain
2317 * @param obj The container object
2320 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2323 * Append object to custom focus chain.
2325 * @note If relative_child equal to NULL or not in custom chain, the object
2326 * will be added in end.
2328 * @note On focus cycle, only will be evaluated children of this container.
2330 * @param obj The container object
2331 * @param child The child to be added in custom chain
2332 * @param relative_child The relative object to position the child
2335 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2338 * Prepend object to custom focus chain.
2340 * @note If relative_child equal to NULL or not in custom chain, the object
2341 * will be added in begin.
2343 * @note On focus cycle, only will be evaluated children of this container.
2345 * @param obj The container object
2346 * @param child The child to be added in custom chain
2347 * @param relative_child The relative object to position the child
2350 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2353 * Give focus to next object in object tree.
2355 * Give focus to next object in focus chain of one object sub-tree.
2356 * If the last object of chain already have focus, the focus will go to the
2357 * first object of chain.
2359 * @param obj The object root of sub-tree
2360 * @param dir Direction to cycle the focus
2364 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2367 * Give focus to near object in one direction.
2369 * Give focus to near object in direction of one object.
2370 * If none focusable object in given direction, the focus will not change.
2372 * @param obj The reference object
2373 * @param x Horizontal component of direction to focus
2374 * @param y Vertical component of direction to focus
2378 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2381 * Make the elementary object and its children to be unfocusable
2384 * @param obj The Elementary object to operate on
2385 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2386 * @c EINA_FALSE for focusable.
2388 * This sets whether the object @p obj and its children objects
2389 * are able to take focus or not. If the tree is set as unfocusable,
2390 * newest focused object which is not in this tree will get focus.
2391 * This API can be helpful for an object to be deleted.
2392 * When an object will be deleted soon, it and its children may not
2393 * want to get focus (by focus reverting or by other focus controls).
2394 * Then, just use this API before deleting.
2396 * @see elm_object_tree_unfocusable_get()
2400 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2403 * Get whether an Elementary object and its children are unfocusable or not.
2405 * @param obj The Elementary object to get the information from
2406 * @return @c EINA_TRUE, if the tree is unfocussable,
2407 * @c EINA_FALSE if not (and on errors).
2409 * @see elm_object_tree_unfocusable_set()
2413 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2416 * @defgroup Scrolling Scrolling
2418 * These are functions setting how scrollable views in Elementary
2419 * widgets should behave on user interaction.
2425 * Get whether scrollers should bounce when they reach their
2426 * viewport's edge during a scroll.
2428 * @return the thumb scroll bouncing state
2430 * This is the default behavior for touch screens, in general.
2431 * @ingroup Scrolling
2433 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2436 * Set whether scrollers should bounce when they reach their
2437 * viewport's edge during a scroll.
2439 * @param enabled the thumb scroll bouncing state
2441 * @see elm_thumbscroll_bounce_enabled_get()
2442 * @ingroup Scrolling
2444 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2447 * Set whether scrollers should bounce when they reach their
2448 * viewport's edge during a scroll, for all Elementary application
2451 * @param enabled the thumb scroll bouncing state
2453 * @see elm_thumbscroll_bounce_enabled_get()
2454 * @ingroup Scrolling
2456 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2459 * Get the amount of inertia a scroller will impose at bounce
2462 * @return the thumb scroll bounce friction
2464 * @ingroup Scrolling
2466 EAPI double elm_scroll_bounce_friction_get(void);
2469 * Set the amount of inertia a scroller will impose at bounce
2472 * @param friction the thumb scroll bounce friction
2474 * @see elm_thumbscroll_bounce_friction_get()
2475 * @ingroup Scrolling
2477 EAPI void elm_scroll_bounce_friction_set(double friction);
2480 * Set the amount of inertia a scroller will impose at bounce
2481 * animations, for all Elementary application windows.
2483 * @param friction the thumb scroll bounce friction
2485 * @see elm_thumbscroll_bounce_friction_get()
2486 * @ingroup Scrolling
2488 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2491 * Get the amount of inertia a <b>paged</b> scroller will impose at
2492 * page fitting animations.
2494 * @return the page scroll friction
2496 * @ingroup Scrolling
2498 EAPI double elm_scroll_page_scroll_friction_get(void);
2501 * Set the amount of inertia a <b>paged</b> scroller will impose at
2502 * page fitting animations.
2504 * @param friction the page scroll friction
2506 * @see elm_thumbscroll_page_scroll_friction_get()
2507 * @ingroup Scrolling
2509 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2512 * Set the amount of inertia a <b>paged</b> scroller will impose at
2513 * page fitting animations, for all Elementary application windows.
2515 * @param friction the page scroll friction
2517 * @see elm_thumbscroll_page_scroll_friction_get()
2518 * @ingroup Scrolling
2520 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2523 * Get the amount of inertia a scroller will impose at region bring
2526 * @return the bring in scroll friction
2528 * @ingroup Scrolling
2530 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2533 * Set the amount of inertia a scroller will impose at region bring
2536 * @param friction the bring in scroll friction
2538 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2539 * @ingroup Scrolling
2541 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2544 * Set the amount of inertia a scroller will impose at region bring
2545 * animations, for all Elementary application windows.
2547 * @param friction the bring in scroll friction
2549 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2550 * @ingroup Scrolling
2552 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2555 * Get the amount of inertia scrollers will impose at animations
2556 * triggered by Elementary widgets' zooming API.
2558 * @return the zoom friction
2560 * @ingroup Scrolling
2562 EAPI double elm_scroll_zoom_friction_get(void);
2565 * Set the amount of inertia scrollers will impose at animations
2566 * triggered by Elementary widgets' zooming API.
2568 * @param friction the zoom friction
2570 * @see elm_thumbscroll_zoom_friction_get()
2571 * @ingroup Scrolling
2573 EAPI void elm_scroll_zoom_friction_set(double friction);
2576 * Set the amount of inertia scrollers will impose at animations
2577 * triggered by Elementary widgets' zooming API, for all Elementary
2578 * application windows.
2580 * @param friction the zoom friction
2582 * @see elm_thumbscroll_zoom_friction_get()
2583 * @ingroup Scrolling
2585 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2588 * Get whether scrollers should be draggable from any point in their
2591 * @return the thumb scroll state
2593 * @note This is the default behavior for touch screens, in general.
2594 * @note All other functions namespaced with "thumbscroll" will only
2595 * have effect if this mode is enabled.
2597 * @ingroup Scrolling
2599 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2602 * Set whether scrollers should be draggable from any point in their
2605 * @param enabled the thumb scroll state
2607 * @see elm_thumbscroll_enabled_get()
2608 * @ingroup Scrolling
2610 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2613 * Set whether scrollers should be draggable from any point in their
2614 * views, for all Elementary application windows.
2616 * @param enabled the thumb scroll state
2618 * @see elm_thumbscroll_enabled_get()
2619 * @ingroup Scrolling
2621 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2624 * Get the number of pixels one should travel while dragging a
2625 * scroller's view to actually trigger scrolling.
2627 * @return the thumb scroll threshould
2629 * One would use higher values for touch screens, in general, because
2630 * of their inherent imprecision.
2631 * @ingroup Scrolling
2633 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2636 * Set the number of pixels one should travel while dragging a
2637 * scroller's view to actually trigger scrolling.
2639 * @param threshold the thumb scroll threshould
2641 * @see elm_thumbscroll_threshould_get()
2642 * @ingroup Scrolling
2644 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2647 * Set the number of pixels one should travel while dragging a
2648 * scroller's view to actually trigger scrolling, for all Elementary
2649 * application windows.
2651 * @param threshold the thumb scroll threshould
2653 * @see elm_thumbscroll_threshould_get()
2654 * @ingroup Scrolling
2656 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2659 * Get the minimum speed of mouse cursor movement which will trigger
2660 * list self scrolling animation after a mouse up event
2663 * @return the thumb scroll momentum threshould
2665 * @ingroup Scrolling
2667 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2670 * Set the minimum speed of mouse cursor movement which will trigger
2671 * list self scrolling animation after a mouse up event
2674 * @param threshold the thumb scroll momentum threshould
2676 * @see elm_thumbscroll_momentum_threshould_get()
2677 * @ingroup Scrolling
2679 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2682 * Set the minimum speed of mouse cursor movement which will trigger
2683 * list self scrolling animation after a mouse up event
2684 * (pixels/second), for all Elementary application windows.
2686 * @param threshold the thumb scroll momentum threshould
2688 * @see elm_thumbscroll_momentum_threshould_get()
2689 * @ingroup Scrolling
2691 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2694 * Get the amount of inertia a scroller will impose at self scrolling
2697 * @return the thumb scroll friction
2699 * @ingroup Scrolling
2701 EAPI double elm_scroll_thumbscroll_friction_get(void);
2704 * Set the amount of inertia a scroller will impose at self scrolling
2707 * @param friction the thumb scroll friction
2709 * @see elm_thumbscroll_friction_get()
2710 * @ingroup Scrolling
2712 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2715 * Set the amount of inertia a scroller will impose at self scrolling
2716 * animations, for all Elementary application windows.
2718 * @param friction the thumb scroll friction
2720 * @see elm_thumbscroll_friction_get()
2721 * @ingroup Scrolling
2723 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2726 * Get the amount of lag between your actual mouse cursor dragging
2727 * movement and a scroller's view movement itself, while pushing it
2728 * into bounce state manually.
2730 * @return the thumb scroll border friction
2732 * @ingroup Scrolling
2734 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2737 * Set the amount of lag between your actual mouse cursor dragging
2738 * movement and a scroller's view movement itself, while pushing it
2739 * into bounce state manually.
2741 * @param friction the thumb scroll border friction. @c 0.0 for
2742 * perfect synchrony between two movements, @c 1.0 for maximum
2745 * @see elm_thumbscroll_border_friction_get()
2746 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2753 * Set 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, for all Elementary application windows.
2757 * @param friction the thumb scroll border friction. @c 0.0 for
2758 * perfect synchrony between two movements, @c 1.0 for maximum
2761 * @see elm_thumbscroll_border_friction_get()
2762 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2764 * @ingroup Scrolling
2766 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2773 * @defgroup Scrollhints Scrollhints
2775 * Objects when inside a scroller can scroll, but this may not always be
2776 * desirable in certain situations. This allows an object to hint to itself
2777 * and parents to "not scroll" in one of 2 ways. If any child object of a
2778 * scroller has pushed a scroll freeze or hold then it affects all parent
2779 * scrollers until all children have released them.
2781 * 1. To hold on scrolling. This means just flicking and dragging may no
2782 * longer scroll, but pressing/dragging near an edge of the scroller will
2783 * still scroll. This is automatically used by the entry object when
2786 * 2. To totally freeze scrolling. This means it stops. until
2793 * Push the scroll hold by 1
2795 * This increments the scroll hold count by one. If it is more than 0 it will
2796 * take effect on the parents of the indicated object.
2798 * @param obj The object
2799 * @ingroup Scrollhints
2801 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2804 * Pop the scroll hold by 1
2806 * This decrements the scroll hold count by one. If it is more than 0 it will
2807 * take effect on the parents of the indicated object.
2809 * @param obj The object
2810 * @ingroup Scrollhints
2812 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2815 * Push the scroll freeze by 1
2817 * This increments the scroll freeze count by one. If it is more
2818 * than 0 it will take effect on the parents of the indicated
2821 * @param obj The object
2822 * @ingroup Scrollhints
2824 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2827 * Pop the scroll freeze by 1
2829 * This decrements the scroll freeze count by one. If it is more
2830 * than 0 it will take effect on the parents of the indicated
2833 * @param obj The object
2834 * @ingroup Scrollhints
2836 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2839 * Lock the scrolling of the given widget (and thus all parents)
2841 * This locks the given object from scrolling in the X axis (and implicitly
2842 * also locks all parent scrollers too from doing the same).
2844 * @param obj The object
2845 * @param lock The lock state (1 == locked, 0 == unlocked)
2846 * @ingroup Scrollhints
2848 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2851 * Lock the scrolling of the given widget (and thus all parents)
2853 * This locks the given object from scrolling in the Y axis (and implicitly
2854 * also locks all parent scrollers too from doing the same).
2856 * @param obj The object
2857 * @param lock The lock state (1 == locked, 0 == unlocked)
2858 * @ingroup Scrollhints
2860 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2863 * Get the scrolling lock of the given widget
2865 * This gets the lock for X axis scrolling.
2867 * @param obj The object
2868 * @ingroup Scrollhints
2870 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2873 * Get the scrolling lock of the given widget
2875 * This gets the lock for X axis scrolling.
2877 * @param obj The object
2878 * @ingroup Scrollhints
2880 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2887 * Send a signal to the widget edje object.
2889 * This function sends a signal to the edje object of the obj. An
2890 * edje program can respond to a signal by specifying matching
2891 * 'signal' and 'source' fields.
2893 * @param obj The object
2894 * @param emission The signal's name.
2895 * @param source The signal's source.
2898 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2901 * Add a callback for a signal emitted by widget edje object.
2903 * This function connects a callback function to a signal emitted by the
2904 * edje object of the obj.
2905 * Globs can occur in either the emission or source name.
2907 * @param obj The object
2908 * @param emission The signal's name.
2909 * @param source The signal's source.
2910 * @param func The callback function to be executed when the signal is
2912 * @param data A pointer to data to pass in to the callback function.
2915 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);
2918 * Remove a signal-triggered callback from a widget edje object.
2920 * This function removes a callback, previoulsy attached to a
2921 * signal emitted by the edje object of the obj. The parameters
2922 * emission, source and func must match exactly those passed to a
2923 * previous call to elm_object_signal_callback_add(). The data
2924 * pointer that was passed to this call will be returned.
2926 * @param obj The object
2927 * @param emission The signal's name.
2928 * @param source The signal's source.
2929 * @param func The callback function to be executed when the signal is
2931 * @return The data pointer
2934 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);
2937 * Add a callback for input events (key up, key down, mouse wheel)
2938 * on a given Elementary widget
2940 * @param obj The widget to add an event callback on
2941 * @param func The callback function to be executed when the event
2943 * @param data Data to pass in to @p func
2945 * Every widget in an Elementary interface set to receive focus,
2946 * with elm_object_focus_allow_set(), will propagate @b all of its
2947 * key up, key down and mouse wheel input events up to its parent
2948 * object, and so on. All of the focusable ones in this chain which
2949 * had an event callback set, with this call, will be able to treat
2950 * those events. There are two ways of making the propagation of
2951 * these event upwards in the tree of widgets to @b cease:
2952 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2953 * the event was @b not processed, so the propagation will go on.
2954 * - The @c event_info pointer passed to @p func will contain the
2955 * event's structure and, if you OR its @c event_flags inner
2956 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2957 * one has already handled it, thus killing the event's
2960 * @note Your event callback will be issued on those events taking
2961 * place only if no other child widget of @obj has consumed the
2964 * @note Not to be confused with @c
2965 * evas_object_event_callback_add(), which will add event callbacks
2966 * per type on general Evas objects (no event propagation
2967 * infrastructure taken in account).
2969 * @note Not to be confused with @c
2970 * elm_object_signal_callback_add(), which will add callbacks to @b
2971 * signals coming from a widget's theme, not input events.
2973 * @note Not to be confused with @c
2974 * edje_object_signal_callback_add(), which does the same as
2975 * elm_object_signal_callback_add(), but directly on an Edje
2978 * @note Not to be confused with @c
2979 * evas_object_smart_callback_add(), which adds callbacks to smart
2980 * objects' <b>smart events</b>, and not input events.
2982 * @see elm_object_event_callback_del()
2986 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2989 * Remove an event callback from a widget.
2991 * This function removes a callback, previoulsy attached to event emission
2993 * The parameters func and data must match exactly those passed to
2994 * a previous call to elm_object_event_callback_add(). The data pointer that
2995 * was passed to this call will be returned.
2997 * @param obj The object
2998 * @param func The callback function to be executed when the event is
3000 * @param data Data to pass in to the callback function.
3001 * @return The data pointer
3004 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3007 * Adjust size of an element for finger usage.
3009 * @param times_w How many fingers should fit horizontally
3010 * @param w Pointer to the width size to adjust
3011 * @param times_h How many fingers should fit vertically
3012 * @param h Pointer to the height size to adjust
3014 * This takes width and height sizes (in pixels) as input and a
3015 * size multiple (which is how many fingers you want to place
3016 * within the area, being "finger" the size set by
3017 * elm_finger_size_set()), and adjusts the size to be large enough
3018 * to accommodate the resulting size -- if it doesn't already
3019 * accommodate it. On return the @p w and @p h sizes pointed to by
3020 * these parameters will be modified, on those conditions.
3022 * @note This is kind of a low level Elementary call, most useful
3023 * on size evaluation times for widgets. An external user wouldn't
3024 * be calling, most of the time.
3028 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3031 * Get the duration for occuring long press event.
3033 * @return Timeout for long press event
3034 * @ingroup Longpress
3036 EAPI double elm_longpress_timeout_get(void);
3039 * Set the duration for occuring long press event.
3041 * @param lonpress_timeout Timeout for long press event
3042 * @ingroup Longpress
3044 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3047 * @defgroup Debug Debug
3048 * don't use it unless you are sure
3054 * Print Tree object hierarchy in stdout
3056 * @param obj The root object
3059 EAPI void elm_object_tree_dump(const Evas_Object *top);
3062 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3064 * @param obj The root object
3065 * @param file The path of output file
3068 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3075 * @defgroup Theme Theme
3077 * Elementary uses Edje to theme its widgets, naturally. But for the most
3078 * part this is hidden behind a simpler interface that lets the user set
3079 * extensions and choose the style of widgets in a much easier way.
3081 * Instead of thinking in terms of paths to Edje files and their groups
3082 * each time you want to change the appearance of a widget, Elementary
3083 * works so you can add any theme file with extensions or replace the
3084 * main theme at one point in the application, and then just set the style
3085 * of widgets with elm_object_style_set() and related functions. Elementary
3086 * will then look in its list of themes for a matching group and apply it,
3087 * and when the theme changes midway through the application, all widgets
3088 * will be updated accordingly.
3090 * There are three concepts you need to know to understand how Elementary
3091 * theming works: default theme, extensions and overlays.
3093 * Default theme, obviously enough, is the one that provides the default
3094 * look of all widgets. End users can change the theme used by Elementary
3095 * by setting the @c ELM_THEME environment variable before running an
3096 * application, or globally for all programs using the @c elementary_config
3097 * utility. Applications can change the default theme using elm_theme_set(),
3098 * but this can go against the user wishes, so it's not an adviced practice.
3100 * Ideally, applications should find everything they need in the already
3101 * provided theme, but there may be occasions when that's not enough and
3102 * custom styles are required to correctly express the idea. For this
3103 * cases, Elementary has extensions.
3105 * Extensions allow the application developer to write styles of its own
3106 * to apply to some widgets. This requires knowledge of how each widget
3107 * is themed, as extensions will always replace the entire group used by
3108 * the widget, so important signals and parts need to be there for the
3109 * object to behave properly (see documentation of Edje for details).
3110 * Once the theme for the extension is done, the application needs to add
3111 * it to the list of themes Elementary will look into, using
3112 * elm_theme_extension_add(), and set the style of the desired widgets as
3113 * he would normally with elm_object_style_set().
3115 * Overlays, on the other hand, can replace the look of all widgets by
3116 * overriding the default style. Like extensions, it's up to the application
3117 * developer to write the theme for the widgets it wants, the difference
3118 * being that when looking for the theme, Elementary will check first the
3119 * list of overlays, then the set theme and lastly the list of extensions,
3120 * so with overlays it's possible to replace the default view and every
3121 * widget will be affected. This is very much alike to setting the whole
3122 * theme for the application and will probably clash with the end user
3123 * options, not to mention the risk of ending up with not matching styles
3124 * across the program. Unless there's a very special reason to use them,
3125 * overlays should be avoided for the resons exposed before.
3127 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3128 * keeps one default internally and every function that receives one of
3129 * these can be called with NULL to refer to this default (except for
3130 * elm_theme_free()). It's possible to create a new instance of a
3131 * ::Elm_Theme to set other theme for a specific widget (and all of its
3132 * children), but this is as discouraged, if not even more so, than using
3133 * overlays. Don't use this unless you really know what you are doing.
3135 * But to be less negative about things, you can look at the following
3137 * @li @ref theme_example_01 "Using extensions"
3138 * @li @ref theme_example_02 "Using overlays"
3143 * @typedef Elm_Theme
3145 * Opaque handler for the list of themes Elementary looks for when
3146 * rendering widgets.
3148 * Stay out of this unless you really know what you are doing. For most
3149 * cases, sticking to the default is all a developer needs.
3151 typedef struct _Elm_Theme Elm_Theme;
3154 * Create a new specific theme
3156 * This creates an empty specific theme that only uses the default theme. A
3157 * specific theme has its own private set of extensions and overlays too
3158 * (which are empty by default). Specific themes do not fall back to themes
3159 * of parent objects. They are not intended for this use. Use styles, overlays
3160 * and extensions when needed, but avoid specific themes unless there is no
3161 * other way (example: you want to have a preview of a new theme you are
3162 * selecting in a "theme selector" window. The preview is inside a scroller
3163 * and should display what the theme you selected will look like, but not
3164 * actually apply it yet. The child of the scroller will have a specific
3165 * theme set to show this preview before the user decides to apply it to all
3168 EAPI Elm_Theme *elm_theme_new(void);
3170 * Free a specific theme
3172 * @param th The theme to free
3174 * This frees a theme created with elm_theme_new().
3176 EAPI void elm_theme_free(Elm_Theme *th);
3178 * Copy the theme fom the source to the destination theme
3180 * @param th The source theme to copy from
3181 * @param thdst The destination theme to copy data to
3183 * This makes a one-time static copy of all the theme config, extensions
3184 * and overlays from @p th to @p thdst. If @p th references a theme, then
3185 * @p thdst is also set to reference it, with all the theme settings,
3186 * overlays and extensions that @p th had.
3188 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3190 * Tell the source theme to reference the ref theme
3192 * @param th The theme that will do the referencing
3193 * @param thref The theme that is the reference source
3195 * This clears @p th to be empty and then sets it to refer to @p thref
3196 * so @p th acts as an override to @p thref, but where its overrides
3197 * don't apply, it will fall through to @p thref for configuration.
3199 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3201 * Return the theme referred to
3203 * @param th The theme to get the reference from
3204 * @return The referenced theme handle
3206 * This gets the theme set as the reference theme by elm_theme_ref_set().
3207 * If no theme is set as a reference, NULL is returned.
3209 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3211 * Return the default theme
3213 * @return The default theme handle
3215 * This returns the internal default theme setup handle that all widgets
3216 * use implicitly unless a specific theme is set. This is also often use
3217 * as a shorthand of NULL.
3219 EAPI Elm_Theme *elm_theme_default_get(void);
3221 * Prepends a theme overlay to the list of overlays
3223 * @param th The theme to add to, or if NULL, the default theme
3224 * @param item The Edje file path to be used
3226 * Use this if your application needs to provide some custom overlay theme
3227 * (An Edje file that replaces some default styles of widgets) where adding
3228 * new styles, or changing system theme configuration is not possible. Do
3229 * NOT use this instead of a proper system theme configuration. Use proper
3230 * configuration files, profiles, environment variables etc. to set a theme
3231 * so that the theme can be altered by simple confiugration by a user. Using
3232 * this call to achieve that effect is abusing the API and will create lots
3235 * @see elm_theme_extension_add()
3237 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3239 * Delete a theme overlay from the list of overlays
3241 * @param th The theme to delete from, or if NULL, the default theme
3242 * @param item The name of the theme overlay
3244 * @see elm_theme_overlay_add()
3246 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3248 * Appends a theme extension to the list of extensions.
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 * This is intended when an application needs more styles of widgets or new
3254 * widget themes that the default does not provide (or may not provide). The
3255 * application has "extended" usage by coming up with new custom style names
3256 * for widgets for specific uses, but as these are not "standard", they are
3257 * not guaranteed to be provided by a default theme. This means the
3258 * application is required to provide these extra elements itself in specific
3259 * Edje files. This call adds one of those Edje files to the theme search
3260 * path to be search after the default theme. The use of this call is
3261 * encouraged when default styles do not meet the needs of the application.
3262 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3264 * @see elm_object_style_set()
3266 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3268 * Deletes a theme extension from the list of extensions.
3270 * @param th The theme to delete from, or if NULL, the default theme
3271 * @param item The name of the theme extension
3273 * @see elm_theme_extension_add()
3275 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3277 * Set the theme search order for the given theme
3279 * @param th The theme to set the search order, or if NULL, the default theme
3280 * @param theme Theme search string
3282 * This sets the search string for the theme in path-notation from first
3283 * theme to search, to last, delimited by the : character. Example:
3285 * "shiny:/path/to/file.edj:default"
3287 * See the ELM_THEME environment variable for more information.
3289 * @see elm_theme_get()
3290 * @see elm_theme_list_get()
3292 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3294 * Return the theme search order
3296 * @param th The theme to get the search order, or if NULL, the default theme
3297 * @return The internal search order path
3299 * This function returns a colon separated string of theme elements as
3300 * returned by elm_theme_list_get().
3302 * @see elm_theme_set()
3303 * @see elm_theme_list_get()
3305 EAPI const char *elm_theme_get(Elm_Theme *th);
3307 * Return a list of theme elements to be used in a theme.
3309 * @param th Theme to get the list of theme elements from.
3310 * @return The internal list of theme elements
3312 * This returns the internal list of theme elements (will only be valid as
3313 * long as the theme is not modified by elm_theme_set() or theme is not
3314 * freed by elm_theme_free(). This is a list of strings which must not be
3315 * altered as they are also internal. If @p th is NULL, then the default
3316 * theme element list is returned.
3318 * A theme element can consist of a full or relative path to a .edj file,
3319 * or a name, without extension, for a theme to be searched in the known
3320 * theme paths for Elemementary.
3322 * @see elm_theme_set()
3323 * @see elm_theme_get()
3325 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3327 * Return the full patrh for a theme element
3329 * @param f The theme element name
3330 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3331 * @return The full path to the file found.
3333 * This returns a string you should free with free() on success, NULL on
3334 * failure. This will search for the given theme element, and if it is a
3335 * full or relative path element or a simple searchable name. The returned
3336 * path is the full path to the file, if searched, and the file exists, or it
3337 * is simply the full path given in the element or a resolved path if
3338 * relative to home. The @p in_search_path boolean pointed to is set to
3339 * EINA_TRUE if the file was a searchable file andis in the search path,
3340 * and EINA_FALSE otherwise.
3342 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3344 * Flush the current theme.
3346 * @param th Theme to flush
3348 * This flushes caches that let elementary know where to find theme elements
3349 * in the given theme. If @p th is NULL, then the default theme is flushed.
3350 * Call this function if source theme data has changed in such a way as to
3351 * make any caches Elementary kept invalid.
3353 EAPI void elm_theme_flush(Elm_Theme *th);
3355 * This flushes all themes (default and specific ones).
3357 * This will flush all themes in the current application context, by calling
3358 * elm_theme_flush() on each of them.
3360 EAPI void elm_theme_full_flush(void);
3362 * Set the theme for all elementary using applications on the current display
3364 * @param theme The name of the theme to use. Format same as the ELM_THEME
3365 * environment variable.
3367 EAPI void elm_theme_all_set(const char *theme);
3369 * Return a list of theme elements in the theme search path
3371 * @return A list of strings that are the theme element names.
3373 * This lists all available theme files in the standard Elementary search path
3374 * for theme elements, and returns them in alphabetical order as theme
3375 * element names in a list of strings. Free this with
3376 * elm_theme_name_available_list_free() when you are done with the list.
3378 EAPI Eina_List *elm_theme_name_available_list_new(void);
3380 * Free the list returned by elm_theme_name_available_list_new()
3382 * This frees the list of themes returned by
3383 * elm_theme_name_available_list_new(). Once freed the list should no longer
3384 * be used. a new list mys be created.
3386 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3388 * Set a specific theme to be used for this object and its children
3390 * @param obj The object to set the theme on
3391 * @param th The theme to set
3393 * This sets a specific theme that will be used for the given object and any
3394 * child objects it has. If @p th is NULL then the theme to be used is
3395 * cleared and the object will inherit its theme from its parent (which
3396 * ultimately will use the default theme if no specific themes are set).
3398 * Use special themes with great care as this will annoy users and make
3399 * configuration difficult. Avoid any custom themes at all if it can be
3402 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3404 * Get the specific theme to be used
3406 * @param obj The object to get the specific theme from
3407 * @return The specifc theme set.
3409 * This will return a specific theme set, or NULL if no specific theme is
3410 * set on that object. It will not return inherited themes from parents, only
3411 * the specific theme set for that specific object. See elm_object_theme_set()
3412 * for more information.
3414 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3420 /** @defgroup Win Win
3422 * @image html img/widget/win/preview-00.png
3423 * @image latex img/widget/win/preview-00.eps
3425 * The window class of Elementary. Contains functions to manipulate
3426 * windows. The Evas engine used to render the window contents is specified
3427 * in the system or user elementary config files (whichever is found last),
3428 * and can be overridden with the ELM_ENGINE environment variable for
3429 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3430 * compilation setup and modules actually installed at runtime) are (listed
3431 * in order of best supported and most likely to be complete and work to
3434 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3435 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3437 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3439 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3441 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3443 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3444 * rendering using SDL as the buffer)
3445 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3446 * GDI with software)
3447 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3448 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3449 * grayscale using dedicated 8bit software engine in X11)
3450 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3451 * X11 using 16bit software engine)
3452 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3453 * (Windows CE rendering via GDI with 16bit software renderer)
3454 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3455 * buffer with 16bit software renderer)
3457 * All engines use a simple string to select the engine to render, EXCEPT
3458 * the "shot" engine. This actually encodes the output of the virtual
3459 * screenshot and how long to delay in the engine string. The engine string
3460 * is encoded in the following way:
3462 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3464 * Where options are separated by a ":" char if more than one option is
3465 * given, with delay, if provided being the first option and file the last
3466 * (order is important). The delay specifies how long to wait after the
3467 * window is shown before doing the virtual "in memory" rendering and then
3468 * save the output to the file specified by the file option (and then exit).
3469 * If no delay is given, the default is 0.5 seconds. If no file is given the
3470 * default output file is "out.png". Repeat option is for continous
3471 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3472 * fixed to "out001.png" Some examples of using the shot engine:
3474 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3475 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3476 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3477 * ELM_ENGINE="shot:delay=2.0" elementary_test
3478 * ELM_ENGINE="shot:" elementary_test
3480 * Signals that you can add callbacks for are:
3482 * @li "delete,request": the user requested to close the window. See
3483 * elm_win_autodel_set().
3484 * @li "focus,in": window got focus
3485 * @li "focus,out": window lost focus
3486 * @li "moved": window that holds the canvas was moved
3489 * @li @ref win_example_01
3494 * Defines the types of window that can be created
3496 * These are hints set on the window so that a running Window Manager knows
3497 * how the window should be handled and/or what kind of decorations it
3500 * Currently, only the X11 backed engines use them.
3502 typedef enum _Elm_Win_Type
3504 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3505 window. Almost every window will be created with this
3507 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3508 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3509 window holding desktop icons. */
3510 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3511 be kept on top of any other window by the Window
3513 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3515 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3516 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3518 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3519 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3520 entry in a menubar is clicked. Typically used
3521 with elm_win_override_set(). This hint exists
3522 for completion only, as the EFL way of
3523 implementing a menu would not normally use a
3524 separate window for its contents. */
3525 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3526 triggered by right-clicking an object. */
3527 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3528 explanatory text that typically appear after the
3529 mouse cursor hovers over an object for a while.
3530 Typically used with elm_win_override_set() and also
3531 not very commonly used in the EFL. */
3532 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3533 battery life or a new E-Mail received. */
3534 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3535 usually used in the EFL. */
3536 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3537 object being dragged across different windows, or even
3538 applications. Typically used with
3539 elm_win_override_set(). */
3540 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3541 buffer. No actual window is created for this
3542 type, instead the window and all of its
3543 contents will be rendered to an image buffer.
3544 This allows to have children window inside a
3545 parent one just like any other object would
3546 be, and do other things like applying @c
3547 Evas_Map effects to it. This is the only type
3548 of window that requires the @c parent
3549 parameter of elm_win_add() to be a valid @c
3554 * The differents layouts that can be requested for the virtual keyboard.
3556 * When the application window is being managed by Illume, it may request
3557 * any of the following layouts for the virtual keyboard.
3559 typedef enum _Elm_Win_Keyboard_Mode
3561 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3562 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3563 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3564 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3565 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3566 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3567 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3568 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3569 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3570 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3571 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3572 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3573 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3574 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3575 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3576 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3577 } Elm_Win_Keyboard_Mode;
3580 * Available commands that can be sent to the Illume manager.
3582 * When running under an Illume session, a window may send commands to the
3583 * Illume manager to perform different actions.
3585 typedef enum _Elm_Illume_Command
3587 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3589 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3591 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3593 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3594 } Elm_Illume_Command;
3597 * Adds a window object. If this is the first window created, pass NULL as
3600 * @param parent Parent object to add the window to, or NULL
3601 * @param name The name of the window
3602 * @param type The window type, one of #Elm_Win_Type.
3604 * The @p parent paramter can be @c NULL for every window @p type except
3605 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3606 * which the image object will be created.
3608 * @return The created object, or NULL on failure
3610 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3612 * Add @p subobj as a resize object of window @p obj.
3615 * Setting an object as a resize object of the window means that the
3616 * @p subobj child's size and position will be controlled by the window
3617 * directly. That is, the object will be resized to match the window size
3618 * and should never be moved or resized manually by the developer.
3620 * In addition, resize objects of the window control what the minimum size
3621 * of it will be, as well as whether it can or not be resized by the user.
3623 * For the end user to be able to resize a window by dragging the handles
3624 * or borders provided by the Window Manager, or using any other similar
3625 * mechanism, all of the resize objects in the window should have their
3626 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3628 * @param obj The window object
3629 * @param subobj The resize object to add
3631 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3633 * Delete @p subobj as a resize object of window @p obj.
3635 * This function removes the object @p subobj from the resize objects of
3636 * the window @p obj. It will not delete the object itself, which will be
3637 * left unmanaged and should be deleted by the developer, manually handled
3638 * or set as child of some other container.
3640 * @param obj The window object
3641 * @param subobj The resize object to add
3643 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3645 * Set the title of the window
3647 * @param obj The window object
3648 * @param title The title to set
3650 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3652 * Get the title of the window
3654 * The returned string is an internal one and should not be freed or
3655 * modified. It will also be rendered invalid if a new title is set or if
3656 * the window is destroyed.
3658 * @param obj The window object
3661 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3663 * Set the window's autodel state.
3665 * When closing the window in any way outside of the program control, like
3666 * pressing the X button in the titlebar or using a command from the
3667 * Window Manager, a "delete,request" signal is emitted to indicate that
3668 * this event occurred and the developer can take any action, which may
3669 * include, or not, destroying the window object.
3671 * When the @p autodel parameter is set, the window will be automatically
3672 * destroyed when this event occurs, after the signal is emitted.
3673 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3674 * and is up to the program to do so when it's required.
3676 * @param obj The window object
3677 * @param autodel If true, the window will automatically delete itself when
3680 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3682 * Get the window's autodel state.
3684 * @param obj The window object
3685 * @return If the window will automatically delete itself when closed
3687 * @see elm_win_autodel_set()
3689 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3691 * Activate a window object.
3693 * This function sends a request to the Window Manager to activate the
3694 * window pointed by @p obj. If honored by the WM, the window will receive
3695 * the keyboard focus.
3697 * @note This is just a request that a Window Manager may ignore, so calling
3698 * this function does not ensure in any way that the window will be the
3699 * active one after it.
3701 * @param obj The window object
3703 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3705 * Lower a window object.
3707 * Places the window pointed by @p obj at the bottom of the stack, so that
3708 * no other window is covered by it.
3710 * If elm_win_override_set() is not set, the Window Manager may ignore this
3713 * @param obj The window object
3715 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3717 * Raise a window object.
3719 * Places the window pointed by @p obj at the top of the stack, so that it's
3720 * not covered by any other window.
3722 * If elm_win_override_set() is not set, the Window Manager may ignore this
3725 * @param obj The window object
3727 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3729 * Set the borderless state of a window.
3731 * This function requests the Window Manager to not draw any decoration
3732 * around the window.
3734 * @param obj The window object
3735 * @param borderless If true, the window is borderless
3737 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3739 * Get the borderless state of a window.
3741 * @param obj The window object
3742 * @return If true, the window is borderless
3744 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3746 * Set the shaped state of a window.
3748 * Shaped windows, when supported, will render the parts of the window that
3749 * has no content, transparent.
3751 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3752 * background object or cover the entire window in any other way, or the
3753 * parts of the canvas that have no data will show framebuffer artifacts.
3755 * @param obj The window object
3756 * @param shaped If true, the window is shaped
3758 * @see elm_win_alpha_set()
3760 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3762 * Get the shaped state of a window.
3764 * @param obj The window object
3765 * @return If true, the window is shaped
3767 * @see elm_win_shaped_set()
3769 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3771 * Set the alpha channel state of a window.
3773 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3774 * possibly making parts of the window completely or partially transparent.
3775 * This is also subject to the underlying system supporting it, like for
3776 * example, running under a compositing manager. If no compositing is
3777 * available, enabling this option will instead fallback to using shaped
3778 * windows, with elm_win_shaped_set().
3780 * @param obj The window object
3781 * @param alpha If true, the window has an alpha channel
3783 * @see elm_win_alpha_set()
3785 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3787 * Get the transparency state of a window.
3789 * @param obj The window object
3790 * @return If true, the window is transparent
3792 * @see elm_win_transparent_set()
3794 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3796 * Set the transparency state of a window.
3798 * Use elm_win_alpha_set() instead.
3800 * @param obj The window object
3801 * @param transparent If true, the window is transparent
3803 * @see elm_win_alpha_set()
3805 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3807 * Get the alpha channel state of a window.
3809 * @param obj The window object
3810 * @return If true, the window has an alpha channel
3812 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3814 * Set the override state of a window.
3816 * A window with @p override set to EINA_TRUE will not be managed by the
3817 * Window Manager. This means that no decorations of any kind will be shown
3818 * for it, moving and resizing must be handled by the application, as well
3819 * as the window visibility.
3821 * This should not be used for normal windows, and even for not so normal
3822 * ones, it should only be used when there's a good reason and with a lot
3823 * of care. Mishandling override windows may result situations that
3824 * disrupt the normal workflow of the end user.
3826 * @param obj The window object
3827 * @param override If true, the window is overridden
3829 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3831 * Get the override state of a window.
3833 * @param obj The window object
3834 * @return If true, the window is overridden
3836 * @see elm_win_override_set()
3838 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3840 * Set the fullscreen state of a window.
3842 * @param obj The window object
3843 * @param fullscreen If true, the window is fullscreen
3845 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3847 * Get the fullscreen state of a window.
3849 * @param obj The window object
3850 * @return If true, the window is fullscreen
3852 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3854 * Set the maximized state of a window.
3856 * @param obj The window object
3857 * @param maximized If true, the window is maximized
3859 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3861 * Get the maximized state of a window.
3863 * @param obj The window object
3864 * @return If true, the window is maximized
3866 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3868 * Set the iconified state of a window.
3870 * @param obj The window object
3871 * @param iconified If true, the window is iconified
3873 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3875 * Get the iconified state of a window.
3877 * @param obj The window object
3878 * @return If true, the window is iconified
3880 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3882 * Set the layer of the window.
3884 * What this means exactly will depend on the underlying engine used.
3886 * In the case of X11 backed engines, the value in @p layer has the
3887 * following meanings:
3888 * @li < 3: The window will be placed below all others.
3889 * @li > 5: The window will be placed above all others.
3890 * @li other: The window will be placed in the default layer.
3892 * @param obj The window object
3893 * @param layer The layer of the window
3895 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3897 * Get the layer of the window.
3899 * @param obj The window object
3900 * @return The layer of the window
3902 * @see elm_win_layer_set()
3904 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3906 * Set the rotation of the window.
3908 * Most engines only work with multiples of 90.
3910 * This function is used to set the orientation of the window @p obj to
3911 * match that of the screen. The window itself will be resized to adjust
3912 * to the new geometry of its contents. If you want to keep the window size,
3913 * see elm_win_rotation_with_resize_set().
3915 * @param obj The window object
3916 * @param rotation The rotation of the window, in degrees (0-360),
3917 * counter-clockwise.
3919 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3921 * Rotates the window and resizes it.
3923 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3924 * that they fit inside the current window geometry.
3926 * @param obj The window object
3927 * @param layer The rotation of the window in degrees (0-360),
3928 * counter-clockwise.
3930 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3932 * Get the rotation of the window.
3934 * @param obj The window object
3935 * @return The rotation of the window in degrees (0-360)
3937 * @see elm_win_rotation_set()
3938 * @see elm_win_rotation_with_resize_set()
3940 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3942 * Set the sticky state of the window.
3944 * Hints the Window Manager that the window in @p obj should be left fixed
3945 * at its position even when the virtual desktop it's on moves or changes.
3947 * @param obj The window object
3948 * @param sticky If true, the window's sticky state is enabled
3950 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3952 * Get the sticky state of the window.
3954 * @param obj The window object
3955 * @return If true, the window's sticky state is enabled
3957 * @see elm_win_sticky_set()
3959 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961 * Set if this window is an illume conformant window
3963 * @param obj The window object
3964 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3966 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3968 * Get if this window is an illume conformant window
3970 * @param obj The window object
3971 * @return A boolean if this window is illume conformant or not
3973 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3975 * Set a window to be an illume quickpanel window
3977 * By default window objects are not quickpanel windows.
3979 * @param obj The window object
3980 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3982 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3984 * Get if this window is a quickpanel or not
3986 * @param obj The window object
3987 * @return A boolean if this window is a quickpanel or not
3989 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3991 * Set the major priority of a quickpanel window
3993 * @param obj The window object
3994 * @param priority The major priority for this quickpanel
3996 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3998 * Get the major priority of a quickpanel window
4000 * @param obj The window object
4001 * @return The major priority of this quickpanel
4003 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4005 * Set the minor priority of a quickpanel window
4007 * @param obj The window object
4008 * @param priority The minor priority for this quickpanel
4010 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4012 * Get the minor priority of a quickpanel window
4014 * @param obj The window object
4015 * @return The minor priority of this quickpanel
4017 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019 * Set which zone this quickpanel should appear in
4021 * @param obj The window object
4022 * @param zone The requested zone for this quickpanel
4024 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4026 * Get which zone this quickpanel should appear in
4028 * @param obj The window object
4029 * @return The requested zone for this quickpanel
4031 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4033 * Set the window to be skipped by keyboard focus
4035 * This sets the window to be skipped by normal keyboard input. This means
4036 * a window manager will be asked to not focus this window as well as omit
4037 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4039 * Call this and enable it on a window BEFORE you show it for the first time,
4040 * otherwise it may have no effect.
4042 * Use this for windows that have only output information or might only be
4043 * interacted with by the mouse or fingers, and never for typing input.
4044 * Be careful that this may have side-effects like making the window
4045 * non-accessible in some cases unless the window is specially handled. Use
4048 * @param obj The window object
4049 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4051 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4053 * Send a command to the windowing environment
4055 * This is intended to work in touchscreen or small screen device
4056 * environments where there is a more simplistic window management policy in
4057 * place. This uses the window object indicated to select which part of the
4058 * environment to control (the part that this window lives in), and provides
4059 * a command and an optional parameter structure (use NULL for this if not
4062 * @param obj The window object that lives in the environment to control
4063 * @param command The command to send
4064 * @param params Optional parameters for the command
4066 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4068 * Get the inlined image object handle
4070 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4071 * then the window is in fact an evas image object inlined in the parent
4072 * canvas. You can get this object (be careful to not manipulate it as it
4073 * is under control of elementary), and use it to do things like get pixel
4074 * data, save the image to a file, etc.
4076 * @param obj The window object to get the inlined image from
4077 * @return The inlined image object, or NULL if none exists
4079 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4081 * Set the enabled status for the focus highlight in a window
4083 * This function will enable or disable the focus highlight only for the
4084 * given window, regardless of the global setting for it
4086 * @param obj The window where to enable the highlight
4087 * @param enabled The enabled value for the highlight
4089 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4091 * Get the enabled value of the focus highlight for this window
4093 * @param obj The window in which to check if the focus highlight is enabled
4095 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4097 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4099 * Set the style for the focus highlight on this window
4101 * Sets the style to use for theming the highlight of focused objects on
4102 * the given window. If @p style is NULL, the default will be used.
4104 * @param obj The window where to set the style
4105 * @param style The style to set
4107 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4109 * Get the style set for the focus highlight object
4111 * Gets the style set for this windows highilght object, or NULL if none
4114 * @param obj The window to retrieve the highlights style from
4116 * @return The style set or NULL if none was. Default is used in that case.
4118 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4120 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4121 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4122 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4123 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4124 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4125 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4126 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4128 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4129 * (blank mouse, private mouse obj, defaultmouse)
4133 * Sets the keyboard mode of the window.
4135 * @param obj The window object
4136 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4138 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4140 * Gets the keyboard mode of the window.
4142 * @param obj The window object
4143 * @return The mode, one of #Elm_Win_Keyboard_Mode
4145 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4147 * Sets whether the window is a keyboard.
4149 * @param obj The window object
4150 * @param is_keyboard If true, the window is a virtual keyboard
4152 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4154 * Gets whether the window is a keyboard.
4156 * @param obj The window object
4157 * @return If the window is a virtual keyboard
4159 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4162 * Get the screen position of a window.
4164 * @param obj The window object
4165 * @param x The int to store the x coordinate to
4166 * @param y The int to store the y coordinate to
4168 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4174 * @defgroup Inwin Inwin
4176 * @image html img/widget/inwin/preview-00.png
4177 * @image latex img/widget/inwin/preview-00.eps
4178 * @image html img/widget/inwin/preview-01.png
4179 * @image latex img/widget/inwin/preview-01.eps
4180 * @image html img/widget/inwin/preview-02.png
4181 * @image latex img/widget/inwin/preview-02.eps
4183 * An inwin is a window inside a window that is useful for a quick popup.
4184 * It does not hover.
4186 * It works by creating an object that will occupy the entire window, so it
4187 * must be created using an @ref Win "elm_win" as parent only. The inwin
4188 * object can be hidden or restacked below every other object if it's
4189 * needed to show what's behind it without destroying it. If this is done,
4190 * the elm_win_inwin_activate() function can be used to bring it back to
4191 * full visibility again.
4193 * There are three styles available in the default theme. These are:
4194 * @li default: The inwin is sized to take over most of the window it's
4196 * @li minimal: The size of the inwin will be the minimum necessary to show
4198 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4199 * possible, but it's sized vertically the most it needs to fit its\
4202 * Some examples of Inwin can be found in the following:
4203 * @li @ref inwin_example_01
4208 * Adds an inwin to the current window
4210 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4211 * Never call this function with anything other than the top-most window
4212 * as its parameter, unless you are fond of undefined behavior.
4214 * After creating the object, the widget will set itself as resize object
4215 * for the window with elm_win_resize_object_add(), so when shown it will
4216 * appear to cover almost the entire window (how much of it depends on its
4217 * content and the style used). It must not be added into other container
4218 * objects and it needs not be moved or resized manually.
4220 * @param parent The parent object
4221 * @return The new object or NULL if it cannot be created
4223 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4225 * Activates an inwin object, ensuring its visibility
4227 * This function will make sure that the inwin @p obj is completely visible
4228 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4229 * to the front. It also sets the keyboard focus to it, which will be passed
4232 * The object's theme will also receive the signal "elm,action,show" with
4235 * @param obj The inwin to activate
4237 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4239 * Set the content of an inwin object.
4241 * Once the content object is set, a previously set one will be deleted.
4242 * If you want to keep that old content object, use the
4243 * elm_win_inwin_content_unset() function.
4245 * @param obj The inwin object
4246 * @param content The object to set as content
4248 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4250 * Get the content of an inwin object.
4252 * Return the content object which is set for this widget.
4254 * The returned object is valid as long as the inwin is still alive and no
4255 * other content is set on it. Deleting the object will notify the inwin
4256 * about it and this one will be left empty.
4258 * If you need to remove an inwin's content to be reused somewhere else,
4259 * see elm_win_inwin_content_unset().
4261 * @param obj The inwin object
4262 * @return The content that is being used
4264 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4266 * Unset the content of an inwin object.
4268 * Unparent and return the content object which was set for this widget.
4270 * @param obj The inwin object
4271 * @return The content that was being used
4273 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4277 /* X specific calls - won't work on non-x engines (return 0) */
4280 * Get the Ecore_X_Window of an Evas_Object
4282 * @param obj The object
4284 * @return The Ecore_X_Window of @p obj
4288 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4290 /* smart callbacks called:
4291 * "delete,request" - the user requested to delete the window
4292 * "focus,in" - window got focus
4293 * "focus,out" - window lost focus
4294 * "moved" - window that holds the canvas was moved
4300 * @image html img/widget/bg/preview-00.png
4301 * @image latex img/widget/bg/preview-00.eps
4303 * @brief Background object, used for setting a solid color, image or Edje
4304 * group as background to a window or any container object.
4306 * The bg object is used for setting a solid background to a window or
4307 * packing into any container object. It works just like an image, but has
4308 * some properties useful to a background, like setting it to tiled,
4309 * centered, scaled or stretched.
4311 * Here is some sample code using it:
4312 * @li @ref bg_01_example_page
4313 * @li @ref bg_02_example_page
4314 * @li @ref bg_03_example_page
4318 typedef enum _Elm_Bg_Option
4320 ELM_BG_OPTION_CENTER, /**< center the background */
4321 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4322 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4323 ELM_BG_OPTION_TILE /**< tile background at its original size */
4327 * Add a new background to the parent
4329 * @param parent The parent object
4330 * @return The new object or NULL if it cannot be created
4334 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4337 * Set the file (image or edje) used for the background
4339 * @param obj The bg object
4340 * @param file The file path
4341 * @param group Optional key (group in Edje) within the file
4343 * This sets the image file used in the background object. The image (or edje)
4344 * will be stretched (retaining aspect if its an image file) to completely fill
4345 * the bg object. This may mean some parts are not visible.
4347 * @note Once the image of @p obj is set, a previously set one will be deleted,
4348 * even if @p file is NULL.
4352 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4355 * Get the file (image or edje) used for the background
4357 * @param obj The bg object
4358 * @param file The file path
4359 * @param group Optional key (group in Edje) within the file
4363 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4366 * Set the option used for the background image
4368 * @param obj The bg object
4369 * @param option The desired background option (TILE, SCALE)
4371 * This sets the option used for manipulating the display of the background
4372 * image. The image can be tiled or scaled.
4376 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4379 * Get the option used for the background image
4381 * @param obj The bg object
4382 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4386 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4388 * Set the option used for the background color
4390 * @param obj The bg object
4395 * This sets the color used for the background rectangle. Its range goes
4400 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4402 * Get the option used for the background color
4404 * @param obj The bg object
4411 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4414 * Set the overlay object used for the background object.
4416 * @param obj The bg object
4417 * @param overlay The overlay object
4419 * This provides a way for elm_bg to have an 'overlay' that will be on top
4420 * of the bg. Once the over object is set, a previously set one will be
4421 * deleted, even if you set the new one to NULL. If you want to keep that
4422 * old content object, use the elm_bg_overlay_unset() function.
4427 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4430 * Get the overlay object used for the background object.
4432 * @param obj The bg object
4433 * @return The content that is being used
4435 * Return the content object which is set for this widget
4439 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4442 * Get the overlay object used for the background object.
4444 * @param obj The bg object
4445 * @return The content that was being used
4447 * Unparent and return the overlay object which was set for this widget
4451 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4454 * Set the size of the pixmap representation of the image.
4456 * This option just makes sense if an image is going to be set in the bg.
4458 * @param obj The bg object
4459 * @param w The new width of the image pixmap representation.
4460 * @param h The new height of the image pixmap representation.
4462 * This function sets a new size for pixmap representation of the given bg
4463 * image. It allows the image to be loaded already in the specified size,
4464 * reducing the memory usage and load time when loading a big image with load
4465 * size set to a smaller size.
4467 * NOTE: this is just a hint, the real size of the pixmap may differ
4468 * depending on the type of image being loaded, being bigger than requested.
4472 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4473 /* smart callbacks called:
4477 * @defgroup Icon Icon
4479 * @image html img/widget/icon/preview-00.png
4480 * @image latex img/widget/icon/preview-00.eps
4482 * An object that provides standard icon images (delete, edit, arrows, etc.)
4483 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4485 * The icon image requested can be in the elementary theme, or in the
4486 * freedesktop.org paths. It's possible to set the order of preference from
4487 * where the image will be used.
4489 * This API is very similar to @ref Image, but with ready to use images.
4491 * Default images provided by the theme are described below.
4493 * The first list contains icons that were first intended to be used in
4494 * toolbars, but can be used in many other places too:
4510 * Now some icons that were designed to be used in menus (but again, you can
4511 * use them anywhere else):
4516 * @li menu/arrow_down
4517 * @li menu/arrow_left
4518 * @li menu/arrow_right
4527 * And here we have some media player specific icons:
4528 * @li media_player/forward
4529 * @li media_player/info
4530 * @li media_player/next
4531 * @li media_player/pause
4532 * @li media_player/play
4533 * @li media_player/prev
4534 * @li media_player/rewind
4535 * @li media_player/stop
4537 * Signals that you can add callbacks for are:
4539 * "clicked" - This is called when a user has clicked the icon
4541 * An example of usage for this API follows:
4542 * @li @ref tutorial_icon
4550 typedef enum _Elm_Icon_Type
4557 * @enum _Elm_Icon_Lookup_Order
4558 * @typedef Elm_Icon_Lookup_Order
4560 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4561 * theme, FDO paths, or both?
4565 typedef enum _Elm_Icon_Lookup_Order
4567 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4568 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4569 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4570 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4571 } Elm_Icon_Lookup_Order;
4574 * Add a new icon object to the parent.
4576 * @param parent The parent object
4577 * @return The new object or NULL if it cannot be created
4579 * @see elm_icon_file_set()
4583 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4585 * Set the file that will be used as icon.
4587 * @param obj The icon object
4588 * @param file The path to file that will be used as icon image
4589 * @param group The group that the icon belongs to in edje file
4591 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4593 * @note The icon image set by this function can be changed by
4594 * elm_icon_standard_set().
4596 * @see elm_icon_file_get()
4600 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4602 * Set a location in memory to be used as an icon
4604 * @param obj The icon object
4605 * @param img The binary data that will be used as an image
4606 * @param size The size of binary data @p img
4607 * @param format Optional format of @p img to pass to the image loader
4608 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4610 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4612 * @note The icon image set by this function can be changed by
4613 * elm_icon_standard_set().
4617 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);
4619 * Get the file that will be used as icon.
4621 * @param obj The icon object
4622 * @param file The path to file that will be used as icon icon image
4623 * @param group The group that the icon belongs to in edje file
4625 * @see elm_icon_file_set()
4629 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4630 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4632 * Set the icon by icon standards names.
4634 * @param obj The icon object
4635 * @param name The icon name
4637 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4639 * For example, freedesktop.org defines standard icon names such as "home",
4640 * "network", etc. There can be different icon sets to match those icon
4641 * keys. The @p name given as parameter is one of these "keys", and will be
4642 * used to look in the freedesktop.org paths and elementary theme. One can
4643 * change the lookup order with elm_icon_order_lookup_set().
4645 * If name is not found in any of the expected locations and it is the
4646 * absolute path of an image file, this image will be used.
4648 * @note The icon image set by this function can be changed by
4649 * elm_icon_file_set().
4651 * @see elm_icon_standard_get()
4652 * @see elm_icon_file_set()
4656 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4658 * Get the icon name set by icon standard names.
4660 * @param obj The icon object
4661 * @return The icon name
4663 * If the icon image was set using elm_icon_file_set() instead of
4664 * elm_icon_standard_set(), then this function will return @c NULL.
4666 * @see elm_icon_standard_set()
4670 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4672 * Set the smooth effect for an icon object.
4674 * @param obj The icon object
4675 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4676 * otherwise. Default is @c EINA_TRUE.
4678 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4679 * scaling provides a better resulting image, but is slower.
4681 * The smooth scaling should be disabled when making animations that change
4682 * the icon size, since they will be faster. Animations that don't require
4683 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4684 * is already scaled, since the scaled icon image will be cached).
4686 * @see elm_icon_smooth_get()
4690 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4692 * Get the smooth effect for an icon object.
4694 * @param obj The icon object
4695 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4697 * @see elm_icon_smooth_set()
4701 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4703 * Disable scaling of this object.
4705 * @param obj The icon object.
4706 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4707 * otherwise. Default is @c EINA_FALSE.
4709 * This function disables scaling of the icon object through the function
4710 * elm_object_scale_set(). However, this does not affect the object
4711 * size/resize in any way. For that effect, take a look at
4712 * elm_icon_scale_set().
4714 * @see elm_icon_no_scale_get()
4715 * @see elm_icon_scale_set()
4716 * @see elm_object_scale_set()
4720 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4722 * Get whether scaling is disabled on the object.
4724 * @param obj The icon object
4725 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4727 * @see elm_icon_no_scale_set()
4731 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4733 * Set if the object is (up/down) resizable.
4735 * @param obj The icon object
4736 * @param scale_up A bool to set if the object is resizable up. Default is
4738 * @param scale_down A bool to set if the object is resizable down. Default
4741 * This function limits the icon object resize ability. If @p scale_up is set to
4742 * @c EINA_FALSE, the object can't have its height or width resized to a value
4743 * higher than the original icon size. Same is valid for @p scale_down.
4745 * @see elm_icon_scale_get()
4749 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4751 * Get if the object is (up/down) resizable.
4753 * @param obj The icon object
4754 * @param scale_up A bool to set if the object is resizable up
4755 * @param scale_down A bool to set if the object is resizable down
4757 * @see elm_icon_scale_set()
4761 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4763 * Get the object's image size
4765 * @param obj The icon object
4766 * @param w A pointer to store the width in
4767 * @param h A pointer to store the height in
4771 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4773 * Set if the icon fill the entire object area.
4775 * @param obj The icon object
4776 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4777 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4779 * When the icon object is resized to a different aspect ratio from the
4780 * original icon image, the icon image will still keep its aspect. This flag
4781 * tells how the image should fill the object's area. They are: keep the
4782 * entire icon inside the limits of height and width of the object (@p
4783 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4784 * of the object, and the icon will fill the entire object (@p fill_outside
4787 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4788 * retain property to false. Thus, the icon image will always keep its
4789 * original aspect ratio.
4791 * @see elm_icon_fill_outside_get()
4792 * @see elm_image_fill_outside_set()
4796 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4798 * Get if the object is filled outside.
4800 * @param obj The icon object
4801 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4803 * @see elm_icon_fill_outside_set()
4807 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4809 * Set the prescale size for the icon.
4811 * @param obj The icon object
4812 * @param size The prescale size. This value is used for both width and
4815 * This function sets a new size for pixmap representation of the given
4816 * icon. It allows the icon to be loaded already in the specified size,
4817 * reducing the memory usage and load time when loading a big icon with load
4818 * size set to a smaller size.
4820 * It's equivalent to the elm_bg_load_size_set() function for bg.
4822 * @note this is just a hint, the real size of the pixmap may differ
4823 * depending on the type of icon being loaded, being bigger than requested.
4825 * @see elm_icon_prescale_get()
4826 * @see elm_bg_load_size_set()
4830 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4832 * Get the prescale size for the icon.
4834 * @param obj The icon object
4835 * @return The prescale size
4837 * @see elm_icon_prescale_set()
4841 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4843 * Sets the icon lookup order used by elm_icon_standard_set().
4845 * @param obj The icon object
4846 * @param order The icon lookup order (can be one of
4847 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4848 * or ELM_ICON_LOOKUP_THEME)
4850 * @see elm_icon_order_lookup_get()
4851 * @see Elm_Icon_Lookup_Order
4855 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4857 * Gets the icon lookup order.
4859 * @param obj The icon object
4860 * @return The icon lookup order
4862 * @see elm_icon_order_lookup_set()
4863 * @see Elm_Icon_Lookup_Order
4867 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4869 * Get if the icon supports animation or not.
4871 * @param obj The icon object
4872 * @return @c EINA_TRUE if the icon supports animation,
4873 * @c EINA_FALSE otherwise.
4875 * Return if this elm icon's image can be animated. Currently Evas only
4876 * supports gif animation. If the return value is EINA_FALSE, other
4877 * elm_icon_animated_XXX APIs won't work.
4880 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882 * Set animation mode of the icon.
4884 * @param obj The icon object
4885 * @param anim @c EINA_TRUE if the object do animation job,
4886 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4888 * Even though elm icon's file can be animated,
4889 * sometimes appication developer want to just first page of image.
4890 * In that time, don't call this function, because default value is EINA_FALSE
4891 * Only when you want icon support anition,
4892 * use this function and set animated to EINA_TURE
4895 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4897 * Get animation mode of the icon.
4899 * @param obj The icon object
4900 * @return The animation mode of the icon object
4901 * @see elm_icon_animated_set
4904 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4906 * Set animation play mode of the icon.
4908 * @param obj The icon object
4909 * @param play @c EINA_TRUE the object play animation images,
4910 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4912 * If you want to play elm icon's animation, you set play to EINA_TURE.
4913 * For example, you make gif player using this set/get API and click event.
4915 * 1. Click event occurs
4916 * 2. Check play flag using elm_icon_animaged_play_get
4917 * 3. If elm icon was playing, set play to EINA_FALSE.
4918 * Then animation will be stopped and vice versa
4921 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4923 * Get animation play mode of the icon.
4925 * @param obj The icon object
4926 * @return The play mode of the icon object
4928 * @see elm_icon_animated_lay_get
4931 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4938 * @defgroup Image Image
4940 * @image html img/widget/image/preview-00.png
4941 * @image latex img/widget/image/preview-00.eps
4944 * An object that allows one to load an image file to it. It can be used
4945 * anywhere like any other elementary widget.
4947 * This widget provides most of the functionality provided from @ref Bg or @ref
4948 * Icon, but with a slightly different API (use the one that fits better your
4951 * The features not provided by those two other image widgets are:
4952 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4953 * @li change the object orientation with elm_image_orient_set();
4954 * @li and turning the image editable with elm_image_editable_set().
4956 * Signals that you can add callbacks for are:
4958 * @li @c "clicked" - This is called when a user has clicked the image
4960 * An example of usage for this API follows:
4961 * @li @ref tutorial_image
4970 * @enum _Elm_Image_Orient
4971 * @typedef Elm_Image_Orient
4973 * Possible orientation options for elm_image_orient_set().
4975 * @image html elm_image_orient_set.png
4976 * @image latex elm_image_orient_set.eps width=\textwidth
4980 typedef enum _Elm_Image_Orient
4982 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4983 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4984 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4985 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4986 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4987 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4988 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4989 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4993 * Add a new image to the parent.
4995 * @param parent The parent object
4996 * @return The new object or NULL if it cannot be created
4998 * @see elm_image_file_set()
5002 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5004 * Set the file that will be used as image.
5006 * @param obj The image object
5007 * @param file The path to file that will be used as image
5008 * @param group The group that the image belongs in edje file (if it's an
5011 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5013 * @see elm_image_file_get()
5017 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5019 * Get the file that will be used as image.
5021 * @param obj The image object
5022 * @param file The path to file
5023 * @param group The group that the image belongs in edje file
5025 * @see elm_image_file_set()
5029 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5031 * Set the smooth effect for an image.
5033 * @param obj The image object
5034 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5035 * otherwise. Default is @c EINA_TRUE.
5037 * Set the scaling algorithm to be used when scaling the image. Smooth
5038 * scaling provides a better resulting image, but is slower.
5040 * The smooth scaling should be disabled when making animations that change
5041 * the image size, since it will be faster. Animations that don't require
5042 * resizing of the image can keep the smooth scaling enabled (even if the
5043 * image is already scaled, since the scaled image will be cached).
5045 * @see elm_image_smooth_get()
5049 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5051 * Get the smooth effect for an image.
5053 * @param obj The image object
5054 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5056 * @see elm_image_smooth_get()
5060 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5062 * Gets the current size of the image.
5064 * @param obj The image object.
5065 * @param w Pointer to store width, or NULL.
5066 * @param h Pointer to store height, or NULL.
5068 * This is the real size of the image, not the size of the object.
5070 * On error, neither w or h will be written.
5074 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5076 * Disable scaling of this object.
5078 * @param obj The image object.
5079 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5080 * otherwise. Default is @c EINA_FALSE.
5082 * This function disables scaling of the elm_image widget through the
5083 * function elm_object_scale_set(). However, this does not affect the widget
5084 * size/resize in any way. For that effect, take a look at
5085 * elm_image_scale_set().
5087 * @see elm_image_no_scale_get()
5088 * @see elm_image_scale_set()
5089 * @see elm_object_scale_set()
5093 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5095 * Get whether scaling is disabled on the object.
5097 * @param obj The image object
5098 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5100 * @see elm_image_no_scale_set()
5104 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5106 * Set if the object is (up/down) resizable.
5108 * @param obj The image object
5109 * @param scale_up A bool to set if the object is resizable up. Default is
5111 * @param scale_down A bool to set if the object is resizable down. Default
5114 * This function limits the image resize ability. If @p scale_up is set to
5115 * @c EINA_FALSE, the object can't have its height or width resized to a value
5116 * higher than the original image size. Same is valid for @p scale_down.
5118 * @see elm_image_scale_get()
5122 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5124 * Get if the object is (up/down) resizable.
5126 * @param obj The image object
5127 * @param scale_up A bool to set if the object is resizable up
5128 * @param scale_down A bool to set if the object is resizable down
5130 * @see elm_image_scale_set()
5134 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5136 * Set if the image fill the entire object area when keeping the aspect ratio.
5138 * @param obj The image object
5139 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5140 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5142 * When the image should keep its aspect ratio even if resized to another
5143 * aspect ratio, there are two possibilities to resize it: keep the entire
5144 * image inside the limits of height and width of the object (@p fill_outside
5145 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5146 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5148 * @note This option will have no effect if
5149 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5151 * @see elm_image_fill_outside_get()
5152 * @see elm_image_aspect_ratio_retained_set()
5156 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5158 * Get if the object is filled outside
5160 * @param obj The image object
5161 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5163 * @see elm_image_fill_outside_set()
5167 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5169 * Set the prescale size for the image
5171 * @param obj The image object
5172 * @param size The prescale size. This value is used for both width and
5175 * This function sets a new size for pixmap representation of the given
5176 * image. It allows the image to be loaded already in the specified size,
5177 * reducing the memory usage and load time when loading a big image with load
5178 * size set to a smaller size.
5180 * It's equivalent to the elm_bg_load_size_set() function for bg.
5182 * @note this is just a hint, the real size of the pixmap may differ
5183 * depending on the type of image being loaded, being bigger than requested.
5185 * @see elm_image_prescale_get()
5186 * @see elm_bg_load_size_set()
5190 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5192 * Get the prescale size for the image
5194 * @param obj The image object
5195 * @return The prescale size
5197 * @see elm_image_prescale_set()
5201 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5203 * Set the image orientation.
5205 * @param obj The image object
5206 * @param orient The image orientation
5207 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5208 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5209 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5210 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5211 * Default is #ELM_IMAGE_ORIENT_NONE.
5213 * This function allows to rotate or flip the given image.
5215 * @see elm_image_orient_get()
5216 * @see @ref Elm_Image_Orient
5220 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5222 * Get the image orientation.
5224 * @param obj The image object
5225 * @return The image orientation
5226 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5227 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5228 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5229 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5231 * @see elm_image_orient_set()
5232 * @see @ref Elm_Image_Orient
5236 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5238 * Make the image 'editable'.
5240 * @param obj Image object.
5241 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5243 * This means the image is a valid drag target for drag and drop, and can be
5244 * cut or pasted too.
5248 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5250 * Make the image 'editable'.
5252 * @param obj Image object.
5253 * @return Editability.
5255 * This means the image is a valid drag target for drag and drop, and can be
5256 * cut or pasted too.
5260 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5262 * Get the basic Evas_Image object from this object (widget).
5264 * @param obj The image object to get the inlined image from
5265 * @return The inlined image object, or NULL if none exists
5267 * This function allows one to get the underlying @c Evas_Object of type
5268 * Image from this elementary widget. It can be useful to do things like get
5269 * the pixel data, save the image to a file, etc.
5271 * @note Be careful to not manipulate it, as it is under control of
5276 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5278 * Set whether the original aspect ratio of the image should be kept on resize.
5280 * @param obj The image object.
5281 * @param retained @c EINA_TRUE if the image should retain the aspect,
5282 * @c EINA_FALSE otherwise.
5284 * The original aspect ratio (width / height) of the image is usually
5285 * distorted to match the object's size. Enabling this option will retain
5286 * this original aspect, and the way that the image is fit into the object's
5287 * area depends on the option set by elm_image_fill_outside_set().
5289 * @see elm_image_aspect_ratio_retained_get()
5290 * @see elm_image_fill_outside_set()
5294 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5296 * Get if the object retains the original aspect ratio.
5298 * @param obj The image object.
5299 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5304 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5306 /* smart callbacks called:
5307 * "clicked" - the user clicked the image
5315 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5317 typedef enum _Elm_GLView_Mode
5319 ELM_GLVIEW_ALPHA = 1,
5320 ELM_GLVIEW_DEPTH = 2,
5321 ELM_GLVIEW_STENCIL = 4
5325 * Defines a policy for the glview resizing.
5327 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5329 typedef enum _Elm_GLView_Resize_Policy
5331 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5332 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5333 } Elm_GLView_Resize_Policy;
5335 typedef enum _Elm_GLView_Render_Policy
5337 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5338 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5339 } Elm_GLView_Render_Policy;
5344 * A simple GLView widget that allows GL rendering.
5346 * Signals that you can add callbacks for are:
5352 * Add a new glview to the parent
5354 * @param parent The parent object
5355 * @return The new object or NULL if it cannot be created
5359 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5362 * Sets the size of the glview
5364 * @param obj The glview object
5365 * @param width width of the glview object
5366 * @param height height of the glview object
5370 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5373 * Gets the size of the glview.
5375 * @param obj The glview object
5376 * @param width width of the glview object
5377 * @param height height of the glview object
5379 * Note that this function returns the actual image size of the
5380 * glview. This means that when the scale policy is set to
5381 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5386 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5389 * Gets the gl api struct for gl rendering
5391 * @param obj The glview object
5392 * @return The api object or NULL if it cannot be created
5396 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5399 * Set the mode of the GLView. Supports Three simple modes.
5401 * @param obj The glview object
5402 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5403 * @return True if set properly.
5407 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5410 * Set the resize policy for the glview object.
5412 * @param obj The glview object.
5413 * @param policy The scaling policy.
5415 * By default, the resize policy is set to
5416 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5417 * destroys the previous surface and recreates the newly specified
5418 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5419 * however, glview only scales the image object and not the underlying
5424 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5427 * Set the render policy for the glview object.
5429 * @param obj The glview object.
5430 * @param policy The render policy.
5432 * By default, the render policy is set to
5433 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5434 * that during the render loop, glview is only redrawn if it needs
5435 * to be redrawn. (i.e. When it is visible) If the policy is set to
5436 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5437 * whether it is visible/need redrawing or not.
5441 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5444 * Set the init function that runs once in the main loop.
5446 * @param obj The glview object.
5447 * @param func The init function to be registered.
5449 * The registered init function gets called once during the render loop.
5453 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5456 * Set the render function that runs in the main loop.
5458 * @param obj The glview object.
5459 * @param func The delete function to be registered.
5461 * The registered del function gets called when GLView object is deleted.
5465 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5468 * Set the resize function that gets called when resize happens.
5470 * @param obj The glview object.
5471 * @param func The resize function to be registered.
5475 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5478 * Set the render function that runs in the main loop.
5480 * @param obj The glview object.
5481 * @param func The render function to be registered.
5485 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5488 * Notifies that there has been changes in the GLView.
5490 * @param obj The glview object.
5494 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5504 * @image html img/widget/box/preview-00.png
5505 * @image latex img/widget/box/preview-00.eps width=\textwidth
5507 * @image html img/box.png
5508 * @image latex img/box.eps width=\textwidth
5510 * A box arranges objects in a linear fashion, governed by a layout function
5511 * that defines the details of this arrangement.
5513 * By default, the box will use an internal function to set the layout to
5514 * a single row, either vertical or horizontal. This layout is affected
5515 * by a number of parameters, such as the homogeneous flag set by
5516 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5517 * elm_box_align_set() and the hints set to each object in the box.
5519 * For this default layout, it's possible to change the orientation with
5520 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5521 * placing its elements ordered from top to bottom. When horizontal is set,
5522 * the order will go from left to right. If the box is set to be
5523 * homogeneous, every object in it will be assigned the same space, that
5524 * of the largest object. Padding can be used to set some spacing between
5525 * the cell given to each object. The alignment of the box, set with
5526 * elm_box_align_set(), determines how the bounding box of all the elements
5527 * will be placed within the space given to the box widget itself.
5529 * The size hints of each object also affect how they are placed and sized
5530 * within the box. evas_object_size_hint_min_set() will give the minimum
5531 * size the object can have, and the box will use it as the basis for all
5532 * latter calculations. Elementary widgets set their own minimum size as
5533 * needed, so there's rarely any need to use it manually.
5535 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5536 * used to tell whether the object will be allocated the minimum size it
5537 * needs or if the space given to it should be expanded. It's important
5538 * to realize that expanding the size given to the object is not the same
5539 * thing as resizing the object. It could very well end being a small
5540 * widget floating in a much larger empty space. If not set, the weight
5541 * for objects will normally be 0.0 for both axis, meaning the widget will
5542 * not be expanded. To take as much space possible, set the weight to
5543 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5545 * Besides how much space each object is allocated, it's possible to control
5546 * how the widget will be placed within that space using
5547 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5548 * for both axis, meaning the object will be centered, but any value from
5549 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5550 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5551 * is -1.0, means the object will be resized to fill the entire space it
5554 * In addition, customized functions to define the layout can be set, which
5555 * allow the application developer to organize the objects within the box
5556 * in any number of ways.
5558 * The special elm_box_layout_transition() function can be used
5559 * to switch from one layout to another, animating the motion of the
5560 * children of the box.
5562 * @note Objects should not be added to box objects using _add() calls.
5564 * Some examples on how to use boxes follow:
5565 * @li @ref box_example_01
5566 * @li @ref box_example_02
5571 * @typedef Elm_Box_Transition
5573 * Opaque handler containing the parameters to perform an animated
5574 * transition of the layout the box uses.
5576 * @see elm_box_transition_new()
5577 * @see elm_box_layout_set()
5578 * @see elm_box_layout_transition()
5580 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5583 * Add a new box to the parent
5585 * By default, the box will be in vertical mode and non-homogeneous.
5587 * @param parent The parent object
5588 * @return The new object or NULL if it cannot be created
5590 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5592 * Set the horizontal orientation
5594 * By default, box object arranges their contents vertically from top to
5596 * By calling this function with @p horizontal as EINA_TRUE, the box will
5597 * become horizontal, arranging contents from left to right.
5599 * @note This flag is ignored if a custom layout function is set.
5601 * @param obj The box object
5602 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5603 * EINA_FALSE = vertical)
5605 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5607 * Get the horizontal orientation
5609 * @param obj The box object
5610 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5612 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5614 * Set the box to arrange its children homogeneously
5616 * If enabled, homogeneous layout makes all items the same size, according
5617 * to the size of the largest of its children.
5619 * @note This flag is ignored if a custom layout function is set.
5621 * @param obj The box object
5622 * @param homogeneous The homogeneous flag
5624 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5626 * Get whether the box is using homogeneous mode or not
5628 * @param obj The box object
5629 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5631 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5632 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5633 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5635 * Add an object to the beginning of the pack list
5637 * Pack @p subobj into the box @p obj, placing it first in the list of
5638 * children objects. The actual position the object will get on screen
5639 * depends on the layout used. If no custom layout is set, it will be at
5640 * the top or left, depending if the box is vertical or horizontal,
5643 * @param obj The box object
5644 * @param subobj The object to add to the box
5646 * @see elm_box_pack_end()
5647 * @see elm_box_pack_before()
5648 * @see elm_box_pack_after()
5649 * @see elm_box_unpack()
5650 * @see elm_box_unpack_all()
5651 * @see elm_box_clear()
5653 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5655 * Add an object at the end of the pack list
5657 * Pack @p subobj into the box @p obj, placing it last in the list of
5658 * children objects. The actual position the object will get on screen
5659 * depends on the layout used. If no custom layout is set, it will be at
5660 * the bottom or right, depending if the box is vertical or horizontal,
5663 * @param obj The box object
5664 * @param subobj The object to add to the box
5666 * @see elm_box_pack_start()
5667 * @see elm_box_pack_before()
5668 * @see elm_box_pack_after()
5669 * @see elm_box_unpack()
5670 * @see elm_box_unpack_all()
5671 * @see elm_box_clear()
5673 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5675 * Adds an object to the box before the indicated object
5677 * This will add the @p subobj to the box indicated before the object
5678 * indicated with @p before. If @p before is not already in the box, results
5679 * are undefined. Before means either to the left of the indicated object or
5680 * above it depending on orientation.
5682 * @param obj The box object
5683 * @param subobj The object to add to the box
5684 * @param before The object before which to add it
5686 * @see elm_box_pack_start()
5687 * @see elm_box_pack_end()
5688 * @see elm_box_pack_after()
5689 * @see elm_box_unpack()
5690 * @see elm_box_unpack_all()
5691 * @see elm_box_clear()
5693 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5695 * Adds an object to the box after the indicated object
5697 * This will add the @p subobj to the box indicated after the object
5698 * indicated with @p after. If @p after is not already in the box, results
5699 * are undefined. After means either to the right of the indicated object or
5700 * below it depending on orientation.
5702 * @param obj The box object
5703 * @param subobj The object to add to the box
5704 * @param after The object after which to add it
5706 * @see elm_box_pack_start()
5707 * @see elm_box_pack_end()
5708 * @see elm_box_pack_before()
5709 * @see elm_box_unpack()
5710 * @see elm_box_unpack_all()
5711 * @see elm_box_clear()
5713 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5715 * Clear the box of all children
5717 * Remove all the elements contained by the box, deleting the respective
5720 * @param obj The box object
5722 * @see elm_box_unpack()
5723 * @see elm_box_unpack_all()
5725 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5729 * Remove the object given by @p subobj from the box @p obj without
5732 * @param obj The box object
5734 * @see elm_box_unpack_all()
5735 * @see elm_box_clear()
5737 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5739 * Remove all items from the box, without deleting them
5741 * Clear the box from all children, but don't delete the respective objects.
5742 * If no other references of the box children exist, the objects will never
5743 * be deleted, and thus the application will leak the memory. Make sure
5744 * when using this function that you hold a reference to all the objects
5745 * in the box @p obj.
5747 * @param obj The box object
5749 * @see elm_box_clear()
5750 * @see elm_box_unpack()
5752 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5754 * Retrieve a list of the objects packed into the box
5756 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5757 * The order of the list corresponds to the packing order the box uses.
5759 * You must free this list with eina_list_free() once you are done with it.
5761 * @param obj The box object
5763 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5765 * Set the space (padding) between the box's elements.
5767 * Extra space in pixels that will be added between a box child and its
5768 * neighbors after its containing cell has been calculated. This padding
5769 * is set for all elements in the box, besides any possible padding that
5770 * individual elements may have through their size hints.
5772 * @param obj The box object
5773 * @param horizontal The horizontal space between elements
5774 * @param vertical The vertical space between elements
5776 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5778 * Get the space (padding) between the box's elements.
5780 * @param obj The box object
5781 * @param horizontal The horizontal space between elements
5782 * @param vertical The vertical space between elements
5784 * @see elm_box_padding_set()
5786 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5788 * Set the alignment of the whole bouding box of contents.
5790 * Sets how the bounding box containing all the elements of the box, after
5791 * their sizes and position has been calculated, will be aligned within
5792 * the space given for the whole box widget.
5794 * @param obj The box object
5795 * @param horizontal The horizontal alignment of elements
5796 * @param vertical The vertical alignment of elements
5798 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5800 * Get the alignment of the whole bouding box of contents.
5802 * @param obj The box object
5803 * @param horizontal The horizontal alignment of elements
5804 * @param vertical The vertical alignment of elements
5806 * @see elm_box_align_set()
5808 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5811 * Set the layout defining function to be used by the box
5813 * Whenever anything changes that requires the box in @p obj to recalculate
5814 * the size and position of its elements, the function @p cb will be called
5815 * to determine what the layout of the children will be.
5817 * Once a custom function is set, everything about the children layout
5818 * is defined by it. The flags set by elm_box_horizontal_set() and
5819 * elm_box_homogeneous_set() no longer have any meaning, and the values
5820 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5821 * layout function to decide if they are used and how. These last two
5822 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5823 * passed to @p cb. The @c Evas_Object the function receives is not the
5824 * Elementary widget, but the internal Evas Box it uses, so none of the
5825 * functions described here can be used on it.
5827 * Any of the layout functions in @c Evas can be used here, as well as the
5828 * special elm_box_layout_transition().
5830 * The final @p data argument received by @p cb is the same @p data passed
5831 * here, and the @p free_data function will be called to free it
5832 * whenever the box is destroyed or another layout function is set.
5834 * Setting @p cb to NULL will revert back to the default layout function.
5836 * @param obj The box object
5837 * @param cb The callback function used for layout
5838 * @param data Data that will be passed to layout function
5839 * @param free_data Function called to free @p data
5841 * @see elm_box_layout_transition()
5843 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);
5845 * Special layout function that animates the transition from one layout to another
5847 * Normally, when switching the layout function for a box, this will be
5848 * reflected immediately on screen on the next render, but it's also
5849 * possible to do this through an animated transition.
5851 * This is done by creating an ::Elm_Box_Transition and setting the box
5852 * layout to this function.
5856 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5857 * evas_object_box_layout_vertical, // start
5858 * NULL, // data for initial layout
5859 * NULL, // free function for initial data
5860 * evas_object_box_layout_horizontal, // end
5861 * NULL, // data for final layout
5862 * NULL, // free function for final data
5863 * anim_end, // will be called when animation ends
5864 * NULL); // data for anim_end function\
5865 * elm_box_layout_set(box, elm_box_layout_transition, t,
5866 * elm_box_transition_free);
5869 * @note This function can only be used with elm_box_layout_set(). Calling
5870 * it directly will not have the expected results.
5872 * @see elm_box_transition_new
5873 * @see elm_box_transition_free
5874 * @see elm_box_layout_set
5876 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5878 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5880 * If you want to animate the change from one layout to another, you need
5881 * to set the layout function of the box to elm_box_layout_transition(),
5882 * passing as user data to it an instance of ::Elm_Box_Transition with the
5883 * necessary information to perform this animation. The free function to
5884 * set for the layout is elm_box_transition_free().
5886 * The parameters to create an ::Elm_Box_Transition sum up to how long
5887 * will it be, in seconds, a layout function to describe the initial point,
5888 * another for the final position of the children and one function to be
5889 * called when the whole animation ends. This last function is useful to
5890 * set the definitive layout for the box, usually the same as the end
5891 * layout for the animation, but could be used to start another transition.
5893 * @param start_layout The layout function that will be used to start the animation
5894 * @param start_layout_data The data to be passed the @p start_layout function
5895 * @param start_layout_free_data Function to free @p start_layout_data
5896 * @param end_layout The layout function that will be used to end the animation
5897 * @param end_layout_free_data The data to be passed the @p end_layout function
5898 * @param end_layout_free_data Function to free @p end_layout_data
5899 * @param transition_end_cb Callback function called when animation ends
5900 * @param transition_end_data Data to be passed to @p transition_end_cb
5901 * @return An instance of ::Elm_Box_Transition
5903 * @see elm_box_transition_new
5904 * @see elm_box_layout_transition
5906 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);
5908 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5910 * This function is mostly useful as the @c free_data parameter in
5911 * elm_box_layout_set() when elm_box_layout_transition().
5913 * @param data The Elm_Box_Transition instance to be freed.
5915 * @see elm_box_transition_new
5916 * @see elm_box_layout_transition
5918 EAPI void elm_box_transition_free(void *data);
5925 * @defgroup Button Button
5927 * @image html img/widget/button/preview-00.png
5928 * @image latex img/widget/button/preview-00.eps
5929 * @image html img/widget/button/preview-01.png
5930 * @image latex img/widget/button/preview-01.eps
5931 * @image html img/widget/button/preview-02.png
5932 * @image latex img/widget/button/preview-02.eps
5934 * This is a push-button. Press it and run some function. It can contain
5935 * a simple label and icon object and it also has an autorepeat feature.
5937 * This widgets emits the following signals:
5938 * @li "clicked": the user clicked the button (press/release).
5939 * @li "repeated": the user pressed the button without releasing it.
5940 * @li "pressed": button was pressed.
5941 * @li "unpressed": button was released after being pressed.
5942 * In all three cases, the @c event parameter of the callback will be
5945 * Also, defined in the default theme, the button has the following styles
5947 * @li default: a normal button.
5948 * @li anchor: Like default, but the button fades away when the mouse is not
5949 * over it, leaving only the text or icon.
5950 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5951 * continuous look across its options.
5952 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5954 * Follow through a complete example @ref button_example_01 "here".
5958 * Add a new button to the parent's canvas
5960 * @param parent The parent object
5961 * @return The new object or NULL if it cannot be created
5963 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5965 * Set the label used in the button
5967 * The passed @p label can be NULL to clean any existing text in it and
5968 * leave the button as an icon only object.
5970 * @param obj The button object
5971 * @param label The text will be written on the button
5972 * @deprecated use elm_object_text_set() instead.
5974 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5976 * Get the label set for the button
5978 * The string returned is an internal pointer and should not be freed or
5979 * altered. It will also become invalid when the button is destroyed.
5980 * The string returned, if not NULL, is a stringshare, so if you need to
5981 * keep it around even after the button is destroyed, you can use
5982 * eina_stringshare_ref().
5984 * @param obj The button object
5985 * @return The text set to the label, or NULL if nothing is set
5986 * @deprecated use elm_object_text_set() instead.
5988 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5990 * Set the icon used for the button
5992 * Setting a new icon will delete any other that was previously set, making
5993 * any reference to them invalid. If you need to maintain the previous
5994 * object alive, unset it first with elm_button_icon_unset().
5996 * @param obj The button object
5997 * @param icon The icon object for the button
5999 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6001 * Get the icon used for the button
6003 * Return the icon object which is set for this widget. If the button is
6004 * destroyed or another icon is set, the returned object will be deleted
6005 * and any reference to it will be invalid.
6007 * @param obj The button object
6008 * @return The icon object that is being used
6010 * @see elm_button_icon_unset()
6012 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6014 * Remove the icon set without deleting it and return the object
6016 * This function drops the reference the button holds of the icon object
6017 * and returns this last object. It is used in case you want to remove any
6018 * icon, or set another one, without deleting the actual object. The button
6019 * will be left without an icon set.
6021 * @param obj The button object
6022 * @return The icon object that was being used
6024 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6026 * Turn on/off the autorepeat event generated when the button is kept pressed
6028 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6029 * signal when they are clicked.
6031 * When on, keeping a button pressed will continuously emit a @c repeated
6032 * signal until the button is released. The time it takes until it starts
6033 * emitting the signal is given by
6034 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6035 * new emission by elm_button_autorepeat_gap_timeout_set().
6037 * @param obj The button object
6038 * @param on A bool to turn on/off the event
6040 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6042 * Get whether the autorepeat feature is enabled
6044 * @param obj The button object
6045 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6047 * @see elm_button_autorepeat_set()
6049 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6051 * Set the initial timeout before the autorepeat event is generated
6053 * Sets the timeout, in seconds, since the button is pressed until the
6054 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6055 * won't be any delay and the even will be fired the moment the button is
6058 * @param obj The button object
6059 * @param t Timeout in seconds
6061 * @see elm_button_autorepeat_set()
6062 * @see elm_button_autorepeat_gap_timeout_set()
6064 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6066 * Get the initial timeout before the autorepeat event is generated
6068 * @param obj The button object
6069 * @return Timeout in seconds
6071 * @see elm_button_autorepeat_initial_timeout_set()
6073 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6075 * Set the interval between each generated autorepeat event
6077 * After the first @c repeated event is fired, all subsequent ones will
6078 * follow after a delay of @p t seconds for each.
6080 * @param obj The button object
6081 * @param t Interval in seconds
6083 * @see elm_button_autorepeat_initial_timeout_set()
6085 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6087 * Get the interval between each generated autorepeat event
6089 * @param obj The button object
6090 * @return Interval in seconds
6092 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6098 * @defgroup File_Selector_Button File Selector Button
6100 * @image html img/widget/fileselector_button/preview-00.png
6101 * @image latex img/widget/fileselector_button/preview-00.eps
6102 * @image html img/widget/fileselector_button/preview-01.png
6103 * @image latex img/widget/fileselector_button/preview-01.eps
6104 * @image html img/widget/fileselector_button/preview-02.png
6105 * @image latex img/widget/fileselector_button/preview-02.eps
6107 * This is a button that, when clicked, creates an Elementary
6108 * window (or inner window) <b> with a @ref Fileselector "file
6109 * selector widget" within</b>. When a file is chosen, the (inner)
6110 * window is closed and the button emits a signal having the
6111 * selected file as it's @c event_info.
6113 * This widget encapsulates operations on its internal file
6114 * selector on its own API. There is less control over its file
6115 * selector than that one would have instatiating one directly.
6117 * The following styles are available for this button:
6120 * @li @c "hoversel_vertical"
6121 * @li @c "hoversel_vertical_entry"
6123 * Smart callbacks one can register to:
6124 * - @c "file,chosen" - the user has selected a path, whose string
6125 * pointer comes as the @c event_info data (a stringshared
6128 * Here is an example on its usage:
6129 * @li @ref fileselector_button_example
6131 * @see @ref File_Selector_Entry for a similar widget.
6136 * Add a new file selector button widget to the given parent
6137 * Elementary (container) object
6139 * @param parent The parent object
6140 * @return a new file selector button widget handle or @c NULL, on
6143 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6146 * Set the label for a given file selector button widget
6148 * @param obj The file selector button widget
6149 * @param label The text label to be displayed on @p obj
6151 * @deprecated use elm_object_text_set() instead.
6153 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6156 * Get the label set for a given file selector button widget
6158 * @param obj The file selector button widget
6159 * @return The button label
6161 * @deprecated use elm_object_text_set() instead.
6163 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6166 * Set the icon on a given file selector button widget
6168 * @param obj The file selector button widget
6169 * @param icon The icon object for the button
6171 * Once the icon object is set, a previously set one will be
6172 * deleted. If you want to keep the latter, use the
6173 * elm_fileselector_button_icon_unset() function.
6175 * @see elm_fileselector_button_icon_get()
6177 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6180 * Get the icon set for a given file selector button widget
6182 * @param obj The file selector button widget
6183 * @return The icon object currently set on @p obj or @c NULL, if
6186 * @see elm_fileselector_button_icon_set()
6188 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6191 * Unset the icon used in a given file selector button widget
6193 * @param obj The file selector button widget
6194 * @return The icon object that was being used on @p obj or @c
6197 * Unparent and return the icon object which was set for this
6200 * @see elm_fileselector_button_icon_set()
6202 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6205 * Set the title for a given file selector button widget's window
6207 * @param obj The file selector button widget
6208 * @param title The title string
6210 * This will change the window's title, when the file selector pops
6211 * out after a click on the button. Those windows have the default
6212 * (unlocalized) value of @c "Select a file" as titles.
6214 * @note It will only take any effect if the file selector
6215 * button widget is @b not under "inwin mode".
6217 * @see elm_fileselector_button_window_title_get()
6219 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6222 * Get the title set for a given file selector button widget's
6225 * @param obj The file selector button widget
6226 * @return Title of the file selector button's window
6228 * @see elm_fileselector_button_window_title_get() for more details
6230 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6233 * Set the size of a given file selector button widget's window,
6234 * holding the file selector itself.
6236 * @param obj The file selector button widget
6237 * @param width The window's width
6238 * @param height The window's height
6240 * @note it will only take any effect if the file selector button
6241 * widget is @b not under "inwin mode". The default size for the
6242 * window (when applicable) is 400x400 pixels.
6244 * @see elm_fileselector_button_window_size_get()
6246 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6249 * Get the size of a given file selector button widget's window,
6250 * holding the file selector itself.
6252 * @param obj The file selector button widget
6253 * @param width Pointer into which to store the width value
6254 * @param height Pointer into which to store the height value
6256 * @note Use @c NULL pointers on the size values you're not
6257 * interested in: they'll be ignored by the function.
6259 * @see elm_fileselector_button_window_size_set(), for more details
6261 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6264 * Set the initial file system path for a given file selector
6267 * @param obj The file selector button widget
6268 * @param path The path string
6270 * It must be a <b>directory</b> path, which will have the contents
6271 * displayed initially in the file selector's view, when invoked
6272 * from @p obj. The default initial path is the @c "HOME"
6273 * environment variable's value.
6275 * @see elm_fileselector_button_path_get()
6277 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6280 * Get the initial file system path set for a given file selector
6283 * @param obj The file selector button widget
6284 * @return path The path string
6286 * @see elm_fileselector_button_path_set() for more details
6288 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291 * Enable/disable a tree view in the given file selector button
6292 * widget's internal file selector
6294 * @param obj The file selector button widget
6295 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6298 * This has the same effect as elm_fileselector_expandable_set(),
6299 * but now applied to a file selector button's internal file
6302 * @note There's no way to put a file selector button's internal
6303 * file selector in "grid mode", as one may do with "pure" file
6306 * @see elm_fileselector_expandable_get()
6308 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6311 * Get whether tree view is enabled for the given file selector
6312 * button widget's internal file selector
6314 * @param obj The file selector button widget
6315 * @return @c EINA_TRUE if @p obj widget's internal file selector
6316 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6318 * @see elm_fileselector_expandable_set() for more details
6320 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6323 * Set whether a given file selector button widget's internal file
6324 * selector is to display folders only or the directory contents,
6327 * @param obj The file selector button widget
6328 * @param only @c EINA_TRUE to make @p obj widget's internal file
6329 * selector only display directories, @c EINA_FALSE to make files
6330 * to be displayed in it too
6332 * This has the same effect as elm_fileselector_folder_only_set(),
6333 * but now applied to a file selector button's internal file
6336 * @see elm_fileselector_folder_only_get()
6338 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6341 * Get whether a given file selector button widget's internal file
6342 * selector is displaying folders only or the directory contents,
6345 * @param obj The file selector button widget
6346 * @return @c EINA_TRUE if @p obj widget's internal file
6347 * selector is only displaying directories, @c EINA_FALSE if files
6348 * are being displayed in it too (and on errors)
6350 * @see elm_fileselector_button_folder_only_set() for more details
6352 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6355 * Enable/disable the file name entry box where the user can type
6356 * in a name for a file, in a given file selector button widget's
6357 * internal file selector.
6359 * @param obj The file selector button widget
6360 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6361 * file selector a "saving dialog", @c EINA_FALSE otherwise
6363 * This has the same effect as elm_fileselector_is_save_set(),
6364 * but now applied to a file selector button's internal file
6367 * @see elm_fileselector_is_save_get()
6369 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6372 * Get whether the given file selector button widget's internal
6373 * file selector is in "saving dialog" mode
6375 * @param obj The file selector button widget
6376 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6377 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6380 * @see elm_fileselector_button_is_save_set() for more details
6382 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6385 * Set whether a given file selector button widget's internal file
6386 * selector will raise an Elementary "inner window", instead of a
6387 * dedicated Elementary window. By default, it won't.
6389 * @param obj The file selector button widget
6390 * @param value @c EINA_TRUE to make it use an inner window, @c
6391 * EINA_TRUE to make it use a dedicated window
6393 * @see elm_win_inwin_add() for more information on inner windows
6394 * @see elm_fileselector_button_inwin_mode_get()
6396 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6399 * Get whether a given file selector button widget's internal file
6400 * selector will raise an Elementary "inner window", instead of a
6401 * dedicated Elementary window.
6403 * @param obj The file selector button widget
6404 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6405 * if it will use a dedicated window
6407 * @see elm_fileselector_button_inwin_mode_set() for more details
6409 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6416 * @defgroup File_Selector_Entry File Selector Entry
6418 * @image html img/widget/fileselector_entry/preview-00.png
6419 * @image latex img/widget/fileselector_entry/preview-00.eps
6421 * This is an entry made to be filled with or display a <b>file
6422 * system path string</b>. Besides the entry itself, the widget has
6423 * a @ref File_Selector_Button "file selector button" on its side,
6424 * which will raise an internal @ref Fileselector "file selector widget",
6425 * when clicked, for path selection aided by file system
6428 * This file selector may appear in an Elementary window or in an
6429 * inner window. When a file is chosen from it, the (inner) window
6430 * is closed and the selected file's path string is exposed both as
6431 * an smart event and as the new text on the entry.
6433 * This widget encapsulates operations on its internal file
6434 * selector on its own API. There is less control over its file
6435 * selector than that one would have instatiating one directly.
6437 * Smart callbacks one can register to:
6438 * - @c "changed" - The text within the entry was changed
6439 * - @c "activated" - The entry has had editing finished and
6440 * changes are to be "committed"
6441 * - @c "press" - The entry has been clicked
6442 * - @c "longpressed" - The entry has been clicked (and held) for a
6444 * - @c "clicked" - The entry has been clicked
6445 * - @c "clicked,double" - The entry has been double clicked
6446 * - @c "focused" - The entry has received focus
6447 * - @c "unfocused" - The entry has lost focus
6448 * - @c "selection,paste" - A paste action has occurred on the
6450 * - @c "selection,copy" - A copy action has occurred on the entry
6451 * - @c "selection,cut" - A cut action has occurred on the entry
6452 * - @c "unpressed" - The file selector entry's button was released
6453 * after being pressed.
6454 * - @c "file,chosen" - The user has selected a path via the file
6455 * selector entry's internal file selector, whose string pointer
6456 * comes as the @c event_info data (a stringshared string)
6458 * Here is an example on its usage:
6459 * @li @ref fileselector_entry_example
6461 * @see @ref File_Selector_Button for a similar widget.
6466 * Add a new file selector entry widget to the given parent
6467 * Elementary (container) object
6469 * @param parent The parent object
6470 * @return a new file selector entry widget handle or @c NULL, on
6473 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6476 * Set the label for a given file selector entry widget's button
6478 * @param obj The file selector entry widget
6479 * @param label The text label to be displayed on @p obj widget's
6482 * @deprecated use elm_object_text_set() instead.
6484 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6487 * Get the label set for a given file selector entry widget's button
6489 * @param obj The file selector entry widget
6490 * @return The widget button's label
6492 * @deprecated use elm_object_text_set() instead.
6494 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6497 * Set the icon on a given file selector entry widget's button
6499 * @param obj The file selector entry widget
6500 * @param icon The icon object for the entry's button
6502 * Once the icon object is set, a previously set one will be
6503 * deleted. If you want to keep the latter, use the
6504 * elm_fileselector_entry_button_icon_unset() function.
6506 * @see elm_fileselector_entry_button_icon_get()
6508 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6511 * Get the icon set for a given file selector entry widget's button
6513 * @param obj The file selector entry widget
6514 * @return The icon object currently set on @p obj widget's button
6515 * or @c NULL, if none is
6517 * @see elm_fileselector_entry_button_icon_set()
6519 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6522 * Unset the icon used in a given file selector entry widget's
6525 * @param obj The file selector entry widget
6526 * @return The icon object that was being used on @p obj widget's
6527 * button or @c NULL, on errors
6529 * Unparent and return the icon object which was set for this
6532 * @see elm_fileselector_entry_button_icon_set()
6534 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6537 * Set the title for a given file selector entry widget's window
6539 * @param obj The file selector entry widget
6540 * @param title The title string
6542 * This will change the window's title, when the file selector pops
6543 * out after a click on the entry's button. Those windows have the
6544 * default (unlocalized) value of @c "Select a file" as titles.
6546 * @note It will only take any effect if the file selector
6547 * entry widget is @b not under "inwin mode".
6549 * @see elm_fileselector_entry_window_title_get()
6551 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6554 * Get the title set for a given file selector entry widget's
6557 * @param obj The file selector entry widget
6558 * @return Title of the file selector entry's window
6560 * @see elm_fileselector_entry_window_title_get() for more details
6562 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6565 * Set the size of a given file selector entry widget's window,
6566 * holding the file selector itself.
6568 * @param obj The file selector entry widget
6569 * @param width The window's width
6570 * @param height The window's height
6572 * @note it will only take any effect if the file selector entry
6573 * widget is @b not under "inwin mode". The default size for the
6574 * window (when applicable) is 400x400 pixels.
6576 * @see elm_fileselector_entry_window_size_get()
6578 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6581 * Get the size of a given file selector entry widget's window,
6582 * holding the file selector itself.
6584 * @param obj The file selector entry widget
6585 * @param width Pointer into which to store the width value
6586 * @param height Pointer into which to store the height value
6588 * @note Use @c NULL pointers on the size values you're not
6589 * interested in: they'll be ignored by the function.
6591 * @see elm_fileselector_entry_window_size_set(), for more details
6593 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6596 * Set the initial file system path and the entry's path string for
6597 * a given file selector entry widget
6599 * @param obj The file selector entry widget
6600 * @param path The path string
6602 * It must be a <b>directory</b> path, which will have the contents
6603 * displayed initially in the file selector's view, when invoked
6604 * from @p obj. The default initial path is the @c "HOME"
6605 * environment variable's value.
6607 * @see elm_fileselector_entry_path_get()
6609 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6612 * Get the entry's path string for a given file selector entry
6615 * @param obj The file selector entry widget
6616 * @return path The path string
6618 * @see elm_fileselector_entry_path_set() for more details
6620 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6623 * Enable/disable a tree view in the given file selector entry
6624 * widget's internal file selector
6626 * @param obj The file selector entry widget
6627 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6630 * This has the same effect as elm_fileselector_expandable_set(),
6631 * but now applied to a file selector entry's internal file
6634 * @note There's no way to put a file selector entry's internal
6635 * file selector in "grid mode", as one may do with "pure" file
6638 * @see elm_fileselector_expandable_get()
6640 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6643 * Get whether tree view is enabled for the given file selector
6644 * entry widget's internal file selector
6646 * @param obj The file selector entry widget
6647 * @return @c EINA_TRUE if @p obj widget's internal file selector
6648 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6650 * @see elm_fileselector_expandable_set() for more details
6652 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6655 * Set whether a given file selector entry widget's internal file
6656 * selector is to display folders only or the directory contents,
6659 * @param obj The file selector entry widget
6660 * @param only @c EINA_TRUE to make @p obj widget's internal file
6661 * selector only display directories, @c EINA_FALSE to make files
6662 * to be displayed in it too
6664 * This has the same effect as elm_fileselector_folder_only_set(),
6665 * but now applied to a file selector entry's internal file
6668 * @see elm_fileselector_folder_only_get()
6670 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6673 * Get whether a given file selector entry widget's internal file
6674 * selector is displaying folders only or the directory contents,
6677 * @param obj The file selector entry widget
6678 * @return @c EINA_TRUE if @p obj widget's internal file
6679 * selector is only displaying directories, @c EINA_FALSE if files
6680 * are being displayed in it too (and on errors)
6682 * @see elm_fileselector_entry_folder_only_set() for more details
6684 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6687 * Enable/disable the file name entry box where the user can type
6688 * in a name for a file, in a given file selector entry widget's
6689 * internal file selector.
6691 * @param obj The file selector entry widget
6692 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6693 * file selector a "saving dialog", @c EINA_FALSE otherwise
6695 * This has the same effect as elm_fileselector_is_save_set(),
6696 * but now applied to a file selector entry's internal file
6699 * @see elm_fileselector_is_save_get()
6701 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6704 * Get whether the given file selector entry widget's internal
6705 * file selector is in "saving dialog" mode
6707 * @param obj The file selector entry widget
6708 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6709 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6712 * @see elm_fileselector_entry_is_save_set() for more details
6714 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6717 * Set whether a given file selector entry widget's internal file
6718 * selector will raise an Elementary "inner window", instead of a
6719 * dedicated Elementary window. By default, it won't.
6721 * @param obj The file selector entry widget
6722 * @param value @c EINA_TRUE to make it use an inner window, @c
6723 * EINA_TRUE to make it use a dedicated window
6725 * @see elm_win_inwin_add() for more information on inner windows
6726 * @see elm_fileselector_entry_inwin_mode_get()
6728 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6731 * Get whether a given file selector entry widget's internal file
6732 * selector will raise an Elementary "inner window", instead of a
6733 * dedicated Elementary window.
6735 * @param obj The file selector entry widget
6736 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6737 * if it will use a dedicated window
6739 * @see elm_fileselector_entry_inwin_mode_set() for more details
6741 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6744 * Set the initial file system path for a given file selector entry
6747 * @param obj The file selector entry widget
6748 * @param path The path string
6750 * It must be a <b>directory</b> path, which will have the contents
6751 * displayed initially in the file selector's view, when invoked
6752 * from @p obj. The default initial path is the @c "HOME"
6753 * environment variable's value.
6755 * @see elm_fileselector_entry_path_get()
6757 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6760 * Get the parent directory's path to the latest file selection on
6761 * a given filer selector entry widget
6763 * @param obj The file selector object
6764 * @return The (full) path of the directory of the last selection
6765 * on @p obj widget, a @b stringshared string
6767 * @see elm_fileselector_entry_path_set()
6769 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6776 * @defgroup Scroller Scroller
6778 * A scroller holds a single object and "scrolls it around". This means that
6779 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6780 * region around, allowing to move through a much larger object that is
6781 * contained in the scroller. The scroiller will always have a small minimum
6782 * size by default as it won't be limited by the contents of the scroller.
6784 * Signals that you can add callbacks for are:
6785 * @li "edge,left" - the left edge of the content has been reached
6786 * @li "edge,right" - the right edge of the content has been reached
6787 * @li "edge,top" - the top edge of the content has been reached
6788 * @li "edge,bottom" - the bottom edge of the content has been reached
6789 * @li "scroll" - the content has been scrolled (moved)
6790 * @li "scroll,anim,start" - scrolling animation has started
6791 * @li "scroll,anim,stop" - scrolling animation has stopped
6792 * @li "scroll,drag,start" - dragging the contents around has started
6793 * @li "scroll,drag,stop" - dragging the contents around has stopped
6794 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6797 * @note When Elemementary is in embedded mode the scrollbars will not be
6798 * dragable, they appear merely as indicators of how much has been scrolled.
6799 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6800 * fingerscroll) won't work.
6802 * In @ref tutorial_scroller you'll find an example of how to use most of
6807 * @brief Type that controls when scrollbars should appear.
6809 * @see elm_scroller_policy_set()
6811 typedef enum _Elm_Scroller_Policy
6813 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6814 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6815 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6816 ELM_SCROLLER_POLICY_LAST
6817 } Elm_Scroller_Policy;
6819 * @brief Add a new scroller to the parent
6821 * @param parent The parent object
6822 * @return The new object or NULL if it cannot be created
6824 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6826 * @brief Set the content of the scroller widget (the object to be scrolled around).
6828 * @param obj The scroller object
6829 * @param content The new content object
6831 * Once the content object is set, a previously set one will be deleted.
6832 * If you want to keep that old content object, use the
6833 * elm_scroller_content_unset() function.
6835 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6837 * @brief Get the content of the scroller widget
6839 * @param obj The slider object
6840 * @return The content that is being used
6842 * Return the content object which is set for this widget
6844 * @see elm_scroller_content_set()
6846 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6848 * @brief Unset the content of the scroller widget
6850 * @param obj The slider object
6851 * @return The content that was being used
6853 * Unparent and return the content object which was set for this widget
6855 * @see elm_scroller_content_set()
6857 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6859 * @brief Set custom theme elements for the scroller
6861 * @param obj The scroller object
6862 * @param widget The widget name to use (default is "scroller")
6863 * @param base The base name to use (default is "base")
6865 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6867 * @brief Make the scroller minimum size limited to the minimum size of the content
6869 * @param obj The scroller object
6870 * @param w Enable limiting minimum size horizontally
6871 * @param h Enable limiting minimum size vertically
6873 * By default the scroller will be as small as its design allows,
6874 * irrespective of its content. This will make the scroller minimum size the
6875 * right size horizontally and/or vertically to perfectly fit its content in
6878 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6880 * @brief Show a specific virtual region within the scroller content object
6882 * @param obj The scroller object
6883 * @param x X coordinate of the region
6884 * @param y Y coordinate of the region
6885 * @param w Width of the region
6886 * @param h Height of the region
6888 * This will ensure all (or part if it does not fit) of the designated
6889 * region in the virtual content object (0, 0 starting at the top-left of the
6890 * virtual content object) is shown within the scroller.
6892 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);
6894 * @brief Set the scrollbar visibility policy
6896 * @param obj The scroller object
6897 * @param policy_h Horizontal scrollbar policy
6898 * @param policy_v Vertical scrollbar policy
6900 * This sets the scrollbar visibility policy for the given scroller.
6901 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6902 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6903 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6904 * respectively for the horizontal and vertical scrollbars.
6906 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6908 * @brief Gets scrollbar visibility policy
6910 * @param obj The scroller object
6911 * @param policy_h Horizontal scrollbar policy
6912 * @param policy_v Vertical scrollbar policy
6914 * @see elm_scroller_policy_set()
6916 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6918 * @brief Get the currently visible content region
6920 * @param obj The scroller object
6921 * @param x X coordinate of the region
6922 * @param y Y coordinate of the region
6923 * @param w Width of the region
6924 * @param h Height of the region
6926 * This gets the current region in the content object that is visible through
6927 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6928 * w, @p h values pointed to.
6930 * @note All coordinates are relative to the content.
6932 * @see elm_scroller_region_show()
6934 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);
6936 * @brief Get the size of the content object
6938 * @param obj The scroller object
6939 * @param w Width return
6940 * @param h Height return
6942 * This gets the size of the content object of the scroller.
6944 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6946 * @brief Set bouncing behavior
6948 * @param obj The scroller object
6949 * @param h_bounce Will the scroller bounce horizontally or not
6950 * @param v_bounce Will the scroller bounce vertically or not
6952 * When scrolling, the scroller may "bounce" when reaching an edge of the
6953 * content object. This is a visual way to indicate the end has been reached.
6954 * This is enabled by default for both axis. This will set if it is enabled
6955 * for that axis with the boolean parameters for each axis.
6957 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6959 * @brief Get the bounce mode
6961 * @param obj The Scroller object
6962 * @param h_bounce Allow bounce horizontally
6963 * @param v_bounce Allow bounce vertically
6965 * @see elm_scroller_bounce_set()
6967 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6969 * @brief Set scroll page size relative to viewport size.
6971 * @param obj The scroller object
6972 * @param h_pagerel The horizontal page relative size
6973 * @param v_pagerel The vertical page relative size
6975 * The scroller is capable of limiting scrolling by the user to "pages". That
6976 * is to jump by and only show a "whole page" at a time as if the continuous
6977 * area of the scroller content is split into page sized pieces. This sets
6978 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6979 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6980 * axis. This is mutually exclusive with page size
6981 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6982 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6983 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6986 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6988 * @brief Set scroll page size.
6990 * @param obj The scroller object
6991 * @param h_pagesize The horizontal page size
6992 * @param v_pagesize The vertical page size
6994 * This sets the page size to an absolute fixed value, with 0 turning it off
6997 * @see elm_scroller_page_relative_set()
6999 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7001 * @brief Get scroll current page number.
7003 * @param obj The scroller object
7004 * @param h_pagenumber The horizoptal page number
7005 * @param v_pagenumber The vertical page number
7007 * The page number starts from 0. 0 is the first page.
7008 * Current page means the page which meet the top-left of the viewport.
7009 * If there are two or more pages in the viewport, it returns the number of page
7010 * which meet the top-left of the viewport.
7012 * @see elm_scroller_last_page_get()
7013 * @see elm_scroller_page_show()
7014 * @see elm_scroller_page_brint_in()
7016 EAPI void elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7018 * @brief Get scroll last page number.
7020 * @param obj The scroller object
7021 * @param h_pagenumber The horizoptal page number
7022 * @param v_pagenumber The vertical page number
7024 * The page number starts from 0. 0 is the first page.
7025 * This returns the last page number among the pages.
7027 * @see elm_scroller_current_page_get()
7028 * @see elm_scroller_page_show()
7029 * @see elm_scroller_page_brint_in()
7031 EAPI void elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7033 * Show a specific virtual region within the scroller content object by page number.
7035 * @param obj The scroller object
7036 * @param h_pagenumber The horizoptal page number
7037 * @param v_pagenumber The vertical page number
7039 * 0, 0 of the indicated page is located at the top-left of the viewport.
7040 * This will jump to the page directly without animation.
7045 * sc = elm_scroller_add(win);
7046 * elm_scroller_content_set(sc, content);
7047 * elm_scroller_page_relative_set(sc, 1, 0);
7048 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7049 * elm_scroller_page_show(sc, h_page + 1, v_page);
7052 * @see elm_scroller_page_bring_in()
7054 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7056 * Show a specific virtual region within the scroller content object by page number.
7058 * @param obj The scroller object
7059 * @param h_pagenumber The horizoptal page number
7060 * @param v_pagenumber The vertical page number
7062 * 0, 0 of the indicated page is located at the top-left of the viewport.
7063 * This will slide to the page with animation.
7068 * sc = elm_scroller_add(win);
7069 * elm_scroller_content_set(sc, content);
7070 * elm_scroller_page_relative_set(sc, 1, 0);
7071 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7072 * elm_scroller_page_bring_in(sc, h_page, v_page);
7075 * @see elm_scroller_page_show()
7077 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7079 * @brief Show a specific virtual region within the scroller content object.
7081 * @param obj The scroller object
7082 * @param x X coordinate of the region
7083 * @param y Y coordinate of the region
7084 * @param w Width of the region
7085 * @param h Height of the region
7087 * This will ensure all (or part if it does not fit) of the designated
7088 * region in the virtual content object (0, 0 starting at the top-left of the
7089 * virtual content object) is shown within the scroller. Unlike
7090 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7091 * to this location (if configuration in general calls for transitions). It
7092 * may not jump immediately to the new location and make take a while and
7093 * show other content along the way.
7095 * @see elm_scroller_region_show()
7097 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);
7099 * @brief Set event propagation on a scroller
7101 * @param obj The scroller object
7102 * @param propagation If propagation is enabled or not
7104 * This enables or disabled event propagation from the scroller content to
7105 * the scroller and its parent. By default event propagation is disabled.
7107 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7109 * @brief Get event propagation for a scroller
7111 * @param obj The scroller object
7112 * @return The propagation state
7114 * This gets the event propagation for a scroller.
7116 * @see elm_scroller_propagate_events_set()
7118 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7124 * @defgroup Label Label
7126 * @image html img/widget/label/preview-00.png
7127 * @image latex img/widget/label/preview-00.eps
7129 * @brief Widget to display text, with simple html-like markup.
7131 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7132 * text doesn't fit the geometry of the label it will be ellipsized or be
7133 * cut. Elementary provides several themes for this widget:
7134 * @li default - No animation
7135 * @li marker - Centers the text in the label and make it bold by default
7136 * @li slide_long - The entire text appears from the right of the screen and
7137 * slides until it disappears in the left of the screen(reappering on the
7139 * @li slide_short - The text appears in the left of the label and slides to
7140 * the right to show the overflow. When all of the text has been shown the
7141 * position is reset.
7142 * @li slide_bounce - The text appears in the left of the label and slides to
7143 * the right to show the overflow. When all of the text has been shown the
7144 * animation reverses, moving the text to the left.
7146 * Custom themes can of course invent new markup tags and style them any way
7149 * See @ref tutorial_label for a demonstration of how to use a label widget.
7153 * @brief Add a new label to the parent
7155 * @param parent The parent object
7156 * @return The new object or NULL if it cannot be created
7158 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7160 * @brief Set the label on the label object
7162 * @param obj The label object
7163 * @param label The label will be used on the label object
7164 * @deprecated See elm_object_text_set()
7166 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 */
7168 * @brief Get the label used on the label object
7170 * @param obj The label object
7171 * @return The string inside the label
7172 * @deprecated See elm_object_text_get()
7174 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7176 * @brief Set the wrapping behavior of the label
7178 * @param obj The label object
7179 * @param wrap To wrap text or not
7181 * By default no wrapping is done. Possible values for @p wrap are:
7182 * @li ELM_WRAP_NONE - No wrapping
7183 * @li ELM_WRAP_CHAR - wrap between characters
7184 * @li ELM_WRAP_WORD - wrap between words
7185 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7187 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7189 * @brief Get the wrapping behavior of the label
7191 * @param obj The label object
7194 * @see elm_label_line_wrap_set()
7196 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7198 * @brief Set wrap width of the label
7200 * @param obj The label object
7201 * @param w The wrap width in pixels at a minimum where words need to wrap
7203 * This function sets the maximum width size hint of the label.
7205 * @warning This is only relevant if the label is inside a container.
7207 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7209 * @brief Get wrap width of the label
7211 * @param obj The label object
7212 * @return The wrap width in pixels at a minimum where words need to wrap
7214 * @see elm_label_wrap_width_set()
7216 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7218 * @brief Set wrap height of the label
7220 * @param obj The label object
7221 * @param h The wrap height in pixels at a minimum where words need to wrap
7223 * This function sets the maximum height size hint of the label.
7225 * @warning This is only relevant if the label is inside a container.
7227 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7229 * @brief get wrap width of the label
7231 * @param obj The label object
7232 * @return The wrap height in pixels at a minimum where words need to wrap
7234 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7236 * @brief Set the font size on the label object.
7238 * @param obj The label object
7239 * @param size font size
7241 * @warning NEVER use this. It is for hyper-special cases only. use styles
7242 * instead. e.g. "big", "medium", "small" - or better name them by use:
7243 * "title", "footnote", "quote" etc.
7245 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7247 * @brief Set the text color on the label object
7249 * @param obj The label object
7250 * @param r Red property background color of The label object
7251 * @param g Green property background color of The label object
7252 * @param b Blue property background color of The label object
7253 * @param a Alpha property background color of The label object
7255 * @warning NEVER use this. It is for hyper-special cases only. use styles
7256 * instead. e.g. "big", "medium", "small" - or better name them by use:
7257 * "title", "footnote", "quote" etc.
7259 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);
7261 * @brief Set the text align on the label object
7263 * @param obj The label object
7264 * @param align align mode ("left", "center", "right")
7266 * @warning NEVER use this. It is for hyper-special cases only. use styles
7267 * instead. e.g. "big", "medium", "small" - or better name them by use:
7268 * "title", "footnote", "quote" etc.
7270 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7272 * @brief Set background color of the label
7274 * @param obj The label object
7275 * @param r Red property background color of The label object
7276 * @param g Green property background color of The label object
7277 * @param b Blue property background color of The label object
7278 * @param a Alpha property background alpha of The label object
7280 * @warning NEVER use this. It is for hyper-special cases only. use styles
7281 * instead. e.g. "big", "medium", "small" - or better name them by use:
7282 * "title", "footnote", "quote" etc.
7284 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);
7286 * @brief Set the ellipsis behavior of the label
7288 * @param obj The label object
7289 * @param ellipsis To ellipsis text or not
7291 * If set to true and the text doesn't fit in the label an ellipsis("...")
7292 * will be shown at the end of the widget.
7294 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7295 * choosen wrap method was ELM_WRAP_WORD.
7297 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7299 * @brief Set the text slide of the label
7301 * @param obj The label object
7302 * @param slide To start slide or stop
7304 * If set to true the text of the label will slide throught the length of
7307 * @warning This only work with the themes "slide_short", "slide_long" and
7310 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7312 * @brief Get the text slide mode of the label
7314 * @param obj The label object
7315 * @return slide slide mode value
7317 * @see elm_label_slide_set()
7319 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7321 * @brief Set the slide duration(speed) of the label
7323 * @param obj The label object
7324 * @return The duration in seconds in moving text from slide begin position
7325 * to slide end position
7327 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7329 * @brief Get the slide duration(speed) of the label
7331 * @param obj The label object
7332 * @return The duration time in moving text from slide begin position to slide end position
7334 * @see elm_label_slide_duration_set()
7336 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7342 * @defgroup Toggle Toggle
7344 * @image html img/widget/toggle/preview-00.png
7345 * @image latex img/widget/toggle/preview-00.eps
7347 * @brief A toggle is a slider which can be used to toggle between
7348 * two values. It has two states: on and off.
7350 * Signals that you can add callbacks for are:
7351 * @li "changed" - Whenever the toggle value has been changed. Is not called
7352 * until the toggle is released by the cursor (assuming it
7353 * has been triggered by the cursor in the first place).
7355 * @ref tutorial_toggle show how to use a toggle.
7359 * @brief Add a toggle to @p parent.
7361 * @param parent The parent object
7363 * @return The toggle object
7365 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7367 * @brief Sets the label to be displayed with the toggle.
7369 * @param obj The toggle object
7370 * @param label The label to be displayed
7372 * @deprecated use elm_object_text_set() instead.
7374 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7376 * @brief Gets the label of the toggle
7378 * @param obj toggle object
7379 * @return The label of the toggle
7381 * @deprecated use elm_object_text_get() instead.
7383 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7385 * @brief Set the icon used for the toggle
7387 * @param obj The toggle object
7388 * @param icon The icon object for the button
7390 * Once the icon object is set, a previously set one will be deleted
7391 * If you want to keep that old content object, use the
7392 * elm_toggle_icon_unset() function.
7394 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7396 * @brief Get the icon used for the toggle
7398 * @param obj The toggle object
7399 * @return The icon object that is being used
7401 * Return the icon object which is set for this widget.
7403 * @see elm_toggle_icon_set()
7405 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7407 * @brief Unset the icon used for the toggle
7409 * @param obj The toggle object
7410 * @return The icon object that was being used
7412 * Unparent and return the icon object which was set for this widget.
7414 * @see elm_toggle_icon_set()
7416 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7418 * @brief Sets the labels to be associated with the on and off states of the toggle.
7420 * @param obj The toggle object
7421 * @param onlabel The label displayed when the toggle is in the "on" state
7422 * @param offlabel The label displayed when the toggle is in the "off" state
7424 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7426 * @brief Gets the labels associated with the on and off states of the toggle.
7428 * @param obj The toggle object
7429 * @param onlabel A char** to place the onlabel of @p obj into
7430 * @param offlabel A char** to place the offlabel of @p obj into
7432 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7434 * @brief Sets the state of the toggle to @p state.
7436 * @param obj The toggle object
7437 * @param state The state of @p obj
7439 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7441 * @brief Gets the state of the toggle to @p state.
7443 * @param obj The toggle object
7444 * @return The state of @p obj
7446 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7448 * @brief Sets the state pointer of the toggle to @p statep.
7450 * @param obj The toggle object
7451 * @param statep The state pointer of @p obj
7453 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7459 * @defgroup Frame Frame
7461 * @image html img/widget/frame/preview-00.png
7462 * @image latex img/widget/frame/preview-00.eps
7464 * @brief Frame is a widget that holds some content and has a title.
7466 * The default look is a frame with a title, but Frame supports multple
7474 * @li outdent_bottom
7476 * Of all this styles only default shows the title. Frame emits no signals.
7478 * For a detailed example see the @ref tutorial_frame.
7483 * @brief Add a new frame to the parent
7485 * @param parent The parent object
7486 * @return The new object or NULL if it cannot be created
7488 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7490 * @brief Set the frame label
7492 * @param obj The frame object
7493 * @param label The label of this frame object
7495 * @deprecated use elm_object_text_set() instead.
7497 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7499 * @brief Get the frame label
7501 * @param obj The frame object
7503 * @return The label of this frame objet or NULL if unable to get frame
7505 * @deprecated use elm_object_text_get() instead.
7507 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7509 * @brief Set the content of the frame widget
7511 * Once the content object is set, a previously set one will be deleted.
7512 * If you want to keep that old content object, use the
7513 * elm_frame_content_unset() function.
7515 * @param obj The frame object
7516 * @param content The content will be filled in this frame object
7518 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7520 * @brief Get the content of the frame widget
7522 * Return the content object which is set for this widget
7524 * @param obj The frame object
7525 * @return The content that is being used
7527 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7529 * @brief Unset the content of the frame widget
7531 * Unparent and return the content object which was set for this widget
7533 * @param obj The frame object
7534 * @return The content that was being used
7536 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7542 * @defgroup Table Table
7544 * A container widget to arrange other widgets in a table where items can
7545 * also span multiple columns or rows - even overlap (and then be raised or
7546 * lowered accordingly to adjust stacking if they do overlap).
7548 * The followin are examples of how to use a table:
7549 * @li @ref tutorial_table_01
7550 * @li @ref tutorial_table_02
7555 * @brief Add a new table to the parent
7557 * @param parent The parent object
7558 * @return The new object or NULL if it cannot be created
7560 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7562 * @brief Set the homogeneous layout in the table
7564 * @param obj The layout object
7565 * @param homogeneous A boolean to set if the layout is homogeneous in the
7566 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7568 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7570 * @brief Get the current table homogeneous mode.
7572 * @param obj The table object
7573 * @return A boolean to indicating if the layout is homogeneous in the table
7574 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7576 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7578 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7580 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7582 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7584 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7586 * @brief Set padding between cells.
7588 * @param obj The layout object.
7589 * @param horizontal set the horizontal padding.
7590 * @param vertical set the vertical padding.
7592 * Default value is 0.
7594 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7596 * @brief Get padding between cells.
7598 * @param obj The layout object.
7599 * @param horizontal set the horizontal padding.
7600 * @param vertical set the vertical padding.
7602 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7604 * @brief Add a subobject on the table with the coordinates passed
7606 * @param obj The table object
7607 * @param subobj The subobject to be added to the table
7608 * @param x Row number
7609 * @param y Column number
7613 * @note All positioning inside the table is relative to rows and columns, so
7614 * a value of 0 for x and y, means the top left cell of the table, and a
7615 * value of 1 for w and h means @p subobj only takes that 1 cell.
7617 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7619 * @brief Remove child from table.
7621 * @param obj The table object
7622 * @param subobj The subobject
7624 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7626 * @brief Faster way to remove all child objects from a table object.
7628 * @param obj The table object
7629 * @param clear If true, will delete children, else just remove from table.
7631 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7633 * @brief Set the packing location of an existing child of the table
7635 * @param subobj The subobject to be modified in the table
7636 * @param x Row number
7637 * @param y Column number
7641 * Modifies the position of an object already in the table.
7643 * @note All positioning inside the table is relative to rows and columns, so
7644 * a value of 0 for x and y, means the top left cell of the table, and a
7645 * value of 1 for w and h means @p subobj only takes that 1 cell.
7647 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7649 * @brief Get the packing location of an existing child of the table
7651 * @param subobj The subobject to be modified in the table
7652 * @param x Row number
7653 * @param y Column number
7657 * @see elm_table_pack_set()
7659 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7665 * @defgroup Gengrid Gengrid (Generic grid)
7667 * This widget aims to position objects in a grid layout while
7668 * actually creating and rendering only the visible ones, using the
7669 * same idea as the @ref Genlist "genlist": the user defines a @b
7670 * class for each item, specifying functions that will be called at
7671 * object creation, deletion, etc. When those items are selected by
7672 * the user, a callback function is issued. Users may interact with
7673 * a gengrid via the mouse (by clicking on items to select them and
7674 * clicking on the grid's viewport and swiping to pan the whole
7675 * view) or via the keyboard, navigating through item with the
7678 * @section Gengrid_Layouts Gengrid layouts
7680 * Gengrids may layout its items in one of two possible layouts:
7684 * When in "horizontal mode", items will be placed in @b columns,
7685 * from top to bottom and, when the space for a column is filled,
7686 * another one is started on the right, thus expanding the grid
7687 * horizontally, making for horizontal scrolling. When in "vertical
7688 * mode" , though, items will be placed in @b rows, from left to
7689 * right and, when the space for a row is filled, another one is
7690 * started below, thus expanding the grid vertically (and making
7691 * for vertical scrolling).
7693 * @section Gengrid_Items Gengrid items
7695 * An item in a gengrid can have 0 or more text labels (they can be
7696 * regular text or textblock Evas objects - that's up to the style
7697 * to determine), 0 or more icons (which are simply objects
7698 * swallowed into the gengrid item's theming Edje object) and 0 or
7699 * more <b>boolean states</b>, which have the behavior left to the
7700 * user to define. The Edje part names for each of these properties
7701 * will be looked up, in the theme file for the gengrid, under the
7702 * Edje (string) data items named @c "labels", @c "icons" and @c
7703 * "states", respectively. For each of those properties, if more
7704 * than one part is provided, they must have names listed separated
7705 * by spaces in the data fields. For the default gengrid item
7706 * theme, we have @b one label part (@c "elm.text"), @b two icon
7707 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7710 * A gengrid item may be at one of several styles. Elementary
7711 * provides one by default - "default", but this can be extended by
7712 * system or application custom themes/overlays/extensions (see
7713 * @ref Theme "themes" for more details).
7715 * @section Gengrid_Item_Class Gengrid item classes
7717 * In order to have the ability to add and delete items on the fly,
7718 * gengrid implements a class (callback) system where the
7719 * application provides a structure with information about that
7720 * type of item (gengrid may contain multiple different items with
7721 * different classes, states and styles). Gengrid will call the
7722 * functions in this struct (methods) when an item is "realized"
7723 * (i.e., created dynamically, while the user is scrolling the
7724 * grid). All objects will simply be deleted when no longer needed
7725 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7726 * contains the following members:
7727 * - @c item_style - This is a constant string and simply defines
7728 * the name of the item style. It @b must be specified and the
7729 * default should be @c "default".
7730 * - @c func.label_get - This function is called when an item
7731 * object is actually created. The @c data parameter will point to
7732 * the same data passed to elm_gengrid_item_append() and related
7733 * item creation functions. The @c obj parameter is the gengrid
7734 * object itself, while the @c part one is the name string of one
7735 * of the existing text parts in the Edje group implementing the
7736 * item's theme. This function @b must return a strdup'()ed string,
7737 * as the caller will free() it when done. See
7738 * #Elm_Gengrid_Item_Label_Get_Cb.
7739 * - @c func.icon_get - This function is called when an item object
7740 * is actually created. The @c data parameter will point to the
7741 * same data passed to elm_gengrid_item_append() and related item
7742 * creation functions. The @c obj parameter is the gengrid object
7743 * itself, while the @c part one is the name string of one of the
7744 * existing (icon) swallow parts in the Edje group implementing the
7745 * item's theme. It must return @c NULL, when no icon is desired,
7746 * or a valid object handle, otherwise. The object will be deleted
7747 * by the gengrid on its deletion or when the item is "unrealized".
7748 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7749 * - @c func.state_get - This function is called when an item
7750 * object is actually created. The @c data parameter will point to
7751 * the same data passed to elm_gengrid_item_append() and related
7752 * item creation functions. The @c obj parameter is the gengrid
7753 * object itself, while the @c part one is the name string of one
7754 * of the state parts in the Edje group implementing the item's
7755 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7756 * true/on. Gengrids will emit a signal to its theming Edje object
7757 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7758 * "source" arguments, respectively, when the state is true (the
7759 * default is false), where @c XXX is the name of the (state) part.
7760 * See #Elm_Gengrid_Item_State_Get_Cb.
7761 * - @c func.del - This is called when elm_gengrid_item_del() is
7762 * called on an item or elm_gengrid_clear() is called on the
7763 * gengrid. This is intended for use when gengrid items are
7764 * deleted, so any data attached to the item (e.g. its data
7765 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7767 * @section Gengrid_Usage_Hints Usage hints
7769 * If the user wants to have multiple items selected at the same
7770 * time, elm_gengrid_multi_select_set() will permit it. If the
7771 * gengrid is single-selection only (the default), then
7772 * elm_gengrid_select_item_get() will return the selected item or
7773 * @c NULL, if none is selected. If the gengrid is under
7774 * multi-selection, then elm_gengrid_selected_items_get() will
7775 * return a list (that is only valid as long as no items are
7776 * modified (added, deleted, selected or unselected) of child items
7779 * If an item changes (internal (boolean) state, label or icon
7780 * changes), then use elm_gengrid_item_update() to have gengrid
7781 * update the item with the new state. A gengrid will re-"realize"
7782 * the item, thus calling the functions in the
7783 * #Elm_Gengrid_Item_Class set for that item.
7785 * To programmatically (un)select an item, use
7786 * elm_gengrid_item_selected_set(). To get its selected state use
7787 * elm_gengrid_item_selected_get(). To make an item disabled
7788 * (unable to be selected and appear differently) use
7789 * elm_gengrid_item_disabled_set() to set this and
7790 * elm_gengrid_item_disabled_get() to get the disabled state.
7792 * Grid cells will only have their selection smart callbacks called
7793 * when firstly getting selected. Any further clicks will do
7794 * nothing, unless you enable the "always select mode", with
7795 * elm_gengrid_always_select_mode_set(), thus making every click to
7796 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7797 * turn off the ability to select items entirely in the widget and
7798 * they will neither appear selected nor call the selection smart
7801 * Remember that you can create new styles and add your own theme
7802 * augmentation per application with elm_theme_extension_add(). If
7803 * you absolutely must have a specific style that overrides any
7804 * theme the user or system sets up you can use
7805 * elm_theme_overlay_add() to add such a file.
7807 * @section Gengrid_Smart_Events Gengrid smart events
7809 * Smart events that you can add callbacks for are:
7810 * - @c "activated" - The user has double-clicked or pressed
7811 * (enter|return|spacebar) on an item. The @c event_info parameter
7812 * is the gengrid item that was activated.
7813 * - @c "clicked,double" - The user has double-clicked an item.
7814 * The @c event_info parameter is the gengrid item that was double-clicked.
7815 * - @c "selected" - The user has made an item selected. The
7816 * @c event_info parameter is the gengrid item that was selected.
7817 * - @c "unselected" - The user has made an item unselected. The
7818 * @c event_info parameter is the gengrid item that was unselected.
7819 * - @c "realized" - This is called when the item in the gengrid
7820 * has its implementing Evas object instantiated, de facto. @c
7821 * event_info is the gengrid item that was created. The object
7822 * may be deleted at any time, so it is highly advised to the
7823 * caller @b not to use the object pointer returned from
7824 * elm_gengrid_item_object_get(), because it may point to freed
7826 * - @c "unrealized" - This is called when the implementing Evas
7827 * object for this item is deleted. @c event_info is the gengrid
7828 * item that was deleted.
7829 * - @c "changed" - Called when an item is added, removed, resized
7830 * or moved and when the gengrid is resized or gets "horizontal"
7832 * - @c "scroll,anim,start" - This is called when scrolling animation has
7834 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7836 * - @c "drag,start,up" - Called when the item in the gengrid has
7837 * been dragged (not scrolled) up.
7838 * - @c "drag,start,down" - Called when the item in the gengrid has
7839 * been dragged (not scrolled) down.
7840 * - @c "drag,start,left" - Called when the item in the gengrid has
7841 * been dragged (not scrolled) left.
7842 * - @c "drag,start,right" - Called when the item in the gengrid has
7843 * been dragged (not scrolled) right.
7844 * - @c "drag,stop" - Called when the item in the gengrid has
7845 * stopped being dragged.
7846 * - @c "drag" - Called when the item in the gengrid is being
7848 * - @c "scroll" - called when the content has been scrolled
7850 * - @c "scroll,drag,start" - called when dragging the content has
7852 * - @c "scroll,drag,stop" - called when dragging the content has
7855 * List of gendrid examples:
7856 * @li @ref gengrid_example
7860 * @addtogroup Gengrid
7864 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7865 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7866 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7867 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7868 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. */
7869 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. */
7870 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7872 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7873 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7874 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7875 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7878 * @struct _Elm_Gengrid_Item_Class
7880 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7883 struct _Elm_Gengrid_Item_Class
7885 const char *item_style;
7886 struct _Elm_Gengrid_Item_Class_Func
7888 Elm_Gengrid_Item_Label_Get_Cb label_get;
7889 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7890 Elm_Gengrid_Item_State_Get_Cb state_get;
7891 Elm_Gengrid_Item_Del_Cb del;
7893 }; /**< #Elm_Gengrid_Item_Class member definitions */
7896 * Add a new gengrid widget to the given parent Elementary
7897 * (container) object
7899 * @param parent The parent object
7900 * @return a new gengrid widget handle or @c NULL, on errors
7902 * This function inserts a new gengrid widget on the canvas.
7904 * @see elm_gengrid_item_size_set()
7905 * @see elm_gengrid_horizontal_set()
7906 * @see elm_gengrid_item_append()
7907 * @see elm_gengrid_item_del()
7908 * @see elm_gengrid_clear()
7912 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7915 * Set the size for the items of a given gengrid widget
7917 * @param obj The gengrid object.
7918 * @param w The items' width.
7919 * @param h The items' height;
7921 * A gengrid, after creation, has still no information on the size
7922 * to give to each of its cells. So, you most probably will end up
7923 * with squares one @ref Fingers "finger" wide, the default
7924 * size. Use this function to force a custom size for you items,
7925 * making them as big as you wish.
7927 * @see elm_gengrid_item_size_get()
7931 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7934 * Get the size set for the items of a given gengrid widget
7936 * @param obj The gengrid object.
7937 * @param w Pointer to a variable where to store the items' width.
7938 * @param h Pointer to a variable where to store the items' height.
7940 * @note Use @c NULL pointers on the size values you're not
7941 * interested in: they'll be ignored by the function.
7943 * @see elm_gengrid_item_size_get() for more details
7947 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7950 * Set the items grid's alignment within a given gengrid widget
7952 * @param obj The gengrid object.
7953 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7954 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7956 * This sets the alignment of the whole grid of items of a gengrid
7957 * within its given viewport. By default, those values are both
7958 * 0.5, meaning that the gengrid will have its items grid placed
7959 * exactly in the middle of its viewport.
7961 * @note If given alignment values are out of the cited ranges,
7962 * they'll be changed to the nearest boundary values on the valid
7965 * @see elm_gengrid_align_get()
7969 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7972 * Get the items grid's alignment values within a given gengrid
7975 * @param obj The gengrid object.
7976 * @param align_x Pointer to a variable where to store the
7977 * horizontal alignment.
7978 * @param align_y Pointer to a variable where to store the vertical
7981 * @note Use @c NULL pointers on the alignment values you're not
7982 * interested in: they'll be ignored by the function.
7984 * @see elm_gengrid_align_set() for more details
7988 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7991 * Set whether a given gengrid widget is or not able have items
7994 * @param obj The gengrid object
7995 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7996 * @c EINA_FALSE to turn it off
7998 * If a gengrid is set to allow reordering, a click held for more
7999 * than 0.5 over a given item will highlight it specially,
8000 * signalling the gengrid has entered the reordering state. From
8001 * that time on, the user will be able to, while still holding the
8002 * mouse button down, move the item freely in the gengrid's
8003 * viewport, replacing to said item to the locations it goes to.
8004 * The replacements will be animated and, whenever the user
8005 * releases the mouse button, the item being replaced gets a new
8006 * definitive place in the grid.
8008 * @see elm_gengrid_reorder_mode_get()
8012 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8015 * Get whether a given gengrid widget is or not able have items
8018 * @param obj The gengrid object
8019 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8022 * @see elm_gengrid_reorder_mode_set() for more details
8026 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8029 * Append a new item in a given gengrid widget.
8031 * @param obj The gengrid object.
8032 * @param gic The item class for the item.
8033 * @param data The item data.
8034 * @param func Convenience function called when the item is
8036 * @param func_data Data to be passed to @p func.
8037 * @return A handle to the item added or @c NULL, on errors.
8039 * This adds an item to the beginning of the gengrid.
8041 * @see elm_gengrid_item_prepend()
8042 * @see elm_gengrid_item_insert_before()
8043 * @see elm_gengrid_item_insert_after()
8044 * @see elm_gengrid_item_del()
8048 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);
8051 * Prepend a new item in a given gengrid widget.
8053 * @param obj The gengrid object.
8054 * @param gic The item class for the item.
8055 * @param data The item data.
8056 * @param func Convenience function called when the item is
8058 * @param func_data Data to be passed to @p func.
8059 * @return A handle to the item added or @c NULL, on errors.
8061 * This adds an item to the end of the gengrid.
8063 * @see elm_gengrid_item_append()
8064 * @see elm_gengrid_item_insert_before()
8065 * @see elm_gengrid_item_insert_after()
8066 * @see elm_gengrid_item_del()
8070 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);
8073 * Insert an item before another in a gengrid widget
8075 * @param obj The gengrid object.
8076 * @param gic The item class for the item.
8077 * @param data The item data.
8078 * @param relative The item to place this new one before.
8079 * @param func Convenience function called when the item is
8081 * @param func_data Data to be passed to @p func.
8082 * @return A handle to the item added or @c NULL, on errors.
8084 * This inserts an item before another in the gengrid.
8086 * @see elm_gengrid_item_append()
8087 * @see elm_gengrid_item_prepend()
8088 * @see elm_gengrid_item_insert_after()
8089 * @see elm_gengrid_item_del()
8093 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);
8096 * Insert an item after another in a gengrid widget
8098 * @param obj The gengrid object.
8099 * @param gic The item class for the item.
8100 * @param data The item data.
8101 * @param relative The item to place this new one after.
8102 * @param func Convenience function called when the item is
8104 * @param func_data Data to be passed to @p func.
8105 * @return A handle to the item added or @c NULL, on errors.
8107 * This inserts an item after another in the gengrid.
8109 * @see elm_gengrid_item_append()
8110 * @see elm_gengrid_item_prepend()
8111 * @see elm_gengrid_item_insert_after()
8112 * @see elm_gengrid_item_del()
8116 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);
8118 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);
8120 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);
8123 * Set whether items on a given gengrid widget are to get their
8124 * selection callbacks issued for @b every subsequent selection
8125 * click on them or just for the first click.
8127 * @param obj The gengrid object
8128 * @param always_select @c EINA_TRUE to make items "always
8129 * selected", @c EINA_FALSE, otherwise
8131 * By default, grid items will only call their selection callback
8132 * function when firstly getting selected, any subsequent further
8133 * clicks will do nothing. With this call, you make those
8134 * subsequent clicks also to issue the selection callbacks.
8136 * @note <b>Double clicks</b> will @b always be reported on items.
8138 * @see elm_gengrid_always_select_mode_get()
8142 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8145 * Get whether items on a given gengrid widget have their selection
8146 * callbacks issued for @b every subsequent selection click on them
8147 * or just for the first click.
8149 * @param obj The gengrid object.
8150 * @return @c EINA_TRUE if the gengrid items are "always selected",
8151 * @c EINA_FALSE, otherwise
8153 * @see elm_gengrid_always_select_mode_set() for more details
8157 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8160 * Set whether items on a given gengrid widget can be selected or not.
8162 * @param obj The gengrid object
8163 * @param no_select @c EINA_TRUE to make items selectable,
8164 * @c EINA_FALSE otherwise
8166 * This will make items in @p obj selectable or not. In the latter
8167 * case, any user interacion on the gendrid items will neither make
8168 * them appear selected nor them call their selection callback
8171 * @see elm_gengrid_no_select_mode_get()
8175 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8178 * Get whether items on a given gengrid widget can be selected or
8181 * @param obj The gengrid object
8182 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8185 * @see elm_gengrid_no_select_mode_set() for more details
8189 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8192 * Enable or disable multi-selection in a given gengrid widget
8194 * @param obj The gengrid object.
8195 * @param multi @c EINA_TRUE, to enable multi-selection,
8196 * @c EINA_FALSE to disable it.
8198 * Multi-selection is the ability for one to have @b more than one
8199 * item selected, on a given gengrid, simultaneously. When it is
8200 * enabled, a sequence of clicks on different items will make them
8201 * all selected, progressively. A click on an already selected item
8202 * will unselect it. If interecting via the keyboard,
8203 * multi-selection is enabled while holding the "Shift" key.
8205 * @note By default, multi-selection is @b disabled on gengrids
8207 * @see elm_gengrid_multi_select_get()
8211 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8214 * Get whether multi-selection is enabled or disabled for a given
8217 * @param obj The gengrid object.
8218 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8219 * EINA_FALSE otherwise
8221 * @see elm_gengrid_multi_select_set() for more details
8225 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8228 * Enable or disable bouncing effect for a given gengrid widget
8230 * @param obj The gengrid object
8231 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8232 * @c EINA_FALSE to disable it
8233 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8234 * @c EINA_FALSE to disable it
8236 * The bouncing effect occurs whenever one reaches the gengrid's
8237 * edge's while panning it -- it will scroll past its limits a
8238 * little bit and return to the edge again, in a animated for,
8241 * @note By default, gengrids have bouncing enabled on both axis
8243 * @see elm_gengrid_bounce_get()
8247 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8250 * Get whether bouncing effects are enabled or disabled, for a
8251 * given gengrid widget, on each axis
8253 * @param obj The gengrid object
8254 * @param h_bounce Pointer to a variable where to store the
8255 * horizontal bouncing flag.
8256 * @param v_bounce Pointer to a variable where to store the
8257 * vertical bouncing flag.
8259 * @see elm_gengrid_bounce_set() for more details
8263 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8266 * Set a given gengrid widget's scrolling page size, relative to
8267 * its viewport size.
8269 * @param obj The gengrid object
8270 * @param h_pagerel The horizontal page (relative) size
8271 * @param v_pagerel The vertical page (relative) size
8273 * The gengrid's scroller is capable of binding scrolling by the
8274 * user to "pages". It means that, while scrolling and, specially
8275 * after releasing the mouse button, the grid will @b snap to the
8276 * nearest displaying page's area. When page sizes are set, the
8277 * grid's continuous content area is split into (equal) page sized
8280 * This function sets the size of a page <b>relatively to the
8281 * viewport dimensions</b> of the gengrid, for each axis. A value
8282 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8283 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8284 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8285 * 1.0. Values beyond those will make it behave behave
8286 * inconsistently. If you only want one axis to snap to pages, use
8287 * the value @c 0.0 for the other one.
8289 * There is a function setting page size values in @b absolute
8290 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8291 * is mutually exclusive to this one.
8293 * @see elm_gengrid_page_relative_get()
8297 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8300 * Get a given gengrid widget's scrolling page size, relative to
8301 * its viewport size.
8303 * @param obj The gengrid object
8304 * @param h_pagerel Pointer to a variable where to store the
8305 * horizontal page (relative) size
8306 * @param v_pagerel Pointer to a variable where to store the
8307 * vertical page (relative) size
8309 * @see elm_gengrid_page_relative_set() for more details
8313 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8316 * Set a given gengrid widget's scrolling page size
8318 * @param obj The gengrid object
8319 * @param h_pagerel The horizontal page size, in pixels
8320 * @param v_pagerel The vertical page size, in pixels
8322 * The gengrid's scroller is capable of binding scrolling by the
8323 * user to "pages". It means that, while scrolling and, specially
8324 * after releasing the mouse button, the grid will @b snap to the
8325 * nearest displaying page's area. When page sizes are set, the
8326 * grid's continuous content area is split into (equal) page sized
8329 * This function sets the size of a page of the gengrid, in pixels,
8330 * for each axis. Sane usable values are, between @c 0 and the
8331 * dimensions of @p obj, for each axis. Values beyond those will
8332 * make it behave behave inconsistently. If you only want one axis
8333 * to snap to pages, use the value @c 0 for the other one.
8335 * There is a function setting page size values in @b relative
8336 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8337 * use is mutually exclusive to this one.
8341 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8344 * Set for what direction a given gengrid widget will expand while
8345 * placing its items.
8347 * @param obj The gengrid object.
8348 * @param setting @c EINA_TRUE to make the gengrid expand
8349 * horizontally, @c EINA_FALSE to expand vertically.
8351 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8352 * in @b columns, from top to bottom and, when the space for a
8353 * column is filled, another one is started on the right, thus
8354 * expanding the grid horizontally. When in "vertical mode"
8355 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8356 * to right and, when the space for a row is filled, another one is
8357 * started below, thus expanding the grid vertically.
8359 * @see elm_gengrid_horizontal_get()
8363 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8366 * Get for what direction a given gengrid widget will expand while
8367 * placing its items.
8369 * @param obj The gengrid object.
8370 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8371 * @c EINA_FALSE if it's set to expand vertically.
8373 * @see elm_gengrid_horizontal_set() for more detais
8377 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8380 * Get the first item in a given gengrid widget
8382 * @param obj The gengrid object
8383 * @return The first item's handle or @c NULL, if there are no
8384 * items in @p obj (and on errors)
8386 * This returns the first item in the @p obj's internal list of
8389 * @see elm_gengrid_last_item_get()
8393 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8396 * Get the last item in a given gengrid widget
8398 * @param obj The gengrid object
8399 * @return The last item's handle or @c NULL, if there are no
8400 * items in @p obj (and on errors)
8402 * This returns the last item in the @p obj's internal list of
8405 * @see elm_gengrid_first_item_get()
8409 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8412 * Get the @b next item in a gengrid widget's internal list of items,
8413 * given a handle to one of those items.
8415 * @param item The gengrid item to fetch next from
8416 * @return The item after @p item, or @c NULL if there's none (and
8419 * This returns the item placed after the @p item, on the container
8422 * @see elm_gengrid_item_prev_get()
8426 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8429 * Get the @b previous item in a gengrid widget's internal list of items,
8430 * given a handle to one of those items.
8432 * @param item The gengrid item to fetch previous from
8433 * @return The item before @p item, or @c NULL if there's none (and
8436 * This returns the item placed before the @p item, on the container
8439 * @see elm_gengrid_item_next_get()
8443 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8446 * Get the gengrid object's handle which contains a given gengrid
8449 * @param item The item to fetch the container from
8450 * @return The gengrid (parent) object
8452 * This returns the gengrid object itself that an item belongs to.
8456 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8459 * Remove a gengrid item from the its parent, deleting it.
8461 * @param item The item to be removed.
8462 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8464 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8469 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8472 * Update the contents of a given gengrid item
8474 * @param item The gengrid item
8476 * This updates an item by calling all the item class functions
8477 * again to get the icons, labels and states. Use this when the
8478 * original item data has changed and you want thta changes to be
8483 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8484 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8485 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8488 * Return the data associated to a given gengrid item
8490 * @param item The gengrid item.
8491 * @return the data associated to this item.
8493 * This returns the @c data value passed on the
8494 * elm_gengrid_item_append() and related item addition calls.
8496 * @see elm_gengrid_item_append()
8497 * @see elm_gengrid_item_data_set()
8501 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8504 * Set the data associated to a given gengrid item
8506 * @param item The gengrid item
8507 * @param data The new data pointer to set on it
8509 * This @b overrides the @c data value passed on the
8510 * elm_gengrid_item_append() and related item addition calls. This
8511 * function @b won't call elm_gengrid_item_update() automatically,
8512 * so you'd issue it afterwards if you want to hove the item
8513 * updated to reflect the that new data.
8515 * @see elm_gengrid_item_data_get()
8519 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8522 * Get a given gengrid item's position, relative to the whole
8523 * gengrid's grid area.
8525 * @param item The Gengrid item.
8526 * @param x Pointer to variable where to store the item's <b>row
8528 * @param y Pointer to variable where to store the item's <b>column
8531 * This returns the "logical" position of the item whithin the
8532 * gengrid. For example, @c (0, 1) would stand for first row,
8537 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8540 * Set whether a given gengrid item is selected or not
8542 * @param item The gengrid item
8543 * @param selected Use @c EINA_TRUE, to make it selected, @c
8544 * EINA_FALSE to make it unselected
8546 * This sets the selected state of an item. If multi selection is
8547 * not enabled on the containing gengrid and @p selected is @c
8548 * EINA_TRUE, any other previously selected items will get
8549 * unselected in favor of this new one.
8551 * @see elm_gengrid_item_selected_get()
8555 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8558 * Get whether a given gengrid item is selected or not
8560 * @param item The gengrid item
8561 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8563 * @see elm_gengrid_item_selected_set() for more details
8567 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8570 * Get the real Evas object created to implement the view of a
8571 * given gengrid item
8573 * @param item The gengrid item.
8574 * @return the Evas object implementing this item's view.
8576 * This returns the actual Evas object used to implement the
8577 * specified gengrid item's view. This may be @c NULL, as it may
8578 * not have been created or may have been deleted, at any time, by
8579 * the gengrid. <b>Do not modify this object</b> (move, resize,
8580 * show, hide, etc.), as the gengrid is controlling it. This
8581 * function is for querying, emitting custom signals or hooking
8582 * lower level callbacks for events on that object. Do not delete
8583 * this object under any circumstances.
8585 * @see elm_gengrid_item_data_get()
8589 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8592 * Show the portion of a gengrid's internal grid containing a given
8593 * item, @b immediately.
8595 * @param item The item to display
8597 * This causes gengrid to @b redraw its viewport's contents to the
8598 * region contining the given @p item item, if it is not fully
8601 * @see elm_gengrid_item_bring_in()
8605 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8608 * Animatedly bring in, to the visible are of a gengrid, a given
8611 * @param item The gengrid item to display
8613 * This causes gengrig to jump to the given @p item item and show
8614 * it (by scrolling), if it is not fully visible. This will use
8615 * animation to do so and take a period of time to complete.
8617 * @see elm_gengrid_item_show()
8621 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8624 * Set whether a given gengrid item is disabled or not.
8626 * @param item The gengrid item
8627 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8628 * to enable it back.
8630 * A disabled item cannot be selected or unselected. It will also
8631 * change its appearance, to signal the user it's disabled.
8633 * @see elm_gengrid_item_disabled_get()
8637 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8640 * Get whether a given gengrid item is disabled or not.
8642 * @param item The gengrid item
8643 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8646 * @see elm_gengrid_item_disabled_set() for more details
8650 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8653 * Set the text to be shown in a given gengrid item's tooltips.
8655 * @param item The gengrid item
8656 * @param text The text to set in the content
8658 * This call will setup the text to be used as tooltip to that item
8659 * (analogous to elm_object_tooltip_text_set(), but being item
8660 * tooltips with higher precedence than object tooltips). It can
8661 * have only one tooltip at a time, so any previous tooltip data
8666 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8669 * Set the content to be shown in a given gengrid item's tooltips
8671 * @param item The gengrid item.
8672 * @param func The function returning the tooltip contents.
8673 * @param data What to provide to @a func as callback data/context.
8674 * @param del_cb Called when data is not needed anymore, either when
8675 * another callback replaces @p func, the tooltip is unset with
8676 * elm_gengrid_item_tooltip_unset() or the owner @p item
8677 * dies. This callback receives as its first parameter the
8678 * given @p data, being @c event_info the item handle.
8680 * This call will setup the tooltip's contents to @p item
8681 * (analogous to elm_object_tooltip_content_cb_set(), but being
8682 * item tooltips with higher precedence than object tooltips). It
8683 * can have only one tooltip at a time, so any previous tooltip
8684 * content will get removed. @p func (with @p data) will be called
8685 * every time Elementary needs to show the tooltip and it should
8686 * return a valid Evas object, which will be fully managed by the
8687 * tooltip system, getting deleted when the tooltip is gone.
8691 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);
8694 * Unset a tooltip from a given gengrid item
8696 * @param item gengrid item to remove a previously set tooltip from.
8698 * This call removes any tooltip set on @p item. The callback
8699 * provided as @c del_cb to
8700 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8701 * notify it is not used anymore (and have resources cleaned, if
8704 * @see elm_gengrid_item_tooltip_content_cb_set()
8708 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8711 * Set a different @b style for a given gengrid item's tooltip.
8713 * @param item gengrid item with tooltip set
8714 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8715 * "default", @c "transparent", etc)
8717 * Tooltips can have <b>alternate styles</b> to be displayed on,
8718 * which are defined by the theme set on Elementary. This function
8719 * works analogously as elm_object_tooltip_style_set(), but here
8720 * applied only to gengrid item objects. The default style for
8721 * tooltips is @c "default".
8723 * @note before you set a style you should define a tooltip with
8724 * elm_gengrid_item_tooltip_content_cb_set() or
8725 * elm_gengrid_item_tooltip_text_set()
8727 * @see elm_gengrid_item_tooltip_style_get()
8731 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8734 * Get the style set a given gengrid item's tooltip.
8736 * @param item gengrid item with tooltip already set on.
8737 * @return style the theme style in use, which defaults to
8738 * "default". If the object does not have a tooltip set,
8739 * then @c NULL is returned.
8741 * @see elm_gengrid_item_tooltip_style_set() for more details
8745 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8747 * @brief Disable size restrictions on an object's tooltip
8748 * @param item The tooltip's anchor object
8749 * @param disable If EINA_TRUE, size restrictions are disabled
8750 * @return EINA_FALSE on failure, EINA_TRUE on success
8752 * This function allows a tooltip to expand beyond its parant window's canvas.
8753 * It will instead be limited only by the size of the display.
8755 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8757 * @brief Retrieve size restriction state of an object's tooltip
8758 * @param item The tooltip's anchor object
8759 * @return If EINA_TRUE, size restrictions are disabled
8761 * This function returns whether a tooltip is allowed to expand beyond
8762 * its parant window's canvas.
8763 * It will instead be limited only by the size of the display.
8765 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8767 * Set the type of mouse pointer/cursor decoration to be shown,
8768 * when the mouse pointer is over the given gengrid widget item
8770 * @param item gengrid item to customize cursor on
8771 * @param cursor the cursor type's name
8773 * This function works analogously as elm_object_cursor_set(), but
8774 * here the cursor's changing area is restricted to the item's
8775 * area, and not the whole widget's. Note that that item cursors
8776 * have precedence over widget cursors, so that a mouse over @p
8777 * item will always show cursor @p type.
8779 * If this function is called twice for an object, a previously set
8780 * cursor will be unset on the second call.
8782 * @see elm_object_cursor_set()
8783 * @see elm_gengrid_item_cursor_get()
8784 * @see elm_gengrid_item_cursor_unset()
8788 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8791 * Get the type of mouse pointer/cursor decoration set to be shown,
8792 * when the mouse pointer is over the given gengrid widget item
8794 * @param item gengrid item with custom cursor set
8795 * @return the cursor type's name or @c NULL, if no custom cursors
8796 * were set to @p item (and on errors)
8798 * @see elm_object_cursor_get()
8799 * @see elm_gengrid_item_cursor_set() for more details
8800 * @see elm_gengrid_item_cursor_unset()
8804 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8807 * Unset any custom mouse pointer/cursor decoration set to be
8808 * shown, when the mouse pointer is over the given gengrid widget
8809 * item, thus making it show the @b default cursor again.
8811 * @param item a gengrid item
8813 * Use this call to undo any custom settings on this item's cursor
8814 * decoration, bringing it back to defaults (no custom style set).
8816 * @see elm_object_cursor_unset()
8817 * @see elm_gengrid_item_cursor_set() for more details
8821 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8824 * Set a different @b style for a given custom cursor set for a
8827 * @param item gengrid item with custom cursor set
8828 * @param style the <b>theme style</b> to use (e.g. @c "default",
8829 * @c "transparent", etc)
8831 * This function only makes sense when one is using custom mouse
8832 * cursor decorations <b>defined in a theme file</b> , which can
8833 * have, given a cursor name/type, <b>alternate styles</b> on
8834 * it. It works analogously as elm_object_cursor_style_set(), but
8835 * here applied only to gengrid item objects.
8837 * @warning Before you set a cursor style you should have defined a
8838 * custom cursor previously on the item, with
8839 * elm_gengrid_item_cursor_set()
8841 * @see elm_gengrid_item_cursor_engine_only_set()
8842 * @see elm_gengrid_item_cursor_style_get()
8846 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8849 * Get the current @b style set for a given gengrid item's custom
8852 * @param item gengrid item with custom cursor set.
8853 * @return style the cursor style in use. If the object does not
8854 * have a cursor set, then @c NULL is returned.
8856 * @see elm_gengrid_item_cursor_style_set() for more details
8860 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8863 * Set if the (custom) cursor for a given gengrid item should be
8864 * searched in its theme, also, or should only rely on the
8867 * @param item item with custom (custom) cursor already set on
8868 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8869 * only on those provided by the rendering engine, @c EINA_FALSE to
8870 * have them searched on the widget's theme, as well.
8872 * @note This call is of use only if you've set a custom cursor
8873 * for gengrid items, with elm_gengrid_item_cursor_set().
8875 * @note By default, cursors will only be looked for between those
8876 * provided by the rendering engine.
8880 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8883 * Get if the (custom) cursor for a given gengrid item is being
8884 * searched in its theme, also, or is only relying on the rendering
8887 * @param item a gengrid item
8888 * @return @c EINA_TRUE, if cursors are being looked for only on
8889 * those provided by the rendering engine, @c EINA_FALSE if they
8890 * are being searched on the widget's theme, as well.
8892 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8896 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8899 * Remove all items from a given gengrid widget
8901 * @param obj The gengrid object.
8903 * This removes (and deletes) all items in @p obj, leaving it
8906 * @see elm_gengrid_item_del(), to remove just one item.
8910 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8913 * Get the selected item in a given gengrid widget
8915 * @param obj The gengrid object.
8916 * @return The selected item's handleor @c NULL, if none is
8917 * selected at the moment (and on errors)
8919 * This returns the selected item in @p obj. If multi selection is
8920 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8921 * the first item in the list is selected, which might not be very
8922 * useful. For that case, see elm_gengrid_selected_items_get().
8926 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8929 * Get <b>a list</b> of selected items in a given gengrid
8931 * @param obj The gengrid object.
8932 * @return The list of selected items or @c NULL, if none is
8933 * selected at the moment (and on errors)
8935 * This returns a list of the selected items, in the order that
8936 * they appear in the grid. This list is only valid as long as no
8937 * more items are selected or unselected (or unselected implictly
8938 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8941 * @see elm_gengrid_selected_item_get()
8945 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8952 * @defgroup Clock Clock
8954 * @image html img/widget/clock/preview-00.png
8955 * @image latex img/widget/clock/preview-00.eps
8957 * This is a @b digital clock widget. In its default theme, it has a
8958 * vintage "flipping numbers clock" appearance, which will animate
8959 * sheets of individual algarisms individually as time goes by.
8961 * A newly created clock will fetch system's time (already
8962 * considering local time adjustments) to start with, and will tick
8963 * accondingly. It may or may not show seconds.
8965 * Clocks have an @b edition mode. When in it, the sheets will
8966 * display extra arrow indications on the top and bottom and the
8967 * user may click on them to raise or lower the time values. After
8968 * it's told to exit edition mode, it will keep ticking with that
8969 * new time set (it keeps the difference from local time).
8971 * Also, when under edition mode, user clicks on the cited arrows
8972 * which are @b held for some time will make the clock to flip the
8973 * sheet, thus editing the time, continuosly and automatically for
8974 * the user. The interval between sheet flips will keep growing in
8975 * time, so that it helps the user to reach a time which is distant
8978 * The time display is, by default, in military mode (24h), but an
8979 * am/pm indicator may be optionally shown, too, when it will
8982 * Smart callbacks one can register to:
8983 * - "changed" - the clock's user changed the time
8985 * Here is an example on its usage:
8986 * @li @ref clock_example
8995 * Identifiers for which clock digits should be editable, when a
8996 * clock widget is in edition mode. Values may be ORed together to
8997 * make a mask, naturally.
8999 * @see elm_clock_edit_set()
9000 * @see elm_clock_digit_edit_set()
9002 typedef enum _Elm_Clock_Digedit
9004 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9005 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9006 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9007 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9008 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9009 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9010 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9011 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9012 } Elm_Clock_Digedit;
9015 * Add a new clock widget to the given parent Elementary
9016 * (container) object
9018 * @param parent The parent object
9019 * @return a new clock widget handle or @c NULL, on errors
9021 * This function inserts a new clock widget on the canvas.
9025 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9028 * Set a clock widget's time, programmatically
9030 * @param obj The clock widget object
9031 * @param hrs The hours to set
9032 * @param min The minutes to set
9033 * @param sec The secondes to set
9035 * This function updates the time that is showed by the clock
9038 * Values @b must be set within the following ranges:
9039 * - 0 - 23, for hours
9040 * - 0 - 59, for minutes
9041 * - 0 - 59, for seconds,
9043 * even if the clock is not in "military" mode.
9045 * @warning The behavior for values set out of those ranges is @b
9050 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9053 * Get a clock widget's time values
9055 * @param obj The clock object
9056 * @param[out] hrs Pointer to the variable to get the hours value
9057 * @param[out] min Pointer to the variable to get the minutes value
9058 * @param[out] sec Pointer to the variable to get the seconds value
9060 * This function gets the time set for @p obj, returning
9061 * it on the variables passed as the arguments to function
9063 * @note Use @c NULL pointers on the time values you're not
9064 * interested in: they'll be ignored by the function.
9068 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9071 * Set whether a given clock widget is under <b>edition mode</b> or
9072 * under (default) displaying-only mode.
9074 * @param obj The clock object
9075 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9076 * put it back to "displaying only" mode
9078 * This function makes a clock's time to be editable or not <b>by
9079 * user interaction</b>. When in edition mode, clocks @b stop
9080 * ticking, until one brings them back to canonical mode. The
9081 * elm_clock_digit_edit_set() function will influence which digits
9082 * of the clock will be editable. By default, all of them will be
9083 * (#ELM_CLOCK_NONE).
9085 * @note am/pm sheets, if being shown, will @b always be editable
9086 * under edition mode.
9088 * @see elm_clock_edit_get()
9092 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9095 * Retrieve whether a given clock widget is under <b>edition
9096 * mode</b> or under (default) displaying-only mode.
9098 * @param obj The clock object
9099 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9102 * This function retrieves whether the clock's time can be edited
9103 * or not by user interaction.
9105 * @see elm_clock_edit_set() for more details
9109 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9112 * Set what digits of the given clock widget should be editable
9113 * when in edition mode.
9115 * @param obj The clock object
9116 * @param digedit Bit mask indicating the digits to be editable
9117 * (values in #Elm_Clock_Digedit).
9119 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9120 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9123 * @see elm_clock_digit_edit_get()
9127 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9130 * Retrieve what digits of the given clock widget should be
9131 * editable when in edition mode.
9133 * @param obj The clock object
9134 * @return Bit mask indicating the digits to be editable
9135 * (values in #Elm_Clock_Digedit).
9137 * @see elm_clock_digit_edit_set() for more details
9141 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9144 * Set if the given clock widget must show hours in military or
9147 * @param obj The clock object
9148 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9151 * This function sets if the clock must show hours in military or
9152 * am/pm mode. In some countries like Brazil the military mode
9153 * (00-24h-format) is used, in opposition to the USA, where the
9154 * am/pm mode is more commonly used.
9156 * @see elm_clock_show_am_pm_get()
9160 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9163 * Get if the given clock widget shows hours in military or am/pm
9166 * @param obj The clock object
9167 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9170 * This function gets if the clock shows hours in military or am/pm
9173 * @see elm_clock_show_am_pm_set() for more details
9177 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9180 * Set if the given clock widget must show time with seconds or not
9182 * @param obj The clock object
9183 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9185 * This function sets if the given clock must show or not elapsed
9186 * seconds. By default, they are @b not shown.
9188 * @see elm_clock_show_seconds_get()
9192 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9195 * Get whether the given clock widget is showing time with seconds
9198 * @param obj The clock object
9199 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9201 * This function gets whether @p obj is showing or not the elapsed
9204 * @see elm_clock_show_seconds_set()
9208 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9211 * Set the interval on time updates for an user mouse button hold
9212 * on clock widgets' time edition.
9214 * @param obj The clock object
9215 * @param interval The (first) interval value in seconds
9217 * This interval value is @b decreased while the user holds the
9218 * mouse pointer either incrementing or decrementing a given the
9219 * clock digit's value.
9221 * This helps the user to get to a given time distant from the
9222 * current one easier/faster, as it will start to flip quicker and
9223 * quicker on mouse button holds.
9225 * The calculation for the next flip interval value, starting from
9226 * the one set with this call, is the previous interval divided by
9227 * 1.05, so it decreases a little bit.
9229 * The default starting interval value for automatic flips is
9232 * @see elm_clock_interval_get()
9236 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9239 * Get the interval on time updates for an user mouse button hold
9240 * on clock widgets' time edition.
9242 * @param obj The clock object
9243 * @return The (first) interval value, in seconds, set on it
9245 * @see elm_clock_interval_set() for more details
9249 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9256 * @defgroup Layout Layout
9258 * @image html img/widget/layout/preview-00.png
9259 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9261 * @image html img/layout-predefined.png
9262 * @image latex img/layout-predefined.eps width=\textwidth
9264 * This is a container widget that takes a standard Edje design file and
9265 * wraps it very thinly in a widget.
9267 * An Edje design (theme) file has a very wide range of possibilities to
9268 * describe the behavior of elements added to the Layout. Check out the Edje
9269 * documentation and the EDC reference to get more information about what can
9270 * be done with Edje.
9272 * Just like @ref List, @ref Box, and other container widgets, any
9273 * object added to the Layout will become its child, meaning that it will be
9274 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9276 * The Layout widget can contain as many Contents, Boxes or Tables as
9277 * described in its theme file. For instance, objects can be added to
9278 * different Tables by specifying the respective Table part names. The same
9279 * is valid for Content and Box.
9281 * The objects added as child of the Layout will behave as described in the
9282 * part description where they were added. There are 3 possible types of
9283 * parts where a child can be added:
9285 * @section secContent Content (SWALLOW part)
9287 * Only one object can be added to the @c SWALLOW part (but you still can
9288 * have many @c SWALLOW parts and one object on each of them). Use the @c
9289 * elm_layout_content_* set of functions to set, retrieve and unset objects
9290 * as content of the @c SWALLOW. After being set to this part, the object
9291 * size, position, visibility, clipping and other description properties
9292 * will be totally controled by the description of the given part (inside
9293 * the Edje theme file).
9295 * One can use @c evas_object_size_hint_* functions on the child to have some
9296 * kind of control over its behavior, but the resulting behavior will still
9297 * depend heavily on the @c SWALLOW part description.
9299 * The Edje theme also can change the part description, based on signals or
9300 * scripts running inside the theme. This change can also be animated. All of
9301 * this will affect the child object set as content accordingly. The object
9302 * size will be changed if the part size is changed, it will animate move if
9303 * the part is moving, and so on.
9305 * The following picture demonstrates a Layout widget with a child object
9306 * added to its @c SWALLOW:
9308 * @image html layout_swallow.png
9309 * @image latex layout_swallow.eps width=\textwidth
9311 * @section secBox Box (BOX part)
9313 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9314 * allows one to add objects to the box and have them distributed along its
9315 * area, accordingly to the specified @a layout property (now by @a layout we
9316 * mean the chosen layouting design of the Box, not the Layout widget
9319 * A similar effect for having a box with its position, size and other things
9320 * controled by the Layout theme would be to create an Elementary @ref Box
9321 * widget and add it as a Content in the @c SWALLOW part.
9323 * The main difference of using the Layout Box is that its behavior, the box
9324 * properties like layouting format, padding, align, etc. will be all
9325 * controled by the theme. This means, for example, that a signal could be
9326 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9327 * handled the signal by changing the box padding, or align, or both. Using
9328 * the Elementary @ref Box widget is not necessarily harder or easier, it
9329 * just depends on the circunstances and requirements.
9331 * The Layout Box can be used through the @c elm_layout_box_* set of
9334 * The following picture demonstrates a Layout widget with many child objects
9335 * added to its @c BOX part:
9337 * @image html layout_box.png
9338 * @image latex layout_box.eps width=\textwidth
9340 * @section secTable Table (TABLE part)
9342 * Just like the @ref secBox, the Layout Table is very similar to the
9343 * Elementary @ref Table widget. It allows one to add objects to the Table
9344 * specifying the row and column where the object should be added, and any
9345 * column or row span if necessary.
9347 * Again, we could have this design by adding a @ref Table widget to the @c
9348 * SWALLOW part using elm_layout_content_set(). The same difference happens
9349 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9350 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9352 * The Layout Table can be used through the @c elm_layout_table_* set of
9355 * The following picture demonstrates a Layout widget with many child objects
9356 * added to its @c TABLE part:
9358 * @image html layout_table.png
9359 * @image latex layout_table.eps width=\textwidth
9361 * @section secPredef Predefined Layouts
9363 * Another interesting thing about the Layout widget is that it offers some
9364 * predefined themes that come with the default Elementary theme. These
9365 * themes can be set by the call elm_layout_theme_set(), and provide some
9366 * basic functionality depending on the theme used.
9368 * Most of them already send some signals, some already provide a toolbar or
9369 * back and next buttons.
9371 * These are available predefined theme layouts. All of them have class = @c
9372 * layout, group = @c application, and style = one of the following options:
9374 * @li @c toolbar-content - application with toolbar and main content area
9375 * @li @c toolbar-content-back - application with toolbar and main content
9376 * area with a back button and title area
9377 * @li @c toolbar-content-back-next - application with toolbar and main
9378 * content area with a back and next buttons and title area
9379 * @li @c content-back - application with a main content area with a back
9380 * button and title area
9381 * @li @c content-back-next - application with a main content area with a
9382 * back and next buttons and title area
9383 * @li @c toolbar-vbox - application with toolbar and main content area as a
9385 * @li @c toolbar-table - application with toolbar and main content area as a
9388 * @section secExamples Examples
9390 * Some examples of the Layout widget can be found here:
9391 * @li @ref layout_example_01
9392 * @li @ref layout_example_02
9393 * @li @ref layout_example_03
9394 * @li @ref layout_example_edc
9399 * Add a new layout to the parent
9401 * @param parent The parent object
9402 * @return The new object or NULL if it cannot be created
9404 * @see elm_layout_file_set()
9405 * @see elm_layout_theme_set()
9409 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9411 * Set the file that will be used as layout
9413 * @param obj The layout object
9414 * @param file The path to file (edj) that will be used as layout
9415 * @param group The group that the layout belongs in edje file
9417 * @return (1 = success, 0 = error)
9421 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9423 * Set the edje group from the elementary theme that will be used as layout
9425 * @param obj The layout object
9426 * @param clas the clas of the group
9427 * @param group the group
9428 * @param style the style to used
9430 * @return (1 = success, 0 = error)
9434 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9436 * Set the layout content.
9438 * @param obj The layout object
9439 * @param swallow The swallow part name in the edje file
9440 * @param content The child that will be added in this layout object
9442 * Once the content object is set, a previously set one will be deleted.
9443 * If you want to keep that old content object, use the
9444 * elm_layout_content_unset() function.
9446 * @note In an Edje theme, the part used as a content container is called @c
9447 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9448 * expected to be a part name just like the second parameter of
9449 * elm_layout_box_append().
9451 * @see elm_layout_box_append()
9452 * @see elm_layout_content_get()
9453 * @see elm_layout_content_unset()
9458 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9460 * Get the child object in the given content part.
9462 * @param obj The layout object
9463 * @param swallow The SWALLOW part to get its content
9465 * @return The swallowed object or NULL if none or an error occurred
9467 * @see elm_layout_content_set()
9471 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9473 * Unset the layout content.
9475 * @param obj The layout object
9476 * @param swallow The swallow part name in the edje file
9477 * @return The content that was being used
9479 * Unparent and return the content object which was set for this part.
9481 * @see elm_layout_content_set()
9485 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9487 * Set the text of the given part
9489 * @param obj The layout object
9490 * @param part The TEXT part where to set the text
9491 * @param text The text to set
9494 * @deprecated use elm_object_text_* instead.
9496 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9498 * Get the text set in the given part
9500 * @param obj The layout object
9501 * @param part The TEXT part to retrieve the text off
9503 * @return The text set in @p part
9506 * @deprecated use elm_object_text_* instead.
9508 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9510 * Append child to layout box part.
9512 * @param obj the layout object
9513 * @param part the box part to which the object will be appended.
9514 * @param child the child object to append to box.
9516 * Once the object is appended, it will become child of the layout. Its
9517 * lifetime will be bound to the layout, whenever the layout dies the child
9518 * will be deleted automatically. One should use elm_layout_box_remove() to
9519 * make this layout forget about the object.
9521 * @see elm_layout_box_prepend()
9522 * @see elm_layout_box_insert_before()
9523 * @see elm_layout_box_insert_at()
9524 * @see elm_layout_box_remove()
9528 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9530 * Prepend child to layout box part.
9532 * @param obj the layout object
9533 * @param part the box part to prepend.
9534 * @param child the child object to prepend to box.
9536 * Once the object is prepended, it will become child of the layout. Its
9537 * lifetime will be bound to the layout, whenever the layout dies the child
9538 * will be deleted automatically. One should use elm_layout_box_remove() to
9539 * make this layout forget about the object.
9541 * @see elm_layout_box_append()
9542 * @see elm_layout_box_insert_before()
9543 * @see elm_layout_box_insert_at()
9544 * @see elm_layout_box_remove()
9548 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9550 * Insert child to layout box part before a reference object.
9552 * @param obj the layout object
9553 * @param part the box part to insert.
9554 * @param child the child object to insert into box.
9555 * @param reference another reference object to insert before in box.
9557 * Once the object is inserted, it will become child of the layout. Its
9558 * lifetime will be bound to the layout, whenever the layout dies the child
9559 * will be deleted automatically. One should use elm_layout_box_remove() to
9560 * make this layout forget about the object.
9562 * @see elm_layout_box_append()
9563 * @see elm_layout_box_prepend()
9564 * @see elm_layout_box_insert_before()
9565 * @see elm_layout_box_remove()
9569 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9571 * Insert child to layout box part at a given position.
9573 * @param obj the layout object
9574 * @param part the box part to insert.
9575 * @param child the child object to insert into box.
9576 * @param pos the numeric position >=0 to insert the child.
9578 * Once the object is inserted, it will become child of the layout. Its
9579 * lifetime will be bound to the layout, whenever the layout dies the child
9580 * will be deleted automatically. One should use elm_layout_box_remove() to
9581 * make this layout forget about the object.
9583 * @see elm_layout_box_append()
9584 * @see elm_layout_box_prepend()
9585 * @see elm_layout_box_insert_before()
9586 * @see elm_layout_box_remove()
9590 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9592 * Remove a child of the given part box.
9594 * @param obj The layout object
9595 * @param part The box part name to remove child.
9596 * @param child The object to remove from box.
9597 * @return The object that was being used, or NULL if not found.
9599 * The object will be removed from the box part and its lifetime will
9600 * not be handled by the layout anymore. This is equivalent to
9601 * elm_layout_content_unset() for box.
9603 * @see elm_layout_box_append()
9604 * @see elm_layout_box_remove_all()
9608 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9610 * Remove all child of the given part box.
9612 * @param obj The layout object
9613 * @param part The box part name to remove child.
9614 * @param clear If EINA_TRUE, then all objects will be deleted as
9615 * well, otherwise they will just be removed and will be
9616 * dangling on the canvas.
9618 * The objects will be removed from the box part and their lifetime will
9619 * not be handled by the layout anymore. This is equivalent to
9620 * elm_layout_box_remove() for all box children.
9622 * @see elm_layout_box_append()
9623 * @see elm_layout_box_remove()
9627 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9629 * Insert child to layout table part.
9631 * @param obj the layout object
9632 * @param part the box part to pack child.
9633 * @param child_obj the child object to pack into table.
9634 * @param col the column to which the child should be added. (>= 0)
9635 * @param row the row to which the child should be added. (>= 0)
9636 * @param colspan how many columns should be used to store this object. (>=
9638 * @param rowspan how many rows should be used to store this object. (>= 1)
9640 * Once the object is inserted, it will become child of the table. Its
9641 * lifetime will be bound to the layout, and whenever the layout dies the
9642 * child will be deleted automatically. One should use
9643 * elm_layout_table_remove() to make this layout forget about the object.
9645 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9646 * more space than a single cell. For instance, the following code:
9648 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9651 * Would result in an object being added like the following picture:
9653 * @image html layout_colspan.png
9654 * @image latex layout_colspan.eps width=\textwidth
9656 * @see elm_layout_table_unpack()
9657 * @see elm_layout_table_clear()
9661 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);
9663 * Unpack (remove) a child of the given part table.
9665 * @param obj The layout object
9666 * @param part The table part name to remove child.
9667 * @param child_obj The object to remove from table.
9668 * @return The object that was being used, or NULL if not found.
9670 * The object will be unpacked from the table part and its lifetime
9671 * will not be handled by the layout anymore. This is equivalent to
9672 * elm_layout_content_unset() for table.
9674 * @see elm_layout_table_pack()
9675 * @see elm_layout_table_clear()
9679 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9681 * Remove all child of the given part table.
9683 * @param obj The layout object
9684 * @param part The table part name to remove child.
9685 * @param clear If EINA_TRUE, then all objects will be deleted as
9686 * well, otherwise they will just be removed and will be
9687 * dangling on the canvas.
9689 * The objects will be removed from the table part and their lifetime will
9690 * not be handled by the layout anymore. This is equivalent to
9691 * elm_layout_table_unpack() for all table children.
9693 * @see elm_layout_table_pack()
9694 * @see elm_layout_table_unpack()
9698 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9700 * Get the edje layout
9702 * @param obj The layout object
9704 * @return A Evas_Object with the edje layout settings loaded
9705 * with function elm_layout_file_set
9707 * This returns the edje object. It is not expected to be used to then
9708 * swallow objects via edje_object_part_swallow() for example. Use
9709 * elm_layout_content_set() instead so child object handling and sizing is
9712 * @note This function should only be used if you really need to call some
9713 * low level Edje function on this edje object. All the common stuff (setting
9714 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9715 * with proper elementary functions.
9717 * @see elm_object_signal_callback_add()
9718 * @see elm_object_signal_emit()
9719 * @see elm_object_text_part_set()
9720 * @see elm_layout_content_set()
9721 * @see elm_layout_box_append()
9722 * @see elm_layout_table_pack()
9723 * @see elm_layout_data_get()
9727 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9729 * Get the edje data from the given layout
9731 * @param obj The layout object
9732 * @param key The data key
9734 * @return The edje data string
9736 * This function fetches data specified inside the edje theme of this layout.
9737 * This function return NULL if data is not found.
9739 * In EDC this comes from a data block within the group block that @p
9740 * obj was loaded from. E.g.
9747 * item: "key1" "value1";
9748 * item: "key2" "value2";
9756 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9760 * @param obj The layout object
9762 * Manually forces a sizing re-evaluation. This is useful when the minimum
9763 * size required by the edje theme of this layout has changed. The change on
9764 * the minimum size required by the edje theme is not immediately reported to
9765 * the elementary layout, so one needs to call this function in order to tell
9766 * the widget (layout) that it needs to reevaluate its own size.
9768 * The minimum size of the theme is calculated based on minimum size of
9769 * parts, the size of elements inside containers like box and table, etc. All
9770 * of this can change due to state changes, and that's when this function
9773 * Also note that a standard signal of "size,eval" "elm" emitted from the
9774 * edje object will cause this to happen too.
9778 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9781 * Sets a specific cursor for an edje part.
9783 * @param obj The layout object.
9784 * @param part_name a part from loaded edje group.
9785 * @param cursor cursor name to use, see Elementary_Cursor.h
9787 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9788 * part not exists or it has "mouse_events: 0".
9792 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9795 * Get the cursor to be shown when mouse is over an edje part
9797 * @param obj The layout object.
9798 * @param part_name a part from loaded edje group.
9799 * @return the cursor name.
9803 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9806 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9808 * @param obj The layout object.
9809 * @param part_name a part from loaded edje group, that had a cursor set
9810 * with elm_layout_part_cursor_set().
9814 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9817 * Sets a specific cursor style for an edje part.
9819 * @param obj The layout object.
9820 * @param part_name a part from loaded edje group.
9821 * @param style the theme style to use (default, transparent, ...)
9823 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9824 * part not exists or it did not had a cursor set.
9828 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9831 * Gets a specific cursor style for an edje part.
9833 * @param obj The layout object.
9834 * @param part_name a part from loaded edje group.
9836 * @return the theme style in use, defaults to "default". If the
9837 * object does not have a cursor set, then NULL is returned.
9841 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9844 * Sets if the cursor set should be searched on the theme or should use
9845 * the provided by the engine, only.
9847 * @note before you set if should look on theme you should define a
9848 * cursor with elm_layout_part_cursor_set(). By default it will only
9849 * look for cursors provided by the engine.
9851 * @param obj The layout object.
9852 * @param part_name a part from loaded edje group.
9853 * @param engine_only if cursors should be just provided by the engine
9854 * or should also search on widget's theme as well
9856 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9857 * part not exists or it did not had a cursor set.
9861 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);
9864 * Gets a specific cursor engine_only for an edje part.
9866 * @param obj The layout object.
9867 * @param part_name a part from loaded edje group.
9869 * @return whenever the cursor is just provided by engine or also from theme.
9873 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9876 * @def elm_layout_icon_set
9877 * Convienience macro to set the icon object in a layout that follows the
9878 * Elementary naming convention for its parts.
9882 #define elm_layout_icon_set(_ly, _obj) \
9885 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9886 if ((_obj)) sig = "elm,state,icon,visible"; \
9887 else sig = "elm,state,icon,hidden"; \
9888 elm_object_signal_emit((_ly), sig, "elm"); \
9892 * @def elm_layout_icon_get
9893 * Convienience macro to get the icon object from a layout that follows the
9894 * Elementary naming convention for its parts.
9898 #define elm_layout_icon_get(_ly) \
9899 elm_layout_content_get((_ly), "elm.swallow.icon")
9902 * @def elm_layout_end_set
9903 * Convienience macro to set the end object in a layout that follows the
9904 * Elementary naming convention for its parts.
9908 #define elm_layout_end_set(_ly, _obj) \
9911 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9912 if ((_obj)) sig = "elm,state,end,visible"; \
9913 else sig = "elm,state,end,hidden"; \
9914 elm_object_signal_emit((_ly), sig, "elm"); \
9918 * @def elm_layout_end_get
9919 * Convienience macro to get the end object in a layout that follows the
9920 * Elementary naming convention for its parts.
9924 #define elm_layout_end_get(_ly) \
9925 elm_layout_content_get((_ly), "elm.swallow.end")
9928 * @def elm_layout_label_set
9929 * Convienience macro to set the label in a layout that follows the
9930 * Elementary naming convention for its parts.
9933 * @deprecated use elm_object_text_* instead.
9935 #define elm_layout_label_set(_ly, _txt) \
9936 elm_layout_text_set((_ly), "elm.text", (_txt))
9939 * @def elm_layout_label_get
9940 * Convienience macro to get the label in a layout that follows the
9941 * Elementary naming convention for its parts.
9944 * @deprecated use elm_object_text_* instead.
9946 #define elm_layout_label_get(_ly) \
9947 elm_layout_text_get((_ly), "elm.text")
9949 /* smart callbacks called:
9950 * "theme,changed" - when elm theme is changed.
9954 * @defgroup Notify Notify
9956 * @image html img/widget/notify/preview-00.png
9957 * @image latex img/widget/notify/preview-00.eps
9959 * Display a container in a particular region of the parent(top, bottom,
9960 * etc. A timeout can be set to automatically hide the notify. This is so
9961 * that, after an evas_object_show() on a notify object, if a timeout was set
9962 * on it, it will @b automatically get hidden after that time.
9964 * Signals that you can add callbacks for are:
9965 * @li "timeout" - when timeout happens on notify and it's hidden
9966 * @li "block,clicked" - when a click outside of the notify happens
9968 * @ref tutorial_notify show usage of the API.
9973 * @brief Possible orient values for notify.
9975 * This values should be used in conjunction to elm_notify_orient_set() to
9976 * set the position in which the notify should appear(relative to its parent)
9977 * and in conjunction with elm_notify_orient_get() to know where the notify
9980 typedef enum _Elm_Notify_Orient
9982 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9983 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9984 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9985 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9986 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9987 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9988 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9989 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9990 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9991 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9992 } Elm_Notify_Orient;
9994 * @brief Add a new notify to the parent
9996 * @param parent The parent object
9997 * @return The new object or NULL if it cannot be created
9999 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10001 * @brief Set the content of the notify widget
10003 * @param obj The notify object
10004 * @param content The content will be filled in this notify object
10006 * Once the content object is set, a previously set one will be deleted. If
10007 * you want to keep that old content object, use the
10008 * elm_notify_content_unset() function.
10010 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10012 * @brief Unset the content of the notify widget
10014 * @param obj The notify object
10015 * @return The content that was being used
10017 * Unparent and return the content object which was set for this widget
10019 * @see elm_notify_content_set()
10021 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10023 * @brief Return the content of the notify widget
10025 * @param obj The notify object
10026 * @return The content that is being used
10028 * @see elm_notify_content_set()
10030 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10032 * @brief Set the notify parent
10034 * @param obj The notify object
10035 * @param content The new parent
10037 * Once the parent object is set, a previously set one will be disconnected
10040 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10042 * @brief Get the notify parent
10044 * @param obj The notify object
10045 * @return The parent
10047 * @see elm_notify_parent_set()
10049 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10051 * @brief Set the orientation
10053 * @param obj The notify object
10054 * @param orient The new orientation
10056 * Sets the position in which the notify will appear in its parent.
10058 * @see @ref Elm_Notify_Orient for possible values.
10060 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10062 * @brief Return the orientation
10063 * @param obj The notify object
10064 * @return The orientation of the notification
10066 * @see elm_notify_orient_set()
10067 * @see Elm_Notify_Orient
10069 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10071 * @brief Set the time interval after which the notify window is going to be
10074 * @param obj The notify object
10075 * @param time The timeout in seconds
10077 * This function sets a timeout and starts the timer controlling when the
10078 * notify is hidden. Since calling evas_object_show() on a notify restarts
10079 * the timer controlling when the notify is hidden, setting this before the
10080 * notify is shown will in effect mean starting the timer when the notify is
10083 * @note Set a value <= 0.0 to disable a running timer.
10085 * @note If the value > 0.0 and the notify is previously visible, the
10086 * timer will be started with this value, canceling any running timer.
10088 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10090 * @brief Return the timeout value (in seconds)
10091 * @param obj the notify object
10093 * @see elm_notify_timeout_set()
10095 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10097 * @brief Sets whether events should be passed to by a click outside
10100 * @param obj The notify object
10101 * @param repeats EINA_TRUE Events are repeats, else no
10103 * When true if the user clicks outside the window the events will be caught
10104 * by the others widgets, else the events are blocked.
10106 * @note The default value is EINA_TRUE.
10108 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10110 * @brief Return true if events are repeat below the notify object
10111 * @param obj the notify object
10113 * @see elm_notify_repeat_events_set()
10115 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10121 * @defgroup Hover Hover
10123 * @image html img/widget/hover/preview-00.png
10124 * @image latex img/widget/hover/preview-00.eps
10126 * A Hover object will hover over its @p parent object at the @p target
10127 * location. Anything in the background will be given a darker coloring to
10128 * indicate that the hover object is on top (at the default theme). When the
10129 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10130 * clicked that @b doesn't cause the hover to be dismissed.
10132 * @note The hover object will take up the entire space of @p target
10135 * Elementary has the following styles for the hover widget:
10139 * @li hoversel_vertical
10141 * The following are the available position for content:
10153 * Signals that you can add callbacks for are:
10154 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10155 * @li "smart,changed" - a content object placed under the "smart"
10156 * policy was replaced to a new slot direction.
10158 * See @ref tutorial_hover for more information.
10162 typedef enum _Elm_Hover_Axis
10164 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10165 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10166 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10167 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10170 * @brief Adds a hover object to @p parent
10172 * @param parent The parent object
10173 * @return The hover object or NULL if one could not be created
10175 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10177 * @brief Sets the target object for the hover.
10179 * @param obj The hover object
10180 * @param target The object to center the hover onto. The hover
10182 * This function will cause the hover to be centered on the target object.
10184 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10186 * @brief Gets the target object for the hover.
10188 * @param obj The hover object
10189 * @param parent The object to locate the hover over.
10191 * @see elm_hover_target_set()
10193 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10195 * @brief Sets the parent object for the hover.
10197 * @param obj The hover object
10198 * @param parent The object to locate the hover over.
10200 * This function will cause the hover to take up the entire space that the
10201 * parent object fills.
10203 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10205 * @brief Gets the parent object for the hover.
10207 * @param obj The hover object
10208 * @return The parent object to locate the hover over.
10210 * @see elm_hover_parent_set()
10212 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10214 * @brief Sets the content of the hover object and the direction in which it
10217 * @param obj The hover object
10218 * @param swallow The direction that the object will be displayed
10219 * at. Accepted values are "left", "top-left", "top", "top-right",
10220 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10222 * @param content The content to place at @p swallow
10224 * Once the content object is set for a given direction, a previously
10225 * set one (on the same direction) will be deleted. If you want to
10226 * keep that old content object, use the elm_hover_content_unset()
10229 * All directions may have contents at the same time, except for
10230 * "smart". This is a special placement hint and its use case
10231 * independs of the calculations coming from
10232 * elm_hover_best_content_location_get(). Its use is for cases when
10233 * one desires only one hover content, but with a dinamic special
10234 * placement within the hover area. The content's geometry, whenever
10235 * it changes, will be used to decide on a best location not
10236 * extrapolating the hover's parent object view to show it in (still
10237 * being the hover's target determinant of its medium part -- move and
10238 * resize it to simulate finger sizes, for example). If one of the
10239 * directions other than "smart" are used, a previously content set
10240 * using it will be deleted, and vice-versa.
10242 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10244 * @brief Get the content of the hover object, in a given direction.
10246 * Return the content object which was set for this widget in the
10247 * @p swallow direction.
10249 * @param obj The hover object
10250 * @param swallow The direction that the object was display at.
10251 * @return The content that was being used
10253 * @see elm_hover_content_set()
10255 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10257 * @brief Unset the content of the hover object, in a given direction.
10259 * Unparent and return the content object set at @p swallow direction.
10261 * @param obj The hover object
10262 * @param swallow The direction that the object was display at.
10263 * @return The content that was being used.
10265 * @see elm_hover_content_set()
10267 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10269 * @brief Returns the best swallow location for content in the hover.
10271 * @param obj The hover object
10272 * @param pref_axis The preferred orientation axis for the hover object to use
10273 * @return The edje location to place content into the hover or @c
10276 * Best is defined here as the location at which there is the most available
10279 * @p pref_axis may be one of
10280 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10281 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10282 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10283 * - @c ELM_HOVER_AXIS_BOTH -- both
10285 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10286 * nescessarily be along the horizontal axis("left" or "right"). If
10287 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10288 * be along the vertical axis("top" or "bottom"). Chossing
10289 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10290 * returned position may be in either axis.
10292 * @see elm_hover_content_set()
10294 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10301 * @defgroup Entry Entry
10303 * @image html img/widget/entry/preview-00.png
10304 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10305 * @image html img/widget/entry/preview-01.png
10306 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10307 * @image html img/widget/entry/preview-02.png
10308 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10309 * @image html img/widget/entry/preview-03.png
10310 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10312 * An entry is a convenience widget which shows a box that the user can
10313 * enter text into. Entries by default don't scroll, so they grow to
10314 * accomodate the entire text, resizing the parent window as needed. This
10315 * can be changed with the elm_entry_scrollable_set() function.
10317 * They can also be single line or multi line (the default) and when set
10318 * to multi line mode they support text wrapping in any of the modes
10319 * indicated by #Elm_Wrap_Type.
10321 * Other features include password mode, filtering of inserted text with
10322 * elm_entry_text_filter_append() and related functions, inline "items" and
10323 * formatted markup text.
10325 * @section entry-markup Formatted text
10327 * The markup tags supported by the Entry are defined by the theme, but
10328 * even when writing new themes or extensions it's a good idea to stick to
10329 * a sane default, to maintain coherency and avoid application breakages.
10330 * Currently defined by the default theme are the following tags:
10331 * @li \<br\>: Inserts a line break.
10332 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10334 * @li \<tab\>: Inserts a tab.
10335 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10337 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10338 * @li \<link\>...\</link\>: Underlines the enclosed text.
10339 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10341 * @section entry-special Special markups
10343 * Besides those used to format text, entries support two special markup
10344 * tags used to insert clickable portions of text or items inlined within
10347 * @subsection entry-anchors Anchors
10349 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10350 * \</a\> tags and an event will be generated when this text is clicked,
10354 * This text is outside <a href=anc-01>but this one is an anchor</a>
10357 * The @c href attribute in the opening tag gives the name that will be
10358 * used to identify the anchor and it can be any valid utf8 string.
10360 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10361 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10362 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10363 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10366 * @subsection entry-items Items
10368 * Inlined in the text, any other @c Evas_Object can be inserted by using
10369 * \<item\> tags this way:
10372 * <item size=16x16 vsize=full href=emoticon/haha></item>
10375 * Just like with anchors, the @c href identifies each item, but these need,
10376 * in addition, to indicate their size, which is done using any one of
10377 * @c size, @c absize or @c relsize attributes. These attributes take their
10378 * value in the WxH format, where W is the width and H the height of the
10381 * @li absize: Absolute pixel size for the item. Whatever value is set will
10382 * be the item's size regardless of any scale value the object may have
10383 * been set to. The final line height will be adjusted to fit larger items.
10384 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10386 * @li relsize: Size is adjusted for the item to fit within the current
10389 * Besides their size, items are specificed a @c vsize value that affects
10390 * how their final size and position are calculated. The possible values
10392 * @li ascent: Item will be placed within the line's baseline and its
10393 * ascent. That is, the height between the line where all characters are
10394 * positioned and the highest point in the line. For @c size and @c absize
10395 * items, the descent value will be added to the total line height to make
10396 * them fit. @c relsize items will be adjusted to fit within this space.
10397 * @li full: Items will be placed between the descent and ascent, or the
10398 * lowest point in the line and its highest.
10400 * The next image shows different configurations of items and how they
10401 * are the previously mentioned options affect their sizes. In all cases,
10402 * the green line indicates the ascent, blue for the baseline and red for
10405 * @image html entry_item.png
10406 * @image latex entry_item.eps width=\textwidth
10408 * And another one to show how size differs from absize. In the first one,
10409 * the scale value is set to 1.0, while the second one is using one of 2.0.
10411 * @image html entry_item_scale.png
10412 * @image latex entry_item_scale.eps width=\textwidth
10414 * After the size for an item is calculated, the entry will request an
10415 * object to place in its space. For this, the functions set with
10416 * elm_entry_item_provider_append() and related functions will be called
10417 * in order until one of them returns a @c non-NULL value. If no providers
10418 * are available, or all of them return @c NULL, then the entry falls back
10419 * to one of the internal defaults, provided the name matches with one of
10422 * All of the following are currently supported:
10425 * - emoticon/angry-shout
10426 * - emoticon/crazy-laugh
10427 * - emoticon/evil-laugh
10429 * - emoticon/goggle-smile
10430 * - emoticon/grumpy
10431 * - emoticon/grumpy-smile
10432 * - emoticon/guilty
10433 * - emoticon/guilty-smile
10435 * - emoticon/half-smile
10436 * - emoticon/happy-panting
10438 * - emoticon/indifferent
10440 * - emoticon/knowing-grin
10442 * - emoticon/little-bit-sorry
10443 * - emoticon/love-lots
10445 * - emoticon/minimal-smile
10446 * - emoticon/not-happy
10447 * - emoticon/not-impressed
10449 * - emoticon/opensmile
10452 * - emoticon/squint-laugh
10453 * - emoticon/surprised
10454 * - emoticon/suspicious
10455 * - emoticon/tongue-dangling
10456 * - emoticon/tongue-poke
10458 * - emoticon/unhappy
10459 * - emoticon/very-sorry
10462 * - emoticon/worried
10465 * Alternatively, an item may reference an image by its path, using
10466 * the URI form @c file:///path/to/an/image.png and the entry will then
10467 * use that image for the item.
10469 * @section entry-files Loading and saving files
10471 * Entries have convinience functions to load text from a file and save
10472 * changes back to it after a short delay. The automatic saving is enabled
10473 * by default, but can be disabled with elm_entry_autosave_set() and files
10474 * can be loaded directly as plain text or have any markup in them
10475 * recognized. See elm_entry_file_set() for more details.
10477 * @section entry-signals Emitted signals
10479 * This widget emits the following signals:
10481 * @li "changed": The text within the entry was changed.
10482 * @li "changed,user": The text within the entry was changed because of user interaction.
10483 * @li "activated": The enter key was pressed on a single line entry.
10484 * @li "press": A mouse button has been pressed on the entry.
10485 * @li "longpressed": A mouse button has been pressed and held for a couple
10487 * @li "clicked": The entry has been clicked (mouse press and release).
10488 * @li "clicked,double": The entry has been double clicked.
10489 * @li "clicked,triple": The entry has been triple clicked.
10490 * @li "focused": The entry has received focus.
10491 * @li "unfocused": The entry has lost focus.
10492 * @li "selection,paste": A paste of the clipboard contents was requested.
10493 * @li "selection,copy": A copy of the selected text into the clipboard was
10495 * @li "selection,cut": A cut of the selected text into the clipboard was
10497 * @li "selection,start": A selection has begun and no previous selection
10499 * @li "selection,changed": The current selection has changed.
10500 * @li "selection,cleared": The current selection has been cleared.
10501 * @li "cursor,changed": The cursor has changed position.
10502 * @li "anchor,clicked": An anchor has been clicked. The event_info
10503 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10504 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10505 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10506 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10507 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10508 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10509 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10510 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10511 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10512 * @li "preedit,changed": The preedit string has changed.
10514 * @section entry-examples
10516 * An overview of the Entry API can be seen in @ref entry_example_01
10521 * @typedef Elm_Entry_Anchor_Info
10523 * The info sent in the callback for the "anchor,clicked" signals emitted
10526 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10528 * @struct _Elm_Entry_Anchor_Info
10530 * The info sent in the callback for the "anchor,clicked" signals emitted
10533 struct _Elm_Entry_Anchor_Info
10535 const char *name; /**< The name of the anchor, as stated in its href */
10536 int button; /**< The mouse button used to click on it */
10537 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10538 y, /**< Anchor geometry, relative to canvas */
10539 w, /**< Anchor geometry, relative to canvas */
10540 h; /**< Anchor geometry, relative to canvas */
10543 * @typedef Elm_Entry_Filter_Cb
10544 * This callback type is used by entry filters to modify text.
10545 * @param data The data specified as the last param when adding the filter
10546 * @param entry The entry object
10547 * @param text A pointer to the location of the text being filtered. This data can be modified,
10548 * but any additional allocations must be managed by the user.
10549 * @see elm_entry_text_filter_append
10550 * @see elm_entry_text_filter_prepend
10552 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10555 * This adds an entry to @p parent object.
10557 * By default, entries are:
10561 * @li autosave is enabled
10563 * @param parent The parent object
10564 * @return The new object or NULL if it cannot be created
10566 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10568 * Sets the entry to single line mode.
10570 * In single line mode, entries don't ever wrap when the text reaches the
10571 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10572 * key will generate an @c "activate" event instead of adding a new line.
10574 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10575 * and pressing enter will break the text into a different line
10576 * without generating any events.
10578 * @param obj The entry object
10579 * @param single_line If true, the text in the entry
10580 * will be on a single line.
10582 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10584 * Gets whether the entry is set to be single line.
10586 * @param obj The entry object
10587 * @return single_line If true, the text in the entry is set to display
10588 * on a single line.
10590 * @see elm_entry_single_line_set()
10592 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10594 * Sets the entry to password mode.
10596 * In password mode, entries are implicitly single line and the display of
10597 * any text in them is replaced with asterisks (*).
10599 * @param obj The entry object
10600 * @param password If true, password mode is enabled.
10602 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10604 * Gets whether the entry is set to password mode.
10606 * @param obj The entry object
10607 * @return If true, the entry is set to display all characters
10608 * as asterisks (*).
10610 * @see elm_entry_password_set()
10612 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10614 * This sets the text displayed within the entry to @p entry.
10616 * @param obj The entry object
10617 * @param entry The text to be displayed
10619 * @deprecated Use elm_object_text_set() instead.
10621 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10623 * This returns the text currently shown in object @p entry.
10624 * See also elm_entry_entry_set().
10626 * @param obj The entry object
10627 * @return The currently displayed text or NULL on failure
10629 * @deprecated Use elm_object_text_get() instead.
10631 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10633 * Appends @p entry to the text of the entry.
10635 * Adds the text in @p entry to the end of any text already present in the
10638 * The appended text is subject to any filters set for the widget.
10640 * @param obj The entry object
10641 * @param entry The text to be displayed
10643 * @see elm_entry_text_filter_append()
10645 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10647 * Gets whether the entry is empty.
10649 * Empty means no text at all. If there are any markup tags, like an item
10650 * tag for which no provider finds anything, and no text is displayed, this
10651 * function still returns EINA_FALSE.
10653 * @param obj The entry object
10654 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10656 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10658 * Gets any selected text within the entry.
10660 * If there's any selected text in the entry, this function returns it as
10661 * a string in markup format. NULL is returned if no selection exists or
10662 * if an error occurred.
10664 * The returned value points to an internal string and should not be freed
10665 * or modified in any way. If the @p entry object is deleted or its
10666 * contents are changed, the returned pointer should be considered invalid.
10668 * @param obj The entry object
10669 * @return The selected text within the entry or NULL on failure
10671 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10673 * Inserts the given text into the entry at the current cursor position.
10675 * This inserts text at the cursor position as if it was typed
10676 * by the user (note that this also allows markup which a user
10677 * can't just "type" as it would be converted to escaped text, so this
10678 * call can be used to insert things like emoticon items or bold push/pop
10679 * tags, other font and color change tags etc.)
10681 * If any selection exists, it will be replaced by the inserted text.
10683 * The inserted text is subject to any filters set for the widget.
10685 * @param obj The entry object
10686 * @param entry The text to insert
10688 * @see elm_entry_text_filter_append()
10690 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10692 * Set the line wrap type to use on multi-line entries.
10694 * Sets the wrap type used by the entry to any of the specified in
10695 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10696 * line (without inserting a line break or paragraph separator) when it
10697 * reaches the far edge of the widget.
10699 * Note that this only makes sense for multi-line entries. A widget set
10700 * to be single line will never wrap.
10702 * @param obj The entry object
10703 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10705 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10707 * Gets the wrap mode the entry was set to use.
10709 * @param obj The entry object
10710 * @return Wrap type
10712 * @see also elm_entry_line_wrap_set()
10714 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10716 * Sets if the entry is to be editable or not.
10718 * By default, entries are editable and when focused, any text input by the
10719 * user will be inserted at the current cursor position. But calling this
10720 * function with @p editable as EINA_FALSE will prevent the user from
10721 * inputting text into the entry.
10723 * The only way to change the text of a non-editable entry is to use
10724 * elm_object_text_set(), elm_entry_entry_insert() and other related
10727 * @param obj The entry object
10728 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10729 * if not, the entry is read-only and no user input is allowed.
10731 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10733 * Gets whether the entry is editable or not.
10735 * @param obj The entry object
10736 * @return If true, the entry is editable by the user.
10737 * If false, it is not editable by the user
10739 * @see elm_entry_editable_set()
10741 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10743 * This drops any existing text selection within the entry.
10745 * @param obj The entry object
10747 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10749 * This selects all text within the entry.
10751 * @param obj The entry object
10753 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10755 * This moves the cursor one place to the right within the entry.
10757 * @param obj The entry object
10758 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10760 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10762 * This moves the cursor one place to the left within the entry.
10764 * @param obj The entry object
10765 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10767 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10769 * This moves the cursor one line up within the entry.
10771 * @param obj The entry object
10772 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10774 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10776 * This moves the cursor one line down within the entry.
10778 * @param obj The entry object
10779 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10781 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10783 * This moves the cursor to the beginning of the entry.
10785 * @param obj The entry object
10787 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10789 * This moves the cursor to the end of the entry.
10791 * @param obj The entry object
10793 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10795 * This moves the cursor to the beginning of the current line.
10797 * @param obj The entry object
10799 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10801 * This moves the cursor to the end of the current line.
10803 * @param obj The entry object
10805 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10807 * This begins a selection within the entry as though
10808 * the user were holding down the mouse button to make a selection.
10810 * @param obj The entry object
10812 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10814 * This ends a selection within the entry as though
10815 * the user had just released the mouse button while making a selection.
10817 * @param obj The entry object
10819 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10821 * Gets whether a format node exists at the current cursor position.
10823 * A format node is anything that defines how the text is rendered. It can
10824 * be a visible format node, such as a line break or a paragraph separator,
10825 * or an invisible one, such as bold begin or end tag.
10826 * This function returns whether any format node exists at the current
10829 * @param obj The entry object
10830 * @return EINA_TRUE if the current cursor position contains a format node,
10831 * EINA_FALSE otherwise.
10833 * @see elm_entry_cursor_is_visible_format_get()
10835 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10837 * Gets if the current cursor position holds a visible format node.
10839 * @param obj The entry object
10840 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10841 * if it's an invisible one or no format exists.
10843 * @see elm_entry_cursor_is_format_get()
10845 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10847 * Gets the character pointed by the cursor at its current position.
10849 * This function returns a string with the utf8 character stored at the
10850 * current cursor position.
10851 * Only the text is returned, any format that may exist will not be part
10852 * of the return value.
10854 * @param obj The entry object
10855 * @return The text pointed by the cursors.
10857 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10859 * This function returns the geometry of the cursor.
10861 * It's useful if you want to draw something on the cursor (or where it is),
10862 * or for example in the case of scrolled entry where you want to show the
10865 * @param obj The entry object
10866 * @param x returned geometry
10867 * @param y returned geometry
10868 * @param w returned geometry
10869 * @param h returned geometry
10870 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10872 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);
10874 * Sets the cursor position in the entry to the given value
10876 * The value in @p pos is the index of the character position within the
10877 * contents of the string as returned by elm_entry_cursor_pos_get().
10879 * @param obj The entry object
10880 * @param pos The position of the cursor
10882 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10884 * Retrieves the current position of the cursor in the entry
10886 * @param obj The entry object
10887 * @return The cursor position
10889 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10891 * This executes a "cut" action on the selected text in the entry.
10893 * @param obj The entry object
10895 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10897 * This executes a "copy" action on the selected text in the entry.
10899 * @param obj The entry object
10901 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10903 * This executes a "paste" action in the entry.
10905 * @param obj The entry object
10907 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10909 * This clears and frees the items in a entry's contextual (longpress)
10912 * @param obj The entry object
10914 * @see elm_entry_context_menu_item_add()
10916 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * This adds an item to the entry's contextual menu.
10920 * A longpress on an entry will make the contextual menu show up, if this
10921 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10922 * By default, this menu provides a few options like enabling selection mode,
10923 * which is useful on embedded devices that need to be explicit about it,
10924 * and when a selection exists it also shows the copy and cut actions.
10926 * With this function, developers can add other options to this menu to
10927 * perform any action they deem necessary.
10929 * @param obj The entry object
10930 * @param label The item's text label
10931 * @param icon_file The item's icon file
10932 * @param icon_type The item's icon type
10933 * @param func The callback to execute when the item is clicked
10934 * @param data The data to associate with the item for related functions
10936 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);
10938 * This disables the entry's contextual (longpress) menu.
10940 * @param obj The entry object
10941 * @param disabled If true, the menu is disabled
10943 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10945 * This returns whether the entry's contextual (longpress) menu is
10948 * @param obj The entry object
10949 * @return If true, the menu is disabled
10951 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10953 * This appends a custom item provider to the list for that entry
10955 * This appends the given callback. The list is walked from beginning to end
10956 * with each function called given the item href string in the text. If the
10957 * function returns an object handle other than NULL (it should create an
10958 * object to do this), then this object is used to replace that item. If
10959 * not the next provider is called until one provides an item object, or the
10960 * default provider in entry does.
10962 * @param obj The entry object
10963 * @param func The function called to provide the item object
10964 * @param data The data passed to @p func
10966 * @see @ref entry-items
10968 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);
10970 * This prepends a custom item provider to the list for that entry
10972 * This prepends the given callback. See elm_entry_item_provider_append() for
10975 * @param obj The entry object
10976 * @param func The function called to provide the item object
10977 * @param data The data passed to @p func
10979 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);
10981 * This removes a custom item provider to the list for that entry
10983 * This removes the given callback. See elm_entry_item_provider_append() for
10986 * @param obj The entry object
10987 * @param func The function called to provide the item object
10988 * @param data The data passed to @p func
10990 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);
10992 * Append a filter function for text inserted in the entry
10994 * Append the given callback to the list. This functions will be called
10995 * whenever any text is inserted into the entry, with the text to be inserted
10996 * as a parameter. The callback function is free to alter the text in any way
10997 * it wants, but it must remember to free the given pointer and update it.
10998 * If the new text is to be discarded, the function can free it and set its
10999 * text parameter to NULL. This will also prevent any following filters from
11002 * @param obj The entry object
11003 * @param func The function to use as text filter
11004 * @param data User data to pass to @p func
11006 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11008 * Prepend a filter function for text insdrted in the entry
11010 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11011 * for more information
11013 * @param obj The entry object
11014 * @param func The function to use as text filter
11015 * @param data User data to pass to @p func
11017 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11019 * Remove a filter from the list
11021 * Removes the given callback from the filter list. See
11022 * elm_entry_text_filter_append() for more information.
11024 * @param obj The entry object
11025 * @param func The filter function to remove
11026 * @param data The user data passed when adding the function
11028 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11030 * This converts a markup (HTML-like) string into UTF-8.
11032 * The returned string is a malloc'ed buffer and it should be freed when
11033 * not needed anymore.
11035 * @param s The string (in markup) to be converted
11036 * @return The converted string (in UTF-8). It should be freed.
11038 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11040 * This converts a UTF-8 string into markup (HTML-like).
11042 * The returned string is a malloc'ed buffer and it should be freed when
11043 * not needed anymore.
11045 * @param s The string (in UTF-8) to be converted
11046 * @return The converted string (in markup). It should be freed.
11048 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11050 * This sets the file (and implicitly loads it) for the text to display and
11051 * then edit. All changes are written back to the file after a short delay if
11052 * the entry object is set to autosave (which is the default).
11054 * If the entry had any other file set previously, any changes made to it
11055 * will be saved if the autosave feature is enabled, otherwise, the file
11056 * will be silently discarded and any non-saved changes will be lost.
11058 * @param obj The entry object
11059 * @param file The path to the file to load and save
11060 * @param format The file format
11062 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11064 * Gets the file being edited by the entry.
11066 * This function can be used to retrieve any file set on the entry for
11067 * edition, along with the format used to load and save it.
11069 * @param obj The entry object
11070 * @param file The path to the file to load and save
11071 * @param format The file format
11073 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11075 * This function writes any changes made to the file set with
11076 * elm_entry_file_set()
11078 * @param obj The entry object
11080 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11082 * This sets the entry object to 'autosave' the loaded text file or not.
11084 * @param obj The entry object
11085 * @param autosave Autosave the loaded file or not
11087 * @see elm_entry_file_set()
11089 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11091 * This gets the entry object's 'autosave' status.
11093 * @param obj The entry object
11094 * @return Autosave the loaded file or not
11096 * @see elm_entry_file_set()
11098 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11100 * Control pasting of text and images for the widget.
11102 * Normally the entry allows both text and images to be pasted. By setting
11103 * textonly to be true, this prevents images from being pasted.
11105 * Note this only changes the behaviour of text.
11107 * @param obj The entry object
11108 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11109 * text+image+other.
11111 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11113 * Getting elm_entry text paste/drop mode.
11115 * In textonly mode, only text may be pasted or dropped into the widget.
11117 * @param obj The entry object
11118 * @return If the widget only accepts text from pastes.
11120 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11122 * Enable or disable scrolling in entry
11124 * Normally the entry is not scrollable unless you enable it with this call.
11126 * @param obj The entry object
11127 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11129 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11131 * Get the scrollable state of the entry
11133 * Normally the entry is not scrollable. This gets the scrollable state
11134 * of the entry. See elm_entry_scrollable_set() for more information.
11136 * @param obj The entry object
11137 * @return The scrollable state
11139 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11141 * This sets a widget to be displayed to the left of a scrolled entry.
11143 * @param obj The scrolled entry object
11144 * @param icon The widget to display on the left side of the scrolled
11147 * @note A previously set widget will be destroyed.
11148 * @note If the object being set does not have minimum size hints set,
11149 * it won't get properly displayed.
11151 * @see elm_entry_end_set()
11153 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11155 * Gets the leftmost widget of the scrolled entry. This object is
11156 * owned by the scrolled entry and should not be modified.
11158 * @param obj The scrolled entry object
11159 * @return the left widget inside the scroller
11161 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11163 * Unset the leftmost widget of the scrolled entry, unparenting and
11166 * @param obj The scrolled entry object
11167 * @return the previously set icon sub-object of this entry, on
11170 * @see elm_entry_icon_set()
11172 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11174 * Sets the visibility of the left-side widget of the scrolled entry,
11175 * set by elm_entry_icon_set().
11177 * @param obj The scrolled entry object
11178 * @param setting EINA_TRUE if the object should be displayed,
11179 * EINA_FALSE if not.
11181 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11183 * This sets a widget to be displayed to the end of a scrolled entry.
11185 * @param obj The scrolled entry object
11186 * @param end The widget to display on the right side of the scrolled
11189 * @note A previously set widget will be destroyed.
11190 * @note If the object being set does not have minimum size hints set,
11191 * it won't get properly displayed.
11193 * @see elm_entry_icon_set
11195 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11197 * Gets the endmost widget of the scrolled entry. This object is owned
11198 * by the scrolled entry and should not be modified.
11200 * @param obj The scrolled entry object
11201 * @return the right widget inside the scroller
11203 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11205 * Unset the endmost widget of the scrolled entry, unparenting and
11208 * @param obj The scrolled entry object
11209 * @return the previously set icon sub-object of this entry, on
11212 * @see elm_entry_icon_set()
11214 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11216 * Sets the visibility of the end widget of the scrolled entry, set by
11217 * elm_entry_end_set().
11219 * @param obj The scrolled entry object
11220 * @param setting EINA_TRUE if the object should be displayed,
11221 * EINA_FALSE if not.
11223 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11225 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11228 * Setting an entry to single-line mode with elm_entry_single_line_set()
11229 * will automatically disable the display of scrollbars when the entry
11230 * moves inside its scroller.
11232 * @param obj The scrolled entry object
11233 * @param h The horizontal scrollbar policy to apply
11234 * @param v The vertical scrollbar policy to apply
11236 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11238 * This enables/disables bouncing within the entry.
11240 * This function sets whether the entry will bounce when scrolling reaches
11241 * the end of the contained entry.
11243 * @param obj The scrolled entry object
11244 * @param h The horizontal bounce state
11245 * @param v The vertical bounce state
11247 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11249 * Get the bounce mode
11251 * @param obj The Entry object
11252 * @param h_bounce Allow bounce horizontally
11253 * @param v_bounce Allow bounce vertically
11255 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11257 /* pre-made filters for entries */
11259 * @typedef Elm_Entry_Filter_Limit_Size
11261 * Data for the elm_entry_filter_limit_size() entry filter.
11263 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11265 * @struct _Elm_Entry_Filter_Limit_Size
11267 * Data for the elm_entry_filter_limit_size() entry filter.
11269 struct _Elm_Entry_Filter_Limit_Size
11271 int max_char_count; /**< The maximum number of characters allowed. */
11272 int max_byte_count; /**< The maximum number of bytes allowed*/
11275 * Filter inserted text based on user defined character and byte limits
11277 * Add this filter to an entry to limit the characters that it will accept
11278 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11279 * The funtion works on the UTF-8 representation of the string, converting
11280 * it from the set markup, thus not accounting for any format in it.
11282 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11283 * it as data when setting the filter. In it, it's possible to set limits
11284 * by character count or bytes (any of them is disabled if 0), and both can
11285 * be set at the same time. In that case, it first checks for characters,
11288 * The function will cut the inserted text in order to allow only the first
11289 * number of characters that are still allowed. The cut is made in
11290 * characters, even when limiting by bytes, in order to always contain
11291 * valid ones and avoid half unicode characters making it in.
11293 * This filter, like any others, does not apply when setting the entry text
11294 * directly with elm_object_text_set() (or the deprecated
11295 * elm_entry_entry_set()).
11297 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11299 * @typedef Elm_Entry_Filter_Accept_Set
11301 * Data for the elm_entry_filter_accept_set() entry filter.
11303 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11305 * @struct _Elm_Entry_Filter_Accept_Set
11307 * Data for the elm_entry_filter_accept_set() entry filter.
11309 struct _Elm_Entry_Filter_Accept_Set
11311 const char *accepted; /**< Set of characters accepted in the entry. */
11312 const char *rejected; /**< Set of characters rejected from the entry. */
11315 * Filter inserted text based on accepted or rejected sets of characters
11317 * Add this filter to an entry to restrict the set of accepted characters
11318 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11319 * This structure contains both accepted and rejected sets, but they are
11320 * mutually exclusive.
11322 * The @c accepted set takes preference, so if it is set, the filter will
11323 * only work based on the accepted characters, ignoring anything in the
11324 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11326 * In both cases, the function filters by matching utf8 characters to the
11327 * raw markup text, so it can be used to remove formatting tags.
11329 * This filter, like any others, does not apply when setting the entry text
11330 * directly with elm_object_text_set() (or the deprecated
11331 * elm_entry_entry_set()).
11333 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11335 * Set the input panel layout of the entry
11337 * @param obj The entry object
11338 * @param layout layout type
11340 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11342 * Get the input panel layout of the entry
11344 * @param obj The entry object
11345 * @return layout type
11347 * @see elm_entry_input_panel_layout_set
11349 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11354 /* composite widgets - these basically put together basic widgets above
11355 * in convenient packages that do more than basic stuff */
11359 * @defgroup Anchorview Anchorview
11361 * @image html img/widget/anchorview/preview-00.png
11362 * @image latex img/widget/anchorview/preview-00.eps
11364 * Anchorview is for displaying text that contains markup with anchors
11365 * like <c>\<a href=1234\>something\</\></c> in it.
11367 * Besides being styled differently, the anchorview widget provides the
11368 * necessary functionality so that clicking on these anchors brings up a
11369 * popup with user defined content such as "call", "add to contacts" or
11370 * "open web page". This popup is provided using the @ref Hover widget.
11372 * This widget is very similar to @ref Anchorblock, so refer to that
11373 * widget for an example. The only difference Anchorview has is that the
11374 * widget is already provided with scrolling functionality, so if the
11375 * text set to it is too large to fit in the given space, it will scroll,
11376 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11377 * text can be displayed.
11379 * This widget emits the following signals:
11380 * @li "anchor,clicked": will be called when an anchor is clicked. The
11381 * @p event_info parameter on the callback will be a pointer of type
11382 * ::Elm_Entry_Anchorview_Info.
11384 * See @ref Anchorblock for an example on how to use both of them.
11393 * @typedef Elm_Entry_Anchorview_Info
11395 * The info sent in the callback for "anchor,clicked" signals emitted by
11396 * the Anchorview widget.
11398 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11400 * @struct _Elm_Entry_Anchorview_Info
11402 * The info sent in the callback for "anchor,clicked" signals emitted by
11403 * the Anchorview widget.
11405 struct _Elm_Entry_Anchorview_Info
11407 const char *name; /**< Name of the anchor, as indicated in its href
11409 int button; /**< The mouse button used to click on it */
11410 Evas_Object *hover; /**< The hover object to use for the popup */
11412 Evas_Coord x, y, w, h;
11413 } anchor, /**< Geometry selection of text used as anchor */
11414 hover_parent; /**< Geometry of the object used as parent by the
11416 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11417 for content on the left side of
11418 the hover. Before calling the
11419 callback, the widget will make the
11420 necessary calculations to check
11421 which sides are fit to be set with
11422 content, based on the position the
11423 hover is activated and its distance
11424 to the edges of its parent object
11426 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11427 the right side of the hover.
11428 See @ref hover_left */
11429 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11430 of the hover. See @ref hover_left */
11431 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11432 below the hover. See @ref
11436 * Add a new Anchorview object
11438 * @param parent The parent object
11439 * @return The new object or NULL if it cannot be created
11441 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11443 * Set the text to show in the anchorview
11445 * Sets the text of the anchorview to @p text. This text can include markup
11446 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11447 * text that will be specially styled and react to click events, ended with
11448 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11449 * "anchor,clicked" signal that you can attach a callback to with
11450 * evas_object_smart_callback_add(). The name of the anchor given in the
11451 * event info struct will be the one set in the href attribute, in this
11452 * case, anchorname.
11454 * Other markup can be used to style the text in different ways, but it's
11455 * up to the style defined in the theme which tags do what.
11456 * @deprecated use elm_object_text_set() instead.
11458 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11460 * Get the markup text set for the anchorview
11462 * Retrieves the text set on the anchorview, with markup tags included.
11464 * @param obj The anchorview object
11465 * @return The markup text set or @c NULL if nothing was set or an error
11467 * @deprecated use elm_object_text_set() instead.
11469 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11471 * Set the parent of the hover popup
11473 * Sets the parent object to use by the hover created by the anchorview
11474 * when an anchor is clicked. See @ref Hover for more details on this.
11475 * If no parent is set, the same anchorview object will be used.
11477 * @param obj The anchorview object
11478 * @param parent The object to use as parent for the hover
11480 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11482 * Get the parent of the hover popup
11484 * Get the object used as parent for the hover created by the anchorview
11485 * widget. See @ref Hover for more details on this.
11487 * @param obj The anchorview object
11488 * @return The object used as parent for the hover, NULL if none is set.
11490 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11492 * Set the style that the hover should use
11494 * When creating the popup hover, anchorview will request that it's
11495 * themed according to @p style.
11497 * @param obj The anchorview object
11498 * @param style The style to use for the underlying hover
11500 * @see elm_object_style_set()
11502 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11504 * Get the style that the hover should use
11506 * Get the style the hover created by anchorview will use.
11508 * @param obj The anchorview object
11509 * @return The style to use by the hover. NULL means the default is used.
11511 * @see elm_object_style_set()
11513 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11515 * Ends the hover popup in the anchorview
11517 * When an anchor is clicked, the anchorview widget will create a hover
11518 * object to use as a popup with user provided content. This function
11519 * terminates this popup, returning the anchorview to its normal state.
11521 * @param obj The anchorview object
11523 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11525 * Set bouncing behaviour when the scrolled content reaches an edge
11527 * Tell the internal scroller object whether it should bounce or not
11528 * when it reaches the respective edges for each axis.
11530 * @param obj The anchorview object
11531 * @param h_bounce Whether to bounce or not in the horizontal axis
11532 * @param v_bounce Whether to bounce or not in the vertical axis
11534 * @see elm_scroller_bounce_set()
11536 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11538 * Get the set bouncing behaviour of the internal scroller
11540 * Get whether the internal scroller should bounce when the edge of each
11541 * axis is reached scrolling.
11543 * @param obj The anchorview object
11544 * @param h_bounce Pointer where to store the bounce state of the horizontal
11546 * @param v_bounce Pointer where to store the bounce state of the vertical
11549 * @see elm_scroller_bounce_get()
11551 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11553 * Appends a custom item provider to the given anchorview
11555 * Appends the given function to the list of items providers. This list is
11556 * called, one function at a time, with the given @p data pointer, the
11557 * anchorview object and, in the @p item parameter, the item name as
11558 * referenced in its href string. Following functions in the list will be
11559 * called in order until one of them returns something different to NULL,
11560 * which should be an Evas_Object which will be used in place of the item
11563 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11564 * href=item/name\>\</item\>
11566 * @param obj The anchorview object
11567 * @param func The function to add to the list of providers
11568 * @param data User data that will be passed to the callback function
11570 * @see elm_entry_item_provider_append()
11572 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);
11574 * Prepend a custom item provider to the given anchorview
11576 * Like elm_anchorview_item_provider_append(), but it adds the function
11577 * @p func to the beginning of the list, instead of the end.
11579 * @param obj The anchorview object
11580 * @param func The function to add to the list of providers
11581 * @param data User data that will be passed to the callback function
11583 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);
11585 * Remove a custom item provider from the list of the given anchorview
11587 * Removes the function and data pairing that matches @p func and @p data.
11588 * That is, unless the same function and same user data are given, the
11589 * function will not be removed from the list. This allows us to add the
11590 * same callback several times, with different @p data pointers and be
11591 * able to remove them later without conflicts.
11593 * @param obj The anchorview object
11594 * @param func The function to remove from the list
11595 * @param data The data matching the function to remove from the list
11597 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);
11604 * @defgroup Anchorblock Anchorblock
11606 * @image html img/widget/anchorblock/preview-00.png
11607 * @image latex img/widget/anchorblock/preview-00.eps
11609 * Anchorblock is for displaying text that contains markup with anchors
11610 * like <c>\<a href=1234\>something\</\></c> in it.
11612 * Besides being styled differently, the anchorblock widget provides the
11613 * necessary functionality so that clicking on these anchors brings up a
11614 * popup with user defined content such as "call", "add to contacts" or
11615 * "open web page". This popup is provided using the @ref Hover widget.
11617 * This widget emits the following signals:
11618 * @li "anchor,clicked": will be called when an anchor is clicked. The
11619 * @p event_info parameter on the callback will be a pointer of type
11620 * ::Elm_Entry_Anchorblock_Info.
11626 * Since examples are usually better than plain words, we might as well
11627 * try @ref tutorial_anchorblock_example "one".
11630 * @addtogroup Anchorblock
11634 * @typedef Elm_Entry_Anchorblock_Info
11636 * The info sent in the callback for "anchor,clicked" signals emitted by
11637 * the Anchorblock widget.
11639 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11641 * @struct _Elm_Entry_Anchorblock_Info
11643 * The info sent in the callback for "anchor,clicked" signals emitted by
11644 * the Anchorblock widget.
11646 struct _Elm_Entry_Anchorblock_Info
11648 const char *name; /**< Name of the anchor, as indicated in its href
11650 int button; /**< The mouse button used to click on it */
11651 Evas_Object *hover; /**< The hover object to use for the popup */
11653 Evas_Coord x, y, w, h;
11654 } anchor, /**< Geometry selection of text used as anchor */
11655 hover_parent; /**< Geometry of the object used as parent by the
11657 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11658 for content on the left side of
11659 the hover. Before calling the
11660 callback, the widget will make the
11661 necessary calculations to check
11662 which sides are fit to be set with
11663 content, based on the position the
11664 hover is activated and its distance
11665 to the edges of its parent object
11667 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11668 the right side of the hover.
11669 See @ref hover_left */
11670 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11671 of the hover. See @ref hover_left */
11672 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11673 below the hover. See @ref
11677 * Add a new Anchorblock object
11679 * @param parent The parent object
11680 * @return The new object or NULL if it cannot be created
11682 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11684 * Set the text to show in the anchorblock
11686 * Sets the text of the anchorblock to @p text. This text can include markup
11687 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11688 * of text that will be specially styled and react to click events, ended
11689 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11690 * "anchor,clicked" signal that you can attach a callback to with
11691 * evas_object_smart_callback_add(). The name of the anchor given in the
11692 * event info struct will be the one set in the href attribute, in this
11693 * case, anchorname.
11695 * Other markup can be used to style the text in different ways, but it's
11696 * up to the style defined in the theme which tags do what.
11697 * @deprecated use elm_object_text_set() instead.
11699 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11701 * Get the markup text set for the anchorblock
11703 * Retrieves the text set on the anchorblock, with markup tags included.
11705 * @param obj The anchorblock object
11706 * @return The markup text set or @c NULL if nothing was set or an error
11708 * @deprecated use elm_object_text_set() instead.
11710 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11712 * Set the parent of the hover popup
11714 * Sets the parent object to use by the hover created by the anchorblock
11715 * when an anchor is clicked. See @ref Hover for more details on this.
11717 * @param obj The anchorblock object
11718 * @param parent The object to use as parent for the hover
11720 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11722 * Get the parent of the hover popup
11724 * Get the object used as parent for the hover created by the anchorblock
11725 * widget. See @ref Hover for more details on this.
11726 * If no parent is set, the same anchorblock object will be used.
11728 * @param obj The anchorblock object
11729 * @return The object used as parent for the hover, NULL if none is set.
11731 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11733 * Set the style that the hover should use
11735 * When creating the popup hover, anchorblock will request that it's
11736 * themed according to @p style.
11738 * @param obj The anchorblock object
11739 * @param style The style to use for the underlying hover
11741 * @see elm_object_style_set()
11743 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11745 * Get the style that the hover should use
11747 * Get the style the hover created by anchorblock will use.
11749 * @param obj The anchorblock object
11750 * @return The style to use by the hover. NULL means the default is used.
11752 * @see elm_object_style_set()
11754 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11756 * Ends the hover popup in the anchorblock
11758 * When an anchor is clicked, the anchorblock widget will create a hover
11759 * object to use as a popup with user provided content. This function
11760 * terminates this popup, returning the anchorblock to its normal state.
11762 * @param obj The anchorblock object
11764 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11766 * Appends a custom item provider to the given anchorblock
11768 * Appends the given function to the list of items providers. This list is
11769 * called, one function at a time, with the given @p data pointer, the
11770 * anchorblock object and, in the @p item parameter, the item name as
11771 * referenced in its href string. Following functions in the list will be
11772 * called in order until one of them returns something different to NULL,
11773 * which should be an Evas_Object which will be used in place of the item
11776 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11777 * href=item/name\>\</item\>
11779 * @param obj The anchorblock object
11780 * @param func The function to add to the list of providers
11781 * @param data User data that will be passed to the callback function
11783 * @see elm_entry_item_provider_append()
11785 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);
11787 * Prepend a custom item provider to the given anchorblock
11789 * Like elm_anchorblock_item_provider_append(), but it adds the function
11790 * @p func to the beginning of the list, instead of the end.
11792 * @param obj The anchorblock object
11793 * @param func The function to add to the list of providers
11794 * @param data User data that will be passed to the callback function
11796 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);
11798 * Remove a custom item provider from the list of the given anchorblock
11800 * Removes the function and data pairing that matches @p func and @p data.
11801 * That is, unless the same function and same user data are given, the
11802 * function will not be removed from the list. This allows us to add the
11803 * same callback several times, with different @p data pointers and be
11804 * able to remove them later without conflicts.
11806 * @param obj The anchorblock object
11807 * @param func The function to remove from the list
11808 * @param data The data matching the function to remove from the list
11810 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);
11816 * @defgroup Bubble Bubble
11818 * @image html img/widget/bubble/preview-00.png
11819 * @image latex img/widget/bubble/preview-00.eps
11820 * @image html img/widget/bubble/preview-01.png
11821 * @image latex img/widget/bubble/preview-01.eps
11822 * @image html img/widget/bubble/preview-02.png
11823 * @image latex img/widget/bubble/preview-02.eps
11825 * @brief The Bubble is a widget to show text similarly to how speech is
11826 * represented in comics.
11828 * The bubble widget contains 5 important visual elements:
11829 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11830 * @li The @p icon is an image to which the frame's arrow points to.
11831 * @li The @p label is a text which appears to the right of the icon if the
11832 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11834 * @li The @p info is a text which appears to the right of the label. Info's
11835 * font is of a ligther color than label.
11836 * @li The @p content is an evas object that is shown inside the frame.
11838 * The position of the arrow, icon, label and info depends on which corner is
11839 * selected. The four available corners are:
11840 * @li "top_left" - Default
11842 * @li "bottom_left"
11843 * @li "bottom_right"
11845 * Signals that you can add callbacks for are:
11846 * @li "clicked" - This is called when a user has clicked the bubble.
11848 * For an example of using a buble see @ref bubble_01_example_page "this".
11853 * Add a new bubble to the parent
11855 * @param parent The parent object
11856 * @return The new object or NULL if it cannot be created
11858 * This function adds a text bubble to the given parent evas object.
11860 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11862 * Set the label of the bubble
11864 * @param obj The bubble object
11865 * @param label The string to set in the label
11867 * This function sets the title of the bubble. Where this appears depends on
11868 * the selected corner.
11869 * @deprecated use elm_object_text_set() instead.
11871 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11873 * Get the label of the bubble
11875 * @param obj The bubble object
11876 * @return The string of set in the label
11878 * This function gets the title of the bubble.
11879 * @deprecated use elm_object_text_get() instead.
11881 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11883 * Set the info of the bubble
11885 * @param obj The bubble object
11886 * @param info The given info about the bubble
11888 * This function sets the info of the bubble. Where this appears depends on
11889 * the selected corner.
11890 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11892 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11894 * Get the info of the bubble
11896 * @param obj The bubble object
11898 * @return The "info" string of the bubble
11900 * This function gets the info text.
11901 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11903 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11905 * Set the content to be shown in the bubble
11907 * Once the content object is set, a previously set one will be deleted.
11908 * If you want to keep the old content object, use the
11909 * elm_bubble_content_unset() function.
11911 * @param obj The bubble object
11912 * @param content The given content of the bubble
11914 * This function sets the content shown on the middle of the bubble.
11916 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11918 * Get the content shown in the bubble
11920 * Return the content object which is set for this widget.
11922 * @param obj The bubble object
11923 * @return The content that is being used
11925 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11927 * Unset the content shown in the bubble
11929 * Unparent and return the content object which was set for this widget.
11931 * @param obj The bubble object
11932 * @return The content that was being used
11934 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11936 * Set the icon of the bubble
11938 * Once the icon object is set, a previously set one will be deleted.
11939 * If you want to keep the old content object, use the
11940 * elm_icon_content_unset() function.
11942 * @param obj The bubble object
11943 * @param icon The given icon for the bubble
11945 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11947 * Get the icon of the bubble
11949 * @param obj The bubble object
11950 * @return The icon for the bubble
11952 * This function gets the icon shown on the top left of bubble.
11954 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11956 * Unset the icon of the bubble
11958 * Unparent and return the icon object which was set for this widget.
11960 * @param obj The bubble object
11961 * @return The icon that was being used
11963 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11965 * Set the corner of the bubble
11967 * @param obj The bubble object.
11968 * @param corner The given corner for the bubble.
11970 * This function sets the corner of the bubble. The corner will be used to
11971 * determine where the arrow in the frame points to and where label, icon and
11974 * Possible values for corner are:
11975 * @li "top_left" - Default
11977 * @li "bottom_left"
11978 * @li "bottom_right"
11980 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11982 * Get the corner of the bubble
11984 * @param obj The bubble object.
11985 * @return The given corner for the bubble.
11987 * This function gets the selected corner of the bubble.
11989 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11995 * @defgroup Photo Photo
11997 * For displaying the photo of a person (contact). Simple yet
11998 * with a very specific purpose.
12000 * Signals that you can add callbacks for are:
12002 * "clicked" - This is called when a user has clicked the photo
12003 * "drag,start" - Someone started dragging the image out of the object
12004 * "drag,end" - Dragged item was dropped (somewhere)
12010 * Add a new photo to the parent
12012 * @param parent The parent object
12013 * @return The new object or NULL if it cannot be created
12017 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12020 * Set the file that will be used as photo
12022 * @param obj The photo object
12023 * @param file The path to file that will be used as photo
12025 * @return (1 = success, 0 = error)
12029 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12032 * Set the size that will be used on the photo
12034 * @param obj The photo object
12035 * @param size The size that the photo will be
12039 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12042 * Set if the photo should be completely visible or not.
12044 * @param obj The photo object
12045 * @param fill if true the photo will be completely visible
12049 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12052 * Set editability of the photo.
12054 * An editable photo can be dragged to or from, and can be cut or
12055 * pasted too. Note that pasting an image or dropping an item on
12056 * the image will delete the existing content.
12058 * @param obj The photo object.
12059 * @param set To set of clear editablity.
12061 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12067 /* gesture layer */
12069 * @defgroup Elm_Gesture_Layer Gesture Layer
12070 * Gesture Layer Usage:
12072 * Use Gesture Layer to detect gestures.
12073 * The advantage is that you don't have to implement
12074 * gesture detection, just set callbacks of gesture state.
12075 * By using gesture layer we make standard interface.
12077 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12078 * with a parent object parameter.
12079 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12080 * call. Usually with same object as target (2nd parameter).
12082 * Now you need to tell gesture layer what gestures you follow.
12083 * This is done with @ref elm_gesture_layer_cb_set call.
12084 * By setting the callback you actually saying to gesture layer:
12085 * I would like to know when the gesture @ref Elm_Gesture_Types
12086 * switches to state @ref Elm_Gesture_State.
12088 * Next, you need to implement the actual action that follows the input
12089 * in your callback.
12091 * Note that if you like to stop being reported about a gesture, just set
12092 * all callbacks referring this gesture to NULL.
12093 * (again with @ref elm_gesture_layer_cb_set)
12095 * The information reported by gesture layer to your callback is depending
12096 * on @ref Elm_Gesture_Types:
12097 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12098 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12099 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12101 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12102 * @ref ELM_GESTURE_MOMENTUM.
12104 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12105 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12106 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12107 * Note that we consider a flick as a line-gesture that should be completed
12108 * in flick-time-limit as defined in @ref Config.
12110 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12112 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12116 * @enum _Elm_Gesture_Types
12117 * Enum of supported gesture types.
12118 * @ingroup Elm_Gesture_Layer
12120 enum _Elm_Gesture_Types
12122 ELM_GESTURE_FIRST = 0,
12124 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12125 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12126 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12127 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12129 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12131 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12132 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12134 ELM_GESTURE_ZOOM, /**< Zoom */
12135 ELM_GESTURE_ROTATE, /**< Rotate */
12141 * @typedef Elm_Gesture_Types
12142 * gesture types enum
12143 * @ingroup Elm_Gesture_Layer
12145 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12148 * @enum _Elm_Gesture_State
12149 * Enum of gesture states.
12150 * @ingroup Elm_Gesture_Layer
12152 enum _Elm_Gesture_State
12154 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12155 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12156 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12157 ELM_GESTURE_STATE_END, /**< Gesture completed */
12158 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12162 * @typedef Elm_Gesture_State
12163 * gesture states enum
12164 * @ingroup Elm_Gesture_Layer
12166 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12169 * @struct _Elm_Gesture_Taps_Info
12170 * Struct holds taps info for user
12171 * @ingroup Elm_Gesture_Layer
12173 struct _Elm_Gesture_Taps_Info
12175 Evas_Coord x, y; /**< Holds center point between fingers */
12176 unsigned int n; /**< Number of fingers tapped */
12177 unsigned int timestamp; /**< event timestamp */
12181 * @typedef Elm_Gesture_Taps_Info
12182 * holds taps info for user
12183 * @ingroup Elm_Gesture_Layer
12185 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12188 * @struct _Elm_Gesture_Momentum_Info
12189 * Struct holds momentum info for user
12190 * x1 and y1 are not necessarily in sync
12191 * x1 holds x value of x direction starting point
12192 * and same holds for y1.
12193 * This is noticeable when doing V-shape movement
12194 * @ingroup Elm_Gesture_Layer
12196 struct _Elm_Gesture_Momentum_Info
12197 { /* Report line ends, timestamps, and momentum computed */
12198 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12199 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12200 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12201 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12203 unsigned int tx; /**< Timestamp of start of final x-swipe */
12204 unsigned int ty; /**< Timestamp of start of final y-swipe */
12206 Evas_Coord mx; /**< Momentum on X */
12207 Evas_Coord my; /**< Momentum on Y */
12211 * @typedef Elm_Gesture_Momentum_Info
12212 * holds momentum info for user
12213 * @ingroup Elm_Gesture_Layer
12215 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12218 * @struct _Elm_Gesture_Line_Info
12219 * Struct holds line info for user
12220 * @ingroup Elm_Gesture_Layer
12222 struct _Elm_Gesture_Line_Info
12223 { /* Report line ends, timestamps, and momentum computed */
12224 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12225 unsigned int n; /**< Number of fingers (lines) */
12226 /* FIXME should be radians, bot degrees */
12227 double angle; /**< Angle (direction) of lines */
12231 * @typedef Elm_Gesture_Line_Info
12232 * Holds line info for user
12233 * @ingroup Elm_Gesture_Layer
12235 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12238 * @struct _Elm_Gesture_Zoom_Info
12239 * Struct holds zoom info for user
12240 * @ingroup Elm_Gesture_Layer
12242 struct _Elm_Gesture_Zoom_Info
12244 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12245 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12246 double zoom; /**< Zoom value: 1.0 means no zoom */
12247 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12251 * @typedef Elm_Gesture_Zoom_Info
12252 * Holds zoom info for user
12253 * @ingroup Elm_Gesture_Layer
12255 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12258 * @struct _Elm_Gesture_Rotate_Info
12259 * Struct holds rotation info for user
12260 * @ingroup Elm_Gesture_Layer
12262 struct _Elm_Gesture_Rotate_Info
12264 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12265 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12266 double base_angle; /**< Holds start-angle */
12267 double angle; /**< Rotation value: 0.0 means no rotation */
12268 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12272 * @typedef Elm_Gesture_Rotate_Info
12273 * Holds rotation info for user
12274 * @ingroup Elm_Gesture_Layer
12276 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12279 * @typedef Elm_Gesture_Event_Cb
12280 * User callback used to stream gesture info from gesture layer
12281 * @param data user data
12282 * @param event_info gesture report info
12283 * Returns a flag field to be applied on the causing event.
12284 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12285 * upon the event, in an irreversible way.
12287 * @ingroup Elm_Gesture_Layer
12289 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12292 * Use function to set callbacks to be notified about
12293 * change of state of gesture.
12294 * When a user registers a callback with this function
12295 * this means this gesture has to be tested.
12297 * When ALL callbacks for a gesture are set to NULL
12298 * it means user isn't interested in gesture-state
12299 * and it will not be tested.
12301 * @param obj Pointer to gesture-layer.
12302 * @param idx The gesture you would like to track its state.
12303 * @param cb callback function pointer.
12304 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12305 * @param data user info to be sent to callback (usually, Smart Data)
12307 * @ingroup Elm_Gesture_Layer
12309 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);
12312 * Call this function to get repeat-events settings.
12314 * @param obj Pointer to gesture-layer.
12316 * @return repeat events settings.
12317 * @see elm_gesture_layer_hold_events_set()
12318 * @ingroup Elm_Gesture_Layer
12320 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12323 * This function called in order to make gesture-layer repeat events.
12324 * Set this of you like to get the raw events only if gestures were not detected.
12325 * Clear this if you like gesture layer to fwd events as testing gestures.
12327 * @param obj Pointer to gesture-layer.
12328 * @param r Repeat: TRUE/FALSE
12330 * @ingroup Elm_Gesture_Layer
12332 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12335 * This function sets step-value for zoom action.
12336 * Set step to any positive value.
12337 * Cancel step setting by setting to 0.0
12339 * @param obj Pointer to gesture-layer.
12340 * @param s new zoom step value.
12342 * @ingroup Elm_Gesture_Layer
12344 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12347 * This function sets step-value for rotate action.
12348 * Set step to any positive value.
12349 * Cancel step setting by setting to 0.0
12351 * @param obj Pointer to gesture-layer.
12352 * @param s new roatate step value.
12354 * @ingroup Elm_Gesture_Layer
12356 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12359 * This function called to attach gesture-layer to an Evas_Object.
12360 * @param obj Pointer to gesture-layer.
12361 * @param t Pointer to underlying object (AKA Target)
12363 * @return TRUE, FALSE on success, failure.
12365 * @ingroup Elm_Gesture_Layer
12367 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12370 * Call this function to construct a new gesture-layer object.
12371 * This does not activate the gesture layer. You have to
12372 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12374 * @param parent the parent object.
12376 * @return Pointer to new gesture-layer object.
12378 * @ingroup Elm_Gesture_Layer
12380 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12383 * @defgroup Thumb Thumb
12385 * @image html img/widget/thumb/preview-00.png
12386 * @image latex img/widget/thumb/preview-00.eps
12388 * A thumb object is used for displaying the thumbnail of an image or video.
12389 * You must have compiled Elementary with Ethumb_Client support and the DBus
12390 * service must be present and auto-activated in order to have thumbnails to
12393 * Once the thumbnail object becomes visible, it will check if there is a
12394 * previously generated thumbnail image for the file set on it. If not, it
12395 * will start generating this thumbnail.
12397 * Different config settings will cause different thumbnails to be generated
12398 * even on the same file.
12400 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12401 * Ethumb documentation to change this path, and to see other configuration
12404 * Signals that you can add callbacks for are:
12406 * - "clicked" - This is called when a user has clicked the thumb without dragging
12408 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12409 * - "press" - This is called when a user has pressed down the thumb.
12410 * - "generate,start" - The thumbnail generation started.
12411 * - "generate,stop" - The generation process stopped.
12412 * - "generate,error" - The generation failed.
12413 * - "load,error" - The thumbnail image loading failed.
12415 * available styles:
12419 * An example of use of thumbnail:
12421 * - @ref thumb_example_01
12425 * @addtogroup Thumb
12430 * @enum _Elm_Thumb_Animation_Setting
12431 * @typedef Elm_Thumb_Animation_Setting
12433 * Used to set if a video thumbnail is animating or not.
12437 typedef enum _Elm_Thumb_Animation_Setting
12439 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12440 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12441 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12442 ELM_THUMB_ANIMATION_LAST
12443 } Elm_Thumb_Animation_Setting;
12446 * Add a new thumb object to the parent.
12448 * @param parent The parent object.
12449 * @return The new object or NULL if it cannot be created.
12451 * @see elm_thumb_file_set()
12452 * @see elm_thumb_ethumb_client_get()
12456 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12458 * Reload thumbnail if it was generated before.
12460 * @param obj The thumb object to reload
12462 * This is useful if the ethumb client configuration changed, like its
12463 * size, aspect or any other property one set in the handle returned
12464 * by elm_thumb_ethumb_client_get().
12466 * If the options didn't change, the thumbnail won't be generated again, but
12467 * the old one will still be used.
12469 * @see elm_thumb_file_set()
12473 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12475 * Set the file that will be used as thumbnail.
12477 * @param obj The thumb object.
12478 * @param file The path to file that will be used as thumb.
12479 * @param key The key used in case of an EET file.
12481 * The file can be an image or a video (in that case, acceptable extensions are:
12482 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12483 * function elm_thumb_animate().
12485 * @see elm_thumb_file_get()
12486 * @see elm_thumb_reload()
12487 * @see elm_thumb_animate()
12491 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12493 * Get the image or video path and key used to generate the thumbnail.
12495 * @param obj The thumb object.
12496 * @param file Pointer to filename.
12497 * @param key Pointer to key.
12499 * @see elm_thumb_file_set()
12500 * @see elm_thumb_path_get()
12504 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12506 * Get the path and key to the image or video generated by ethumb.
12508 * One just need to make sure that the thumbnail was generated before getting
12509 * its path; otherwise, the path will be NULL. One way to do that is by asking
12510 * for the path when/after the "generate,stop" smart callback is called.
12512 * @param obj The thumb object.
12513 * @param file Pointer to thumb path.
12514 * @param key Pointer to thumb key.
12516 * @see elm_thumb_file_get()
12520 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12522 * Set the animation state for the thumb object. If its content is an animated
12523 * video, you may start/stop the animation or tell it to play continuously and
12526 * @param obj The thumb object.
12527 * @param setting The animation setting.
12529 * @see elm_thumb_file_set()
12533 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12535 * Get the animation state for the thumb object.
12537 * @param obj The thumb object.
12538 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12541 * @see elm_thumb_animate_set()
12545 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12547 * Get the ethumb_client handle so custom configuration can be made.
12549 * @return Ethumb_Client instance or NULL.
12551 * This must be called before the objects are created to be sure no object is
12552 * visible and no generation started.
12554 * Example of usage:
12557 * #include <Elementary.h>
12558 * #ifndef ELM_LIB_QUICKLAUNCH
12560 * elm_main(int argc, char **argv)
12562 * Ethumb_Client *client;
12564 * elm_need_ethumb();
12568 * client = elm_thumb_ethumb_client_get();
12571 * ERR("could not get ethumb_client");
12574 * ethumb_client_size_set(client, 100, 100);
12575 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12578 * // Create elm_thumb objects here
12588 * @note There's only one client handle for Ethumb, so once a configuration
12589 * change is done to it, any other request for thumbnails (for any thumbnail
12590 * object) will use that configuration. Thus, this configuration is global.
12594 EAPI void *elm_thumb_ethumb_client_get(void);
12596 * Get the ethumb_client connection state.
12598 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12601 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12603 * Make the thumbnail 'editable'.
12605 * @param obj Thumb object.
12606 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12608 * This means the thumbnail is a valid drag target for drag and drop, and can be
12609 * cut or pasted too.
12611 * @see elm_thumb_editable_get()
12615 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12617 * Make the thumbnail 'editable'.
12619 * @param obj Thumb object.
12620 * @return Editability.
12622 * This means the thumbnail is a valid drag target for drag and drop, and can be
12623 * cut or pasted too.
12625 * @see elm_thumb_editable_set()
12629 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12636 * @defgroup Hoversel Hoversel
12638 * @image html img/widget/hoversel/preview-00.png
12639 * @image latex img/widget/hoversel/preview-00.eps
12641 * A hoversel is a button that pops up a list of items (automatically
12642 * choosing the direction to display) that have a label and, optionally, an
12643 * icon to select from. It is a convenience widget to avoid the need to do
12644 * all the piecing together yourself. It is intended for a small number of
12645 * items in the hoversel menu (no more than 8), though is capable of many
12648 * Signals that you can add callbacks for are:
12649 * "clicked" - the user clicked the hoversel button and popped up the sel
12650 * "selected" - an item in the hoversel list is selected. event_info is the item
12651 * "dismissed" - the hover is dismissed
12653 * See @ref tutorial_hoversel for an example.
12656 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12658 * @brief Add a new Hoversel object
12660 * @param parent The parent object
12661 * @return The new object or NULL if it cannot be created
12663 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12665 * @brief This sets the hoversel to expand horizontally.
12667 * @param obj The hoversel object
12668 * @param horizontal If true, the hover will expand horizontally to the
12671 * @note The initial button will display horizontally regardless of this
12674 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12676 * @brief This returns whether the hoversel is set to expand horizontally.
12678 * @param obj The hoversel object
12679 * @return If true, the hover will expand horizontally to the right.
12681 * @see elm_hoversel_horizontal_set()
12683 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12685 * @brief Set the Hover parent
12687 * @param obj The hoversel object
12688 * @param parent The parent to use
12690 * Sets the hover parent object, the area that will be darkened when the
12691 * hoversel is clicked. Should probably be the window that the hoversel is
12692 * in. See @ref Hover objects for more information.
12694 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12696 * @brief Get the Hover parent
12698 * @param obj The hoversel object
12699 * @return The used parent
12701 * Gets the hover parent object.
12703 * @see elm_hoversel_hover_parent_set()
12705 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12707 * @brief Set the hoversel button label
12709 * @param obj The hoversel object
12710 * @param label The label text.
12712 * This sets the label of the button that is always visible (before it is
12713 * clicked and expanded).
12715 * @deprecated elm_object_text_set()
12717 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12719 * @brief Get the hoversel button label
12721 * @param obj The hoversel object
12722 * @return The label text.
12724 * @deprecated elm_object_text_get()
12726 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12728 * @brief Set the icon of the hoversel button
12730 * @param obj The hoversel object
12731 * @param icon The icon object
12733 * Sets the icon of the button that is always visible (before it is clicked
12734 * and expanded). Once the icon object is set, a previously set one will be
12735 * deleted, if you want to keep that old content object, use the
12736 * elm_hoversel_icon_unset() function.
12738 * @see elm_button_icon_set()
12740 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12742 * @brief Get the icon of the hoversel button
12744 * @param obj The hoversel object
12745 * @return The icon object
12747 * Get the icon of the button that is always visible (before it is clicked
12748 * and expanded). Also see elm_button_icon_get().
12750 * @see elm_hoversel_icon_set()
12752 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12754 * @brief Get and unparent the icon of the hoversel button
12756 * @param obj The hoversel object
12757 * @return The icon object that was being used
12759 * Unparent and return the icon of the button that is always visible
12760 * (before it is clicked and expanded).
12762 * @see elm_hoversel_icon_set()
12763 * @see elm_button_icon_unset()
12765 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12767 * @brief This triggers the hoversel popup from code, the same as if the user
12768 * had clicked the button.
12770 * @param obj The hoversel object
12772 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12774 * @brief This dismisses the hoversel popup as if the user had clicked
12775 * outside the hover.
12777 * @param obj The hoversel object
12779 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12781 * @brief Returns whether the hoversel is expanded.
12783 * @param obj The hoversel object
12784 * @return This will return EINA_TRUE if the hoversel is expanded or
12785 * EINA_FALSE if it is not expanded.
12787 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12789 * @brief This will remove all the children items from the hoversel.
12791 * @param obj The hoversel object
12793 * @warning Should @b not be called while the hoversel is active; use
12794 * elm_hoversel_expanded_get() to check first.
12796 * @see elm_hoversel_item_del_cb_set()
12797 * @see elm_hoversel_item_del()
12799 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12801 * @brief Get the list of items within the given hoversel.
12803 * @param obj The hoversel object
12804 * @return Returns a list of Elm_Hoversel_Item*
12806 * @see elm_hoversel_item_add()
12808 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12810 * @brief Add an item to the hoversel button
12812 * @param obj The hoversel object
12813 * @param label The text label to use for the item (NULL if not desired)
12814 * @param icon_file An image file path on disk to use for the icon or standard
12815 * icon name (NULL if not desired)
12816 * @param icon_type The icon type if relevant
12817 * @param func Convenience function to call when this item is selected
12818 * @param data Data to pass to item-related functions
12819 * @return A handle to the item added.
12821 * This adds an item to the hoversel to show when it is clicked. Note: if you
12822 * need to use an icon from an edje file then use
12823 * elm_hoversel_item_icon_set() right after the this function, and set
12824 * icon_file to NULL here.
12826 * For more information on what @p icon_file and @p icon_type are see the
12827 * @ref Icon "icon documentation".
12829 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);
12831 * @brief Delete an item from the hoversel
12833 * @param item The item to delete
12835 * This deletes the item from the hoversel (should not be called while the
12836 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12838 * @see elm_hoversel_item_add()
12839 * @see elm_hoversel_item_del_cb_set()
12841 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12843 * @brief Set the function to be called when an item from the hoversel is
12846 * @param item The item to set the callback on
12847 * @param func The function called
12849 * That function will receive these parameters:
12850 * @li void *item_data
12851 * @li Evas_Object *the_item_object
12852 * @li Elm_Hoversel_Item *the_object_struct
12854 * @see elm_hoversel_item_add()
12856 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12858 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12859 * that will be passed to associated function callbacks.
12861 * @param item The item to get the data from
12862 * @return The data pointer set with elm_hoversel_item_add()
12864 * @see elm_hoversel_item_add()
12866 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12868 * @brief This returns the label text of the given hoversel item.
12870 * @param item The item to get the label
12871 * @return The label text of the hoversel item
12873 * @see elm_hoversel_item_add()
12875 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12877 * @brief This sets the icon for the given hoversel item.
12879 * @param item The item to set the icon
12880 * @param icon_file An image file path on disk to use for the icon or standard
12882 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12883 * to NULL if the icon is not an edje file
12884 * @param icon_type The icon type
12886 * The icon can be loaded from the standard set, from an image file, or from
12889 * @see elm_hoversel_item_add()
12891 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);
12893 * @brief Get the icon object of the hoversel item
12895 * @param item The item to get the icon from
12896 * @param icon_file The image file path on disk used for the icon or standard
12898 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12899 * if the icon is not an edje file
12900 * @param icon_type The icon type
12902 * @see elm_hoversel_item_icon_set()
12903 * @see elm_hoversel_item_add()
12905 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);
12911 * @defgroup Toolbar Toolbar
12912 * @ingroup Elementary
12914 * @image html img/widget/toolbar/preview-00.png
12915 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12917 * @image html img/toolbar.png
12918 * @image latex img/toolbar.eps width=\textwidth
12920 * A toolbar is a widget that displays a list of items inside
12921 * a box. It can be scrollable, show a menu with items that don't fit
12922 * to toolbar size or even crop them.
12924 * Only one item can be selected at a time.
12926 * Items can have multiple states, or show menus when selected by the user.
12928 * Smart callbacks one can listen to:
12929 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12931 * Available styles for it:
12933 * - @c "transparent" - no background or shadow, just show the content
12935 * List of examples:
12936 * @li @ref toolbar_example_01
12937 * @li @ref toolbar_example_02
12938 * @li @ref toolbar_example_03
12942 * @addtogroup Toolbar
12947 * @enum _Elm_Toolbar_Shrink_Mode
12948 * @typedef Elm_Toolbar_Shrink_Mode
12950 * Set toolbar's items display behavior, it can be scrollabel,
12951 * show a menu with exceeding items, or simply hide them.
12953 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12956 * Values <b> don't </b> work as bitmask, only one can be choosen.
12958 * @see elm_toolbar_mode_shrink_set()
12959 * @see elm_toolbar_mode_shrink_get()
12963 typedef enum _Elm_Toolbar_Shrink_Mode
12965 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12966 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12967 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12968 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12969 } Elm_Toolbar_Shrink_Mode;
12971 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(). */
12973 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(). */
12976 * Add a new toolbar widget to the given parent Elementary
12977 * (container) object.
12979 * @param parent The parent object.
12980 * @return a new toolbar widget handle or @c NULL, on errors.
12982 * This function inserts a new toolbar widget on the canvas.
12986 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12989 * Set the icon size, in pixels, to be used by toolbar items.
12991 * @param obj The toolbar object
12992 * @param icon_size The icon size in pixels
12994 * @note Default value is @c 32. It reads value from elm config.
12996 * @see elm_toolbar_icon_size_get()
13000 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13003 * Get the icon size, in pixels, to be used by toolbar items.
13005 * @param obj The toolbar object.
13006 * @return The icon size in pixels.
13008 * @see elm_toolbar_icon_size_set() for details.
13012 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13015 * Sets icon lookup order, for toolbar items' icons.
13017 * @param obj The toolbar object.
13018 * @param order The icon lookup order.
13020 * Icons added before calling this function will not be affected.
13021 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13023 * @see elm_toolbar_icon_order_lookup_get()
13027 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13030 * Gets the icon lookup order.
13032 * @param obj The toolbar object.
13033 * @return The icon lookup order.
13035 * @see elm_toolbar_icon_order_lookup_set() for details.
13039 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13042 * Set whether the toolbar items' should be selected by the user or not.
13044 * @param obj The toolbar object.
13045 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13048 * This will turn off the ability to select items entirely and they will
13049 * neither appear selected nor emit selected signals. The clicked
13050 * callback function will still be called.
13052 * Selection is enabled by default.
13054 * @see elm_toolbar_no_select_mode_get().
13058 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13061 * Set whether the toolbar items' should be selected by the user or not.
13063 * @param obj The toolbar object.
13064 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13065 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13067 * @see elm_toolbar_no_select_mode_set() for details.
13071 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13074 * Append item to the toolbar.
13076 * @param obj The toolbar object.
13077 * @param icon A string with icon name or the absolute path of an image file.
13078 * @param label The label of the item.
13079 * @param func The function to call when the item is clicked.
13080 * @param data The data to associate with the item for related callbacks.
13081 * @return The created item or @c NULL upon failure.
13083 * A new item will be created and appended to the toolbar, i.e., will
13084 * be set as @b last item.
13086 * Items created with this method can be deleted with
13087 * elm_toolbar_item_del().
13089 * Associated @p data can be properly freed when item is deleted if a
13090 * callback function is set with elm_toolbar_item_del_cb_set().
13092 * If a function is passed as argument, it will be called everytime this item
13093 * is selected, i.e., the user clicks over an unselected item.
13094 * If such function isn't needed, just passing
13095 * @c NULL as @p func is enough. The same should be done for @p data.
13097 * Toolbar will load icon image from fdo or current theme.
13098 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13099 * If an absolute path is provided it will load it direct from a file.
13101 * @see elm_toolbar_item_icon_set()
13102 * @see elm_toolbar_item_del()
13103 * @see elm_toolbar_item_del_cb_set()
13107 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);
13110 * Prepend item to the toolbar.
13112 * @param obj The toolbar object.
13113 * @param icon A string with icon name or the absolute path of an image file.
13114 * @param label The label of the item.
13115 * @param func The function to call when the item is clicked.
13116 * @param data The data to associate with the item for related callbacks.
13117 * @return The created item or @c NULL upon failure.
13119 * A new item will be created and prepended to the toolbar, i.e., will
13120 * be set as @b first item.
13122 * Items created with this method can be deleted with
13123 * elm_toolbar_item_del().
13125 * Associated @p data can be properly freed when item is deleted if a
13126 * callback function is set with elm_toolbar_item_del_cb_set().
13128 * If a function is passed as argument, it will be called everytime this item
13129 * is selected, i.e., the user clicks over an unselected item.
13130 * If such function isn't needed, just passing
13131 * @c NULL as @p func is enough. The same should be done for @p data.
13133 * Toolbar will load icon image from fdo or current theme.
13134 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13135 * If an absolute path is provided it will load it direct from a file.
13137 * @see elm_toolbar_item_icon_set()
13138 * @see elm_toolbar_item_del()
13139 * @see elm_toolbar_item_del_cb_set()
13143 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);
13146 * Insert a new item into the toolbar object before item @p before.
13148 * @param obj The toolbar object.
13149 * @param before The toolbar item to insert before.
13150 * @param icon A string with icon name or the absolute path of an image file.
13151 * @param label The label of the item.
13152 * @param func The function to call when the item is clicked.
13153 * @param data The data to associate with the item for related callbacks.
13154 * @return The created item or @c NULL upon failure.
13156 * A new item will be created and added to the toolbar. Its position in
13157 * this toolbar will be just before item @p before.
13159 * Items created with this method can be deleted with
13160 * elm_toolbar_item_del().
13162 * Associated @p data can be properly freed when item is deleted if a
13163 * callback function is set with elm_toolbar_item_del_cb_set().
13165 * If a function is passed as argument, it will be called everytime this item
13166 * is selected, i.e., the user clicks over an unselected item.
13167 * If such function isn't needed, just passing
13168 * @c NULL as @p func is enough. The same should be done for @p data.
13170 * Toolbar will load icon image from fdo or current theme.
13171 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13172 * If an absolute path is provided it will load it direct from a file.
13174 * @see elm_toolbar_item_icon_set()
13175 * @see elm_toolbar_item_del()
13176 * @see elm_toolbar_item_del_cb_set()
13180 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);
13183 * Insert a new item into the toolbar object after item @p after.
13185 * @param obj The toolbar object.
13186 * @param before The toolbar item to insert before.
13187 * @param icon A string with icon name or the absolute path of an image file.
13188 * @param label The label of the item.
13189 * @param func The function to call when the item is clicked.
13190 * @param data The data to associate with the item for related callbacks.
13191 * @return The created item or @c NULL upon failure.
13193 * A new item will be created and added to the toolbar. Its position in
13194 * this toolbar will be just after item @p after.
13196 * Items created with this method can be deleted with
13197 * elm_toolbar_item_del().
13199 * Associated @p data can be properly freed when item is deleted if a
13200 * callback function is set with elm_toolbar_item_del_cb_set().
13202 * If a function is passed as argument, it will be called everytime this item
13203 * is selected, i.e., the user clicks over an unselected item.
13204 * If such function isn't needed, just passing
13205 * @c NULL as @p func is enough. The same should be done for @p data.
13207 * Toolbar will load icon image from fdo or current theme.
13208 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13209 * If an absolute path is provided it will load it direct from a file.
13211 * @see elm_toolbar_item_icon_set()
13212 * @see elm_toolbar_item_del()
13213 * @see elm_toolbar_item_del_cb_set()
13217 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);
13220 * Get the first item in the given toolbar widget's list of
13223 * @param obj The toolbar object
13224 * @return The first item or @c NULL, if it has no items (and on
13227 * @see elm_toolbar_item_append()
13228 * @see elm_toolbar_last_item_get()
13232 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13235 * Get the last item in the given toolbar widget's list of
13238 * @param obj The toolbar object
13239 * @return The last item or @c NULL, if it has no items (and on
13242 * @see elm_toolbar_item_prepend()
13243 * @see elm_toolbar_first_item_get()
13247 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13250 * Get the item after @p item in toolbar.
13252 * @param item The toolbar item.
13253 * @return The item after @p item, or @c NULL if none or on failure.
13255 * @note If it is the last item, @c NULL will be returned.
13257 * @see elm_toolbar_item_append()
13261 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13264 * Get the item before @p item in toolbar.
13266 * @param item The toolbar item.
13267 * @return The item before @p item, or @c NULL if none or on failure.
13269 * @note If it is the first item, @c NULL will be returned.
13271 * @see elm_toolbar_item_prepend()
13275 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13278 * Get the toolbar object from an item.
13280 * @param item The item.
13281 * @return The toolbar object.
13283 * This returns the toolbar object itself that an item belongs to.
13287 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13290 * Set the priority of a toolbar item.
13292 * @param item The toolbar item.
13293 * @param priority The item priority. The default is zero.
13295 * This is used only when the toolbar shrink mode is set to
13296 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13297 * When space is less than required, items with low priority
13298 * will be removed from the toolbar and added to a dynamically-created menu,
13299 * while items with higher priority will remain on the toolbar,
13300 * with the same order they were added.
13302 * @see elm_toolbar_item_priority_get()
13306 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13309 * Get the priority of a toolbar item.
13311 * @param item The toolbar item.
13312 * @return The @p item priority, or @c 0 on failure.
13314 * @see elm_toolbar_item_priority_set() for details.
13318 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13321 * Get the label of item.
13323 * @param item The item of toolbar.
13324 * @return The label of item.
13326 * The return value is a pointer to the label associated to @p item when
13327 * it was created, with function elm_toolbar_item_append() or similar,
13329 * with function elm_toolbar_item_label_set. If no label
13330 * was passed as argument, it will return @c NULL.
13332 * @see elm_toolbar_item_label_set() for more details.
13333 * @see elm_toolbar_item_append()
13337 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13340 * Set the label of item.
13342 * @param item The item of toolbar.
13343 * @param text The label of item.
13345 * The label to be displayed by the item.
13346 * Label will be placed at icons bottom (if set).
13348 * If a label was passed as argument on item creation, with function
13349 * elm_toolbar_item_append() or similar, it will be already
13350 * displayed by the item.
13352 * @see elm_toolbar_item_label_get()
13353 * @see elm_toolbar_item_append()
13357 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13360 * Return the data associated with a given toolbar widget item.
13362 * @param item The toolbar widget item handle.
13363 * @return The data associated with @p item.
13365 * @see elm_toolbar_item_data_set()
13369 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13372 * Set the data associated with a given toolbar widget item.
13374 * @param item The toolbar widget item handle.
13375 * @param data The new data pointer to set to @p item.
13377 * This sets new item data on @p item.
13379 * @warning The old data pointer won't be touched by this function, so
13380 * the user had better to free that old data himself/herself.
13384 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13387 * Returns a pointer to a toolbar item by its label.
13389 * @param obj The toolbar object.
13390 * @param label The label of the item to find.
13392 * @return The pointer to the toolbar item matching @p label or @c NULL
13397 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13400 * Get whether the @p item is selected or not.
13402 * @param item The toolbar item.
13403 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13404 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13406 * @see elm_toolbar_selected_item_set() for details.
13407 * @see elm_toolbar_item_selected_get()
13411 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13414 * Set the selected state of an item.
13416 * @param item The toolbar item
13417 * @param selected The selected state
13419 * This sets the selected state of the given item @p it.
13420 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13422 * If a new item is selected the previosly selected will be unselected.
13423 * Previoulsy selected item can be get with function
13424 * elm_toolbar_selected_item_get().
13426 * Selected items will be highlighted.
13428 * @see elm_toolbar_item_selected_get()
13429 * @see elm_toolbar_selected_item_get()
13433 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13436 * Get the selected item.
13438 * @param obj The toolbar object.
13439 * @return The selected toolbar item.
13441 * The selected item can be unselected with function
13442 * elm_toolbar_item_selected_set().
13444 * The selected item always will be highlighted on toolbar.
13446 * @see elm_toolbar_selected_items_get()
13450 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13453 * Set the icon associated with @p item.
13455 * @param obj The parent of this item.
13456 * @param item The toolbar item.
13457 * @param icon A string with icon name or the absolute path of an image file.
13459 * Toolbar will load icon image from fdo or current theme.
13460 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13461 * If an absolute path is provided it will load it direct from a file.
13463 * @see elm_toolbar_icon_order_lookup_set()
13464 * @see elm_toolbar_icon_order_lookup_get()
13468 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13471 * Get the string used to set the icon of @p item.
13473 * @param item The toolbar item.
13474 * @return The string associated with the icon object.
13476 * @see elm_toolbar_item_icon_set() for details.
13480 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13483 * Delete them item from the toolbar.
13485 * @param item The item of toolbar to be deleted.
13487 * @see elm_toolbar_item_append()
13488 * @see elm_toolbar_item_del_cb_set()
13492 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13495 * Set the function called when a toolbar item is freed.
13497 * @param item The item to set the callback on.
13498 * @param func The function called.
13500 * If there is a @p func, then it will be called prior item's memory release.
13501 * That will be called with the following arguments:
13503 * @li item's Evas object;
13506 * This way, a data associated to a toolbar item could be properly freed.
13510 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13513 * Get a value whether toolbar item is disabled or not.
13515 * @param item The item.
13516 * @return The disabled state.
13518 * @see elm_toolbar_item_disabled_set() for more details.
13522 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13525 * Sets the disabled/enabled state of a toolbar item.
13527 * @param item The item.
13528 * @param disabled The disabled state.
13530 * A disabled item cannot be selected or unselected. It will also
13531 * change its appearance (generally greyed out). This sets the
13532 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13537 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13540 * Set or unset item as a separator.
13542 * @param item The toolbar item.
13543 * @param setting @c EINA_TRUE to set item @p item as separator or
13544 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13546 * Items aren't set as separator by default.
13548 * If set as separator it will display separator theme, so won't display
13551 * @see elm_toolbar_item_separator_get()
13555 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13558 * Get a value whether item is a separator or not.
13560 * @param item The toolbar item.
13561 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13562 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13564 * @see elm_toolbar_item_separator_set() for details.
13568 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13571 * Set the shrink state of toolbar @p obj.
13573 * @param obj The toolbar object.
13574 * @param shrink_mode Toolbar's items display behavior.
13576 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13577 * but will enforce a minimun size so all the items will fit, won't scroll
13578 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13579 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13580 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13584 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13587 * Get the shrink mode of toolbar @p obj.
13589 * @param obj The toolbar object.
13590 * @return Toolbar's items display behavior.
13592 * @see elm_toolbar_mode_shrink_set() for details.
13596 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13599 * Enable/disable homogenous mode.
13601 * @param obj The toolbar object
13602 * @param homogeneous Assume the items within the toolbar are of the
13603 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13605 * This will enable the homogeneous mode where items are of the same size.
13606 * @see elm_toolbar_homogeneous_get()
13610 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13613 * Get whether the homogenous mode is enabled.
13615 * @param obj The toolbar object.
13616 * @return Assume the items within the toolbar are of the same height
13617 * and width (EINA_TRUE = on, EINA_FALSE = off).
13619 * @see elm_toolbar_homogeneous_set()
13623 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13626 * Enable/disable homogenous mode.
13628 * @param obj The toolbar object
13629 * @param homogeneous Assume the items within the toolbar are of the
13630 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13632 * This will enable the homogeneous mode where items are of the same size.
13633 * @see elm_toolbar_homogeneous_get()
13635 * @deprecated use elm_toolbar_homogeneous_set() instead.
13639 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13642 * Get whether the homogenous mode is enabled.
13644 * @param obj The toolbar object.
13645 * @return Assume the items within the toolbar are of the same height
13646 * and width (EINA_TRUE = on, EINA_FALSE = off).
13648 * @see elm_toolbar_homogeneous_set()
13649 * @deprecated use elm_toolbar_homogeneous_get() instead.
13653 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13656 * Set the parent object of the toolbar items' menus.
13658 * @param obj The toolbar object.
13659 * @param parent The parent of the menu objects.
13661 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13663 * For more details about setting the parent for toolbar menus, see
13664 * elm_menu_parent_set().
13666 * @see elm_menu_parent_set() for details.
13667 * @see elm_toolbar_item_menu_set() for details.
13671 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13674 * Get the parent object of the toolbar items' menus.
13676 * @param obj The toolbar object.
13677 * @return The parent of the menu objects.
13679 * @see elm_toolbar_menu_parent_set() for details.
13683 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13686 * Set the alignment of the items.
13688 * @param obj The toolbar object.
13689 * @param align The new alignment, a float between <tt> 0.0 </tt>
13690 * and <tt> 1.0 </tt>.
13692 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13693 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13696 * Centered items by default.
13698 * @see elm_toolbar_align_get()
13702 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13705 * Get the alignment of the items.
13707 * @param obj The toolbar object.
13708 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13711 * @see elm_toolbar_align_set() for details.
13715 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13718 * Set whether the toolbar item opens a menu.
13720 * @param item The toolbar item.
13721 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13723 * A toolbar item can be set to be a menu, using this function.
13725 * Once it is set to be a menu, it can be manipulated through the
13726 * menu-like function elm_toolbar_menu_parent_set() and the other
13727 * elm_menu functions, using the Evas_Object @c menu returned by
13728 * elm_toolbar_item_menu_get().
13730 * So, items to be displayed in this item's menu should be added with
13731 * elm_menu_item_add().
13733 * The following code exemplifies the most basic usage:
13735 * tb = elm_toolbar_add(win)
13736 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13737 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13738 * elm_toolbar_menu_parent_set(tb, win);
13739 * menu = elm_toolbar_item_menu_get(item);
13740 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13741 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13745 * @see elm_toolbar_item_menu_get()
13749 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13752 * Get toolbar item's menu.
13754 * @param item The toolbar item.
13755 * @return Item's menu object or @c NULL on failure.
13757 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13758 * this function will set it.
13760 * @see elm_toolbar_item_menu_set() for details.
13764 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13767 * Add a new state to @p item.
13769 * @param item The item.
13770 * @param icon A string with icon name or the absolute path of an image file.
13771 * @param label The label of the new state.
13772 * @param func The function to call when the item is clicked when this
13773 * state is selected.
13774 * @param data The data to associate with the state.
13775 * @return The toolbar item state, or @c NULL upon failure.
13777 * Toolbar will load icon image from fdo or current theme.
13778 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13779 * If an absolute path is provided it will load it direct from a file.
13781 * States created with this function can be removed with
13782 * elm_toolbar_item_state_del().
13784 * @see elm_toolbar_item_state_del()
13785 * @see elm_toolbar_item_state_sel()
13786 * @see elm_toolbar_item_state_get()
13790 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);
13793 * Delete a previoulsy added state to @p item.
13795 * @param item The toolbar item.
13796 * @param state The state to be deleted.
13797 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13799 * @see elm_toolbar_item_state_add()
13801 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13804 * Set @p state as the current state of @p it.
13806 * @param it The item.
13807 * @param state The state to use.
13808 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13810 * If @p state is @c NULL, it won't select any state and the default item's
13811 * icon and label will be used. It's the same behaviour than
13812 * elm_toolbar_item_state_unser().
13814 * @see elm_toolbar_item_state_unset()
13818 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13821 * Unset the state of @p it.
13823 * @param it The item.
13825 * The default icon and label from this item will be displayed.
13827 * @see elm_toolbar_item_state_set() for more details.
13831 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13834 * Get the current state of @p it.
13836 * @param item The item.
13837 * @return The selected state or @c NULL if none is selected or on failure.
13839 * @see elm_toolbar_item_state_set() for details.
13840 * @see elm_toolbar_item_state_unset()
13841 * @see elm_toolbar_item_state_add()
13845 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13848 * Get the state after selected state in toolbar's @p item.
13850 * @param it The toolbar item to change state.
13851 * @return The state after current state, or @c NULL on failure.
13853 * If last state is selected, this function will return first state.
13855 * @see elm_toolbar_item_state_set()
13856 * @see elm_toolbar_item_state_add()
13860 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13863 * Get the state before selected state in toolbar's @p item.
13865 * @param it The toolbar item to change state.
13866 * @return The state before current state, or @c NULL on failure.
13868 * If first state is selected, this function will return last state.
13870 * @see elm_toolbar_item_state_set()
13871 * @see elm_toolbar_item_state_add()
13875 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13878 * Set the text to be shown in a given toolbar item's tooltips.
13880 * @param item Target item.
13881 * @param text The text to set in the content.
13883 * Setup the text as tooltip to object. The item can have only one tooltip,
13884 * so any previous tooltip data - set with this function or
13885 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13887 * @see elm_object_tooltip_text_set() for more details.
13891 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13894 * Set the content to be shown in the tooltip item.
13896 * Setup the tooltip to item. The item can have only one tooltip,
13897 * so any previous tooltip data is removed. @p func(with @p data) will
13898 * be called every time that need show the tooltip and it should
13899 * return a valid Evas_Object. This object is then managed fully by
13900 * tooltip system and is deleted when the tooltip is gone.
13902 * @param item the toolbar item being attached a tooltip.
13903 * @param func the function used to create the tooltip contents.
13904 * @param data what to provide to @a func as callback data/context.
13905 * @param del_cb called when data is not needed anymore, either when
13906 * another callback replaces @a func, the tooltip is unset with
13907 * elm_toolbar_item_tooltip_unset() or the owner @a item
13908 * dies. This callback receives as the first parameter the
13909 * given @a data, and @c event_info is the item.
13911 * @see elm_object_tooltip_content_cb_set() for more details.
13915 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);
13918 * Unset tooltip from item.
13920 * @param item toolbar item to remove previously set tooltip.
13922 * Remove tooltip from item. The callback provided as del_cb to
13923 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13924 * it is not used anymore.
13926 * @see elm_object_tooltip_unset() for more details.
13927 * @see elm_toolbar_item_tooltip_content_cb_set()
13931 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13934 * Sets a different style for this item tooltip.
13936 * @note before you set a style you should define a tooltip with
13937 * elm_toolbar_item_tooltip_content_cb_set() or
13938 * elm_toolbar_item_tooltip_text_set()
13940 * @param item toolbar item with tooltip already set.
13941 * @param style the theme style to use (default, transparent, ...)
13943 * @see elm_object_tooltip_style_set() for more details.
13947 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13950 * Get the style for this item tooltip.
13952 * @param item toolbar item with tooltip already set.
13953 * @return style the theme style in use, defaults to "default". If the
13954 * object does not have a tooltip set, then NULL is returned.
13956 * @see elm_object_tooltip_style_get() for more details.
13957 * @see elm_toolbar_item_tooltip_style_set()
13961 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13964 * Set the type of mouse pointer/cursor decoration to be shown,
13965 * when the mouse pointer is over the given toolbar widget item
13967 * @param item toolbar item to customize cursor on
13968 * @param cursor the cursor type's name
13970 * This function works analogously as elm_object_cursor_set(), but
13971 * here the cursor's changing area is restricted to the item's
13972 * area, and not the whole widget's. Note that that item cursors
13973 * have precedence over widget cursors, so that a mouse over an
13974 * item with custom cursor set will always show @b that cursor.
13976 * If this function is called twice for an object, a previously set
13977 * cursor will be unset on the second call.
13979 * @see elm_object_cursor_set()
13980 * @see elm_toolbar_item_cursor_get()
13981 * @see elm_toolbar_item_cursor_unset()
13985 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13988 * Get the type of mouse pointer/cursor decoration set to be shown,
13989 * when the mouse pointer is over the given toolbar widget item
13991 * @param item toolbar item with custom cursor set
13992 * @return the cursor type's name or @c NULL, if no custom cursors
13993 * were set to @p item (and on errors)
13995 * @see elm_object_cursor_get()
13996 * @see elm_toolbar_item_cursor_set()
13997 * @see elm_toolbar_item_cursor_unset()
14001 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14004 * Unset any custom mouse pointer/cursor decoration set to be
14005 * shown, when the mouse pointer is over the given toolbar widget
14006 * item, thus making it show the @b default cursor again.
14008 * @param item a toolbar item
14010 * Use this call to undo any custom settings on this item's cursor
14011 * decoration, bringing it back to defaults (no custom style set).
14013 * @see elm_object_cursor_unset()
14014 * @see elm_toolbar_item_cursor_set()
14018 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14021 * Set a different @b style for a given custom cursor set for a
14024 * @param item toolbar item with custom cursor set
14025 * @param style the <b>theme style</b> to use (e.g. @c "default",
14026 * @c "transparent", etc)
14028 * This function only makes sense when one is using custom mouse
14029 * cursor decorations <b>defined in a theme file</b>, which can have,
14030 * given a cursor name/type, <b>alternate styles</b> on it. It
14031 * works analogously as elm_object_cursor_style_set(), but here
14032 * applyed only to toolbar item objects.
14034 * @warning Before you set a cursor style you should have definen a
14035 * custom cursor previously on the item, with
14036 * elm_toolbar_item_cursor_set()
14038 * @see elm_toolbar_item_cursor_engine_only_set()
14039 * @see elm_toolbar_item_cursor_style_get()
14043 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14046 * Get the current @b style set for a given toolbar item's custom
14049 * @param item toolbar item with custom cursor set.
14050 * @return style the cursor style in use. If the object does not
14051 * have a cursor set, then @c NULL is returned.
14053 * @see elm_toolbar_item_cursor_style_set() for more details
14057 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14060 * Set if the (custom)cursor for a given toolbar item should be
14061 * searched in its theme, also, or should only rely on the
14062 * rendering engine.
14064 * @param item item with custom (custom) cursor already set on
14065 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14066 * only on those provided by the rendering engine, @c EINA_FALSE to
14067 * have them searched on the widget's theme, as well.
14069 * @note This call is of use only if you've set a custom cursor
14070 * for toolbar items, with elm_toolbar_item_cursor_set().
14072 * @note By default, cursors will only be looked for between those
14073 * provided by the rendering engine.
14077 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14080 * Get if the (custom) cursor for a given toolbar item is being
14081 * searched in its theme, also, or is only relying on the rendering
14084 * @param item a toolbar item
14085 * @return @c EINA_TRUE, if cursors are being looked for only on
14086 * those provided by the rendering engine, @c EINA_FALSE if they
14087 * are being searched on the widget's theme, as well.
14089 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14093 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14096 * Change a toolbar's orientation
14097 * @param obj The toolbar object
14098 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14099 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14102 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14105 * Get a toolbar's orientation
14106 * @param obj The toolbar object
14107 * @return If @c EINA_TRUE, the toolbar is vertical
14108 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14111 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14118 * @defgroup Tooltips Tooltips
14120 * The Tooltip is an (internal, for now) smart object used to show a
14121 * content in a frame on mouse hover of objects(or widgets), with
14122 * tips/information about them.
14127 EAPI double elm_tooltip_delay_get(void);
14128 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14129 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14130 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14131 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14132 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);
14133 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14134 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14135 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14136 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14137 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14144 * @defgroup Cursors Cursors
14146 * The Elementary cursor is an internal smart object used to
14147 * customize the mouse cursor displayed over objects (or
14148 * widgets). In the most common scenario, the cursor decoration
14149 * comes from the graphical @b engine Elementary is running
14150 * on. Those engines may provide different decorations for cursors,
14151 * and Elementary provides functions to choose them (think of X11
14152 * cursors, as an example).
14154 * There's also the possibility of, besides using engine provided
14155 * cursors, also use ones coming from Edje theming files. Both
14156 * globally and per widget, Elementary makes it possible for one to
14157 * make the cursors lookup to be held on engines only or on
14158 * Elementary's theme file, too.
14164 * Set the cursor to be shown when mouse is over the object
14166 * Set the cursor that will be displayed when mouse is over the
14167 * object. The object can have only one cursor set to it, so if
14168 * this function is called twice for an object, the previous set
14170 * If using X cursors, a definition of all the valid cursor names
14171 * is listed on Elementary_Cursors.h. If an invalid name is set
14172 * the default cursor will be used.
14174 * @param obj the object being set a cursor.
14175 * @param cursor the cursor name to be used.
14179 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14182 * Get the cursor to be shown when mouse is over the object
14184 * @param obj an object with cursor already set.
14185 * @return the cursor name.
14189 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14192 * Unset cursor for object
14194 * Unset cursor for object, and set the cursor to default if the mouse
14195 * was over this object.
14197 * @param obj Target object
14198 * @see elm_object_cursor_set()
14202 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14205 * Sets a different style for this object cursor.
14207 * @note before you set a style you should define a cursor with
14208 * elm_object_cursor_set()
14210 * @param obj an object with cursor already set.
14211 * @param style the theme style to use (default, transparent, ...)
14215 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14218 * Get the style for this object cursor.
14220 * @param obj an object with cursor already set.
14221 * @return style the theme style in use, defaults to "default". If the
14222 * object does not have a cursor set, then NULL is returned.
14226 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14229 * Set if the cursor set should be searched on the theme or should use
14230 * the provided by the engine, only.
14232 * @note before you set if should look on theme you should define a cursor
14233 * with elm_object_cursor_set(). By default it will only look for cursors
14234 * provided by the engine.
14236 * @param obj an object with cursor already set.
14237 * @param engine_only boolean to define it cursors should be looked only
14238 * between the provided by the engine or searched on widget's theme as well.
14242 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14245 * Get the cursor engine only usage for this object cursor.
14247 * @param obj an object with cursor already set.
14248 * @return engine_only boolean to define it cursors should be
14249 * looked only between the provided by the engine or searched on
14250 * widget's theme as well. If the object does not have a cursor
14251 * set, then EINA_FALSE is returned.
14255 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14258 * Get the configured cursor engine only usage
14260 * This gets the globally configured exclusive usage of engine cursors.
14262 * @return 1 if only engine cursors should be used
14265 EAPI int elm_cursor_engine_only_get(void);
14268 * Set the configured cursor engine only usage
14270 * This sets the globally configured exclusive usage of engine cursors.
14271 * It won't affect cursors set before changing this value.
14273 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14274 * look for them on theme before.
14275 * @return EINA_TRUE if value is valid and setted (0 or 1)
14278 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14285 * @defgroup Menu Menu
14287 * @image html img/widget/menu/preview-00.png
14288 * @image latex img/widget/menu/preview-00.eps
14290 * A menu is a list of items displayed above its parent. When the menu is
14291 * showing its parent is darkened. Each item can have a sub-menu. The menu
14292 * object can be used to display a menu on a right click event, in a toolbar,
14295 * Signals that you can add callbacks for are:
14296 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14297 * event_info is NULL.
14299 * @see @ref tutorial_menu
14302 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14304 * @brief Add a new menu to the parent
14306 * @param parent The parent object.
14307 * @return The new object or NULL if it cannot be created.
14309 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14311 * @brief Set the parent for the given menu widget
14313 * @param obj The menu object.
14314 * @param parent The new parent.
14316 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14318 * @brief Get the parent for the given menu widget
14320 * @param obj The menu object.
14321 * @return The parent.
14323 * @see elm_menu_parent_set()
14325 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14327 * @brief Move the menu to a new position
14329 * @param obj The menu object.
14330 * @param x The new position.
14331 * @param y The new position.
14333 * Sets the top-left position of the menu to (@p x,@p y).
14335 * @note @p x and @p y coordinates are relative to parent.
14337 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14339 * @brief Close a opened menu
14341 * @param obj the menu object
14344 * Hides the menu and all it's sub-menus.
14346 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14348 * @brief Returns a list of @p item's items.
14350 * @param obj The menu object
14351 * @return An Eina_List* of @p item's items
14353 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14355 * @brief Get the Evas_Object of an Elm_Menu_Item
14357 * @param item The menu item object.
14358 * @return The edje object containing the swallowed content
14360 * @warning Don't manipulate this object!
14362 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14364 * @brief Add an item at the end of the given menu widget
14366 * @param obj The menu object.
14367 * @param parent The parent menu item (optional)
14368 * @param icon A icon display on the item. The icon will be destryed by the menu.
14369 * @param label The label of the item.
14370 * @param func Function called when the user select the item.
14371 * @param data Data sent by the callback.
14372 * @return Returns the new item.
14374 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);
14376 * @brief Add an object swallowed in an item at the end of the given menu
14379 * @param obj The menu object.
14380 * @param parent The parent menu item (optional)
14381 * @param subobj The object to swallow
14382 * @param func Function called when the user select the item.
14383 * @param data Data sent by the callback.
14384 * @return Returns the new item.
14386 * Add an evas object as an item to the menu.
14388 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);
14390 * @brief Set the label of a menu item
14392 * @param item The menu item object.
14393 * @param label The label to set for @p item
14395 * @warning Don't use this funcion on items created with
14396 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14398 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14400 * @brief Get the label of a menu item
14402 * @param item The menu item object.
14403 * @return The label of @p item
14405 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14407 * @brief Set the icon of a menu item to the standard icon with name @p icon
14409 * @param item The menu item object.
14410 * @param icon The icon object to set for the content of @p item
14412 * Once this icon is set, any previously set icon will be deleted.
14414 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14416 * @brief Get the string representation from the icon of a menu item
14418 * @param item The menu item object.
14419 * @return The string representation of @p item's icon or NULL
14421 * @see elm_menu_item_object_icon_name_set()
14423 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14425 * @brief Set the content object of a menu item
14427 * @param item The menu item object
14428 * @param The content object or NULL
14429 * @return EINA_TRUE on success, else EINA_FALSE
14431 * Use this function to change the object swallowed by a menu item, deleting
14432 * any previously swallowed object.
14434 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14436 * @brief Get the content object of a menu item
14438 * @param item The menu item object
14439 * @return The content object or NULL
14440 * @note If @p item was added with elm_menu_item_add_object, this
14441 * function will return the object passed, else it will return the
14444 * @see elm_menu_item_object_content_set()
14446 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14448 * @brief Set the selected state of @p item.
14450 * @param item The menu item object.
14451 * @param selected The selected/unselected state of the item
14453 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14455 * @brief Get the selected state of @p item.
14457 * @param item The menu item object.
14458 * @return The selected/unselected state of the item
14460 * @see elm_menu_item_selected_set()
14462 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14464 * @brief Set the disabled state of @p item.
14466 * @param item The menu item object.
14467 * @param disabled The enabled/disabled state of the item
14469 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14471 * @brief Get the disabled state of @p item.
14473 * @param item The menu item object.
14474 * @return The enabled/disabled state of the item
14476 * @see elm_menu_item_disabled_set()
14478 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14480 * @brief Add a separator item to menu @p obj under @p parent.
14482 * @param obj The menu object
14483 * @param parent The item to add the separator under
14484 * @return The created item or NULL on failure
14486 * This is item is a @ref Separator.
14488 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14490 * @brief Returns whether @p item is a separator.
14492 * @param item The item to check
14493 * @return If true, @p item is a separator
14495 * @see elm_menu_item_separator_add()
14497 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14499 * @brief Deletes an item from the menu.
14501 * @param item The item to delete.
14503 * @see elm_menu_item_add()
14505 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14507 * @brief Set the function called when a menu item is deleted.
14509 * @param item The item to set the callback on
14510 * @param func The function called
14512 * @see elm_menu_item_add()
14513 * @see elm_menu_item_del()
14515 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14517 * @brief Returns the data associated with menu item @p item.
14519 * @param item The item
14520 * @return The data associated with @p item or NULL if none was set.
14522 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14524 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14526 * @brief Sets the data to be associated with menu item @p item.
14528 * @param item The item
14529 * @param data The data to be associated with @p item
14531 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14533 * @brief Returns a list of @p item's subitems.
14535 * @param item The item
14536 * @return An Eina_List* of @p item's subitems
14538 * @see elm_menu_add()
14540 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14542 * @brief Get the position of a menu item
14544 * @param item The menu item
14545 * @return The item's index
14547 * This function returns the index position of a menu item in a menu.
14548 * For a sub-menu, this number is relative to the first item in the sub-menu.
14550 * @note Index values begin with 0
14552 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14554 * @brief @brief Return a menu item's owner menu
14556 * @param item The menu item
14557 * @return The menu object owning @p item, or NULL on failure
14559 * Use this function to get the menu object owning an item.
14561 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14563 * @brief Get the selected item in the menu
14565 * @param obj The menu object
14566 * @return The selected item, or NULL if none
14568 * @see elm_menu_item_selected_get()
14569 * @see elm_menu_item_selected_set()
14571 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14573 * @brief Get the last item in the menu
14575 * @param obj The menu object
14576 * @return The last item, or NULL if none
14578 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14580 * @brief Get the first item in the menu
14582 * @param obj The menu object
14583 * @return The first item, or NULL if none
14585 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14587 * @brief Get the next item in the menu.
14589 * @param item The menu item object.
14590 * @return The item after it, or NULL if none
14592 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14594 * @brief Get the previous item in the menu.
14596 * @param item The menu item object.
14597 * @return The item before it, or NULL if none
14599 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14605 * @defgroup List List
14606 * @ingroup Elementary
14608 * @image html img/widget/list/preview-00.png
14609 * @image latex img/widget/list/preview-00.eps width=\textwidth
14611 * @image html img/list.png
14612 * @image latex img/list.eps width=\textwidth
14614 * A list widget is a container whose children are displayed vertically or
14615 * horizontally, in order, and can be selected.
14616 * The list can accept only one or multiple items selection. Also has many
14617 * modes of items displaying.
14619 * A list is a very simple type of list widget. For more robust
14620 * lists, @ref Genlist should probably be used.
14622 * Smart callbacks one can listen to:
14623 * - @c "activated" - The user has double-clicked or pressed
14624 * (enter|return|spacebar) on an item. The @c event_info parameter
14625 * is the item that was activated.
14626 * - @c "clicked,double" - The user has double-clicked an item.
14627 * The @c event_info parameter is the item that was double-clicked.
14628 * - "selected" - when the user selected an item
14629 * - "unselected" - when the user unselected an item
14630 * - "longpressed" - an item in the list is long-pressed
14631 * - "scroll,edge,top" - the list is scrolled until the top edge
14632 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14633 * - "scroll,edge,left" - the list is scrolled until the left edge
14634 * - "scroll,edge,right" - the list is scrolled until the right edge
14636 * Available styles for it:
14639 * List of examples:
14640 * @li @ref list_example_01
14641 * @li @ref list_example_02
14642 * @li @ref list_example_03
14651 * @enum _Elm_List_Mode
14652 * @typedef Elm_List_Mode
14654 * Set list's resize behavior, transverse axis scroll and
14655 * items cropping. See each mode's description for more details.
14657 * @note Default value is #ELM_LIST_SCROLL.
14659 * Values <b> don't </b> work as bitmask, only one can be choosen.
14661 * @see elm_list_mode_set()
14662 * @see elm_list_mode_get()
14666 typedef enum _Elm_List_Mode
14668 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. */
14669 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). */
14670 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. */
14671 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. */
14672 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14675 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(). */
14678 * Add a new list widget to the given parent Elementary
14679 * (container) object.
14681 * @param parent The parent object.
14682 * @return a new list widget handle or @c NULL, on errors.
14684 * This function inserts a new list widget on the canvas.
14688 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14693 * @param obj The list object
14695 * @note Call before running show() on the list object.
14696 * @warning If not called, it won't display the list properly.
14699 * li = elm_list_add(win);
14700 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14701 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14703 * evas_object_show(li);
14708 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14711 * Enable or disable multiple items selection on the list object.
14713 * @param obj The list object
14714 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14717 * Disabled by default. If disabled, the user can select a single item of
14718 * the list each time. Selected items are highlighted on list.
14719 * If enabled, many items can be selected.
14721 * If a selected item is selected again, it will be unselected.
14723 * @see elm_list_multi_select_get()
14727 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14730 * Get a value whether multiple items selection is enabled or not.
14732 * @see elm_list_multi_select_set() for details.
14734 * @param obj The list object.
14735 * @return @c EINA_TRUE means multiple items selection is enabled.
14736 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14737 * @c EINA_FALSE is returned.
14741 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14744 * Set which mode to use for the list object.
14746 * @param obj The list object
14747 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14748 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14750 * Set list's resize behavior, transverse axis scroll and
14751 * items cropping. See each mode's description for more details.
14753 * @note Default value is #ELM_LIST_SCROLL.
14755 * Only one can be set, if a previous one was set, it will be changed
14756 * by the new mode set. Bitmask won't work as well.
14758 * @see elm_list_mode_get()
14762 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14765 * Get the mode the list is at.
14767 * @param obj The list object
14768 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14769 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14771 * @note see elm_list_mode_set() for more information.
14775 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14778 * Enable or disable horizontal mode on the list object.
14780 * @param obj The list object.
14781 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14782 * disable it, i.e., to enable vertical mode.
14784 * @note Vertical mode is set by default.
14786 * On horizontal mode items are displayed on list from left to right,
14787 * instead of from top to bottom. Also, the list will scroll horizontally.
14788 * Each item will presents left icon on top and right icon, or end, at
14791 * @see elm_list_horizontal_get()
14795 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14798 * Get a value whether horizontal mode is enabled or not.
14800 * @param obj The list object.
14801 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14802 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14803 * @c EINA_FALSE is returned.
14805 * @see elm_list_horizontal_set() for details.
14809 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14812 * Enable or disable always select mode on the list object.
14814 * @param obj The list object
14815 * @param always_select @c EINA_TRUE to enable always select mode or
14816 * @c EINA_FALSE to disable it.
14818 * @note Always select mode is disabled by default.
14820 * Default behavior of list items is to only call its callback function
14821 * the first time it's pressed, i.e., when it is selected. If a selected
14822 * item is pressed again, and multi-select is disabled, it won't call
14823 * this function (if multi-select is enabled it will unselect the item).
14825 * If always select is enabled, it will call the callback function
14826 * everytime a item is pressed, so it will call when the item is selected,
14827 * and again when a selected item is pressed.
14829 * @see elm_list_always_select_mode_get()
14830 * @see elm_list_multi_select_set()
14834 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14837 * Get a value whether always select mode is enabled or not, meaning that
14838 * an item will always call its callback function, even if already selected.
14840 * @param obj The list object
14841 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14842 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14843 * @c EINA_FALSE is returned.
14845 * @see elm_list_always_select_mode_set() for details.
14849 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14852 * Set bouncing behaviour when the scrolled content reaches an edge.
14854 * Tell the internal scroller object whether it should bounce or not
14855 * when it reaches the respective edges for each axis.
14857 * @param obj The list object
14858 * @param h_bounce Whether to bounce or not in the horizontal axis.
14859 * @param v_bounce Whether to bounce or not in the vertical axis.
14861 * @see elm_scroller_bounce_set()
14865 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14868 * Get the bouncing behaviour of the internal scroller.
14870 * Get whether the internal scroller should bounce when the edge of each
14871 * axis is reached scrolling.
14873 * @param obj The list object.
14874 * @param h_bounce Pointer where to store the bounce state of the horizontal
14876 * @param v_bounce Pointer where to store the bounce state of the vertical
14879 * @see elm_scroller_bounce_get()
14880 * @see elm_list_bounce_set()
14884 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14887 * Set the scrollbar policy.
14889 * @param obj The list object
14890 * @param policy_h Horizontal scrollbar policy.
14891 * @param policy_v Vertical scrollbar policy.
14893 * This sets the scrollbar visibility policy for the given scroller.
14894 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14895 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14896 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14897 * This applies respectively for the horizontal and vertical scrollbars.
14899 * The both are disabled by default, i.e., are set to
14900 * #ELM_SCROLLER_POLICY_OFF.
14904 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14907 * Get the scrollbar policy.
14909 * @see elm_list_scroller_policy_get() for details.
14911 * @param obj The list object.
14912 * @param policy_h Pointer where to store horizontal scrollbar policy.
14913 * @param policy_v Pointer where to store vertical scrollbar policy.
14917 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);
14920 * Append a new item to the list object.
14922 * @param obj The list object.
14923 * @param label The label of the list item.
14924 * @param icon The icon object to use for the left side of the item. An
14925 * icon can be any Evas object, but usually it is an icon created
14926 * with elm_icon_add().
14927 * @param end The icon object to use for the right side of the item. An
14928 * icon can be any Evas object.
14929 * @param func The function to call when the item is clicked.
14930 * @param data The data to associate with the item for related callbacks.
14932 * @return The created item or @c NULL upon failure.
14934 * A new item will be created and appended to the list, i.e., will
14935 * be set as @b last item.
14937 * Items created with this method can be deleted with
14938 * elm_list_item_del().
14940 * Associated @p data can be properly freed when item is deleted if a
14941 * callback function is set with elm_list_item_del_cb_set().
14943 * If a function is passed as argument, it will be called everytime this item
14944 * is selected, i.e., the user clicks over an unselected item.
14945 * If always select is enabled it will call this function every time
14946 * user clicks over an item (already selected or not).
14947 * If such function isn't needed, just passing
14948 * @c NULL as @p func is enough. The same should be done for @p data.
14950 * Simple example (with no function callback or data associated):
14952 * li = elm_list_add(win);
14953 * ic = elm_icon_add(win);
14954 * elm_icon_file_set(ic, "path/to/image", NULL);
14955 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14956 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14958 * evas_object_show(li);
14961 * @see elm_list_always_select_mode_set()
14962 * @see elm_list_item_del()
14963 * @see elm_list_item_del_cb_set()
14964 * @see elm_list_clear()
14965 * @see elm_icon_add()
14969 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);
14972 * Prepend a new item to the list object.
14974 * @param obj The list object.
14975 * @param label The label of the list item.
14976 * @param icon The icon object to use for the left side of the item. An
14977 * icon can be any Evas object, but usually it is an icon created
14978 * with elm_icon_add().
14979 * @param end The icon object to use for the right side of the item. An
14980 * icon can be any Evas object.
14981 * @param func The function to call when the item is clicked.
14982 * @param data The data to associate with the item for related callbacks.
14984 * @return The created item or @c NULL upon failure.
14986 * A new item will be created and prepended to the list, i.e., will
14987 * be set as @b first item.
14989 * Items created with this method can be deleted with
14990 * elm_list_item_del().
14992 * Associated @p data can be properly freed when item is deleted if a
14993 * callback function is set with elm_list_item_del_cb_set().
14995 * If a function is passed as argument, it will be called everytime this item
14996 * is selected, i.e., the user clicks over an unselected item.
14997 * If always select is enabled it will call this function every time
14998 * user clicks over an item (already selected or not).
14999 * If such function isn't needed, just passing
15000 * @c NULL as @p func is enough. The same should be done for @p data.
15002 * @see elm_list_item_append() for a simple code example.
15003 * @see elm_list_always_select_mode_set()
15004 * @see elm_list_item_del()
15005 * @see elm_list_item_del_cb_set()
15006 * @see elm_list_clear()
15007 * @see elm_icon_add()
15011 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);
15014 * Insert a new item into the list object before item @p before.
15016 * @param obj The list object.
15017 * @param before The list item to insert before.
15018 * @param label The label of the list item.
15019 * @param icon The icon object to use for the left side of the item. An
15020 * icon can be any Evas object, but usually it is an icon created
15021 * with elm_icon_add().
15022 * @param end The icon object to use for the right side of the item. An
15023 * icon can be any Evas object.
15024 * @param func The function to call when the item is clicked.
15025 * @param data The data to associate with the item for related callbacks.
15027 * @return The created item or @c NULL upon failure.
15029 * A new item will be created and added to the list. Its position in
15030 * this list will be just before item @p before.
15032 * Items created with this method can be deleted with
15033 * elm_list_item_del().
15035 * Associated @p data can be properly freed when item is deleted if a
15036 * callback function is set with elm_list_item_del_cb_set().
15038 * If a function is passed as argument, it will be called everytime this item
15039 * is selected, i.e., the user clicks over an unselected item.
15040 * If always select is enabled it will call this function every time
15041 * user clicks over an item (already selected or not).
15042 * If such function isn't needed, just passing
15043 * @c NULL as @p func is enough. The same should be done for @p data.
15045 * @see elm_list_item_append() for a simple code example.
15046 * @see elm_list_always_select_mode_set()
15047 * @see elm_list_item_del()
15048 * @see elm_list_item_del_cb_set()
15049 * @see elm_list_clear()
15050 * @see elm_icon_add()
15054 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);
15057 * Insert a new item into the list object after item @p after.
15059 * @param obj The list object.
15060 * @param after The list item to insert after.
15061 * @param label The label of the list item.
15062 * @param icon The icon object to use for the left side of the item. An
15063 * icon can be any Evas object, but usually it is an icon created
15064 * with elm_icon_add().
15065 * @param end The icon object to use for the right side of the item. An
15066 * icon can be any Evas object.
15067 * @param func The function to call when the item is clicked.
15068 * @param data The data to associate with the item for related callbacks.
15070 * @return The created item or @c NULL upon failure.
15072 * A new item will be created and added to the list. Its position in
15073 * this list will be just after item @p after.
15075 * Items created with this method can be deleted with
15076 * elm_list_item_del().
15078 * Associated @p data can be properly freed when item is deleted if a
15079 * callback function is set with elm_list_item_del_cb_set().
15081 * If a function is passed as argument, it will be called everytime this item
15082 * is selected, i.e., the user clicks over an unselected item.
15083 * If always select is enabled it will call this function every time
15084 * user clicks over an item (already selected or not).
15085 * If such function isn't needed, just passing
15086 * @c NULL as @p func is enough. The same should be done for @p data.
15088 * @see elm_list_item_append() for a simple code example.
15089 * @see elm_list_always_select_mode_set()
15090 * @see elm_list_item_del()
15091 * @see elm_list_item_del_cb_set()
15092 * @see elm_list_clear()
15093 * @see elm_icon_add()
15097 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);
15100 * Insert a new item into the sorted list object.
15102 * @param obj The list object.
15103 * @param label The label of the list item.
15104 * @param icon The icon object to use for the left side of the item. An
15105 * icon can be any Evas object, but usually it is an icon created
15106 * with elm_icon_add().
15107 * @param end The icon object to use for the right side of the item. An
15108 * icon can be any Evas object.
15109 * @param func The function to call when the item is clicked.
15110 * @param data The data to associate with the item for related callbacks.
15111 * @param cmp_func The comparing function to be used to sort list
15112 * items <b>by #Elm_List_Item item handles</b>. This function will
15113 * receive two items and compare them, returning a non-negative integer
15114 * if the second item should be place after the first, or negative value
15115 * if should be placed before.
15117 * @return The created item or @c NULL upon failure.
15119 * @note This function inserts values into a list object assuming it was
15120 * sorted and the result will be sorted.
15122 * A new item will be created and added to the list. Its position in
15123 * this list will be found comparing the new item with previously inserted
15124 * items using function @p cmp_func.
15126 * Items created with this method can be deleted with
15127 * elm_list_item_del().
15129 * Associated @p data can be properly freed when item is deleted if a
15130 * callback function is set with elm_list_item_del_cb_set().
15132 * If a function is passed as argument, it will be called everytime this item
15133 * is selected, i.e., the user clicks over an unselected item.
15134 * If always select is enabled it will call this function every time
15135 * user clicks over an item (already selected or not).
15136 * If such function isn't needed, just passing
15137 * @c NULL as @p func is enough. The same should be done for @p data.
15139 * @see elm_list_item_append() for a simple code example.
15140 * @see elm_list_always_select_mode_set()
15141 * @see elm_list_item_del()
15142 * @see elm_list_item_del_cb_set()
15143 * @see elm_list_clear()
15144 * @see elm_icon_add()
15148 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);
15151 * Remove all list's items.
15153 * @param obj The list object
15155 * @see elm_list_item_del()
15156 * @see elm_list_item_append()
15160 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15163 * Get a list of all the list items.
15165 * @param obj The list object
15166 * @return An @c Eina_List of list items, #Elm_List_Item,
15167 * or @c NULL on failure.
15169 * @see elm_list_item_append()
15170 * @see elm_list_item_del()
15171 * @see elm_list_clear()
15175 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15178 * Get the selected item.
15180 * @param obj The list object.
15181 * @return The selected list item.
15183 * The selected item can be unselected with function
15184 * elm_list_item_selected_set().
15186 * The selected item always will be highlighted on list.
15188 * @see elm_list_selected_items_get()
15192 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15195 * Return a list of the currently selected list items.
15197 * @param obj The list object.
15198 * @return An @c Eina_List of list items, #Elm_List_Item,
15199 * or @c NULL on failure.
15201 * Multiple items can be selected if multi select is enabled. It can be
15202 * done with elm_list_multi_select_set().
15204 * @see elm_list_selected_item_get()
15205 * @see elm_list_multi_select_set()
15209 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15212 * Set the selected state of an item.
15214 * @param item The list item
15215 * @param selected The selected state
15217 * This sets the selected state of the given item @p it.
15218 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15220 * If a new item is selected the previosly selected will be unselected,
15221 * unless multiple selection is enabled with elm_list_multi_select_set().
15222 * Previoulsy selected item can be get with function
15223 * elm_list_selected_item_get().
15225 * Selected items will be highlighted.
15227 * @see elm_list_item_selected_get()
15228 * @see elm_list_selected_item_get()
15229 * @see elm_list_multi_select_set()
15233 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15236 * Get whether the @p item is selected or not.
15238 * @param item The list item.
15239 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15240 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15242 * @see elm_list_selected_item_set() for details.
15243 * @see elm_list_item_selected_get()
15247 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15250 * Set or unset item as a separator.
15252 * @param it The list item.
15253 * @param setting @c EINA_TRUE to set item @p it as separator or
15254 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15256 * Items aren't set as separator by default.
15258 * If set as separator it will display separator theme, so won't display
15261 * @see elm_list_item_separator_get()
15265 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15268 * Get a value whether item is a separator or not.
15270 * @see elm_list_item_separator_set() for details.
15272 * @param it The list item.
15273 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15274 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15278 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15281 * Show @p item in the list view.
15283 * @param item The list item to be shown.
15285 * It won't animate list until item is visible. If such behavior is wanted,
15286 * use elm_list_bring_in() intead.
15290 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15293 * Bring in the given item to list view.
15295 * @param item The item.
15297 * This causes list to jump to the given item @p item and show it
15298 * (by scrolling), if it is not fully visible.
15300 * This may use animation to do so and take a period of time.
15302 * If animation isn't wanted, elm_list_item_show() can be used.
15306 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15309 * Delete them item from the list.
15311 * @param item The item of list to be deleted.
15313 * If deleting all list items is required, elm_list_clear()
15314 * should be used instead of getting items list and deleting each one.
15316 * @see elm_list_clear()
15317 * @see elm_list_item_append()
15318 * @see elm_list_item_del_cb_set()
15322 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15325 * Set the function called when a list item is freed.
15327 * @param item The item to set the callback on
15328 * @param func The function called
15330 * If there is a @p func, then it will be called prior item's memory release.
15331 * That will be called with the following arguments:
15333 * @li item's Evas object;
15336 * This way, a data associated to a list item could be properly freed.
15340 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15343 * Get the data associated to the item.
15345 * @param item The list item
15346 * @return The data associated to @p item
15348 * The return value is a pointer to data associated to @p item when it was
15349 * created, with function elm_list_item_append() or similar. If no data
15350 * was passed as argument, it will return @c NULL.
15352 * @see elm_list_item_append()
15356 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15359 * Get the left side icon associated to the item.
15361 * @param item The list item
15362 * @return The left side icon associated to @p item
15364 * The return value is a pointer to the icon associated to @p item when
15366 * created, with function elm_list_item_append() or similar, or later
15367 * with function elm_list_item_icon_set(). If no icon
15368 * was passed as argument, it will return @c NULL.
15370 * @see elm_list_item_append()
15371 * @see elm_list_item_icon_set()
15375 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15378 * Set the left side icon associated to the item.
15380 * @param item The list item
15381 * @param icon The left side icon object to associate with @p item
15383 * The icon object to use at left side of the item. An
15384 * icon can be any Evas object, but usually it is an icon created
15385 * with elm_icon_add().
15387 * Once the icon object is set, a previously set one will be deleted.
15388 * @warning Setting the same icon for two items will cause the icon to
15389 * dissapear from the first item.
15391 * If an icon was passed as argument on item creation, with function
15392 * elm_list_item_append() or similar, it will be already
15393 * associated to the item.
15395 * @see elm_list_item_append()
15396 * @see elm_list_item_icon_get()
15400 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15403 * Get the right side icon associated to the item.
15405 * @param item The list item
15406 * @return The right side icon associated to @p item
15408 * The return value is a pointer to the icon associated to @p item when
15410 * created, with function elm_list_item_append() or similar, or later
15411 * with function elm_list_item_icon_set(). If no icon
15412 * was passed as argument, it will return @c NULL.
15414 * @see elm_list_item_append()
15415 * @see elm_list_item_icon_set()
15419 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15422 * Set the right side icon associated to the item.
15424 * @param item The list item
15425 * @param end The right side icon object to associate with @p item
15427 * The icon object to use at right side of the item. An
15428 * icon can be any Evas object, but usually it is an icon created
15429 * with elm_icon_add().
15431 * Once the icon object is set, a previously set one will be deleted.
15432 * @warning Setting the same icon for two items will cause the icon to
15433 * dissapear from the first item.
15435 * If an icon was passed as argument on item creation, with function
15436 * elm_list_item_append() or similar, it will be already
15437 * associated to the item.
15439 * @see elm_list_item_append()
15440 * @see elm_list_item_end_get()
15444 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15447 * Gets the base object of the item.
15449 * @param item The list item
15450 * @return The base object associated with @p item
15452 * Base object is the @c Evas_Object that represents that item.
15456 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15457 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15460 * Get the label of item.
15462 * @param item The item of list.
15463 * @return The label of item.
15465 * The return value is a pointer to the label associated to @p item when
15466 * it was created, with function elm_list_item_append(), or later
15467 * with function elm_list_item_label_set. If no label
15468 * was passed as argument, it will return @c NULL.
15470 * @see elm_list_item_label_set() for more details.
15471 * @see elm_list_item_append()
15475 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15478 * Set the label of item.
15480 * @param item The item of list.
15481 * @param text The label of item.
15483 * The label to be displayed by the item.
15484 * Label will be placed between left and right side icons (if set).
15486 * If a label was passed as argument on item creation, with function
15487 * elm_list_item_append() or similar, it will be already
15488 * displayed by the item.
15490 * @see elm_list_item_label_get()
15491 * @see elm_list_item_append()
15495 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15499 * Get the item before @p it in list.
15501 * @param it The list item.
15502 * @return The item before @p it, or @c NULL if none or on failure.
15504 * @note If it is the first item, @c NULL will be returned.
15506 * @see elm_list_item_append()
15507 * @see elm_list_items_get()
15511 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15514 * Get the item after @p it in list.
15516 * @param it The list item.
15517 * @return The item after @p it, or @c NULL if none or on failure.
15519 * @note If it is the last item, @c NULL will be returned.
15521 * @see elm_list_item_append()
15522 * @see elm_list_items_get()
15526 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15529 * Sets the disabled/enabled state of a list item.
15531 * @param it The item.
15532 * @param disabled The disabled state.
15534 * A disabled item cannot be selected or unselected. It will also
15535 * change its appearance (generally greyed out). This sets the
15536 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15541 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15544 * Get a value whether list item is disabled or not.
15546 * @param it The item.
15547 * @return The disabled state.
15549 * @see elm_list_item_disabled_set() for more details.
15553 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15556 * Set the text to be shown in a given list item's tooltips.
15558 * @param item Target item.
15559 * @param text The text to set in the content.
15561 * Setup the text as tooltip to object. The item can have only one tooltip,
15562 * so any previous tooltip data - set with this function or
15563 * elm_list_item_tooltip_content_cb_set() - is removed.
15565 * @see elm_object_tooltip_text_set() for more details.
15569 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15573 * @brief Disable size restrictions on an object's tooltip
15574 * @param item The tooltip's anchor object
15575 * @param disable If EINA_TRUE, size restrictions are disabled
15576 * @return EINA_FALSE on failure, EINA_TRUE on success
15578 * This function allows a tooltip to expand beyond its parant window's canvas.
15579 * It will instead be limited only by the size of the display.
15581 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15583 * @brief Retrieve size restriction state of an object's tooltip
15584 * @param obj The tooltip's anchor object
15585 * @return If EINA_TRUE, size restrictions are disabled
15587 * This function returns whether a tooltip is allowed to expand beyond
15588 * its parant window's canvas.
15589 * It will instead be limited only by the size of the display.
15591 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15594 * Set the content to be shown in the tooltip item.
15596 * Setup the tooltip to item. The item can have only one tooltip,
15597 * so any previous tooltip data is removed. @p func(with @p data) will
15598 * be called every time that need show the tooltip and it should
15599 * return a valid Evas_Object. This object is then managed fully by
15600 * tooltip system and is deleted when the tooltip is gone.
15602 * @param item the list item being attached a tooltip.
15603 * @param func the function used to create the tooltip contents.
15604 * @param data what to provide to @a func as callback data/context.
15605 * @param del_cb called when data is not needed anymore, either when
15606 * another callback replaces @a func, the tooltip is unset with
15607 * elm_list_item_tooltip_unset() or the owner @a item
15608 * dies. This callback receives as the first parameter the
15609 * given @a data, and @c event_info is the item.
15611 * @see elm_object_tooltip_content_cb_set() for more details.
15615 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);
15618 * Unset tooltip from item.
15620 * @param item list item to remove previously set tooltip.
15622 * Remove tooltip from item. The callback provided as del_cb to
15623 * elm_list_item_tooltip_content_cb_set() will be called to notify
15624 * it is not used anymore.
15626 * @see elm_object_tooltip_unset() for more details.
15627 * @see elm_list_item_tooltip_content_cb_set()
15631 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15634 * Sets a different style for this item tooltip.
15636 * @note before you set a style you should define a tooltip with
15637 * elm_list_item_tooltip_content_cb_set() or
15638 * elm_list_item_tooltip_text_set()
15640 * @param item list item with tooltip already set.
15641 * @param style the theme style to use (default, transparent, ...)
15643 * @see elm_object_tooltip_style_set() for more details.
15647 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15650 * Get the style for this item tooltip.
15652 * @param item list item with tooltip already set.
15653 * @return style the theme style in use, defaults to "default". If the
15654 * object does not have a tooltip set, then NULL is returned.
15656 * @see elm_object_tooltip_style_get() for more details.
15657 * @see elm_list_item_tooltip_style_set()
15661 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15664 * Set the type of mouse pointer/cursor decoration to be shown,
15665 * when the mouse pointer is over the given list widget item
15667 * @param item list item to customize cursor on
15668 * @param cursor the cursor type's name
15670 * This function works analogously as elm_object_cursor_set(), but
15671 * here the cursor's changing area is restricted to the item's
15672 * area, and not the whole widget's. Note that that item cursors
15673 * have precedence over widget cursors, so that a mouse over an
15674 * item with custom cursor set will always show @b that cursor.
15676 * If this function is called twice for an object, a previously set
15677 * cursor will be unset on the second call.
15679 * @see elm_object_cursor_set()
15680 * @see elm_list_item_cursor_get()
15681 * @see elm_list_item_cursor_unset()
15685 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15688 * Get the type of mouse pointer/cursor decoration set to be shown,
15689 * when the mouse pointer is over the given list widget item
15691 * @param item list item with custom cursor set
15692 * @return the cursor type's name or @c NULL, if no custom cursors
15693 * were set to @p item (and on errors)
15695 * @see elm_object_cursor_get()
15696 * @see elm_list_item_cursor_set()
15697 * @see elm_list_item_cursor_unset()
15701 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15704 * Unset any custom mouse pointer/cursor decoration set to be
15705 * shown, when the mouse pointer is over the given list widget
15706 * item, thus making it show the @b default cursor again.
15708 * @param item a list item
15710 * Use this call to undo any custom settings on this item's cursor
15711 * decoration, bringing it back to defaults (no custom style set).
15713 * @see elm_object_cursor_unset()
15714 * @see elm_list_item_cursor_set()
15718 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15721 * Set a different @b style for a given custom cursor set for a
15724 * @param item list item with custom cursor set
15725 * @param style the <b>theme style</b> to use (e.g. @c "default",
15726 * @c "transparent", etc)
15728 * This function only makes sense when one is using custom mouse
15729 * cursor decorations <b>defined in a theme file</b>, which can have,
15730 * given a cursor name/type, <b>alternate styles</b> on it. It
15731 * works analogously as elm_object_cursor_style_set(), but here
15732 * applyed only to list item objects.
15734 * @warning Before you set a cursor style you should have definen a
15735 * custom cursor previously on the item, with
15736 * elm_list_item_cursor_set()
15738 * @see elm_list_item_cursor_engine_only_set()
15739 * @see elm_list_item_cursor_style_get()
15743 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15746 * Get the current @b style set for a given list item's custom
15749 * @param item list item with custom cursor set.
15750 * @return style the cursor style in use. If the object does not
15751 * have a cursor set, then @c NULL is returned.
15753 * @see elm_list_item_cursor_style_set() for more details
15757 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15760 * Set if the (custom)cursor for a given list item should be
15761 * searched in its theme, also, or should only rely on the
15762 * rendering engine.
15764 * @param item item with custom (custom) cursor already set on
15765 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15766 * only on those provided by the rendering engine, @c EINA_FALSE to
15767 * have them searched on the widget's theme, as well.
15769 * @note This call is of use only if you've set a custom cursor
15770 * for list items, with elm_list_item_cursor_set().
15772 * @note By default, cursors will only be looked for between those
15773 * provided by the rendering engine.
15777 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15780 * Get if the (custom) cursor for a given list item is being
15781 * searched in its theme, also, or is only relying on the rendering
15784 * @param item a list item
15785 * @return @c EINA_TRUE, if cursors are being looked for only on
15786 * those provided by the rendering engine, @c EINA_FALSE if they
15787 * are being searched on the widget's theme, as well.
15789 * @see elm_list_item_cursor_engine_only_set(), for more details
15793 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15800 * @defgroup Slider Slider
15801 * @ingroup Elementary
15803 * @image html img/widget/slider/preview-00.png
15804 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15806 * The slider adds a dragable “slider” widget for selecting the value of
15807 * something within a range.
15809 * A slider can be horizontal or vertical. It can contain an Icon and has a
15810 * primary label as well as a units label (that is formatted with floating
15811 * point values and thus accepts a printf-style format string, like
15812 * “%1.2f units”. There is also an indicator string that may be somewhere
15813 * else (like on the slider itself) that also accepts a format string like
15814 * units. Label, Icon Unit and Indicator strings/objects are optional.
15816 * A slider may be inverted which means values invert, with high vales being
15817 * on the left or top and low values on the right or bottom (as opposed to
15818 * normally being low on the left or top and high on the bottom and right).
15820 * The slider should have its minimum and maximum values set by the
15821 * application with elm_slider_min_max_set() and value should also be set by
15822 * the application before use with elm_slider_value_set(). The span of the
15823 * slider is its length (horizontally or vertically). This will be scaled by
15824 * the object or applications scaling factor. At any point code can query the
15825 * slider for its value with elm_slider_value_get().
15827 * Smart callbacks one can listen to:
15828 * - "changed" - Whenever the slider value is changed by the user.
15829 * - "slider,drag,start" - dragging the slider indicator around has started.
15830 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15831 * - "delay,changed" - A short time after the value is changed by the user.
15832 * This will be called only when the user stops dragging for
15833 * a very short period or when they release their
15834 * finger/mouse, so it avoids possibly expensive reactions to
15835 * the value change.
15837 * Available styles for it:
15840 * Here is an example on its usage:
15841 * @li @ref slider_example
15845 * @addtogroup Slider
15850 * Add a new slider widget to the given parent Elementary
15851 * (container) object.
15853 * @param parent The parent object.
15854 * @return a new slider widget handle or @c NULL, on errors.
15856 * This function inserts a new slider widget on the canvas.
15860 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15863 * Set the label of a given slider widget
15865 * @param obj The progress bar object
15866 * @param label The text label string, in UTF-8
15869 * @deprecated use elm_object_text_set() instead.
15871 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15874 * Get the label of a given slider widget
15876 * @param obj The progressbar object
15877 * @return The text label string, in UTF-8
15880 * @deprecated use elm_object_text_get() instead.
15882 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15885 * Set the icon object of the slider object.
15887 * @param obj The slider object.
15888 * @param icon The icon object.
15890 * On horizontal mode, icon is placed at left, and on vertical mode,
15893 * @note Once the icon object is set, a previously set one will be deleted.
15894 * If you want to keep that old content object, use the
15895 * elm_slider_icon_unset() function.
15897 * @warning If the object being set does not have minimum size hints set,
15898 * it won't get properly displayed.
15902 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15905 * Unset an icon set on a given slider widget.
15907 * @param obj The slider object.
15908 * @return The icon object that was being used, if any was set, or
15909 * @c NULL, otherwise (and on errors).
15911 * On horizontal mode, icon is placed at left, and on vertical mode,
15914 * This call will unparent and return the icon object which was set
15915 * for this widget, previously, on success.
15917 * @see elm_slider_icon_set() for more details
15918 * @see elm_slider_icon_get()
15922 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15925 * Retrieve the icon object set for a given slider widget.
15927 * @param obj The slider object.
15928 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15929 * otherwise (and on errors).
15931 * On horizontal mode, icon is placed at left, and on vertical mode,
15934 * @see elm_slider_icon_set() for more details
15935 * @see elm_slider_icon_unset()
15939 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15942 * Set the end object of the slider object.
15944 * @param obj The slider object.
15945 * @param end The end object.
15947 * On horizontal mode, end is placed at left, and on vertical mode,
15948 * placed at bottom.
15950 * @note Once the icon object is set, a previously set one will be deleted.
15951 * If you want to keep that old content object, use the
15952 * elm_slider_end_unset() function.
15954 * @warning If the object being set does not have minimum size hints set,
15955 * it won't get properly displayed.
15959 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15962 * Unset an end object set on a given slider widget.
15964 * @param obj The slider object.
15965 * @return The end object that was being used, if any was set, or
15966 * @c NULL, otherwise (and on errors).
15968 * On horizontal mode, end is placed at left, and on vertical mode,
15969 * placed at bottom.
15971 * This call will unparent and return the icon object which was set
15972 * for this widget, previously, on success.
15974 * @see elm_slider_end_set() for more details.
15975 * @see elm_slider_end_get()
15979 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15982 * Retrieve the end object set for a given slider widget.
15984 * @param obj The slider object.
15985 * @return The end object's handle, if @p obj had one set, or @c NULL,
15986 * otherwise (and on errors).
15988 * On horizontal mode, icon is placed at right, and on vertical mode,
15989 * placed at bottom.
15991 * @see elm_slider_end_set() for more details.
15992 * @see elm_slider_end_unset()
15996 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15999 * Set the (exact) length of the bar region of a given slider widget.
16001 * @param obj The slider object.
16002 * @param size The length of the slider's bar region.
16004 * This sets the minimum width (when in horizontal mode) or height
16005 * (when in vertical mode) of the actual bar area of the slider
16006 * @p obj. This in turn affects the object's minimum size. Use
16007 * this when you're not setting other size hints expanding on the
16008 * given direction (like weight and alignment hints) and you would
16009 * like it to have a specific size.
16011 * @note Icon, end, label, indicator and unit text around @p obj
16012 * will require their
16013 * own space, which will make @p obj to require more the @p size,
16016 * @see elm_slider_span_size_get()
16020 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16023 * Get the length set for the bar region of a given slider widget
16025 * @param obj The slider object.
16026 * @return The length of the slider's bar region.
16028 * If that size was not set previously, with
16029 * elm_slider_span_size_set(), this call will return @c 0.
16033 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16036 * Set the format string for the unit label.
16038 * @param obj The slider object.
16039 * @param format The format string for the unit display.
16041 * Unit label is displayed all the time, if set, after slider's bar.
16042 * In horizontal mode, at right and in vertical mode, at bottom.
16044 * If @c NULL, unit label won't be visible. If not it sets the format
16045 * string for the label text. To the label text is provided a floating point
16046 * value, so the label text can display up to 1 floating point value.
16047 * Note that this is optional.
16049 * Use a format string such as "%1.2f meters" for example, and it will
16050 * display values like: "3.14 meters" for a value equal to 3.14159.
16052 * Default is unit label disabled.
16054 * @see elm_slider_indicator_format_get()
16058 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16061 * Get the unit label format of the slider.
16063 * @param obj The slider object.
16064 * @return The unit label format string in UTF-8.
16066 * Unit label is displayed all the time, if set, after slider's bar.
16067 * In horizontal mode, at right and in vertical mode, at bottom.
16069 * @see elm_slider_unit_format_set() for more
16070 * information on how this works.
16074 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16077 * Set the format string for the indicator label.
16079 * @param obj The slider object.
16080 * @param indicator The format string for the indicator display.
16082 * The slider may display its value somewhere else then unit label,
16083 * for example, above the slider knob that is dragged around. This function
16084 * sets the format string used for this.
16086 * If @c NULL, indicator label won't be visible. If not it sets the format
16087 * string for the label text. To the label text is provided a floating point
16088 * value, so the label text can display up to 1 floating point value.
16089 * Note that this is optional.
16091 * Use a format string such as "%1.2f meters" for example, and it will
16092 * display values like: "3.14 meters" for a value equal to 3.14159.
16094 * Default is indicator label disabled.
16096 * @see elm_slider_indicator_format_get()
16100 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16103 * Get the indicator label format of the slider.
16105 * @param obj The slider object.
16106 * @return The indicator label format string in UTF-8.
16108 * The slider may display its value somewhere else then unit label,
16109 * for example, above the slider knob that is dragged around. This function
16110 * gets the format string used for this.
16112 * @see elm_slider_indicator_format_set() for more
16113 * information on how this works.
16117 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16120 * Set the format function pointer for the indicator label
16122 * @param obj The slider object.
16123 * @param func The indicator format function.
16124 * @param free_func The freeing function for the format string.
16126 * Set the callback function to format the indicator string.
16128 * @see elm_slider_indicator_format_set() for more info on how this works.
16132 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);
16135 * Set the format function pointer for the units label
16137 * @param obj The slider object.
16138 * @param func The units format function.
16139 * @param free_func The freeing function for the format string.
16141 * Set the callback function to format the indicator string.
16143 * @see elm_slider_units_format_set() for more info on how this works.
16147 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);
16150 * Set the orientation of a given slider widget.
16152 * @param obj The slider object.
16153 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16154 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16156 * Use this function to change how your slider is to be
16157 * disposed: vertically or horizontally.
16159 * By default it's displayed horizontally.
16161 * @see elm_slider_horizontal_get()
16165 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16168 * Retrieve the orientation of a given slider widget
16170 * @param obj The slider object.
16171 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16172 * @c EINA_FALSE if it's @b vertical (and on errors).
16174 * @see elm_slider_horizontal_set() for more details.
16178 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16181 * Set the minimum and maximum values for the slider.
16183 * @param obj The slider object.
16184 * @param min The minimum value.
16185 * @param max The maximum value.
16187 * Define the allowed range of values to be selected by the user.
16189 * If actual value is less than @p min, it will be updated to @p min. If it
16190 * is bigger then @p max, will be updated to @p max. Actual value can be
16191 * get with elm_slider_value_get().
16193 * By default, min is equal to 0.0, and max is equal to 1.0.
16195 * @warning Maximum must be greater than minimum, otherwise behavior
16198 * @see elm_slider_min_max_get()
16202 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16205 * Get the minimum and maximum values of the slider.
16207 * @param obj The slider object.
16208 * @param min Pointer where to store the minimum value.
16209 * @param max Pointer where to store the maximum value.
16211 * @note If only one value is needed, the other pointer can be passed
16214 * @see elm_slider_min_max_set() for details.
16218 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16221 * Set the value the slider displays.
16223 * @param obj The slider object.
16224 * @param val The value to be displayed.
16226 * Value will be presented on the unit label following format specified with
16227 * elm_slider_unit_format_set() and on indicator with
16228 * elm_slider_indicator_format_set().
16230 * @warning The value must to be between min and max values. This values
16231 * are set by elm_slider_min_max_set().
16233 * @see elm_slider_value_get()
16234 * @see elm_slider_unit_format_set()
16235 * @see elm_slider_indicator_format_set()
16236 * @see elm_slider_min_max_set()
16240 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16243 * Get the value displayed by the spinner.
16245 * @param obj The spinner object.
16246 * @return The value displayed.
16248 * @see elm_spinner_value_set() for details.
16252 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16255 * Invert a given slider widget's displaying values order
16257 * @param obj The slider object.
16258 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16259 * @c EINA_FALSE to bring it back to default, non-inverted values.
16261 * A slider may be @b inverted, in which state it gets its
16262 * values inverted, with high vales being on the left or top and
16263 * low values on the right or bottom, as opposed to normally have
16264 * the low values on the former and high values on the latter,
16265 * respectively, for horizontal and vertical modes.
16267 * @see elm_slider_inverted_get()
16271 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16274 * Get whether a given slider widget's displaying values are
16277 * @param obj The slider object.
16278 * @return @c EINA_TRUE, if @p obj has inverted values,
16279 * @c EINA_FALSE otherwise (and on errors).
16281 * @see elm_slider_inverted_set() for more details.
16285 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16288 * Set whether to enlarge slider indicator (augmented knob) or not.
16290 * @param obj The slider object.
16291 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16292 * let the knob always at default size.
16294 * By default, indicator will be bigger while dragged by the user.
16296 * @warning It won't display values set with
16297 * elm_slider_indicator_format_set() if you disable indicator.
16301 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16304 * Get whether a given slider widget's enlarging indicator or not.
16306 * @param obj The slider object.
16307 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16308 * @c EINA_FALSE otherwise (and on errors).
16310 * @see elm_slider_indicator_show_set() for details.
16314 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16321 * @addtogroup Actionslider Actionslider
16323 * @image html img/widget/actionslider/preview-00.png
16324 * @image latex img/widget/actionslider/preview-00.eps
16326 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16327 * properties. The indicator is the element the user drags to choose a label.
16328 * When the position is set with magnet, when released the indicator will be
16329 * moved to it if it's nearest the magnetized position.
16331 * @note By default all positions are set as enabled.
16333 * Signals that you can add callbacks for are:
16335 * "selected" - when user selects an enabled position (the label is passed
16338 * "pos_changed" - when the indicator reaches any of the positions("left",
16339 * "right" or "center").
16341 * See an example of actionslider usage @ref actionslider_example_page "here"
16344 typedef enum _Elm_Actionslider_Pos
16346 ELM_ACTIONSLIDER_NONE = 0,
16347 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16348 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16349 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16350 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16351 } Elm_Actionslider_Pos;
16354 * Add a new actionslider to the parent.
16356 * @param parent The parent object
16357 * @return The new actionslider object or NULL if it cannot be created
16359 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16361 * Set actionslider labels.
16363 * @param obj The actionslider object
16364 * @param left_label The label to be set on the left.
16365 * @param center_label The label to be set on the center.
16366 * @param right_label The label to be set on the right.
16367 * @deprecated use elm_object_text_set() instead.
16369 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);
16371 * Get actionslider labels.
16373 * @param obj The actionslider object
16374 * @param left_label A char** to place the left_label of @p obj into.
16375 * @param center_label A char** to place the center_label of @p obj into.
16376 * @param right_label A char** to place the right_label of @p obj into.
16377 * @deprecated use elm_object_text_set() instead.
16379 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);
16381 * Get actionslider selected label.
16383 * @param obj The actionslider object
16384 * @return The selected label
16386 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16388 * Set actionslider indicator position.
16390 * @param obj The actionslider object.
16391 * @param pos The position of the indicator.
16393 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16395 * Get actionslider indicator position.
16397 * @param obj The actionslider object.
16398 * @return The position of the indicator.
16400 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16402 * Set actionslider magnet position. To make multiple positions magnets @c or
16403 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16405 * @param obj The actionslider object.
16406 * @param pos Bit mask indicating the magnet positions.
16408 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16410 * Get actionslider magnet position.
16412 * @param obj The actionslider object.
16413 * @return The positions with magnet property.
16415 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16417 * Set actionslider enabled position. To set multiple positions as enabled @c or
16418 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16420 * @note All the positions are enabled by default.
16422 * @param obj The actionslider object.
16423 * @param pos Bit mask indicating the enabled positions.
16425 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16427 * Get actionslider enabled position.
16429 * @param obj The actionslider object.
16430 * @return The enabled positions.
16432 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16434 * Set the label used on the indicator.
16436 * @param obj The actionslider object
16437 * @param label The label to be set on the indicator.
16438 * @deprecated use elm_object_text_set() instead.
16440 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16442 * Get the label used on the indicator object.
16444 * @param obj The actionslider object
16445 * @return The indicator label
16446 * @deprecated use elm_object_text_get() instead.
16448 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16454 * @defgroup Genlist Genlist
16456 * @image html img/widget/genlist/preview-00.png
16457 * @image latex img/widget/genlist/preview-00.eps
16458 * @image html img/genlist.png
16459 * @image latex img/genlist.eps
16461 * This widget aims to have more expansive list than the simple list in
16462 * Elementary that could have more flexible items and allow many more entries
16463 * while still being fast and low on memory usage. At the same time it was
16464 * also made to be able to do tree structures. But the price to pay is more
16465 * complexity when it comes to usage. If all you want is a simple list with
16466 * icons and a single label, use the normal @ref List object.
16468 * Genlist has a fairly large API, mostly because it's relatively complex,
16469 * trying to be both expansive, powerful and efficient. First we will begin
16470 * an overview on the theory behind genlist.
16472 * @section Genlist_Item_Class Genlist item classes - creating items
16474 * In order to have the ability to add and delete items on the fly, genlist
16475 * implements a class (callback) system where the application provides a
16476 * structure with information about that type of item (genlist may contain
16477 * multiple different items with different classes, states and styles).
16478 * Genlist will call the functions in this struct (methods) when an item is
16479 * "realized" (i.e., created dynamically, while the user is scrolling the
16480 * grid). All objects will simply be deleted when no longer needed with
16481 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16482 * following members:
16483 * - @c item_style - This is a constant string and simply defines the name
16484 * of the item style. It @b must be specified and the default should be @c
16486 * - @c mode_item_style - This is a constant string and simply defines the
16487 * name of the style that will be used for mode animations. It can be left
16488 * as @c NULL if you don't plan to use Genlist mode. See
16489 * elm_genlist_item_mode_set() for more info.
16491 * - @c func - A struct with pointers to functions that will be called when
16492 * an item is going to be actually created. All of them receive a @c data
16493 * parameter that will point to the same data passed to
16494 * elm_genlist_item_append() and related item creation functions, and a @c
16495 * obj parameter that points to the genlist object itself.
16497 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16498 * state_get and @c del. The 3 first functions also receive a @c part
16499 * parameter described below. A brief description of these functions follows:
16501 * - @c label_get - The @c part parameter is the name string of one of the
16502 * existing text parts in the Edje group implementing the item's theme.
16503 * This function @b must return a strdup'()ed string, as the caller will
16504 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16505 * - @c icon_get - The @c part parameter is the name string of one of the
16506 * existing (icon) swallow parts in the Edje group implementing the item's
16507 * theme. It must return @c NULL, when no icon is desired, or a valid
16508 * object handle, otherwise. The object will be deleted by the genlist on
16509 * its deletion or when the item is "unrealized". See
16510 * #Elm_Genlist_Item_Icon_Get_Cb.
16511 * - @c func.state_get - The @c part parameter is the name string of one of
16512 * the state parts in the Edje group implementing the item's theme. Return
16513 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16514 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16515 * and @c "elm" as "emission" and "source" arguments, respectively, when
16516 * the state is true (the default is false), where @c XXX is the name of
16517 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16518 * - @c func.del - This is intended for use when genlist items are deleted,
16519 * so any data attached to the item (e.g. its data parameter on creation)
16520 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16522 * available item styles:
16524 * - default_style - The text part is a textblock
16526 * @image html img/widget/genlist/preview-04.png
16527 * @image latex img/widget/genlist/preview-04.eps
16531 * @image html img/widget/genlist/preview-01.png
16532 * @image latex img/widget/genlist/preview-01.eps
16534 * - icon_top_text_bottom
16536 * @image html img/widget/genlist/preview-02.png
16537 * @image latex img/widget/genlist/preview-02.eps
16541 * @image html img/widget/genlist/preview-03.png
16542 * @image latex img/widget/genlist/preview-03.eps
16544 * @section Genlist_Items Structure of items
16546 * An item in a genlist can have 0 or more text labels (they can be regular
16547 * text or textblock Evas objects - that's up to the style to determine), 0
16548 * or more icons (which are simply objects swallowed into the genlist item's
16549 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16550 * behavior left to the user to define. The Edje part names for each of
16551 * these properties will be looked up, in the theme file for the genlist,
16552 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16553 * "states", respectively. For each of those properties, if more than one
16554 * part is provided, they must have names listed separated by spaces in the
16555 * data fields. For the default genlist item theme, we have @b one label
16556 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16557 * "elm.swallow.end") and @b no state parts.
16559 * A genlist item may be at one of several styles. Elementary provides one
16560 * by default - "default", but this can be extended by system or application
16561 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16564 * @section Genlist_Manipulation Editing and Navigating
16566 * Items can be added by several calls. All of them return a @ref
16567 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16568 * They all take a data parameter that is meant to be used for a handle to
16569 * the applications internal data (eg the struct with the original item
16570 * data). The parent parameter is the parent genlist item this belongs to if
16571 * it is a tree or an indexed group, and NULL if there is no parent. The
16572 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16573 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16574 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16575 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16576 * is set then this item is group index item that is displayed at the top
16577 * until the next group comes. The func parameter is a convenience callback
16578 * that is called when the item is selected and the data parameter will be
16579 * the func_data parameter, obj be the genlist object and event_info will be
16580 * the genlist item.
16582 * elm_genlist_item_append() adds an item to the end of the list, or if
16583 * there is a parent, to the end of all the child items of the parent.
16584 * elm_genlist_item_prepend() is the same but adds to the beginning of
16585 * the list or children list. elm_genlist_item_insert_before() inserts at
16586 * item before another item and elm_genlist_item_insert_after() inserts after
16587 * the indicated item.
16589 * The application can clear the list with elm_genlist_clear() which deletes
16590 * all the items in the list and elm_genlist_item_del() will delete a specific
16591 * item. elm_genlist_item_subitems_clear() will clear all items that are
16592 * children of the indicated parent item.
16594 * To help inspect list items you can jump to the item at the top of the list
16595 * with elm_genlist_first_item_get() which will return the item pointer, and
16596 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16597 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16598 * and previous items respectively relative to the indicated item. Using
16599 * these calls you can walk the entire item list/tree. Note that as a tree
16600 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16601 * let you know which item is the parent (and thus know how to skip them if
16604 * @section Genlist_Muti_Selection Multi-selection
16606 * If the application wants multiple items to be able to be selected,
16607 * elm_genlist_multi_select_set() can enable this. If the list is
16608 * single-selection only (the default), then elm_genlist_selected_item_get()
16609 * will return the selected item, if any, or NULL I none is selected. If the
16610 * list is multi-select then elm_genlist_selected_items_get() will return a
16611 * list (that is only valid as long as no items are modified (added, deleted,
16612 * selected or unselected)).
16614 * @section Genlist_Usage_Hints Usage hints
16616 * There are also convenience functions. elm_genlist_item_genlist_get() will
16617 * return the genlist object the item belongs to. elm_genlist_item_show()
16618 * will make the scroller scroll to show that specific item so its visible.
16619 * elm_genlist_item_data_get() returns the data pointer set by the item
16620 * creation functions.
16622 * If an item changes (state of boolean changes, label or icons change),
16623 * then use elm_genlist_item_update() to have genlist update the item with
16624 * the new state. Genlist will re-realize the item thus call the functions
16625 * in the _Elm_Genlist_Item_Class for that item.
16627 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16628 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16629 * to expand/contract an item and get its expanded state, use
16630 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16631 * again to make an item disabled (unable to be selected and appear
16632 * differently) use elm_genlist_item_disabled_set() to set this and
16633 * elm_genlist_item_disabled_get() to get the disabled state.
16635 * In general to indicate how the genlist should expand items horizontally to
16636 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16637 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16638 * mode means that if items are too wide to fit, the scroller will scroll
16639 * horizontally. Otherwise items are expanded to fill the width of the
16640 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16641 * to the viewport width and limited to that size. This can be combined with
16642 * a different style that uses edjes' ellipsis feature (cutting text off like
16645 * Items will only call their selection func and callback when first becoming
16646 * selected. Any further clicks will do nothing, unless you enable always
16647 * select with elm_genlist_always_select_mode_set(). This means even if
16648 * selected, every click will make the selected callbacks be called.
16649 * elm_genlist_no_select_mode_set() will turn off the ability to select
16650 * items entirely and they will neither appear selected nor call selected
16651 * callback functions.
16653 * Remember that you can create new styles and add your own theme augmentation
16654 * per application with elm_theme_extension_add(). If you absolutely must
16655 * have a specific style that overrides any theme the user or system sets up
16656 * you can use elm_theme_overlay_add() to add such a file.
16658 * @section Genlist_Implementation Implementation
16660 * Evas tracks every object you create. Every time it processes an event
16661 * (mouse move, down, up etc.) it needs to walk through objects and find out
16662 * what event that affects. Even worse every time it renders display updates,
16663 * in order to just calculate what to re-draw, it needs to walk through many
16664 * many many objects. Thus, the more objects you keep active, the more
16665 * overhead Evas has in just doing its work. It is advisable to keep your
16666 * active objects to the minimum working set you need. Also remember that
16667 * object creation and deletion carries an overhead, so there is a
16668 * middle-ground, which is not easily determined. But don't keep massive lists
16669 * of objects you can't see or use. Genlist does this with list objects. It
16670 * creates and destroys them dynamically as you scroll around. It groups them
16671 * into blocks so it can determine the visibility etc. of a whole block at
16672 * once as opposed to having to walk the whole list. This 2-level list allows
16673 * for very large numbers of items to be in the list (tests have used up to
16674 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16675 * may be different sizes, every item added needs to be calculated as to its
16676 * size and thus this presents a lot of overhead on populating the list, this
16677 * genlist employs a queue. Any item added is queued and spooled off over
16678 * time, actually appearing some time later, so if your list has many members
16679 * you may find it takes a while for them to all appear, with your process
16680 * consuming a lot of CPU while it is busy spooling.
16682 * Genlist also implements a tree structure, but it does so with callbacks to
16683 * the application, with the application filling in tree structures when
16684 * requested (allowing for efficient building of a very deep tree that could
16685 * even be used for file-management). See the above smart signal callbacks for
16688 * @section Genlist_Smart_Events Genlist smart events
16690 * Signals that you can add callbacks for are:
16691 * - @c "activated" - The user has double-clicked or pressed
16692 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16693 * item that was activated.
16694 * - @c "clicked,double" - The user has double-clicked an item. The @c
16695 * event_info parameter is the item that was double-clicked.
16696 * - @c "selected" - This is called when a user has made an item selected.
16697 * The event_info parameter is the genlist item that was selected.
16698 * - @c "unselected" - This is called when a user has made an item
16699 * unselected. The event_info parameter is the genlist item that was
16701 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16702 * called and the item is now meant to be expanded. The event_info
16703 * parameter is the genlist item that was indicated to expand. It is the
16704 * job of this callback to then fill in the child items.
16705 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16706 * called and the item is now meant to be contracted. The event_info
16707 * parameter is the genlist item that was indicated to contract. It is the
16708 * job of this callback to then delete the child items.
16709 * - @c "expand,request" - This is called when a user has indicated they want
16710 * to expand a tree branch item. The callback should decide if the item can
16711 * expand (has any children) and then call elm_genlist_item_expanded_set()
16712 * appropriately to set the state. The event_info parameter is the genlist
16713 * item that was indicated to expand.
16714 * - @c "contract,request" - This is called when a user has indicated they
16715 * want to contract a tree branch item. The callback should decide if the
16716 * item can contract (has any children) and then call
16717 * elm_genlist_item_expanded_set() appropriately to set the state. The
16718 * event_info parameter is the genlist item that was indicated to contract.
16719 * - @c "realized" - This is called when the item in the list is created as a
16720 * real evas object. event_info parameter is the genlist item that was
16721 * created. The object may be deleted at any time, so it is up to the
16722 * caller to not use the object pointer from elm_genlist_item_object_get()
16723 * in a way where it may point to freed objects.
16724 * - @c "unrealized" - This is called just before an item is unrealized.
16725 * After this call icon objects provided will be deleted and the item
16726 * object itself delete or be put into a floating cache.
16727 * - @c "drag,start,up" - This is called when the item in the list has been
16728 * dragged (not scrolled) up.
16729 * - @c "drag,start,down" - This is called when the item in the list has been
16730 * dragged (not scrolled) down.
16731 * - @c "drag,start,left" - This is called when the item in the list has been
16732 * dragged (not scrolled) left.
16733 * - @c "drag,start,right" - This is called when the item in the list has
16734 * been dragged (not scrolled) right.
16735 * - @c "drag,stop" - This is called when the item in the list has stopped
16737 * - @c "drag" - This is called when the item in the list is being dragged.
16738 * - @c "longpressed" - This is called when the item is pressed for a certain
16739 * amount of time. By default it's 1 second.
16740 * - @c "scroll,anim,start" - This is called when scrolling animation has
16742 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16744 * - @c "scroll,drag,start" - This is called when dragging the content has
16746 * - @c "scroll,drag,stop" - This is called when dragging the content has
16748 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16750 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16751 * until the bottom edge.
16752 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16753 * until the left edge.
16754 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16755 * until the right edge.
16756 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16758 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16760 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16762 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16764 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16765 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16766 * multi-touch pinched in.
16767 * - @c "swipe" - This is called when the genlist is swiped.
16769 * @section Genlist_Examples Examples
16771 * Here is a list of examples that use the genlist, trying to show some of
16772 * its capabilities:
16773 * - @ref genlist_example_01
16774 * - @ref genlist_example_02
16775 * - @ref genlist_example_03
16776 * - @ref genlist_example_04
16777 * - @ref genlist_example_05
16781 * @addtogroup Genlist
16786 * @enum _Elm_Genlist_Item_Flags
16787 * @typedef Elm_Genlist_Item_Flags
16789 * Defines if the item is of any special type (has subitems or it's the
16790 * index of a group), or is just a simple item.
16794 typedef enum _Elm_Genlist_Item_Flags
16796 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16797 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16798 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16799 } Elm_Genlist_Item_Flags;
16800 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16801 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16802 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16803 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16804 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. */
16805 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. */
16806 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16807 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16809 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16810 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16811 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16812 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16815 * @struct _Elm_Genlist_Item_Class
16817 * Genlist item class definition structs.
16819 * This struct contains the style and fetching functions that will define the
16820 * contents of each item.
16822 * @see @ref Genlist_Item_Class
16824 struct _Elm_Genlist_Item_Class
16826 const char *item_style; /**< style of this class. */
16829 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16830 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16831 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16832 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16833 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16835 const char *mode_item_style;
16839 * Add a new genlist widget to the given parent Elementary
16840 * (container) object
16842 * @param parent The parent object
16843 * @return a new genlist widget handle or @c NULL, on errors
16845 * This function inserts a new genlist widget on the canvas.
16847 * @see elm_genlist_item_append()
16848 * @see elm_genlist_item_del()
16849 * @see elm_genlist_clear()
16853 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16855 * Remove all items from a given genlist widget.
16857 * @param obj The genlist object
16859 * This removes (and deletes) all items in @p obj, leaving it empty.
16861 * @see elm_genlist_item_del(), to remove just one item.
16865 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16867 * Enable or disable multi-selection in the genlist
16869 * @param obj The genlist object
16870 * @param multi Multi-select enable/disable. Default is disabled.
16872 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16873 * the list. This allows more than 1 item to be selected. To retrieve the list
16874 * of selected items, use elm_genlist_selected_items_get().
16876 * @see elm_genlist_selected_items_get()
16877 * @see elm_genlist_multi_select_get()
16881 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16883 * Gets if multi-selection in genlist is enabled or disabled.
16885 * @param obj The genlist object
16886 * @return Multi-select enabled/disabled
16887 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16889 * @see elm_genlist_multi_select_set()
16893 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16895 * This sets the horizontal stretching mode.
16897 * @param obj The genlist object
16898 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16900 * This sets the mode used for sizing items horizontally. Valid modes
16901 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16902 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16903 * the scroller will scroll horizontally. Otherwise items are expanded
16904 * to fill the width of the viewport of the scroller. If it is
16905 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16906 * limited to that size.
16908 * @see elm_genlist_horizontal_get()
16912 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16913 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16915 * Gets the horizontal stretching mode.
16917 * @param obj The genlist object
16918 * @return The mode to use
16919 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16921 * @see elm_genlist_horizontal_set()
16925 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16926 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16928 * Set the always select mode.
16930 * @param obj The genlist object
16931 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16932 * EINA_FALSE = off). Default is @c EINA_FALSE.
16934 * Items will only call their selection func and callback when first
16935 * becoming selected. Any further clicks will do nothing, unless you
16936 * enable always select with elm_genlist_always_select_mode_set().
16937 * This means that, even if selected, every click will make the selected
16938 * callbacks be called.
16940 * @see elm_genlist_always_select_mode_get()
16944 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16946 * Get the always select mode.
16948 * @param obj The genlist object
16949 * @return The always select mode
16950 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16952 * @see elm_genlist_always_select_mode_set()
16956 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16958 * Enable/disable the no select mode.
16960 * @param obj The genlist object
16961 * @param no_select The no select mode
16962 * (EINA_TRUE = on, EINA_FALSE = off)
16964 * This will turn off the ability to select items entirely and they
16965 * will neither appear selected nor call selected callback functions.
16967 * @see elm_genlist_no_select_mode_get()
16971 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16973 * Gets whether the no select mode is enabled.
16975 * @param obj The genlist object
16976 * @return The no select mode
16977 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16979 * @see elm_genlist_no_select_mode_set()
16983 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16985 * Enable/disable compress mode.
16987 * @param obj The genlist object
16988 * @param compress The compress mode
16989 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16991 * This will enable the compress mode where items are "compressed"
16992 * horizontally to fit the genlist scrollable viewport width. This is
16993 * special for genlist. Do not rely on
16994 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16995 * work as genlist needs to handle it specially.
16997 * @see elm_genlist_compress_mode_get()
17001 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17003 * Get whether the compress mode is enabled.
17005 * @param obj The genlist object
17006 * @return The compress mode
17007 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17009 * @see elm_genlist_compress_mode_set()
17013 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17015 * Enable/disable height-for-width mode.
17017 * @param obj The genlist object
17018 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17019 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17021 * With height-for-width mode the item width will be fixed (restricted
17022 * to a minimum of) to the list width when calculating its size in
17023 * order to allow the height to be calculated based on it. This allows,
17024 * for instance, text block to wrap lines if the Edje part is
17025 * configured with "text.min: 0 1".
17027 * @note This mode will make list resize slower as it will have to
17028 * recalculate every item height again whenever the list width
17031 * @note When height-for-width mode is enabled, it also enables
17032 * compress mode (see elm_genlist_compress_mode_set()) and
17033 * disables homogeneous (see elm_genlist_homogeneous_set()).
17037 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17039 * Get whether the height-for-width mode is enabled.
17041 * @param obj The genlist object
17042 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17047 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17049 * Enable/disable horizontal and vertical bouncing effect.
17051 * @param obj The genlist object
17052 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17053 * EINA_FALSE = off). Default is @c EINA_FALSE.
17054 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17055 * EINA_FALSE = off). Default is @c EINA_TRUE.
17057 * This will enable or disable the scroller bouncing effect for the
17058 * genlist. See elm_scroller_bounce_set() for details.
17060 * @see elm_scroller_bounce_set()
17061 * @see elm_genlist_bounce_get()
17065 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17067 * Get whether the horizontal and vertical bouncing effect is enabled.
17069 * @param obj The genlist object
17070 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17072 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17075 * @see elm_genlist_bounce_set()
17079 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17081 * Enable/disable homogenous mode.
17083 * @param obj The genlist object
17084 * @param homogeneous Assume the items within the genlist are of the
17085 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17088 * This will enable the homogeneous mode where items are of the same
17089 * height and width so that genlist may do the lazy-loading at its
17090 * maximum (which increases the performance for scrolling the list). This
17091 * implies 'compressed' mode.
17093 * @see elm_genlist_compress_mode_set()
17094 * @see elm_genlist_homogeneous_get()
17098 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17100 * Get whether the homogenous mode is enabled.
17102 * @param obj The genlist object
17103 * @return Assume the items within the genlist are of the same height
17104 * and width (EINA_TRUE = on, EINA_FALSE = off)
17106 * @see elm_genlist_homogeneous_set()
17110 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17112 * Set the maximum number of items within an item block
17114 * @param obj The genlist object
17115 * @param n Maximum number of items within an item block. Default is 32.
17117 * This will configure the block count to tune to the target with
17118 * particular performance matrix.
17120 * A block of objects will be used to reduce the number of operations due to
17121 * many objects in the screen. It can determine the visibility, or if the
17122 * object has changed, it theme needs to be updated, etc. doing this kind of
17123 * calculation to the entire block, instead of per object.
17125 * The default value for the block count is enough for most lists, so unless
17126 * you know you will have a lot of objects visible in the screen at the same
17127 * time, don't try to change this.
17129 * @see elm_genlist_block_count_get()
17130 * @see @ref Genlist_Implementation
17134 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17136 * Get the maximum number of items within an item block
17138 * @param obj The genlist object
17139 * @return Maximum number of items within an item block
17141 * @see elm_genlist_block_count_set()
17145 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17147 * Set the timeout in seconds for the longpress event.
17149 * @param obj The genlist object
17150 * @param timeout timeout in seconds. Default is 1.
17152 * This option will change how long it takes to send an event "longpressed"
17153 * after the mouse down signal is sent to the list. If this event occurs, no
17154 * "clicked" event will be sent.
17156 * @see elm_genlist_longpress_timeout_set()
17160 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17162 * Get the timeout in seconds for the longpress event.
17164 * @param obj The genlist object
17165 * @return timeout in seconds
17167 * @see elm_genlist_longpress_timeout_get()
17171 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17173 * Append a new item in a given genlist widget.
17175 * @param obj The genlist object
17176 * @param itc The item class for the item
17177 * @param data The item data
17178 * @param parent The parent item, or NULL if none
17179 * @param flags Item flags
17180 * @param func Convenience function called when the item is selected
17181 * @param func_data Data passed to @p func above.
17182 * @return A handle to the item added or @c NULL if not possible
17184 * This adds the given item to the end of the list or the end of
17185 * the children list if the @p parent is given.
17187 * @see elm_genlist_item_prepend()
17188 * @see elm_genlist_item_insert_before()
17189 * @see elm_genlist_item_insert_after()
17190 * @see elm_genlist_item_del()
17194 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);
17196 * Prepend a new item in a given genlist widget.
17198 * @param obj The genlist object
17199 * @param itc The item class for the item
17200 * @param data The item data
17201 * @param parent The parent item, or NULL if none
17202 * @param flags Item flags
17203 * @param func Convenience function called when the item is selected
17204 * @param func_data Data passed to @p func above.
17205 * @return A handle to the item added or NULL if not possible
17207 * This adds an item to the beginning of the list or beginning of the
17208 * children of the parent if given.
17210 * @see elm_genlist_item_append()
17211 * @see elm_genlist_item_insert_before()
17212 * @see elm_genlist_item_insert_after()
17213 * @see elm_genlist_item_del()
17217 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);
17219 * Insert an item before another in a genlist widget
17221 * @param obj The genlist object
17222 * @param itc The item class for the item
17223 * @param data The item data
17224 * @param before The item to place this new one before.
17225 * @param flags Item flags
17226 * @param func Convenience function called when the item is selected
17227 * @param func_data Data passed to @p func above.
17228 * @return A handle to the item added or @c NULL if not possible
17230 * This inserts an item before another in the list. It will be in the
17231 * same tree level or group as the item it is inserted before.
17233 * @see elm_genlist_item_append()
17234 * @see elm_genlist_item_prepend()
17235 * @see elm_genlist_item_insert_after()
17236 * @see elm_genlist_item_del()
17240 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);
17242 * Insert an item after another in a genlist widget
17244 * @param obj The genlist object
17245 * @param itc The item class for the item
17246 * @param data The item data
17247 * @param after The item to place this new one after.
17248 * @param flags Item flags
17249 * @param func Convenience function called when the item is selected
17250 * @param func_data Data passed to @p func above.
17251 * @return A handle to the item added or @c NULL if not possible
17253 * This inserts an item after another in the list. It will be in the
17254 * same tree level or group as the item it is inserted after.
17256 * @see elm_genlist_item_append()
17257 * @see elm_genlist_item_prepend()
17258 * @see elm_genlist_item_insert_before()
17259 * @see elm_genlist_item_del()
17263 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);
17265 * Insert a new item into the sorted genlist object
17267 * @param obj The genlist object
17268 * @param itc The item class for the item
17269 * @param data The item data
17270 * @param parent The parent item, or NULL if none
17271 * @param flags Item flags
17272 * @param comp The function called for the sort
17273 * @param func Convenience function called when item selected
17274 * @param func_data Data passed to @p func above.
17275 * @return A handle to the item added or NULL if not possible
17279 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);
17280 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);
17281 /* operations to retrieve existing items */
17283 * Get the selectd item in the genlist.
17285 * @param obj The genlist object
17286 * @return The selected item, or NULL if none is selected.
17288 * This gets the selected item in the list (if multi-selection is enabled, only
17289 * the item that was first selected in the list is returned - which is not very
17290 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17293 * If no item is selected, NULL is returned.
17295 * @see elm_genlist_selected_items_get()
17299 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17301 * Get a list of selected items in the genlist.
17303 * @param obj The genlist object
17304 * @return The list of selected items, or NULL if none are selected.
17306 * It returns a list of the selected items. This list pointer is only valid so
17307 * long as the selection doesn't change (no items are selected or unselected, or
17308 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17309 * pointers. The order of the items in this list is the order which they were
17310 * selected, i.e. the first item in this list is the first item that was
17311 * selected, and so on.
17313 * @note If not in multi-select mode, consider using function
17314 * elm_genlist_selected_item_get() instead.
17316 * @see elm_genlist_multi_select_set()
17317 * @see elm_genlist_selected_item_get()
17321 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17323 * Get a list of realized items in genlist
17325 * @param obj The genlist object
17326 * @return The list of realized items, nor NULL if none are realized.
17328 * This returns a list of the realized items in the genlist. The list
17329 * contains Elm_Genlist_Item pointers. The list must be freed by the
17330 * caller when done with eina_list_free(). The item pointers in the
17331 * list are only valid so long as those items are not deleted or the
17332 * genlist is not deleted.
17334 * @see elm_genlist_realized_items_update()
17338 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17340 * Get the item that is at the x, y canvas coords.
17342 * @param obj The gelinst object.
17343 * @param x The input x coordinate
17344 * @param y The input y coordinate
17345 * @param posret The position relative to the item returned here
17346 * @return The item at the coordinates or NULL if none
17348 * This returns the item at the given coordinates (which are canvas
17349 * relative, not object-relative). If an item is at that coordinate,
17350 * that item handle is returned, and if @p posret is not NULL, the
17351 * integer pointed to is set to a value of -1, 0 or 1, depending if
17352 * the coordinate is on the upper portion of that item (-1), on the
17353 * middle section (0) or on the lower part (1). If NULL is returned as
17354 * an item (no item found there), then posret may indicate -1 or 1
17355 * based if the coordinate is above or below all items respectively in
17360 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);
17362 * Get the first item in the genlist
17364 * This returns the first item in the list.
17366 * @param obj The genlist object
17367 * @return The first item, or NULL if none
17371 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17373 * Get the last item in the genlist
17375 * This returns the last item in the list.
17377 * @return The last item, or NULL if none
17381 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17383 * Set the scrollbar policy
17385 * @param obj The genlist object
17386 * @param policy_h Horizontal scrollbar policy.
17387 * @param policy_v Vertical scrollbar policy.
17389 * This sets the scrollbar visibility policy for the given genlist
17390 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17391 * made visible if it is needed, and otherwise kept hidden.
17392 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17393 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17394 * respectively for the horizontal and vertical scrollbars. Default is
17395 * #ELM_SMART_SCROLLER_POLICY_AUTO
17397 * @see elm_genlist_scroller_policy_get()
17401 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17403 * Get the scrollbar policy
17405 * @param obj The genlist object
17406 * @param policy_h Pointer to store the horizontal scrollbar policy.
17407 * @param policy_v Pointer to store the vertical scrollbar policy.
17409 * @see elm_genlist_scroller_policy_set()
17413 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);
17415 * Get the @b next item in a genlist widget's internal list of items,
17416 * given a handle to one of those items.
17418 * @param item The genlist item to fetch next from
17419 * @return The item after @p item, or @c NULL if there's none (and
17422 * This returns the item placed after the @p item, on the container
17425 * @see elm_genlist_item_prev_get()
17429 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17431 * Get the @b previous item in a genlist widget's internal list of items,
17432 * given a handle to one of those items.
17434 * @param item The genlist item to fetch previous from
17435 * @return The item before @p item, or @c NULL if there's none (and
17438 * This returns the item placed before the @p item, on the container
17441 * @see elm_genlist_item_next_get()
17445 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17447 * Get the genlist object's handle which contains a given genlist
17450 * @param item The item to fetch the container from
17451 * @return The genlist (parent) object
17453 * This returns the genlist object itself that an item belongs to.
17457 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17459 * Get the parent item of the given item
17461 * @param it The item
17462 * @return The parent of the item or @c NULL if it has no parent.
17464 * This returns the item that was specified as parent of the item @p it on
17465 * elm_genlist_item_append() and insertion related functions.
17469 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17471 * Remove all sub-items (children) of the given item
17473 * @param it The item
17475 * This removes all items that are children (and their descendants) of the
17476 * given item @p it.
17478 * @see elm_genlist_clear()
17479 * @see elm_genlist_item_del()
17483 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17485 * Set whether a given genlist item is selected or not
17487 * @param it The item
17488 * @param selected Use @c EINA_TRUE, to make it selected, @c
17489 * EINA_FALSE to make it unselected
17491 * This sets the selected state of an item. If multi selection is
17492 * not enabled on the containing genlist and @p selected is @c
17493 * EINA_TRUE, any other previously selected items will get
17494 * unselected in favor of this new one.
17496 * @see elm_genlist_item_selected_get()
17500 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17502 * Get whether a given genlist item is selected or not
17504 * @param it The item
17505 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17507 * @see elm_genlist_item_selected_set() for more details
17511 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17513 * Sets the expanded state of an item.
17515 * @param it The item
17516 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17518 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17521 * The theme will respond to this change visually, and a signal "expanded" or
17522 * "contracted" will be sent from the genlist with a pointer to the item that
17523 * has been expanded/contracted.
17525 * Calling this function won't show or hide any child of this item (if it is
17526 * a parent). You must manually delete and create them on the callbacks fo
17527 * the "expanded" or "contracted" signals.
17529 * @see elm_genlist_item_expanded_get()
17533 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17535 * Get the expanded state of an item
17537 * @param it The item
17538 * @return The expanded state
17540 * This gets the expanded state of an item.
17542 * @see elm_genlist_item_expanded_set()
17546 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17548 * Get the depth of expanded item
17550 * @param it The genlist item object
17551 * @return The depth of expanded item
17555 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17557 * Set whether a given genlist item is disabled or not.
17559 * @param it The item
17560 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17561 * to enable it back.
17563 * A disabled item cannot be selected or unselected. It will also
17564 * change its appearance, to signal the user it's disabled.
17566 * @see elm_genlist_item_disabled_get()
17570 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17572 * Get whether a given genlist item is disabled or not.
17574 * @param it The item
17575 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17578 * @see elm_genlist_item_disabled_set() for more details
17582 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17584 * Sets the display only state of an item.
17586 * @param it The item
17587 * @param display_only @c EINA_TRUE if the item is display only, @c
17588 * EINA_FALSE otherwise.
17590 * A display only item cannot be selected or unselected. It is for
17591 * display only and not selecting or otherwise clicking, dragging
17592 * etc. by the user, thus finger size rules will not be applied to
17595 * It's good to set group index items to display only state.
17597 * @see elm_genlist_item_display_only_get()
17601 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17603 * Get the display only state of an item
17605 * @param it The item
17606 * @return @c EINA_TRUE if the item is display only, @c
17607 * EINA_FALSE otherwise.
17609 * @see elm_genlist_item_display_only_set()
17613 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17615 * Show the portion of a genlist's internal list containing a given
17616 * item, immediately.
17618 * @param it The item to display
17620 * This causes genlist to jump to the given item @p it and show it (by
17621 * immediately scrolling to that position), if it is not fully visible.
17623 * @see elm_genlist_item_bring_in()
17624 * @see elm_genlist_item_top_show()
17625 * @see elm_genlist_item_middle_show()
17629 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17631 * Animatedly bring in, to the visible are of a genlist, a given
17634 * @param it The item to display
17636 * This causes genlist to jump to the given item @p it and show it (by
17637 * animatedly scrolling), if it is not fully visible. This may use animation
17638 * to do so and take a period of time
17640 * @see elm_genlist_item_show()
17641 * @see elm_genlist_item_top_bring_in()
17642 * @see elm_genlist_item_middle_bring_in()
17646 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17648 * Show the portion of a genlist's internal list containing a given
17649 * item, immediately.
17651 * @param it The item to display
17653 * This causes genlist to jump to the given item @p it and show it (by
17654 * immediately scrolling to that position), if it is not fully visible.
17656 * The item will be positioned at the top of the genlist viewport.
17658 * @see elm_genlist_item_show()
17659 * @see elm_genlist_item_top_bring_in()
17663 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17665 * Animatedly bring in, to the visible are of a genlist, a given
17668 * @param it The item
17670 * This causes genlist to jump to the given item @p it and show it (by
17671 * animatedly scrolling), if it is not fully visible. This may use animation
17672 * to do so and take a period of time
17674 * The item will be positioned at the top of the genlist viewport.
17676 * @see elm_genlist_item_bring_in()
17677 * @see elm_genlist_item_top_show()
17681 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17683 * Show the portion of a genlist's internal list containing a given
17684 * item, immediately.
17686 * @param it The item to display
17688 * This causes genlist to jump to the given item @p it and show it (by
17689 * immediately scrolling to that position), if it is not fully visible.
17691 * The item will be positioned at the middle of the genlist viewport.
17693 * @see elm_genlist_item_show()
17694 * @see elm_genlist_item_middle_bring_in()
17698 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17700 * Animatedly bring in, to the visible are of a genlist, a given
17703 * @param it The item
17705 * This causes genlist to jump to the given item @p it and show it (by
17706 * animatedly scrolling), if it is not fully visible. This may use animation
17707 * to do so and take a period of time
17709 * The item will be positioned at the middle of the genlist viewport.
17711 * @see elm_genlist_item_bring_in()
17712 * @see elm_genlist_item_middle_show()
17716 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17718 * Remove a genlist item from the its parent, deleting it.
17720 * @param item The item to be removed.
17721 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17723 * @see elm_genlist_clear(), to remove all items in a genlist at
17728 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17730 * Return the data associated to a given genlist item
17732 * @param item The genlist item.
17733 * @return the data associated to this item.
17735 * This returns the @c data value passed on the
17736 * elm_genlist_item_append() and related item addition calls.
17738 * @see elm_genlist_item_append()
17739 * @see elm_genlist_item_data_set()
17743 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17745 * Set the data associated to a given genlist item
17747 * @param item The genlist item
17748 * @param data The new data pointer to set on it
17750 * This @b overrides the @c data value passed on the
17751 * elm_genlist_item_append() and related item addition calls. This
17752 * function @b won't call elm_genlist_item_update() automatically,
17753 * so you'd issue it afterwards if you want to hove the item
17754 * updated to reflect the that new data.
17756 * @see elm_genlist_item_data_get()
17760 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17762 * Tells genlist to "orphan" icons fetchs by the item class
17764 * @param it The item
17766 * This instructs genlist to release references to icons in the item,
17767 * meaning that they will no longer be managed by genlist and are
17768 * floating "orphans" that can be re-used elsewhere if the user wants
17773 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17775 * Get the real Evas object created to implement the view of a
17776 * given genlist item
17778 * @param item The genlist item.
17779 * @return the Evas object implementing this item's view.
17781 * This returns the actual Evas object used to implement the
17782 * specified genlist item's view. This may be @c NULL, as it may
17783 * not have been created or may have been deleted, at any time, by
17784 * the genlist. <b>Do not modify this object</b> (move, resize,
17785 * show, hide, etc.), as the genlist is controlling it. This
17786 * function is for querying, emitting custom signals or hooking
17787 * lower level callbacks for events on that object. Do not delete
17788 * this object under any circumstances.
17790 * @see elm_genlist_item_data_get()
17794 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17796 * Update the contents of an item
17798 * @param it The item
17800 * This updates an item by calling all the item class functions again
17801 * to get the icons, labels and states. Use this when the original
17802 * item data has changed and the changes are desired to be reflected.
17804 * Use elm_genlist_realized_items_update() to update all already realized
17807 * @see elm_genlist_realized_items_update()
17811 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17813 * Update the item class of an item
17815 * @param it The item
17816 * @param itc The item class for the item
17818 * This sets another class fo the item, changing the way that it is
17819 * displayed. After changing the item class, elm_genlist_item_update() is
17820 * called on the item @p it.
17824 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17825 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17827 * Set the text to be shown in a given genlist item's tooltips.
17829 * @param item The genlist item
17830 * @param text The text to set in the content
17832 * This call will setup the text to be used as tooltip to that item
17833 * (analogous to elm_object_tooltip_text_set(), but being item
17834 * tooltips with higher precedence than object tooltips). It can
17835 * have only one tooltip at a time, so any previous tooltip data
17836 * will get removed.
17838 * In order to set an icon or something else as a tooltip, look at
17839 * elm_genlist_item_tooltip_content_cb_set().
17843 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17845 * Set the content to be shown in a given genlist item's tooltips
17847 * @param item The genlist item.
17848 * @param func The function returning the tooltip contents.
17849 * @param data What to provide to @a func as callback data/context.
17850 * @param del_cb Called when data is not needed anymore, either when
17851 * another callback replaces @p func, the tooltip is unset with
17852 * elm_genlist_item_tooltip_unset() or the owner @p item
17853 * dies. This callback receives as its first parameter the
17854 * given @p data, being @c event_info the item handle.
17856 * This call will setup the tooltip's contents to @p item
17857 * (analogous to elm_object_tooltip_content_cb_set(), but being
17858 * item tooltips with higher precedence than object tooltips). It
17859 * can have only one tooltip at a time, so any previous tooltip
17860 * content will get removed. @p func (with @p data) will be called
17861 * every time Elementary needs to show the tooltip and it should
17862 * return a valid Evas object, which will be fully managed by the
17863 * tooltip system, getting deleted when the tooltip is gone.
17865 * In order to set just a text as a tooltip, look at
17866 * elm_genlist_item_tooltip_text_set().
17870 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);
17872 * Unset a tooltip from a given genlist item
17874 * @param item genlist item to remove a previously set tooltip from.
17876 * This call removes any tooltip set on @p item. The callback
17877 * provided as @c del_cb to
17878 * elm_genlist_item_tooltip_content_cb_set() will be called to
17879 * notify it is not used anymore (and have resources cleaned, if
17882 * @see elm_genlist_item_tooltip_content_cb_set()
17886 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17888 * Set a different @b style for a given genlist item's tooltip.
17890 * @param item genlist item with tooltip set
17891 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17892 * "default", @c "transparent", etc)
17894 * Tooltips can have <b>alternate styles</b> to be displayed on,
17895 * which are defined by the theme set on Elementary. This function
17896 * works analogously as elm_object_tooltip_style_set(), but here
17897 * applied only to genlist item objects. The default style for
17898 * tooltips is @c "default".
17900 * @note before you set a style you should define a tooltip with
17901 * elm_genlist_item_tooltip_content_cb_set() or
17902 * elm_genlist_item_tooltip_text_set()
17904 * @see elm_genlist_item_tooltip_style_get()
17908 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17910 * Get the style set a given genlist item's tooltip.
17912 * @param item genlist item with tooltip already set on.
17913 * @return style the theme style in use, which defaults to
17914 * "default". If the object does not have a tooltip set,
17915 * then @c NULL is returned.
17917 * @see elm_genlist_item_tooltip_style_set() for more details
17921 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17923 * @brief Disable size restrictions on an object's tooltip
17924 * @param item The tooltip's anchor object
17925 * @param disable If EINA_TRUE, size restrictions are disabled
17926 * @return EINA_FALSE on failure, EINA_TRUE on success
17928 * This function allows a tooltip to expand beyond its parant window's canvas.
17929 * It will instead be limited only by the size of the display.
17931 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17933 * @brief Retrieve size restriction state of an object's tooltip
17934 * @param item The tooltip's anchor object
17935 * @return If EINA_TRUE, size restrictions are disabled
17937 * This function returns whether a tooltip is allowed to expand beyond
17938 * its parant window's canvas.
17939 * It will instead be limited only by the size of the display.
17941 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17943 * Set the type of mouse pointer/cursor decoration to be shown,
17944 * when the mouse pointer is over the given genlist widget item
17946 * @param item genlist item to customize cursor on
17947 * @param cursor the cursor type's name
17949 * This function works analogously as elm_object_cursor_set(), but
17950 * here the cursor's changing area is restricted to the item's
17951 * area, and not the whole widget's. Note that that item cursors
17952 * have precedence over widget cursors, so that a mouse over @p
17953 * item will always show cursor @p type.
17955 * If this function is called twice for an object, a previously set
17956 * cursor will be unset on the second call.
17958 * @see elm_object_cursor_set()
17959 * @see elm_genlist_item_cursor_get()
17960 * @see elm_genlist_item_cursor_unset()
17964 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17966 * Get the type of mouse pointer/cursor decoration set to be shown,
17967 * when the mouse pointer is over the given genlist widget item
17969 * @param item genlist item with custom cursor set
17970 * @return the cursor type's name or @c NULL, if no custom cursors
17971 * were set to @p item (and on errors)
17973 * @see elm_object_cursor_get()
17974 * @see elm_genlist_item_cursor_set() for more details
17975 * @see elm_genlist_item_cursor_unset()
17979 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17981 * Unset any custom mouse pointer/cursor decoration set to be
17982 * shown, when the mouse pointer is over the given genlist widget
17983 * item, thus making it show the @b default cursor again.
17985 * @param item a genlist item
17987 * Use this call to undo any custom settings on this item's cursor
17988 * decoration, bringing it back to defaults (no custom style set).
17990 * @see elm_object_cursor_unset()
17991 * @see elm_genlist_item_cursor_set() for more details
17995 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17997 * Set a different @b style for a given custom cursor set for a
18000 * @param item genlist item with custom cursor set
18001 * @param style the <b>theme style</b> to use (e.g. @c "default",
18002 * @c "transparent", etc)
18004 * This function only makes sense when one is using custom mouse
18005 * cursor decorations <b>defined in a theme file</b> , which can
18006 * have, given a cursor name/type, <b>alternate styles</b> on
18007 * it. It works analogously as elm_object_cursor_style_set(), but
18008 * here applied only to genlist item objects.
18010 * @warning Before you set a cursor style you should have defined a
18011 * custom cursor previously on the item, with
18012 * elm_genlist_item_cursor_set()
18014 * @see elm_genlist_item_cursor_engine_only_set()
18015 * @see elm_genlist_item_cursor_style_get()
18019 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18021 * Get the current @b style set for a given genlist item's custom
18024 * @param item genlist item with custom cursor set.
18025 * @return style the cursor style in use. If the object does not
18026 * have a cursor set, then @c NULL is returned.
18028 * @see elm_genlist_item_cursor_style_set() for more details
18032 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18034 * Set if the (custom) cursor for a given genlist item should be
18035 * searched in its theme, also, or should only rely on the
18036 * rendering engine.
18038 * @param item item with custom (custom) cursor already set on
18039 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18040 * only on those provided by the rendering engine, @c EINA_FALSE to
18041 * have them searched on the widget's theme, as well.
18043 * @note This call is of use only if you've set a custom cursor
18044 * for genlist items, with elm_genlist_item_cursor_set().
18046 * @note By default, cursors will only be looked for between those
18047 * provided by the rendering engine.
18051 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18053 * Get if the (custom) cursor for a given genlist item is being
18054 * searched in its theme, also, or is only relying on the rendering
18057 * @param item a genlist item
18058 * @return @c EINA_TRUE, if cursors are being looked for only on
18059 * those provided by the rendering engine, @c EINA_FALSE if they
18060 * are being searched on the widget's theme, as well.
18062 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18066 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18068 * Update the contents of all realized items.
18070 * @param obj The genlist object.
18072 * This updates all realized items by calling all the item class functions again
18073 * to get the icons, labels and states. Use this when the original
18074 * item data has changed and the changes are desired to be reflected.
18076 * To update just one item, use elm_genlist_item_update().
18078 * @see elm_genlist_realized_items_get()
18079 * @see elm_genlist_item_update()
18083 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18085 * Activate a genlist mode on an item
18087 * @param item The genlist item
18088 * @param mode Mode name
18089 * @param mode_set Boolean to define set or unset mode.
18091 * A genlist mode is a different way of selecting an item. Once a mode is
18092 * activated on an item, any other selected item is immediately unselected.
18093 * This feature provides an easy way of implementing a new kind of animation
18094 * for selecting an item, without having to entirely rewrite the item style
18095 * theme. However, the elm_genlist_selected_* API can't be used to get what
18096 * item is activate for a mode.
18098 * The current item style will still be used, but applying a genlist mode to
18099 * an item will select it using a different kind of animation.
18101 * The current active item for a mode can be found by
18102 * elm_genlist_mode_item_get().
18104 * The characteristics of genlist mode are:
18105 * - Only one mode can be active at any time, and for only one item.
18106 * - Genlist handles deactivating other items when one item is activated.
18107 * - A mode is defined in the genlist theme (edc), and more modes can easily
18109 * - A mode style and the genlist item style are different things. They
18110 * can be combined to provide a default style to the item, with some kind
18111 * of animation for that item when the mode is activated.
18113 * When a mode is activated on an item, a new view for that item is created.
18114 * The theme of this mode defines the animation that will be used to transit
18115 * the item from the old view to the new view. This second (new) view will be
18116 * active for that item while the mode is active on the item, and will be
18117 * destroyed after the mode is totally deactivated from that item.
18119 * @see elm_genlist_mode_get()
18120 * @see elm_genlist_mode_item_get()
18124 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18126 * Get the last (or current) genlist mode used.
18128 * @param obj The genlist object
18130 * This function just returns the name of the last used genlist mode. It will
18131 * be the current mode if it's still active.
18133 * @see elm_genlist_item_mode_set()
18134 * @see elm_genlist_mode_item_get()
18138 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18140 * Get active genlist mode item
18142 * @param obj The genlist object
18143 * @return The active item for that current mode. Or @c NULL if no item is
18144 * activated with any mode.
18146 * This function returns the item that was activated with a mode, by the
18147 * function elm_genlist_item_mode_set().
18149 * @see elm_genlist_item_mode_set()
18150 * @see elm_genlist_mode_get()
18154 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18159 * @param obj The genlist object
18160 * @param reorder_mode The reorder mode
18161 * (EINA_TRUE = on, EINA_FALSE = off)
18165 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18168 * Get the reorder mode
18170 * @param obj The genlist object
18171 * @return The reorder mode
18172 * (EINA_TRUE = on, EINA_FALSE = off)
18176 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18183 * @defgroup Check Check
18185 * @image html img/widget/check/preview-00.png
18186 * @image latex img/widget/check/preview-00.eps
18187 * @image html img/widget/check/preview-01.png
18188 * @image latex img/widget/check/preview-01.eps
18189 * @image html img/widget/check/preview-02.png
18190 * @image latex img/widget/check/preview-02.eps
18192 * @brief The check widget allows for toggling a value between true and
18195 * Check objects are a lot like radio objects in layout and functionality
18196 * except they do not work as a group, but independently and only toggle the
18197 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18198 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18199 * returns the current state. For convenience, like the radio objects, you
18200 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18201 * for it to modify.
18203 * Signals that you can add callbacks for are:
18204 * "changed" - This is called whenever the user changes the state of one of
18205 * the check object(event_info is NULL).
18207 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18211 * @brief Add a new Check object
18213 * @param parent The parent object
18214 * @return The new object or NULL if it cannot be created
18216 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18218 * @brief Set the text label of the check object
18220 * @param obj The check object
18221 * @param label The text label string in UTF-8
18223 * @deprecated use elm_object_text_set() instead.
18225 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18227 * @brief Get the text label of the check object
18229 * @param obj The check object
18230 * @return The text label string in UTF-8
18232 * @deprecated use elm_object_text_get() instead.
18234 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18236 * @brief Set the icon object of the check object
18238 * @param obj The check object
18239 * @param icon The icon object
18241 * Once the icon object is set, a previously set one will be deleted.
18242 * If you want to keep that old content object, use the
18243 * elm_check_icon_unset() function.
18245 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18247 * @brief Get the icon object of the check object
18249 * @param obj The check object
18250 * @return The icon object
18252 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18254 * @brief Unset the icon used for the check object
18256 * @param obj The check object
18257 * @return The icon object that was being used
18259 * Unparent and return the icon object which was set for this widget.
18261 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18263 * @brief Set the on/off state of the check object
18265 * @param obj The check object
18266 * @param state The state to use (1 == on, 0 == off)
18268 * This sets the state of the check. If set
18269 * with elm_check_state_pointer_set() the state of that variable is also
18270 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18272 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18274 * @brief Get the state of the check object
18276 * @param obj The check object
18277 * @return The boolean state
18279 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18281 * @brief Set a convenience pointer to a boolean to change
18283 * @param obj The check object
18284 * @param statep Pointer to the boolean to modify
18286 * This sets a pointer to a boolean, that, in addition to the check objects
18287 * state will also be modified directly. To stop setting the object pointed
18288 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18289 * then when this is called, the check objects state will also be modified to
18290 * reflect the value of the boolean @p statep points to, just like calling
18291 * elm_check_state_set().
18293 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18299 * @defgroup Radio Radio
18301 * @image html img/widget/radio/preview-00.png
18302 * @image latex img/widget/radio/preview-00.eps
18304 * @brief Radio is a widget that allows for 1 or more options to be displayed
18305 * and have the user choose only 1 of them.
18307 * A radio object contains an indicator, an optional Label and an optional
18308 * icon object. While it's possible to have a group of only one radio they,
18309 * are normally used in groups of 2 or more. To add a radio to a group use
18310 * elm_radio_group_add(). The radio object(s) will select from one of a set
18311 * of integer values, so any value they are configuring needs to be mapped to
18312 * a set of integers. To configure what value that radio object represents,
18313 * use elm_radio_state_value_set() to set the integer it represents. To set
18314 * the value the whole group(which one is currently selected) is to indicate
18315 * use elm_radio_value_set() on any group member, and to get the groups value
18316 * use elm_radio_value_get(). For convenience the radio objects are also able
18317 * to directly set an integer(int) to the value that is selected. To specify
18318 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18319 * The radio objects will modify this directly. That implies the pointer must
18320 * point to valid memory for as long as the radio objects exist.
18322 * Signals that you can add callbacks for are:
18323 * @li changed - This is called whenever the user changes the state of one of
18324 * the radio objects within the group of radio objects that work together.
18326 * @ref tutorial_radio show most of this API in action.
18330 * @brief Add a new radio to the parent
18332 * @param parent The parent object
18333 * @return The new object or NULL if it cannot be created
18335 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18337 * @brief Set the text label of the radio object
18339 * @param obj The radio object
18340 * @param label The text label string in UTF-8
18342 * @deprecated use elm_object_text_set() instead.
18344 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18346 * @brief Get the text label of the radio object
18348 * @param obj The radio object
18349 * @return The text label string in UTF-8
18351 * @deprecated use elm_object_text_set() instead.
18353 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18355 * @brief Set the icon object of the radio object
18357 * @param obj The radio object
18358 * @param icon The icon object
18360 * Once the icon object is set, a previously set one will be deleted. If you
18361 * want to keep that old content object, use the elm_radio_icon_unset()
18364 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18366 * @brief Get the icon object of the radio object
18368 * @param obj The radio object
18369 * @return The icon object
18371 * @see elm_radio_icon_set()
18373 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18375 * @brief Unset the icon used for the radio object
18377 * @param obj The radio object
18378 * @return The icon object that was being used
18380 * Unparent and return the icon object which was set for this widget.
18382 * @see elm_radio_icon_set()
18384 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18386 * @brief Add this radio to a group of other radio objects
18388 * @param obj The radio object
18389 * @param group Any object whose group the @p obj is to join.
18391 * Radio objects work in groups. Each member should have a different integer
18392 * value assigned. In order to have them work as a group, they need to know
18393 * about each other. This adds the given radio object to the group of which
18394 * the group object indicated is a member.
18396 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18398 * @brief Set the integer value that this radio object represents
18400 * @param obj The radio object
18401 * @param value The value to use if this radio object is selected
18403 * This sets the value of the radio.
18405 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18407 * @brief Get the integer value that this radio object represents
18409 * @param obj The radio object
18410 * @return The value used if this radio object is selected
18412 * This gets the value of the radio.
18414 * @see elm_radio_value_set()
18416 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18418 * @brief Set the value of the radio.
18420 * @param obj The radio object
18421 * @param value The value to use for the group
18423 * This sets the value of the radio group and will also set the value if
18424 * pointed to, to the value supplied, but will not call any callbacks.
18426 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18428 * @brief Get the state of the radio object
18430 * @param obj The radio object
18431 * @return The integer state
18433 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18435 * @brief Set a convenience pointer to a integer to change
18437 * @param obj The radio object
18438 * @param valuep Pointer to the integer to modify
18440 * This sets a pointer to a integer, that, in addition to the radio objects
18441 * state will also be modified directly. To stop setting the object pointed
18442 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18443 * when this is called, the radio objects state will also be modified to
18444 * reflect the value of the integer valuep points to, just like calling
18445 * elm_radio_value_set().
18447 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18453 * @defgroup Pager Pager
18455 * @image html img/widget/pager/preview-00.png
18456 * @image latex img/widget/pager/preview-00.eps
18458 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18460 * The flipping between “pages” of objects is animated. All content in pager
18461 * is kept in a stack, the last content to be added will be on the top of the
18462 * stack(be visible).
18464 * Objects can be pushed or popped from the stack or deleted as normal.
18465 * Pushes and pops will animate (and a pop will delete the object once the
18466 * animation is finished). Any object already in the pager can be promoted to
18467 * the top(from its current stacking position) through the use of
18468 * elm_pager_content_promote(). Objects are pushed to the top with
18469 * elm_pager_content_push() and when the top item is no longer wanted, simply
18470 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18471 * object is no longer needed and is not the top item, just delete it as
18472 * normal. You can query which objects are the top and bottom with
18473 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18475 * Signals that you can add callbacks for are:
18476 * "hide,finished" - when the previous page is hided
18478 * This widget has the following styles available:
18481 * @li fade_translucide
18482 * @li fade_invisible
18483 * @note This styles affect only the flipping animations, the appearance when
18484 * not animating is unaffected by styles.
18486 * @ref tutorial_pager gives a good overview of the usage of the API.
18490 * Add a new pager to the parent
18492 * @param parent The parent object
18493 * @return The new object or NULL if it cannot be created
18497 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18499 * @brief Push an object to the top of the pager stack (and show it).
18501 * @param obj The pager object
18502 * @param content The object to push
18504 * The object pushed becomes a child of the pager, it will be controlled and
18505 * deleted when the pager is deleted.
18507 * @note If the content is already in the stack use
18508 * elm_pager_content_promote().
18509 * @warning Using this function on @p content already in the stack results in
18510 * undefined behavior.
18512 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18514 * @brief Pop the object that is on top of the stack
18516 * @param obj The pager object
18518 * This pops the object that is on the top(visible) of the pager, makes it
18519 * disappear, then deletes the object. The object that was underneath it on
18520 * the stack will become visible.
18522 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18524 * @brief Moves an object already in the pager stack to the top of the stack.
18526 * @param obj The pager object
18527 * @param content The object to promote
18529 * This will take the @p content and move it to the top of the stack as
18530 * if it had been pushed there.
18532 * @note If the content isn't already in the stack use
18533 * elm_pager_content_push().
18534 * @warning Using this function on @p content not already in the stack
18535 * results in undefined behavior.
18537 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18539 * @brief Return the object at the bottom of the pager stack
18541 * @param obj The pager object
18542 * @return The bottom object or NULL if none
18544 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18546 * @brief Return the object at the top of the pager stack
18548 * @param obj The pager object
18549 * @return The top object or NULL if none
18551 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18557 * @defgroup Slideshow Slideshow
18559 * @image html img/widget/slideshow/preview-00.png
18560 * @image latex img/widget/slideshow/preview-00.eps
18562 * This widget, as the name indicates, is a pre-made image
18563 * slideshow panel, with API functions acting on (child) image
18564 * items presentation. Between those actions, are:
18565 * - advance to next/previous image
18566 * - select the style of image transition animation
18567 * - set the exhibition time for each image
18568 * - start/stop the slideshow
18570 * The transition animations are defined in the widget's theme,
18571 * consequently new animations can be added without having to
18572 * update the widget's code.
18574 * @section Slideshow_Items Slideshow items
18576 * For slideshow items, just like for @ref Genlist "genlist" ones,
18577 * the user defines a @b classes, specifying functions that will be
18578 * called on the item's creation and deletion times.
18580 * The #Elm_Slideshow_Item_Class structure contains the following
18583 * - @c func.get - When an item is displayed, this function is
18584 * called, and it's where one should create the item object, de
18585 * facto. For example, the object can be a pure Evas image object
18586 * or an Elementary @ref Photocam "photocam" widget. See
18587 * #SlideshowItemGetFunc.
18588 * - @c func.del - When an item is no more displayed, this function
18589 * is called, where the user must delete any data associated to
18590 * the item. See #SlideshowItemDelFunc.
18592 * @section Slideshow_Caching Slideshow caching
18594 * The slideshow provides facilities to have items adjacent to the
18595 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18596 * you, so that the system does not have to decode image data
18597 * anymore at the time it has to actually switch images on its
18598 * viewport. The user is able to set the numbers of items to be
18599 * cached @b before and @b after the current item, in the widget's
18602 * Smart events one can add callbacks for are:
18604 * - @c "changed" - when the slideshow switches its view to a new
18607 * List of examples for the slideshow widget:
18608 * @li @ref slideshow_example
18612 * @addtogroup Slideshow
18616 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18617 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18618 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18619 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18620 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18623 * @struct _Elm_Slideshow_Item_Class
18625 * Slideshow item class definition. See @ref Slideshow_Items for
18628 struct _Elm_Slideshow_Item_Class
18630 struct _Elm_Slideshow_Item_Class_Func
18632 SlideshowItemGetFunc get;
18633 SlideshowItemDelFunc del;
18635 }; /**< #Elm_Slideshow_Item_Class member definitions */
18638 * Add a new slideshow widget to the given parent Elementary
18639 * (container) object
18641 * @param parent The parent object
18642 * @return A new slideshow widget handle or @c NULL, on errors
18644 * This function inserts a new slideshow widget on the canvas.
18646 * @ingroup Slideshow
18648 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18651 * Add (append) a new item in a given slideshow widget.
18653 * @param obj The slideshow object
18654 * @param itc The item class for the item
18655 * @param data The item's data
18656 * @return A handle to the item added or @c NULL, on errors
18658 * Add a new item to @p obj's internal list of items, appending it.
18659 * The item's class must contain the function really fetching the
18660 * image object to show for this item, which could be an Evas image
18661 * object or an Elementary photo, for example. The @p data
18662 * parameter is going to be passed to both class functions of the
18665 * @see #Elm_Slideshow_Item_Class
18666 * @see elm_slideshow_item_sorted_insert()
18668 * @ingroup Slideshow
18670 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18673 * Insert a new item into the given slideshow widget, using the @p func
18674 * function to sort items (by item handles).
18676 * @param obj The slideshow object
18677 * @param itc The item class for the item
18678 * @param data The item's data
18679 * @param func The comparing function to be used to sort slideshow
18680 * items <b>by #Elm_Slideshow_Item item handles</b>
18681 * @return Returns The slideshow item handle, on success, or
18682 * @c NULL, on errors
18684 * Add a new item to @p obj's internal list of items, in a position
18685 * determined by the @p func comparing function. The item's class
18686 * must contain the function really fetching the image object to
18687 * show for this item, which could be an Evas image object or an
18688 * Elementary photo, for example. The @p data parameter is going to
18689 * be passed to both class functions of the item.
18691 * @see #Elm_Slideshow_Item_Class
18692 * @see elm_slideshow_item_add()
18694 * @ingroup Slideshow
18696 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);
18699 * Display a given slideshow widget's item, programmatically.
18701 * @param obj The slideshow object
18702 * @param item The item to display on @p obj's viewport
18704 * The change between the current item and @p item will use the
18705 * transition @p obj is set to use (@see
18706 * elm_slideshow_transition_set()).
18708 * @ingroup Slideshow
18710 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18713 * Slide to the @b next item, in a given slideshow widget
18715 * @param obj The slideshow object
18717 * The sliding animation @p obj is set to use will be the
18718 * transition effect used, after this call is issued.
18720 * @note If the end of the slideshow's internal list of items is
18721 * reached, it'll wrap around to the list's beginning, again.
18723 * @ingroup Slideshow
18725 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18728 * Slide to the @b previous item, in a given slideshow widget
18730 * @param obj The slideshow object
18732 * The sliding animation @p obj is set to use will be the
18733 * transition effect used, after this call is issued.
18735 * @note If the beginning of the slideshow's internal list of items
18736 * is reached, it'll wrap around to the list's end, again.
18738 * @ingroup Slideshow
18740 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18743 * Returns the list of sliding transition/effect names available, for a
18744 * given slideshow widget.
18746 * @param obj The slideshow object
18747 * @return The list of transitions (list of @b stringshared strings
18750 * The transitions, which come from @p obj's theme, must be an EDC
18751 * data item named @c "transitions" on the theme file, with (prefix)
18752 * names of EDC programs actually implementing them.
18754 * The available transitions for slideshows on the default theme are:
18755 * - @c "fade" - the current item fades out, while the new one
18756 * fades in to the slideshow's viewport.
18757 * - @c "black_fade" - the current item fades to black, and just
18758 * then, the new item will fade in.
18759 * - @c "horizontal" - the current item slides horizontally, until
18760 * it gets out of the slideshow's viewport, while the new item
18761 * comes from the left to take its place.
18762 * - @c "vertical" - the current item slides vertically, until it
18763 * gets out of the slideshow's viewport, while the new item comes
18764 * from the bottom to take its place.
18765 * - @c "square" - the new item starts to appear from the middle of
18766 * the current one, but with a tiny size, growing until its
18767 * target (full) size and covering the old one.
18769 * @warning The stringshared strings get no new references
18770 * exclusive to the user grabbing the list, here, so if you'd like
18771 * to use them out of this call's context, you'd better @c
18772 * eina_stringshare_ref() them.
18774 * @see elm_slideshow_transition_set()
18776 * @ingroup Slideshow
18778 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18781 * Set the current slide transition/effect in use for a given
18784 * @param obj The slideshow object
18785 * @param transition The new transition's name string
18787 * If @p transition is implemented in @p obj's theme (i.e., is
18788 * contained in the list returned by
18789 * elm_slideshow_transitions_get()), this new sliding effect will
18790 * be used on the widget.
18792 * @see elm_slideshow_transitions_get() for more details
18794 * @ingroup Slideshow
18796 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18799 * Get the current slide transition/effect in use for a given
18802 * @param obj The slideshow object
18803 * @return The current transition's name
18805 * @see elm_slideshow_transition_set() for more details
18807 * @ingroup Slideshow
18809 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18812 * Set the interval between each image transition on a given
18813 * slideshow widget, <b>and start the slideshow, itself</b>
18815 * @param obj The slideshow object
18816 * @param timeout The new displaying timeout for images
18818 * After this call, the slideshow widget will start cycling its
18819 * view, sequentially and automatically, with the images of the
18820 * items it has. The time between each new image displayed is going
18821 * to be @p timeout, in @b seconds. If a different timeout was set
18822 * previously and an slideshow was in progress, it will continue
18823 * with the new time between transitions, after this call.
18825 * @note A value less than or equal to 0 on @p timeout will disable
18826 * the widget's internal timer, thus halting any slideshow which
18827 * could be happening on @p obj.
18829 * @see elm_slideshow_timeout_get()
18831 * @ingroup Slideshow
18833 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18836 * Get the interval set for image transitions on a given slideshow
18839 * @param obj The slideshow object
18840 * @return Returns the timeout set on it
18842 * @see elm_slideshow_timeout_set() for more details
18844 * @ingroup Slideshow
18846 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18849 * Set if, after a slideshow is started, for a given slideshow
18850 * widget, its items should be displayed cyclically or not.
18852 * @param obj The slideshow object
18853 * @param loop Use @c EINA_TRUE to make it cycle through items or
18854 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18857 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18858 * ignore what is set by this functions, i.e., they'll @b always
18859 * cycle through items. This affects only the "automatic"
18860 * slideshow, as set by elm_slideshow_timeout_set().
18862 * @see elm_slideshow_loop_get()
18864 * @ingroup Slideshow
18866 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18869 * Get if, after a slideshow is started, for a given slideshow
18870 * widget, its items are to be displayed cyclically or not.
18872 * @param obj The slideshow object
18873 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18874 * through or @c EINA_FALSE, otherwise
18876 * @see elm_slideshow_loop_set() for more details
18878 * @ingroup Slideshow
18880 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18883 * Remove all items from a given slideshow widget
18885 * @param obj The slideshow object
18887 * This removes (and deletes) all items in @p obj, leaving it
18890 * @see elm_slideshow_item_del(), to remove just one item.
18892 * @ingroup Slideshow
18894 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18897 * Get the internal list of items in a given slideshow widget.
18899 * @param obj The slideshow object
18900 * @return The list of items (#Elm_Slideshow_Item as data) or
18901 * @c NULL on errors.
18903 * This list is @b not to be modified in any way and must not be
18904 * freed. Use the list members with functions like
18905 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18907 * @warning This list is only valid until @p obj object's internal
18908 * items list is changed. It should be fetched again with another
18909 * call to this function when changes happen.
18911 * @ingroup Slideshow
18913 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18916 * Delete a given item from a slideshow widget.
18918 * @param item The slideshow item
18920 * @ingroup Slideshow
18922 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18925 * Return the data associated with a given slideshow item
18927 * @param item The slideshow item
18928 * @return Returns the data associated to this item
18930 * @ingroup Slideshow
18932 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18935 * Returns the currently displayed item, in a given slideshow widget
18937 * @param obj The slideshow object
18938 * @return A handle to the item being displayed in @p obj or
18939 * @c NULL, if none is (and on errors)
18941 * @ingroup Slideshow
18943 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18946 * Get the real Evas object created to implement the view of a
18947 * given slideshow item
18949 * @param item The slideshow item.
18950 * @return the Evas object implementing this item's view.
18952 * This returns the actual Evas object used to implement the
18953 * specified slideshow item's view. This may be @c NULL, as it may
18954 * not have been created or may have been deleted, at any time, by
18955 * the slideshow. <b>Do not modify this object</b> (move, resize,
18956 * show, hide, etc.), as the slideshow is controlling it. This
18957 * function is for querying, emitting custom signals or hooking
18958 * lower level callbacks for events on that object. Do not delete
18959 * this object under any circumstances.
18961 * @see elm_slideshow_item_data_get()
18963 * @ingroup Slideshow
18965 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18968 * Get the the item, in a given slideshow widget, placed at
18969 * position @p nth, in its internal items list
18971 * @param obj The slideshow object
18972 * @param nth The number of the item to grab a handle to (0 being
18974 * @return The item stored in @p obj at position @p nth or @c NULL,
18975 * if there's no item with that index (and on errors)
18977 * @ingroup Slideshow
18979 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18982 * Set the current slide layout in use for a given slideshow widget
18984 * @param obj The slideshow object
18985 * @param layout The new layout's name string
18987 * If @p layout is implemented in @p obj's theme (i.e., is contained
18988 * in the list returned by elm_slideshow_layouts_get()), this new
18989 * images layout will be used on the widget.
18991 * @see elm_slideshow_layouts_get() for more details
18993 * @ingroup Slideshow
18995 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18998 * Get the current slide layout in use for a given slideshow widget
19000 * @param obj The slideshow object
19001 * @return The current layout's name
19003 * @see elm_slideshow_layout_set() for more details
19005 * @ingroup Slideshow
19007 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19010 * Returns the list of @b layout names available, for a given
19011 * slideshow widget.
19013 * @param obj The slideshow object
19014 * @return The list of layouts (list of @b stringshared strings
19017 * Slideshow layouts will change how the widget is to dispose each
19018 * image item in its viewport, with regard to cropping, scaling,
19021 * The layouts, which come from @p obj's theme, must be an EDC
19022 * data item name @c "layouts" on the theme file, with (prefix)
19023 * names of EDC programs actually implementing them.
19025 * The available layouts for slideshows on the default theme are:
19026 * - @c "fullscreen" - item images with original aspect, scaled to
19027 * touch top and down slideshow borders or, if the image's heigh
19028 * is not enough, left and right slideshow borders.
19029 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19030 * one, but always leaving 10% of the slideshow's dimensions of
19031 * distance between the item image's borders and the slideshow
19032 * borders, for each axis.
19034 * @warning The stringshared strings get no new references
19035 * exclusive to the user grabbing the list, here, so if you'd like
19036 * to use them out of this call's context, you'd better @c
19037 * eina_stringshare_ref() them.
19039 * @see elm_slideshow_layout_set()
19041 * @ingroup Slideshow
19043 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19046 * Set the number of items to cache, on a given slideshow widget,
19047 * <b>before the current item</b>
19049 * @param obj The slideshow object
19050 * @param count Number of items to cache before the current one
19052 * The default value for this property is @c 2. See
19053 * @ref Slideshow_Caching "slideshow caching" for more details.
19055 * @see elm_slideshow_cache_before_get()
19057 * @ingroup Slideshow
19059 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19062 * Retrieve the number of items to cache, on a given slideshow widget,
19063 * <b>before the current item</b>
19065 * @param obj The slideshow object
19066 * @return The number of items set to be cached before the current one
19068 * @see elm_slideshow_cache_before_set() for more details
19070 * @ingroup Slideshow
19072 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19075 * Set the number of items to cache, on a given slideshow widget,
19076 * <b>after the current item</b>
19078 * @param obj The slideshow object
19079 * @param count Number of items to cache after the current one
19081 * The default value for this property is @c 2. See
19082 * @ref Slideshow_Caching "slideshow caching" for more details.
19084 * @see elm_slideshow_cache_after_get()
19086 * @ingroup Slideshow
19088 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19091 * Retrieve the number of items to cache, on a given slideshow widget,
19092 * <b>after the current item</b>
19094 * @param obj The slideshow object
19095 * @return The number of items set to be cached after the current one
19097 * @see elm_slideshow_cache_after_set() for more details
19099 * @ingroup Slideshow
19101 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19104 * Get the number of items stored in a given slideshow widget
19106 * @param obj The slideshow object
19107 * @return The number of items on @p obj, at the moment of this call
19109 * @ingroup Slideshow
19111 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19118 * @defgroup Fileselector File Selector
19120 * @image html img/widget/fileselector/preview-00.png
19121 * @image latex img/widget/fileselector/preview-00.eps
19123 * A file selector is a widget that allows a user to navigate
19124 * through a file system, reporting file selections back via its
19127 * It contains shortcut buttons for home directory (@c ~) and to
19128 * jump one directory upwards (..), as well as cancel/ok buttons to
19129 * confirm/cancel a given selection. After either one of those two
19130 * former actions, the file selector will issue its @c "done" smart
19133 * There's a text entry on it, too, showing the name of the current
19134 * selection. There's the possibility of making it editable, so it
19135 * is useful on file saving dialogs on applications, where one
19136 * gives a file name to save contents to, in a given directory in
19137 * the system. This custom file name will be reported on the @c
19138 * "done" smart callback (explained in sequence).
19140 * Finally, it has a view to display file system items into in two
19145 * If Elementary is built with support of the Ethumb thumbnailing
19146 * library, the second form of view will display preview thumbnails
19147 * of files which it supports.
19149 * Smart callbacks one can register to:
19151 * - @c "selected" - the user has clicked on a file (when not in
19152 * folders-only mode) or directory (when in folders-only mode)
19153 * - @c "directory,open" - the list has been populated with new
19154 * content (@c event_info is a pointer to the directory's
19155 * path, a @b stringshared string)
19156 * - @c "done" - the user has clicked on the "ok" or "cancel"
19157 * buttons (@c event_info is a pointer to the selection's
19158 * path, a @b stringshared string)
19160 * Here is an example on its usage:
19161 * @li @ref fileselector_example
19165 * @addtogroup Fileselector
19170 * Defines how a file selector widget is to layout its contents
19171 * (file system entries).
19173 typedef enum _Elm_Fileselector_Mode
19175 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19176 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19177 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19178 } Elm_Fileselector_Mode;
19181 * Add a new file selector widget to the given parent Elementary
19182 * (container) object
19184 * @param parent The parent object
19185 * @return a new file selector widget handle or @c NULL, on errors
19187 * This function inserts a new file selector widget on the canvas.
19189 * @ingroup Fileselector
19191 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19194 * Enable/disable the file name entry box where the user can type
19195 * in a name for a file, in a given file selector widget
19197 * @param obj The file selector object
19198 * @param is_save @c EINA_TRUE to make the file selector a "saving
19199 * dialog", @c EINA_FALSE otherwise
19201 * Having the entry editable is useful on file saving dialogs on
19202 * applications, where one gives a file name to save contents to,
19203 * in a given directory in the system. This custom file name will
19204 * be reported on the @c "done" smart callback.
19206 * @see elm_fileselector_is_save_get()
19208 * @ingroup Fileselector
19210 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19213 * Get whether the given file selector is in "saving dialog" mode
19215 * @param obj The file selector object
19216 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19217 * mode, @c EINA_FALSE otherwise (and on errors)
19219 * @see elm_fileselector_is_save_set() for more details
19221 * @ingroup Fileselector
19223 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19226 * Enable/disable folder-only view for a given file selector widget
19228 * @param obj The file selector object
19229 * @param only @c EINA_TRUE to make @p obj only display
19230 * directories, @c EINA_FALSE to make files to be displayed in it
19233 * If enabled, the widget's view will only display folder items,
19236 * @see elm_fileselector_folder_only_get()
19238 * @ingroup Fileselector
19240 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19243 * Get whether folder-only view is set for a given file selector
19246 * @param obj The file selector object
19247 * @return only @c EINA_TRUE if @p obj is only displaying
19248 * directories, @c EINA_FALSE if files are being displayed in it
19249 * too (and on errors)
19251 * @see elm_fileselector_folder_only_get()
19253 * @ingroup Fileselector
19255 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19258 * Enable/disable the "ok" and "cancel" buttons on a given file
19261 * @param obj The file selector object
19262 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19264 * @note A file selector without those buttons will never emit the
19265 * @c "done" smart event, and is only usable if one is just hooking
19266 * to the other two events.
19268 * @see elm_fileselector_buttons_ok_cancel_get()
19270 * @ingroup Fileselector
19272 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19275 * Get whether the "ok" and "cancel" buttons on a given file
19276 * selector widget are being shown.
19278 * @param obj The file selector object
19279 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19280 * otherwise (and on errors)
19282 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19284 * @ingroup Fileselector
19286 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19289 * Enable/disable a tree view in the given file selector widget,
19290 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19292 * @param obj The file selector object
19293 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19296 * In a tree view, arrows are created on the sides of directories,
19297 * allowing them to expand in place.
19299 * @note If it's in other mode, the changes made by this function
19300 * will only be visible when one switches back to "list" mode.
19302 * @see elm_fileselector_expandable_get()
19304 * @ingroup Fileselector
19306 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19309 * Get whether tree view is enabled for the given file selector
19312 * @param obj The file selector object
19313 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19314 * otherwise (and or errors)
19316 * @see elm_fileselector_expandable_set() for more details
19318 * @ingroup Fileselector
19320 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19323 * Set, programmatically, the @b directory that a given file
19324 * selector widget will display contents from
19326 * @param obj The file selector object
19327 * @param path The path to display in @p obj
19329 * This will change the @b directory that @p obj is displaying. It
19330 * will also clear the text entry area on the @p obj object, which
19331 * displays select files' names.
19333 * @see elm_fileselector_path_get()
19335 * @ingroup Fileselector
19337 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19340 * Get the parent directory's path that a given file selector
19341 * widget is displaying
19343 * @param obj The file selector object
19344 * @return The (full) path of the directory the file selector is
19345 * displaying, a @b stringshared string
19347 * @see elm_fileselector_path_set()
19349 * @ingroup Fileselector
19351 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19354 * Set, programmatically, the currently selected file/directory in
19355 * the given file selector widget
19357 * @param obj The file selector object
19358 * @param path The (full) path to a file or directory
19359 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19360 * latter case occurs if the directory or file pointed to do not
19363 * @see elm_fileselector_selected_get()
19365 * @ingroup Fileselector
19367 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19370 * Get the currently selected item's (full) path, in the given file
19373 * @param obj The file selector object
19374 * @return The absolute path of the selected item, a @b
19375 * stringshared string
19377 * @note Custom editions on @p obj object's text entry, if made,
19378 * will appear on the return string of this function, naturally.
19380 * @see elm_fileselector_selected_set() for more details
19382 * @ingroup Fileselector
19384 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19387 * Set the mode in which a given file selector widget will display
19388 * (layout) file system entries in its view
19390 * @param obj The file selector object
19391 * @param mode The mode of the fileselector, being it one of
19392 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19393 * first one, naturally, will display the files in a list. The
19394 * latter will make the widget to display its entries in a grid
19397 * @note By using elm_fileselector_expandable_set(), the user may
19398 * trigger a tree view for that list.
19400 * @note If Elementary is built with support of the Ethumb
19401 * thumbnailing library, the second form of view will display
19402 * preview thumbnails of files which it supports. You must have
19403 * elm_need_ethumb() called in your Elementary for thumbnailing to
19406 * @see elm_fileselector_expandable_set().
19407 * @see elm_fileselector_mode_get().
19409 * @ingroup Fileselector
19411 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19414 * Get the mode in which a given file selector widget is displaying
19415 * (layouting) file system entries in its view
19417 * @param obj The fileselector object
19418 * @return The mode in which the fileselector is at
19420 * @see elm_fileselector_mode_set() for more details
19422 * @ingroup Fileselector
19424 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19431 * @defgroup Progressbar Progress bar
19433 * The progress bar is a widget for visually representing the
19434 * progress status of a given job/task.
19436 * A progress bar may be horizontal or vertical. It may display an
19437 * icon besides it, as well as primary and @b units labels. The
19438 * former is meant to label the widget as a whole, while the
19439 * latter, which is formatted with floating point values (and thus
19440 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19441 * units"</c>), is meant to label the widget's <b>progress
19442 * value</b>. Label, icon and unit strings/objects are @b optional
19443 * for progress bars.
19445 * A progress bar may be @b inverted, in which state it gets its
19446 * values inverted, with high values being on the left or top and
19447 * low values on the right or bottom, as opposed to normally have
19448 * the low values on the former and high values on the latter,
19449 * respectively, for horizontal and vertical modes.
19451 * The @b span of the progress, as set by
19452 * elm_progressbar_span_size_set(), is its length (horizontally or
19453 * vertically), unless one puts size hints on the widget to expand
19454 * on desired directions, by any container. That length will be
19455 * scaled by the object or applications scaling factor. At any
19456 * point code can query the progress bar for its value with
19457 * elm_progressbar_value_get().
19459 * Available widget styles for progress bars:
19461 * - @c "wheel" (simple style, no text, no progression, only
19462 * "pulse" effect is available)
19464 * Here is an example on its usage:
19465 * @li @ref progressbar_example
19469 * Add a new progress bar widget to the given parent Elementary
19470 * (container) object
19472 * @param parent The parent object
19473 * @return a new progress bar widget handle or @c NULL, on errors
19475 * This function inserts a new progress bar widget on the canvas.
19477 * @ingroup Progressbar
19479 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19482 * Set whether a given progress bar widget is at "pulsing mode" or
19485 * @param obj The progress bar object
19486 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19487 * @c EINA_FALSE to put it back to its default one
19489 * By default, progress bars will display values from the low to
19490 * high value boundaries. There are, though, contexts in which the
19491 * state of progression of a given task is @b unknown. For those,
19492 * one can set a progress bar widget to a "pulsing state", to give
19493 * the user an idea that some computation is being held, but
19494 * without exact progress values. In the default theme it will
19495 * animate its bar with the contents filling in constantly and back
19496 * to non-filled, in a loop. To start and stop this pulsing
19497 * animation, one has to explicitly call elm_progressbar_pulse().
19499 * @see elm_progressbar_pulse_get()
19500 * @see elm_progressbar_pulse()
19502 * @ingroup Progressbar
19504 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19507 * Get whether a given progress bar widget is at "pulsing mode" or
19510 * @param obj The progress bar object
19511 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19512 * if it's in the default one (and on errors)
19514 * @ingroup Progressbar
19516 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19519 * Start/stop a given progress bar "pulsing" animation, if its
19522 * @param obj The progress bar object
19523 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19524 * @c EINA_FALSE to @b stop it
19526 * @note This call won't do anything if @p obj is not under "pulsing mode".
19528 * @see elm_progressbar_pulse_set() for more details.
19530 * @ingroup Progressbar
19532 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19535 * Set the progress value (in percentage) on a given progress bar
19538 * @param obj The progress bar object
19539 * @param val The progress value (@b must be between @c 0.0 and @c
19542 * Use this call to set progress bar levels.
19544 * @note If you passes a value out of the specified range for @p
19545 * val, it will be interpreted as the @b closest of the @b boundary
19546 * values in the range.
19548 * @ingroup Progressbar
19550 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19553 * Get the progress value (in percentage) on a given progress bar
19556 * @param obj The progress bar object
19557 * @return The value of the progressbar
19559 * @see elm_progressbar_value_set() for more details
19561 * @ingroup Progressbar
19563 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19566 * Set the label of a given progress bar widget
19568 * @param obj The progress bar object
19569 * @param label The text label string, in UTF-8
19571 * @ingroup Progressbar
19572 * @deprecated use elm_object_text_set() instead.
19574 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19577 * Get the label of a given progress bar widget
19579 * @param obj The progressbar object
19580 * @return The text label string, in UTF-8
19582 * @ingroup Progressbar
19583 * @deprecated use elm_object_text_set() instead.
19585 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19588 * Set the icon object of a given progress bar widget
19590 * @param obj The progress bar object
19591 * @param icon The icon object
19593 * Use this call to decorate @p obj with an icon next to it.
19595 * @note Once the icon object is set, a previously set one will be
19596 * deleted. If you want to keep that old content object, use the
19597 * elm_progressbar_icon_unset() function.
19599 * @see elm_progressbar_icon_get()
19601 * @ingroup Progressbar
19603 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19606 * Retrieve the icon object set for a given progress bar widget
19608 * @param obj The progress bar object
19609 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19610 * otherwise (and on errors)
19612 * @see elm_progressbar_icon_set() for more details
19614 * @ingroup Progressbar
19616 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19619 * Unset an icon set on a given progress bar widget
19621 * @param obj The progress bar object
19622 * @return The icon object that was being used, if any was set, or
19623 * @c NULL, otherwise (and on errors)
19625 * This call will unparent and return the icon object which was set
19626 * for this widget, previously, on success.
19628 * @see elm_progressbar_icon_set() for more details
19630 * @ingroup Progressbar
19632 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19635 * Set the (exact) length of the bar region of a given progress bar
19638 * @param obj The progress bar object
19639 * @param size The length of the progress bar's bar region
19641 * This sets the minimum width (when in horizontal mode) or height
19642 * (when in vertical mode) of the actual bar area of the progress
19643 * bar @p obj. This in turn affects the object's minimum size. Use
19644 * this when you're not setting other size hints expanding on the
19645 * given direction (like weight and alignment hints) and you would
19646 * like it to have a specific size.
19648 * @note Icon, label and unit text around @p obj will require their
19649 * own space, which will make @p obj to require more the @p size,
19652 * @see elm_progressbar_span_size_get()
19654 * @ingroup Progressbar
19656 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19659 * Get the length set for the bar region of a given progress bar
19662 * @param obj The progress bar object
19663 * @return The length of the progress bar's bar region
19665 * If that size was not set previously, with
19666 * elm_progressbar_span_size_set(), this call will return @c 0.
19668 * @ingroup Progressbar
19670 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19673 * Set the format string for a given progress bar widget's units
19676 * @param obj The progress bar object
19677 * @param format The format string for @p obj's units label
19679 * If @c NULL is passed on @p format, it will make @p obj's units
19680 * area to be hidden completely. If not, it'll set the <b>format
19681 * string</b> for the units label's @b text. The units label is
19682 * provided a floating point value, so the units text is up display
19683 * at most one floating point falue. Note that the units label is
19684 * optional. Use a format string such as "%1.2f meters" for
19687 * @note The default format string for a progress bar is an integer
19688 * percentage, as in @c "%.0f %%".
19690 * @see elm_progressbar_unit_format_get()
19692 * @ingroup Progressbar
19694 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19697 * Retrieve the format string set for a given progress bar widget's
19700 * @param obj The progress bar object
19701 * @return The format set string for @p obj's units label or
19702 * @c NULL, if none was set (and on errors)
19704 * @see elm_progressbar_unit_format_set() for more details
19706 * @ingroup Progressbar
19708 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19711 * Set the orientation of a given progress bar widget
19713 * @param obj The progress bar object
19714 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19715 * @b horizontal, @c EINA_FALSE to make it @b vertical
19717 * Use this function to change how your progress bar is to be
19718 * disposed: vertically or horizontally.
19720 * @see elm_progressbar_horizontal_get()
19722 * @ingroup Progressbar
19724 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19727 * Retrieve the orientation of a given progress bar widget
19729 * @param obj The progress bar object
19730 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19731 * @c EINA_FALSE if it's @b vertical (and on errors)
19733 * @see elm_progressbar_horizontal_set() for more details
19735 * @ingroup Progressbar
19737 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19740 * Invert a given progress bar widget's displaying values order
19742 * @param obj The progress bar object
19743 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19744 * @c EINA_FALSE to bring it back to default, non-inverted values.
19746 * A progress bar may be @b inverted, in which state it gets its
19747 * values inverted, with high values being on the left or top and
19748 * low values on the right or bottom, as opposed to normally have
19749 * the low values on the former and high values on the latter,
19750 * respectively, for horizontal and vertical modes.
19752 * @see elm_progressbar_inverted_get()
19754 * @ingroup Progressbar
19756 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19759 * Get whether a given progress bar widget's displaying values are
19762 * @param obj The progress bar object
19763 * @return @c EINA_TRUE, if @p obj has inverted values,
19764 * @c EINA_FALSE otherwise (and on errors)
19766 * @see elm_progressbar_inverted_set() for more details
19768 * @ingroup Progressbar
19770 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19773 * @defgroup Separator Separator
19775 * @brief Separator is a very thin object used to separate other objects.
19777 * A separator can be vertical or horizontal.
19779 * @ref tutorial_separator is a good example of how to use a separator.
19783 * @brief Add a separator object to @p parent
19785 * @param parent The parent object
19787 * @return The separator object, or NULL upon failure
19789 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19791 * @brief Set the horizontal mode of a separator object
19793 * @param obj The separator object
19794 * @param horizontal If true, the separator is horizontal
19796 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19798 * @brief Get the horizontal mode of a separator object
19800 * @param obj The separator object
19801 * @return If true, the separator is horizontal
19803 * @see elm_separator_horizontal_set()
19805 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19811 * @defgroup Spinner Spinner
19812 * @ingroup Elementary
19814 * @image html img/widget/spinner/preview-00.png
19815 * @image latex img/widget/spinner/preview-00.eps
19817 * A spinner is a widget which allows the user to increase or decrease
19818 * numeric values using arrow buttons, or edit values directly, clicking
19819 * over it and typing the new value.
19821 * By default the spinner will not wrap and has a label
19822 * of "%.0f" (just showing the integer value of the double).
19824 * A spinner has a label that is formatted with floating
19825 * point values and thus accepts a printf-style format string, like
19828 * It also allows specific values to be replaced by pre-defined labels.
19830 * Smart callbacks one can register to:
19832 * - "changed" - Whenever the spinner value is changed.
19833 * - "delay,changed" - A short time after the value is changed by the user.
19834 * This will be called only when the user stops dragging for a very short
19835 * period or when they release their finger/mouse, so it avoids possibly
19836 * expensive reactions to the value change.
19838 * Available styles for it:
19840 * - @c "vertical": up/down buttons at the right side and text left aligned.
19842 * Here is an example on its usage:
19843 * @ref spinner_example
19847 * @addtogroup Spinner
19852 * Add a new spinner widget to the given parent Elementary
19853 * (container) object.
19855 * @param parent The parent object.
19856 * @return a new spinner widget handle or @c NULL, on errors.
19858 * This function inserts a new spinner widget on the canvas.
19863 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19866 * Set the format string of the displayed label.
19868 * @param obj The spinner object.
19869 * @param fmt The format string for the label display.
19871 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19872 * string for the label text. The label text is provided a floating point
19873 * value, so the label text can display up to 1 floating point value.
19874 * Note that this is optional.
19876 * Use a format string such as "%1.2f meters" for example, and it will
19877 * display values like: "3.14 meters" for a value equal to 3.14159.
19879 * Default is "%0.f".
19881 * @see elm_spinner_label_format_get()
19885 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19888 * Get the label format of the spinner.
19890 * @param obj The spinner object.
19891 * @return The text label format string in UTF-8.
19893 * @see elm_spinner_label_format_set() for details.
19897 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19900 * Set the minimum and maximum values for the spinner.
19902 * @param obj The spinner object.
19903 * @param min The minimum value.
19904 * @param max The maximum value.
19906 * Define the allowed range of values to be selected by the user.
19908 * If actual value is less than @p min, it will be updated to @p min. If it
19909 * is bigger then @p max, will be updated to @p max. Actual value can be
19910 * get with elm_spinner_value_get().
19912 * By default, min is equal to 0, and max is equal to 100.
19914 * @warning Maximum must be greater than minimum.
19916 * @see elm_spinner_min_max_get()
19920 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19923 * Get the minimum and maximum values of the spinner.
19925 * @param obj The spinner object.
19926 * @param min Pointer where to store the minimum value.
19927 * @param max Pointer where to store the maximum value.
19929 * @note If only one value is needed, the other pointer can be passed
19932 * @see elm_spinner_min_max_set() for details.
19936 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19939 * Set the step used to increment or decrement the spinner value.
19941 * @param obj The spinner object.
19942 * @param step The step value.
19944 * This value will be incremented or decremented to the displayed value.
19945 * It will be incremented while the user keep right or top arrow pressed,
19946 * and will be decremented while the user keep left or bottom arrow pressed.
19948 * The interval to increment / decrement can be set with
19949 * elm_spinner_interval_set().
19951 * By default step value is equal to 1.
19953 * @see elm_spinner_step_get()
19957 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19960 * Get the step used to increment or decrement the spinner value.
19962 * @param obj The spinner object.
19963 * @return The step value.
19965 * @see elm_spinner_step_get() for more details.
19969 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19972 * Set the value the spinner displays.
19974 * @param obj The spinner object.
19975 * @param val The value to be displayed.
19977 * Value will be presented on the label following format specified with
19978 * elm_spinner_format_set().
19980 * @warning The value must to be between min and max values. This values
19981 * are set by elm_spinner_min_max_set().
19983 * @see elm_spinner_value_get().
19984 * @see elm_spinner_format_set().
19985 * @see elm_spinner_min_max_set().
19989 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19992 * Get the value displayed by the spinner.
19994 * @param obj The spinner object.
19995 * @return The value displayed.
19997 * @see elm_spinner_value_set() for details.
20001 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20004 * Set whether the spinner should wrap when it reaches its
20005 * minimum or maximum value.
20007 * @param obj The spinner object.
20008 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20011 * Disabled by default. If disabled, when the user tries to increment the
20013 * but displayed value plus step value is bigger than maximum value,
20015 * won't allow it. The same happens when the user tries to decrement it,
20016 * but the value less step is less than minimum value.
20018 * When wrap is enabled, in such situations it will allow these changes,
20019 * but will get the value that would be less than minimum and subtracts
20020 * from maximum. Or add the value that would be more than maximum to
20024 * @li min value = 10
20025 * @li max value = 50
20026 * @li step value = 20
20027 * @li displayed value = 20
20029 * When the user decrement value (using left or bottom arrow), it will
20030 * displays @c 40, because max - (min - (displayed - step)) is
20031 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20033 * @see elm_spinner_wrap_get().
20037 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20040 * Get whether the spinner should wrap when it reaches its
20041 * minimum or maximum value.
20043 * @param obj The spinner object
20044 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20045 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20047 * @see elm_spinner_wrap_set() for details.
20051 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20054 * Set whether the spinner can be directly edited by the user or not.
20056 * @param obj The spinner object.
20057 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20058 * don't allow users to edit it directly.
20060 * Spinner objects can have edition @b disabled, in which state they will
20061 * be changed only by arrows.
20062 * Useful for contexts
20063 * where you don't want your users to interact with it writting the value.
20065 * when using special values, the user can see real value instead
20066 * of special label on edition.
20068 * It's enabled by default.
20070 * @see elm_spinner_editable_get()
20074 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20077 * Get whether the spinner can be directly edited by the user or not.
20079 * @param obj The spinner object.
20080 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20081 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20083 * @see elm_spinner_editable_set() for details.
20087 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20090 * Set a special string to display in the place of the numerical value.
20092 * @param obj The spinner object.
20093 * @param value The value to be replaced.
20094 * @param label The label to be used.
20096 * It's useful for cases when a user should select an item that is
20097 * better indicated by a label than a value. For example, weekdays or months.
20101 * sp = elm_spinner_add(win);
20102 * elm_spinner_min_max_set(sp, 1, 3);
20103 * elm_spinner_special_value_add(sp, 1, "January");
20104 * elm_spinner_special_value_add(sp, 2, "February");
20105 * elm_spinner_special_value_add(sp, 3, "March");
20106 * evas_object_show(sp);
20111 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20114 * Set the interval on time updates for an user mouse button hold
20115 * on spinner widgets' arrows.
20117 * @param obj The spinner object.
20118 * @param interval The (first) interval value in seconds.
20120 * This interval value is @b decreased while the user holds the
20121 * mouse pointer either incrementing or decrementing spinner's value.
20123 * This helps the user to get to a given value distant from the
20124 * current one easier/faster, as it will start to change quicker and
20125 * quicker on mouse button holds.
20127 * The calculation for the next change interval value, starting from
20128 * the one set with this call, is the previous interval divided by
20129 * @c 1.05, so it decreases a little bit.
20131 * The default starting interval value for automatic changes is
20134 * @see elm_spinner_interval_get()
20138 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20141 * Get the interval on time updates for an user mouse button hold
20142 * on spinner widgets' arrows.
20144 * @param obj The spinner object.
20145 * @return The (first) interval value, in seconds, set on it.
20147 * @see elm_spinner_interval_set() for more details.
20151 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @defgroup Index Index
20160 * @image html img/widget/index/preview-00.png
20161 * @image latex img/widget/index/preview-00.eps
20163 * An index widget gives you an index for fast access to whichever
20164 * group of other UI items one might have. It's a list of text
20165 * items (usually letters, for alphabetically ordered access).
20167 * Index widgets are by default hidden and just appear when the
20168 * user clicks over it's reserved area in the canvas. In its
20169 * default theme, it's an area one @ref Fingers "finger" wide on
20170 * the right side of the index widget's container.
20172 * When items on the index are selected, smart callbacks get
20173 * called, so that its user can make other container objects to
20174 * show a given area or child object depending on the index item
20175 * selected. You'd probably be using an index together with @ref
20176 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20179 * Smart events one can add callbacks for are:
20180 * - @c "changed" - When the selected index item changes. @c
20181 * event_info is the selected item's data pointer.
20182 * - @c "delay,changed" - When the selected index item changes, but
20183 * after a small idling period. @c event_info is the selected
20184 * item's data pointer.
20185 * - @c "selected" - When the user releases a mouse button and
20186 * selects an item. @c event_info is the selected item's data
20188 * - @c "level,up" - when the user moves a finger from the first
20189 * level to the second level
20190 * - @c "level,down" - when the user moves a finger from the second
20191 * level to the first level
20193 * The @c "delay,changed" event is so that it'll wait a small time
20194 * before actually reporting those events and, moreover, just the
20195 * last event happening on those time frames will actually be
20198 * Here are some examples on its usage:
20199 * @li @ref index_example_01
20200 * @li @ref index_example_02
20204 * @addtogroup Index
20208 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20211 * Add a new index widget to the given parent Elementary
20212 * (container) object
20214 * @param parent The parent object
20215 * @return a new index widget handle or @c NULL, on errors
20217 * This function inserts a new index widget on the canvas.
20221 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20224 * Set whether a given index widget is or not visible,
20227 * @param obj The index object
20228 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20230 * Not to be confused with visible as in @c evas_object_show() --
20231 * visible with regard to the widget's auto hiding feature.
20233 * @see elm_index_active_get()
20237 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20240 * Get whether a given index widget is currently visible or not.
20242 * @param obj The index object
20243 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20245 * @see elm_index_active_set() for more details
20249 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20252 * Set the items level for a given index widget.
20254 * @param obj The index object.
20255 * @param level @c 0 or @c 1, the currently implemented levels.
20257 * @see elm_index_item_level_get()
20261 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20264 * Get the items level set for a given index widget.
20266 * @param obj The index object.
20267 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20269 * @see elm_index_item_level_set() for more information
20273 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20276 * Returns the last selected item's data, for a given index widget.
20278 * @param obj The index object.
20279 * @return The item @b data associated to the last selected item on
20280 * @p obj (or @c NULL, on errors).
20282 * @warning The returned value is @b not an #Elm_Index_Item item
20283 * handle, but the data associated to it (see the @c item parameter
20284 * in elm_index_item_append(), as an example).
20288 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20291 * Append a new item on a given index widget.
20293 * @param obj The index object.
20294 * @param letter Letter under which the item should be indexed
20295 * @param item The item data to set for the index's item
20297 * Despite the most common usage of the @p letter argument is for
20298 * single char strings, one could use arbitrary strings as index
20301 * @c item will be the pointer returned back on @c "changed", @c
20302 * "delay,changed" and @c "selected" smart events.
20306 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20309 * Prepend a new item on a given index widget.
20311 * @param obj The index object.
20312 * @param letter Letter under which the item should be indexed
20313 * @param item The item data to set for the index's item
20315 * Despite the most common usage of the @p letter argument is for
20316 * single char strings, one could use arbitrary strings as index
20319 * @c item will be the pointer returned back on @c "changed", @c
20320 * "delay,changed" and @c "selected" smart events.
20324 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20327 * Append a new item, on a given index widget, <b>after the item
20328 * having @p relative as data</b>.
20330 * @param obj The index object.
20331 * @param letter Letter under which the item should be indexed
20332 * @param item The item data to set for the index's item
20333 * @param relative The item data of the index item to be the
20334 * predecessor of this new one
20336 * Despite the most common usage of the @p letter argument is for
20337 * single char strings, one could use arbitrary strings as index
20340 * @c item will be the pointer returned back on @c "changed", @c
20341 * "delay,changed" and @c "selected" smart events.
20343 * @note If @p relative is @c NULL or if it's not found to be data
20344 * set on any previous item on @p obj, this function will behave as
20345 * elm_index_item_append().
20349 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20352 * Prepend a new item, on a given index widget, <b>after the item
20353 * having @p relative as data</b>.
20355 * @param obj The index object.
20356 * @param letter Letter under which the item should be indexed
20357 * @param item The item data to set for the index's item
20358 * @param relative The item data of the index item to be the
20359 * successor of this new one
20361 * Despite the most common usage of the @p letter argument is for
20362 * single char strings, one could use arbitrary strings as index
20365 * @c item will be the pointer returned back on @c "changed", @c
20366 * "delay,changed" and @c "selected" smart events.
20368 * @note If @p relative is @c NULL or if it's not found to be data
20369 * set on any previous item on @p obj, this function will behave as
20370 * elm_index_item_prepend().
20374 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20377 * Insert a new item into the given index widget, using @p cmp_func
20378 * function to sort items (by item handles).
20380 * @param obj The index object.
20381 * @param letter Letter under which the item should be indexed
20382 * @param item The item data to set for the index's item
20383 * @param cmp_func The comparing function to be used to sort index
20384 * items <b>by #Elm_Index_Item item handles</b>
20385 * @param cmp_data_func A @b fallback function to be called for the
20386 * sorting of index items <b>by item data</b>). It will be used
20387 * when @p cmp_func returns @c 0 (equality), which means an index
20388 * item with provided item data already exists. To decide which
20389 * data item should be pointed to by the index item in question, @p
20390 * cmp_data_func will be used. If @p cmp_data_func returns a
20391 * non-negative value, the previous index item data will be
20392 * replaced by the given @p item pointer. If the previous data need
20393 * to be freed, it should be done by the @p cmp_data_func function,
20394 * because all references to it will be lost. If this function is
20395 * not provided (@c NULL is given), index items will be @b
20396 * duplicated, if @p cmp_func returns @c 0.
20398 * Despite the most common usage of the @p letter argument is for
20399 * single char strings, one could use arbitrary strings as index
20402 * @c item will be the pointer returned back on @c "changed", @c
20403 * "delay,changed" and @c "selected" smart events.
20407 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);
20410 * Remove an item from a given index widget, <b>to be referenced by
20411 * it's data value</b>.
20413 * @param obj The index object
20414 * @param item The item's data pointer for the item to be removed
20417 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20418 * that callback function will be called by this one.
20420 * @warning The item to be removed from @p obj will be found via
20421 * its item data pointer, and not by an #Elm_Index_Item handle.
20425 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20428 * Find a given index widget's item, <b>using item data</b>.
20430 * @param obj The index object
20431 * @param item The item data pointed to by the desired index item
20432 * @return The index item handle, if found, or @c NULL otherwise
20436 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20439 * Removes @b all items from a given index widget.
20441 * @param obj The index object.
20443 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20444 * that callback function will be called for each item in @p obj.
20448 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20451 * Go to a given items level on a index widget
20453 * @param obj The index object
20454 * @param level The index level (one of @c 0 or @c 1)
20458 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20461 * Return the data associated with a given index widget item
20463 * @param it The index widget item handle
20464 * @return The data associated with @p it
20466 * @see elm_index_item_data_set()
20470 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20473 * Set the data associated with a given index widget item
20475 * @param it The index widget item handle
20476 * @param data The new data pointer to set to @p it
20478 * This sets new item data on @p it.
20480 * @warning The old data pointer won't be touched by this function, so
20481 * the user had better to free that old data himself/herself.
20485 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20488 * Set the function to be called when a given index widget item is freed.
20490 * @param it The item to set the callback on
20491 * @param func The function to call on the item's deletion
20493 * When called, @p func will have both @c data and @c event_info
20494 * arguments with the @p it item's data value and, naturally, the
20495 * @c obj argument with a handle to the parent index widget.
20499 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20502 * Get the letter (string) set on a given index widget item.
20504 * @param it The index item handle
20505 * @return The letter string set on @p it
20509 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20516 * @defgroup Photocam Photocam
20518 * @image html img/widget/photocam/preview-00.png
20519 * @image latex img/widget/photocam/preview-00.eps
20521 * This is a widget specifically for displaying high-resolution digital
20522 * camera photos giving speedy feedback (fast load), low memory footprint
20523 * and zooming and panning as well as fitting logic. It is entirely focused
20524 * on jpeg images, and takes advantage of properties of the jpeg format (via
20525 * evas loader features in the jpeg loader).
20527 * Signals that you can add callbacks for are:
20528 * @li "clicked" - This is called when a user has clicked the photo without
20530 * @li "press" - This is called when a user has pressed down on the photo.
20531 * @li "longpressed" - This is called when a user has pressed down on the
20532 * photo for a long time without dragging around.
20533 * @li "clicked,double" - This is called when a user has double-clicked the
20535 * @li "load" - Photo load begins.
20536 * @li "loaded" - This is called when the image file load is complete for the
20537 * first view (low resolution blurry version).
20538 * @li "load,detail" - Photo detailed data load begins.
20539 * @li "loaded,detail" - This is called when the image file load is complete
20540 * for the detailed image data (full resolution needed).
20541 * @li "zoom,start" - Zoom animation started.
20542 * @li "zoom,stop" - Zoom animation stopped.
20543 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20544 * @li "scroll" - the content has been scrolled (moved)
20545 * @li "scroll,anim,start" - scrolling animation has started
20546 * @li "scroll,anim,stop" - scrolling animation has stopped
20547 * @li "scroll,drag,start" - dragging the contents around has started
20548 * @li "scroll,drag,stop" - dragging the contents around has stopped
20550 * @ref tutorial_photocam shows the API in action.
20554 * @brief Types of zoom available.
20556 typedef enum _Elm_Photocam_Zoom_Mode
20558 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20559 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20560 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20561 ELM_PHOTOCAM_ZOOM_MODE_LAST
20562 } Elm_Photocam_Zoom_Mode;
20564 * @brief Add a new Photocam object
20566 * @param parent The parent object
20567 * @return The new object or NULL if it cannot be created
20569 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20571 * @brief Set the photo file to be shown
20573 * @param obj The photocam object
20574 * @param file The photo file
20575 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20577 * This sets (and shows) the specified file (with a relative or absolute
20578 * path) and will return a load error (same error that
20579 * evas_object_image_load_error_get() will return). The image will change and
20580 * adjust its size at this point and begin a background load process for this
20581 * photo that at some time in the future will be displayed at the full
20584 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20586 * @brief Returns the path of the current image file
20588 * @param obj The photocam object
20589 * @return Returns the path
20591 * @see elm_photocam_file_set()
20593 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20595 * @brief Set the zoom level of the photo
20597 * @param obj The photocam object
20598 * @param zoom The zoom level to set
20600 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20601 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20602 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20603 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20606 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20608 * @brief Get the zoom level of the photo
20610 * @param obj The photocam object
20611 * @return The current zoom level
20613 * This returns the current zoom level of the photocam object. Note that if
20614 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20615 * (which is the default), the zoom level may be changed at any time by the
20616 * photocam object itself to account for photo size and photocam viewpoer
20619 * @see elm_photocam_zoom_set()
20620 * @see elm_photocam_zoom_mode_set()
20622 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20624 * @brief Set the zoom mode
20626 * @param obj The photocam object
20627 * @param mode The desired mode
20629 * This sets the zoom mode to manual or one of several automatic levels.
20630 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20631 * elm_photocam_zoom_set() and will stay at that level until changed by code
20632 * or until zoom mode is changed. This is the default mode. The Automatic
20633 * modes will allow the photocam object to automatically adjust zoom mode
20634 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20635 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20636 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20637 * pixels within the frame are left unfilled.
20639 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20641 * @brief Get the zoom mode
20643 * @param obj The photocam object
20644 * @return The current zoom mode
20646 * This gets the current zoom mode of the photocam object.
20648 * @see elm_photocam_zoom_mode_set()
20650 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20652 * @brief Get the current image pixel width and height
20654 * @param obj The photocam object
20655 * @param w A pointer to the width return
20656 * @param h A pointer to the height return
20658 * This gets the current photo pixel width and height (for the original).
20659 * The size will be returned in the integers @p w and @p h that are pointed
20662 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20664 * @brief Get the area of the image that is currently shown
20667 * @param x A pointer to the X-coordinate of region
20668 * @param y A pointer to the Y-coordinate of region
20669 * @param w A pointer to the width
20670 * @param h A pointer to the height
20672 * @see elm_photocam_image_region_show()
20673 * @see elm_photocam_image_region_bring_in()
20675 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20677 * @brief Set the viewed portion of the image
20679 * @param obj The photocam object
20680 * @param x X-coordinate of region in image original pixels
20681 * @param y Y-coordinate of region in image original pixels
20682 * @param w Width of region in image original pixels
20683 * @param h Height of region in image original pixels
20685 * This shows the region of the image without using animation.
20687 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20689 * @brief Bring in the viewed portion of the image
20691 * @param obj The photocam object
20692 * @param x X-coordinate of region in image original pixels
20693 * @param y Y-coordinate of region in image original pixels
20694 * @param w Width of region in image original pixels
20695 * @param h Height of region in image original pixels
20697 * This shows the region of the image using animation.
20699 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20701 * @brief Set the paused state for photocam
20703 * @param obj The photocam object
20704 * @param paused The pause state to set
20706 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20707 * photocam. The default is off. This will stop zooming using animation on
20708 * zoom levels changes and change instantly. This will stop any existing
20709 * animations that are running.
20711 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20713 * @brief Get the paused state for photocam
20715 * @param obj The photocam object
20716 * @return The current paused state
20718 * This gets the current paused state for the photocam object.
20720 * @see elm_photocam_paused_set()
20722 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20724 * @brief Get the internal low-res image used for photocam
20726 * @param obj The photocam object
20727 * @return The internal image object handle, or NULL if none exists
20729 * This gets the internal image object inside photocam. Do not modify it. It
20730 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20731 * deleted at any time as well.
20733 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20735 * @brief Set the photocam scrolling bouncing.
20737 * @param obj The photocam object
20738 * @param h_bounce bouncing for horizontal
20739 * @param v_bounce bouncing for vertical
20741 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20743 * @brief Get the photocam scrolling bouncing.
20745 * @param obj The photocam object
20746 * @param h_bounce bouncing for horizontal
20747 * @param v_bounce bouncing for vertical
20749 * @see elm_photocam_bounce_set()
20751 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20757 * @defgroup Map Map
20758 * @ingroup Elementary
20760 * @image html img/widget/map/preview-00.png
20761 * @image latex img/widget/map/preview-00.eps
20763 * This is a widget specifically for displaying a map. It uses basically
20764 * OpenStreetMap provider http://www.openstreetmap.org/,
20765 * but custom providers can be added.
20767 * It supports some basic but yet nice features:
20768 * @li zoom and scroll
20769 * @li markers with content to be displayed when user clicks over it
20770 * @li group of markers
20773 * Smart callbacks one can listen to:
20775 * - "clicked" - This is called when a user has clicked the map without
20777 * - "press" - This is called when a user has pressed down on the map.
20778 * - "longpressed" - This is called when a user has pressed down on the map
20779 * for a long time without dragging around.
20780 * - "clicked,double" - This is called when a user has double-clicked
20782 * - "load,detail" - Map detailed data load begins.
20783 * - "loaded,detail" - This is called when all currently visible parts of
20784 * the map are loaded.
20785 * - "zoom,start" - Zoom animation started.
20786 * - "zoom,stop" - Zoom animation stopped.
20787 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20788 * - "scroll" - the content has been scrolled (moved).
20789 * - "scroll,anim,start" - scrolling animation has started.
20790 * - "scroll,anim,stop" - scrolling animation has stopped.
20791 * - "scroll,drag,start" - dragging the contents around has started.
20792 * - "scroll,drag,stop" - dragging the contents around has stopped.
20793 * - "downloaded" - This is called when all currently required map images
20795 * - "route,load" - This is called when route request begins.
20796 * - "route,loaded" - This is called when route request ends.
20797 * - "name,load" - This is called when name request begins.
20798 * - "name,loaded- This is called when name request ends.
20800 * Available style for map widget:
20803 * Available style for markers:
20808 * Available style for marker bubble:
20811 * List of examples:
20812 * @li @ref map_example_01
20813 * @li @ref map_example_02
20814 * @li @ref map_example_03
20823 * @enum _Elm_Map_Zoom_Mode
20824 * @typedef Elm_Map_Zoom_Mode
20826 * Set map's zoom behavior. It can be set to manual or automatic.
20828 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20830 * Values <b> don't </b> work as bitmask, only one can be choosen.
20832 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20833 * than the scroller view.
20835 * @see elm_map_zoom_mode_set()
20836 * @see elm_map_zoom_mode_get()
20840 typedef enum _Elm_Map_Zoom_Mode
20842 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20843 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20844 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20845 ELM_MAP_ZOOM_MODE_LAST
20846 } Elm_Map_Zoom_Mode;
20849 * @enum _Elm_Map_Route_Sources
20850 * @typedef Elm_Map_Route_Sources
20852 * Set route service to be used. By default used source is
20853 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20855 * @see elm_map_route_source_set()
20856 * @see elm_map_route_source_get()
20860 typedef enum _Elm_Map_Route_Sources
20862 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20863 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. */
20864 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20865 ELM_MAP_ROUTE_SOURCE_LAST
20866 } Elm_Map_Route_Sources;
20868 typedef enum _Elm_Map_Name_Sources
20870 ELM_MAP_NAME_SOURCE_NOMINATIM,
20871 ELM_MAP_NAME_SOURCE_LAST
20872 } Elm_Map_Name_Sources;
20875 * @enum _Elm_Map_Route_Type
20876 * @typedef Elm_Map_Route_Type
20878 * Set type of transport used on route.
20880 * @see elm_map_route_add()
20884 typedef enum _Elm_Map_Route_Type
20886 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20887 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20888 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20889 ELM_MAP_ROUTE_TYPE_LAST
20890 } Elm_Map_Route_Type;
20893 * @enum _Elm_Map_Route_Method
20894 * @typedef Elm_Map_Route_Method
20896 * Set the routing method, what should be priorized, time or distance.
20898 * @see elm_map_route_add()
20902 typedef enum _Elm_Map_Route_Method
20904 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20905 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20906 ELM_MAP_ROUTE_METHOD_LAST
20907 } Elm_Map_Route_Method;
20909 typedef enum _Elm_Map_Name_Method
20911 ELM_MAP_NAME_METHOD_SEARCH,
20912 ELM_MAP_NAME_METHOD_REVERSE,
20913 ELM_MAP_NAME_METHOD_LAST
20914 } Elm_Map_Name_Method;
20916 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(). */
20917 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(). */
20918 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(). */
20919 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(). */
20920 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20921 typedef struct _Elm_Map_Track Elm_Map_Track;
20923 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. */
20924 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20925 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20926 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20928 typedef char *(*ElmMapModuleSourceFunc) (void);
20929 typedef int (*ElmMapModuleZoomMinFunc) (void);
20930 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20931 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20932 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20933 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20934 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20935 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20936 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20939 * Add a new map widget to the given parent Elementary (container) object.
20941 * @param parent The parent object.
20942 * @return a new map widget handle or @c NULL, on errors.
20944 * This function inserts a new map widget on the canvas.
20948 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20951 * Set the zoom level of the map.
20953 * @param obj The map object.
20954 * @param zoom The zoom level to set.
20956 * This sets the zoom level.
20958 * It will respect limits defined by elm_map_source_zoom_min_set() and
20959 * elm_map_source_zoom_max_set().
20961 * By default these values are 0 (world map) and 18 (maximum zoom).
20963 * This function should be used when zoom mode is set to
20964 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20965 * with elm_map_zoom_mode_set().
20967 * @see elm_map_zoom_mode_set().
20968 * @see elm_map_zoom_get().
20972 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20975 * Get the zoom level of the map.
20977 * @param obj The map object.
20978 * @return The current zoom level.
20980 * This returns the current zoom level of the map object.
20982 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20983 * (which is the default), the zoom level may be changed at any time by the
20984 * map object itself to account for map size and map viewport size.
20986 * @see elm_map_zoom_set() for details.
20990 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20993 * Set the zoom mode used by the map object.
20995 * @param obj The map object.
20996 * @param mode The zoom mode of the map, being it one of
20997 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20998 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21000 * This sets the zoom mode to manual or one of the automatic levels.
21001 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21002 * elm_map_zoom_set() and will stay at that level until changed by code
21003 * or until zoom mode is changed. This is the default mode.
21005 * The Automatic modes will allow the map object to automatically
21006 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21007 * adjust zoom so the map fits inside the scroll frame with no pixels
21008 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21009 * ensure no pixels within the frame are left unfilled. Do not forget that
21010 * the valid sizes are 2^zoom, consequently the map may be smaller than
21011 * the scroller view.
21013 * @see elm_map_zoom_set()
21017 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21020 * Get the zoom mode used by the map object.
21022 * @param obj The map object.
21023 * @return The zoom mode of the map, being it one of
21024 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21025 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21027 * This function returns the current zoom mode used by the map object.
21029 * @see elm_map_zoom_mode_set() for more details.
21033 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21036 * Get the current coordinates of the map.
21038 * @param obj The map object.
21039 * @param lon Pointer where to store longitude.
21040 * @param lat Pointer where to store latitude.
21042 * This gets the current center coordinates of the map object. It can be
21043 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21045 * @see elm_map_geo_region_bring_in()
21046 * @see elm_map_geo_region_show()
21050 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21053 * Animatedly bring in given coordinates to the center of the map.
21055 * @param obj The map object.
21056 * @param lon Longitude to center at.
21057 * @param lat Latitude to center at.
21059 * This causes map to jump to the given @p lat and @p lon coordinates
21060 * and show it (by scrolling) in the center of the viewport, if it is not
21061 * already centered. This will use animation to do so and take a period
21062 * of time to complete.
21064 * @see elm_map_geo_region_show() for a function to avoid animation.
21065 * @see elm_map_geo_region_get()
21069 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21072 * Show the given coordinates at the center of the map, @b immediately.
21074 * @param obj The map object.
21075 * @param lon Longitude to center at.
21076 * @param lat Latitude to center at.
21078 * This causes map to @b redraw its viewport's contents to the
21079 * region contining the given @p lat and @p lon, that will be moved to the
21080 * center of the map.
21082 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21083 * @see elm_map_geo_region_get()
21087 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21090 * Pause or unpause the map.
21092 * @param obj The map object.
21093 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21096 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21099 * The default is off.
21101 * This will stop zooming using animation, changing zoom levels will
21102 * change instantly. This will stop any existing animations that are running.
21104 * @see elm_map_paused_get()
21108 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21111 * Get a value whether map is paused or not.
21113 * @param obj The map object.
21114 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21115 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21117 * This gets the current paused state for the map object.
21119 * @see elm_map_paused_set() for details.
21123 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21126 * Set to show markers during zoom level changes or not.
21128 * @param obj The map object.
21129 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21132 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21135 * The default is off.
21137 * This will stop zooming using animation, changing zoom levels will
21138 * change instantly. This will stop any existing animations that are running.
21140 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21143 * The default is off.
21145 * Enabling it will force the map to stop displaying the markers during
21146 * zoom level changes. Set to on if you have a large number of markers.
21148 * @see elm_map_paused_markers_get()
21152 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21155 * Get a value whether markers will be displayed on zoom level changes or not
21157 * @param obj The map object.
21158 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21159 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21161 * This gets the current markers paused state for the map object.
21163 * @see elm_map_paused_markers_set() for details.
21167 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21170 * Get the information of downloading status.
21172 * @param obj The map object.
21173 * @param try_num Pointer where to store number of tiles being downloaded.
21174 * @param finish_num Pointer where to store number of tiles successfully
21177 * This gets the current downloading status for the map object, the number
21178 * of tiles being downloaded and the number of tiles already downloaded.
21182 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21185 * Convert a pixel coordinate (x,y) into a geographic coordinate
21186 * (longitude, latitude).
21188 * @param obj The map object.
21189 * @param x the coordinate.
21190 * @param y the coordinate.
21191 * @param size the size in pixels of the map.
21192 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21193 * @param lon Pointer where to store the longitude that correspond to x.
21194 * @param lat Pointer where to store the latitude that correspond to y.
21196 * @note Origin pixel point is the top left corner of the viewport.
21197 * Map zoom and size are taken on account.
21199 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21203 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);
21206 * Convert a geographic coordinate (longitude, latitude) into a pixel
21207 * coordinate (x, y).
21209 * @param obj The map object.
21210 * @param lon the longitude.
21211 * @param lat the latitude.
21212 * @param size the size in pixels of the map. The map is a square
21213 * and generally his size is : pow(2.0, zoom)*256.
21214 * @param x Pointer where to store the horizontal pixel coordinate that
21215 * correspond to the longitude.
21216 * @param y Pointer where to store the vertical pixel coordinate that
21217 * correspond to the latitude.
21219 * @note Origin pixel point is the top left corner of the viewport.
21220 * Map zoom and size are taken on account.
21222 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21226 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);
21229 * Convert a geographic coordinate (longitude, latitude) into a name
21232 * @param obj The map object.
21233 * @param lon the longitude.
21234 * @param lat the latitude.
21235 * @return name A #Elm_Map_Name handle for this coordinate.
21237 * To get the string for this address, elm_map_name_address_get()
21240 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21244 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21247 * Convert a name (address) into a geographic coordinate
21248 * (longitude, latitude).
21250 * @param obj The map object.
21251 * @param name The address.
21252 * @return name A #Elm_Map_Name handle for this address.
21254 * To get the longitude and latitude, elm_map_name_region_get()
21257 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21261 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21264 * Convert a pixel coordinate into a rotated pixel coordinate.
21266 * @param obj The map object.
21267 * @param x horizontal coordinate of the point to rotate.
21268 * @param y vertical coordinate of the point to rotate.
21269 * @param cx rotation's center horizontal position.
21270 * @param cy rotation's center vertical position.
21271 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21272 * @param xx Pointer where to store rotated x.
21273 * @param yy Pointer where to store rotated y.
21277 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);
21280 * Add a new marker to the map object.
21282 * @param obj The map object.
21283 * @param lon The longitude of the marker.
21284 * @param lat The latitude of the marker.
21285 * @param clas The class, to use when marker @b isn't grouped to others.
21286 * @param clas_group The class group, to use when marker is grouped to others
21287 * @param data The data passed to the callbacks.
21289 * @return The created marker or @c NULL upon failure.
21291 * A marker will be created and shown in a specific point of the map, defined
21292 * by @p lon and @p lat.
21294 * It will be displayed using style defined by @p class when this marker
21295 * is displayed alone (not grouped). A new class can be created with
21296 * elm_map_marker_class_new().
21298 * If the marker is grouped to other markers, it will be displayed with
21299 * style defined by @p class_group. Markers with the same group are grouped
21300 * if they are close. A new group class can be created with
21301 * elm_map_marker_group_class_new().
21303 * Markers created with this method can be deleted with
21304 * elm_map_marker_remove().
21306 * A marker can have associated content to be displayed by a bubble,
21307 * when a user click over it, as well as an icon. These objects will
21308 * be fetch using class' callback functions.
21310 * @see elm_map_marker_class_new()
21311 * @see elm_map_marker_group_class_new()
21312 * @see elm_map_marker_remove()
21316 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);
21319 * Set the maximum numbers of markers' content to be displayed in a group.
21321 * @param obj The map object.
21322 * @param max The maximum numbers of items displayed in a bubble.
21324 * A bubble will be displayed when the user clicks over the group,
21325 * and will place the content of markers that belong to this group
21328 * A group can have a long list of markers, consequently the creation
21329 * of the content of the bubble can be very slow.
21331 * In order to avoid this, a maximum number of items is displayed
21334 * By default this number is 30.
21336 * Marker with the same group class are grouped if they are close.
21338 * @see elm_map_marker_add()
21342 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21345 * Remove a marker from the map.
21347 * @param marker The marker to remove.
21349 * @see elm_map_marker_add()
21353 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21356 * Get the current coordinates of the marker.
21358 * @param marker marker.
21359 * @param lat Pointer where to store the marker's latitude.
21360 * @param lon Pointer where to store the marker's longitude.
21362 * These values are set when adding markers, with function
21363 * elm_map_marker_add().
21365 * @see elm_map_marker_add()
21369 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21372 * Animatedly bring in given marker to the center of the map.
21374 * @param marker The marker to center at.
21376 * This causes map to jump to the given @p marker's coordinates
21377 * and show it (by scrolling) in the center of the viewport, if it is not
21378 * already centered. This will use animation to do so and take a period
21379 * of time to complete.
21381 * @see elm_map_marker_show() for a function to avoid animation.
21382 * @see elm_map_marker_region_get()
21386 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21389 * Show the given marker at the center of the map, @b immediately.
21391 * @param marker The marker to center at.
21393 * This causes map to @b redraw its viewport's contents to the
21394 * region contining the given @p marker's coordinates, that will be
21395 * moved to the center of the map.
21397 * @see elm_map_marker_bring_in() for a function to move with animation.
21398 * @see elm_map_markers_list_show() if more than one marker need to be
21400 * @see elm_map_marker_region_get()
21404 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21407 * Move and zoom the map to display a list of markers.
21409 * @param markers A list of #Elm_Map_Marker handles.
21411 * The map will be centered on the center point of the markers in the list.
21412 * Then the map will be zoomed in order to fit the markers using the maximum
21413 * zoom which allows display of all the markers.
21415 * @warning All the markers should belong to the same map object.
21417 * @see elm_map_marker_show() to show a single marker.
21418 * @see elm_map_marker_bring_in()
21422 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21425 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21427 * @param marker The marker wich content should be returned.
21428 * @return Return the evas object if it exists, else @c NULL.
21430 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21431 * elm_map_marker_class_get_cb_set() should be used.
21433 * This content is what will be inside the bubble that will be displayed
21434 * when an user clicks over the marker.
21436 * This returns the actual Evas object used to be placed inside
21437 * the bubble. This may be @c NULL, as it may
21438 * not have been created or may have been deleted, at any time, by
21439 * the map. <b>Do not modify this object</b> (move, resize,
21440 * show, hide, etc.), as the map is controlling it. This
21441 * function is for querying, emitting custom signals or hooking
21442 * lower level callbacks for events on that object. Do not delete
21443 * this object under any circumstances.
21447 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21450 * Update the marker
21452 * @param marker The marker to be updated.
21454 * If a content is set to this marker, it will call function to delete it,
21455 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21456 * #ElmMapMarkerGetFunc.
21458 * These functions are set for the marker class with
21459 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21463 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21466 * Close all the bubbles opened by the user.
21468 * @param obj The map object.
21470 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21471 * when the user clicks on a marker.
21473 * This functions is set for the marker class with
21474 * elm_map_marker_class_get_cb_set().
21478 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21481 * Create a new group class.
21483 * @param obj The map object.
21484 * @return Returns the new group class.
21486 * Each marker must be associated to a group class. Markers in the same
21487 * group are grouped if they are close.
21489 * The group class defines the style of the marker when a marker is grouped
21490 * to others markers. When it is alone, another class will be used.
21492 * A group class will need to be provided when creating a marker with
21493 * elm_map_marker_add().
21495 * Some properties and functions can be set by class, as:
21496 * - style, with elm_map_group_class_style_set()
21497 * - data - to be associated to the group class. It can be set using
21498 * elm_map_group_class_data_set().
21499 * - min zoom to display markers, set with
21500 * elm_map_group_class_zoom_displayed_set().
21501 * - max zoom to group markers, set using
21502 * elm_map_group_class_zoom_grouped_set().
21503 * - visibility - set if markers will be visible or not, set with
21504 * elm_map_group_class_hide_set().
21505 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21506 * It can be set using elm_map_group_class_icon_cb_set().
21508 * @see elm_map_marker_add()
21509 * @see elm_map_group_class_style_set()
21510 * @see elm_map_group_class_data_set()
21511 * @see elm_map_group_class_zoom_displayed_set()
21512 * @see elm_map_group_class_zoom_grouped_set()
21513 * @see elm_map_group_class_hide_set()
21514 * @see elm_map_group_class_icon_cb_set()
21518 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21521 * Set the marker's style of a group class.
21523 * @param clas The group class.
21524 * @param style The style to be used by markers.
21526 * Each marker must be associated to a group class, and will use the style
21527 * defined by such class when grouped to other markers.
21529 * The following styles are provided by default theme:
21530 * @li @c radio - blue circle
21531 * @li @c radio2 - green circle
21534 * @see elm_map_group_class_new() for more details.
21535 * @see elm_map_marker_add()
21539 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21542 * Set the icon callback function of a group class.
21544 * @param clas The group class.
21545 * @param icon_get The callback function that will return the icon.
21547 * Each marker must be associated to a group class, and it can display a
21548 * custom icon. The function @p icon_get must return this icon.
21550 * @see elm_map_group_class_new() for more details.
21551 * @see elm_map_marker_add()
21555 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21558 * Set the data associated to the group class.
21560 * @param clas The group class.
21561 * @param data The new user data.
21563 * This data will be passed for callback functions, like icon get callback,
21564 * that can be set with elm_map_group_class_icon_cb_set().
21566 * If a data was previously set, the object will lose the pointer for it,
21567 * so if needs to be freed, you must do it yourself.
21569 * @see elm_map_group_class_new() for more details.
21570 * @see elm_map_group_class_icon_cb_set()
21571 * @see elm_map_marker_add()
21575 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21578 * Set the minimum zoom from where the markers are displayed.
21580 * @param clas The group class.
21581 * @param zoom The minimum zoom.
21583 * Markers only will be displayed when the map is displayed at @p zoom
21586 * @see elm_map_group_class_new() for more details.
21587 * @see elm_map_marker_add()
21591 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21594 * Set the zoom from where the markers are no more grouped.
21596 * @param clas The group class.
21597 * @param zoom The maximum zoom.
21599 * Markers only will be grouped when the map is displayed at
21600 * less than @p zoom.
21602 * @see elm_map_group_class_new() for more details.
21603 * @see elm_map_marker_add()
21607 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21610 * Set if the markers associated to the group class @clas are hidden or not.
21612 * @param clas The group class.
21613 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21616 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21621 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21624 * Create a new marker class.
21626 * @param obj The map object.
21627 * @return Returns the new group class.
21629 * Each marker must be associated to a class.
21631 * The marker class defines the style of the marker when a marker is
21632 * displayed alone, i.e., not grouped to to others markers. When grouped
21633 * it will use group class style.
21635 * A marker class will need to be provided when creating a marker with
21636 * elm_map_marker_add().
21638 * Some properties and functions can be set by class, as:
21639 * - style, with elm_map_marker_class_style_set()
21640 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21641 * It can be set using elm_map_marker_class_icon_cb_set().
21642 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21643 * Set using elm_map_marker_class_get_cb_set().
21644 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21645 * Set using elm_map_marker_class_del_cb_set().
21647 * @see elm_map_marker_add()
21648 * @see elm_map_marker_class_style_set()
21649 * @see elm_map_marker_class_icon_cb_set()
21650 * @see elm_map_marker_class_get_cb_set()
21651 * @see elm_map_marker_class_del_cb_set()
21655 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21658 * Set the marker's style of a marker class.
21660 * @param clas The marker class.
21661 * @param style The style to be used by markers.
21663 * Each marker must be associated to a marker class, and will use the style
21664 * defined by such class when alone, i.e., @b not grouped to other markers.
21666 * The following styles are provided by default theme:
21671 * @see elm_map_marker_class_new() for more details.
21672 * @see elm_map_marker_add()
21676 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21679 * Set the icon callback function of a marker class.
21681 * @param clas The marker class.
21682 * @param icon_get The callback function that will return the icon.
21684 * Each marker must be associated to a marker class, and it can display a
21685 * custom icon. The function @p icon_get must return this icon.
21687 * @see elm_map_marker_class_new() for more details.
21688 * @see elm_map_marker_add()
21692 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21695 * Set the bubble content callback function of a marker class.
21697 * @param clas The marker class.
21698 * @param get The callback function that will return the content.
21700 * Each marker must be associated to a marker class, and it can display a
21701 * a content on a bubble that opens when the user click over the marker.
21702 * The function @p get must return this content object.
21704 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21707 * @see elm_map_marker_class_new() for more details.
21708 * @see elm_map_marker_class_del_cb_set()
21709 * @see elm_map_marker_add()
21713 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21716 * Set the callback function used to delete bubble content of a marker class.
21718 * @param clas The marker class.
21719 * @param del The callback function that will delete the content.
21721 * Each marker must be associated to a marker class, and it can display a
21722 * a content on a bubble that opens when the user click over the marker.
21723 * The function to return such content can be set with
21724 * elm_map_marker_class_get_cb_set().
21726 * If this content must be freed, a callback function need to be
21727 * set for that task with this function.
21729 * If this callback is defined it will have to delete (or not) the
21730 * object inside, but if the callback is not defined the object will be
21731 * destroyed with evas_object_del().
21733 * @see elm_map_marker_class_new() for more details.
21734 * @see elm_map_marker_class_get_cb_set()
21735 * @see elm_map_marker_add()
21739 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21742 * Get the list of available sources.
21744 * @param obj The map object.
21745 * @return The source names list.
21747 * It will provide a list with all available sources, that can be set as
21748 * current source with elm_map_source_name_set(), or get with
21749 * elm_map_source_name_get().
21751 * Available sources:
21757 * @see elm_map_source_name_set() for more details.
21758 * @see elm_map_source_name_get()
21762 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21765 * Set the source of the map.
21767 * @param obj The map object.
21768 * @param source The source to be used.
21770 * Map widget retrieves images that composes the map from a web service.
21771 * This web service can be set with this method.
21773 * A different service can return a different maps with different
21774 * information and it can use different zoom values.
21776 * The @p source_name need to match one of the names provided by
21777 * elm_map_source_names_get().
21779 * The current source can be get using elm_map_source_name_get().
21781 * @see elm_map_source_names_get()
21782 * @see elm_map_source_name_get()
21787 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21790 * Get the name of currently used source.
21792 * @param obj The map object.
21793 * @return Returns the name of the source in use.
21795 * @see elm_map_source_name_set() for more details.
21799 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21802 * Set the source of the route service to be used by the map.
21804 * @param obj The map object.
21805 * @param source The route service to be used, being it one of
21806 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21807 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21809 * Each one has its own algorithm, so the route retrieved may
21810 * differ depending on the source route. Now, only the default is working.
21812 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21813 * http://www.yournavigation.org/.
21815 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21816 * assumptions. Its routing core is based on Contraction Hierarchies.
21818 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21820 * @see elm_map_route_source_get().
21824 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21827 * Get the current route source.
21829 * @param obj The map object.
21830 * @return The source of the route service used by the map.
21832 * @see elm_map_route_source_set() for details.
21836 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21839 * Set the minimum zoom of the source.
21841 * @param obj The map object.
21842 * @param zoom New minimum zoom value to be used.
21844 * By default, it's 0.
21848 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21851 * Get the minimum zoom of the source.
21853 * @param obj The map object.
21854 * @return Returns the minimum zoom of the source.
21856 * @see elm_map_source_zoom_min_set() for details.
21860 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21863 * Set the maximum zoom of the source.
21865 * @param obj The map object.
21866 * @param zoom New maximum zoom value to be used.
21868 * By default, it's 18.
21872 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21875 * Get the maximum zoom of the source.
21877 * @param obj The map object.
21878 * @return Returns the maximum zoom of the source.
21880 * @see elm_map_source_zoom_min_set() for details.
21884 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21887 * Set the user agent used by the map object to access routing services.
21889 * @param obj The map object.
21890 * @param user_agent The user agent to be used by the map.
21892 * User agent is a client application implementing a network protocol used
21893 * in communications within a client–server distributed computing system
21895 * The @p user_agent identification string will transmitted in a header
21896 * field @c User-Agent.
21898 * @see elm_map_user_agent_get()
21902 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21905 * Get the user agent used by the map object.
21907 * @param obj The map object.
21908 * @return The user agent identification string used by the map.
21910 * @see elm_map_user_agent_set() for details.
21914 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21917 * Add a new route to the map object.
21919 * @param obj The map object.
21920 * @param type The type of transport to be considered when tracing a route.
21921 * @param method The routing method, what should be priorized.
21922 * @param flon The start longitude.
21923 * @param flat The start latitude.
21924 * @param tlon The destination longitude.
21925 * @param tlat The destination latitude.
21927 * @return The created route or @c NULL upon failure.
21929 * A route will be traced by point on coordinates (@p flat, @p flon)
21930 * to point on coordinates (@p tlat, @p tlon), using the route service
21931 * set with elm_map_route_source_set().
21933 * It will take @p type on consideration to define the route,
21934 * depending if the user will be walking or driving, the route may vary.
21935 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21936 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21938 * Another parameter is what the route should priorize, the minor distance
21939 * or the less time to be spend on the route. So @p method should be one
21940 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21942 * Routes created with this method can be deleted with
21943 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21944 * and distance can be get with elm_map_route_distance_get().
21946 * @see elm_map_route_remove()
21947 * @see elm_map_route_color_set()
21948 * @see elm_map_route_distance_get()
21949 * @see elm_map_route_source_set()
21953 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);
21956 * Remove a route from the map.
21958 * @param route The route to remove.
21960 * @see elm_map_route_add()
21964 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21967 * Set the route color.
21969 * @param route The route object.
21970 * @param r Red channel value, from 0 to 255.
21971 * @param g Green channel value, from 0 to 255.
21972 * @param b Blue channel value, from 0 to 255.
21973 * @param a Alpha channel value, from 0 to 255.
21975 * It uses an additive color model, so each color channel represents
21976 * how much of each primary colors must to be used. 0 represents
21977 * ausence of this color, so if all of the three are set to 0,
21978 * the color will be black.
21980 * These component values should be integers in the range 0 to 255,
21981 * (single 8-bit byte).
21983 * This sets the color used for the route. By default, it is set to
21984 * solid red (r = 255, g = 0, b = 0, a = 255).
21986 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21988 * @see elm_map_route_color_get()
21992 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21995 * Get the route color.
21997 * @param route The route object.
21998 * @param r Pointer where to store the red channel value.
21999 * @param g Pointer where to store the green channel value.
22000 * @param b Pointer where to store the blue channel value.
22001 * @param a Pointer where to store the alpha channel value.
22003 * @see elm_map_route_color_set() for details.
22007 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22010 * Get the route distance in kilometers.
22012 * @param route The route object.
22013 * @return The distance of route (unit : km).
22017 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22020 * Get the information of route nodes.
22022 * @param route The route object.
22023 * @return Returns a string with the nodes of route.
22027 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22030 * Get the information of route waypoint.
22032 * @param route the route object.
22033 * @return Returns a string with information about waypoint of route.
22037 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22040 * Get the address of the name.
22042 * @param name The name handle.
22043 * @return Returns the address string of @p name.
22045 * This gets the coordinates of the @p name, created with one of the
22046 * conversion functions.
22048 * @see elm_map_utils_convert_name_into_coord()
22049 * @see elm_map_utils_convert_coord_into_name()
22053 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22056 * Get the current coordinates of the name.
22058 * @param name The name handle.
22059 * @param lat Pointer where to store the latitude.
22060 * @param lon Pointer where to store The longitude.
22062 * This gets the coordinates of the @p name, created with one of the
22063 * conversion functions.
22065 * @see elm_map_utils_convert_name_into_coord()
22066 * @see elm_map_utils_convert_coord_into_name()
22070 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22073 * Remove a name from the map.
22075 * @param name The name to remove.
22077 * Basically the struct handled by @p name will be freed, so convertions
22078 * between address and coordinates will be lost.
22080 * @see elm_map_utils_convert_name_into_coord()
22081 * @see elm_map_utils_convert_coord_into_name()
22085 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22090 * @param obj The map object.
22091 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22092 * @param cx Rotation's center horizontal position.
22093 * @param cy Rotation's center vertical position.
22095 * @see elm_map_rotate_get()
22099 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22102 * Get the rotate degree of the map
22104 * @param obj The map object
22105 * @param degree Pointer where to store degrees from 0.0 to 360.0
22106 * to rotate arount Z axis.
22107 * @param cx Pointer where to store rotation's center horizontal position.
22108 * @param cy Pointer where to store rotation's center vertical position.
22110 * @see elm_map_rotate_set() to set map rotation.
22114 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);
22117 * Enable or disable mouse wheel to be used to zoom in / out the map.
22119 * @param obj The map object.
22120 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22123 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22125 * It's disabled by default.
22127 * @see elm_map_wheel_disabled_get()
22131 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22134 * Get a value whether mouse wheel is enabled or not.
22136 * @param obj The map object.
22137 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22138 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22140 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22142 * @see elm_map_wheel_disabled_set() for details.
22146 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22150 * Add a track on the map
22152 * @param obj The map object.
22153 * @param emap The emap route object.
22154 * @return The route object. This is an elm object of type Route.
22156 * @see elm_route_add() for details.
22160 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22164 * Remove a track from the map
22166 * @param obj The map object.
22167 * @param route The track to remove.
22171 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22178 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22180 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22182 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22183 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22184 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22185 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22189 * @defgroup Panel Panel
22191 * @image html img/widget/panel/preview-00.png
22192 * @image latex img/widget/panel/preview-00.eps
22194 * @brief A panel is a type of animated container that contains subobjects.
22195 * It can be expanded or contracted by clicking the button on it's edge.
22197 * Orientations are as follows:
22198 * @li ELM_PANEL_ORIENT_TOP
22199 * @li ELM_PANEL_ORIENT_LEFT
22200 * @li ELM_PANEL_ORIENT_RIGHT
22202 * @ref tutorial_panel shows one way to use this widget.
22205 typedef enum _Elm_Panel_Orient
22207 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22208 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22209 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22210 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22211 } Elm_Panel_Orient;
22213 * @brief Adds a panel object
22215 * @param parent The parent object
22217 * @return The panel object, or NULL on failure
22219 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22221 * @brief Sets the orientation of the panel
22223 * @param parent The parent object
22224 * @param orient The panel orientation. Can be one of the following:
22225 * @li ELM_PANEL_ORIENT_TOP
22226 * @li ELM_PANEL_ORIENT_LEFT
22227 * @li ELM_PANEL_ORIENT_RIGHT
22229 * Sets from where the panel will (dis)appear.
22231 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22233 * @brief Get the orientation of the panel.
22235 * @param obj The panel object
22236 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22238 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22240 * @brief Set the content of the panel.
22242 * @param obj The panel object
22243 * @param content The panel content
22245 * Once the content object is set, a previously set one will be deleted.
22246 * If you want to keep that old content object, use the
22247 * elm_panel_content_unset() function.
22249 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22251 * @brief Get the content of the panel.
22253 * @param obj The panel object
22254 * @return The content that is being used
22256 * Return the content object which is set for this widget.
22258 * @see elm_panel_content_set()
22260 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22262 * @brief Unset the content of the panel.
22264 * @param obj The panel object
22265 * @return The content that was being used
22267 * Unparent and return the content object which was set for this widget.
22269 * @see elm_panel_content_set()
22271 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22273 * @brief Set the state of the panel.
22275 * @param obj The panel object
22276 * @param hidden If true, the panel will run the animation to contract
22278 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22280 * @brief Get the state of the panel.
22282 * @param obj The panel object
22283 * @param hidden If true, the panel is in the "hide" state
22285 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22287 * @brief Toggle the hidden state of the panel from code
22289 * @param obj The panel object
22291 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22297 * @defgroup Panes Panes
22298 * @ingroup Elementary
22300 * @image html img/widget/panes/preview-00.png
22301 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22303 * @image html img/panes.png
22304 * @image latex img/panes.eps width=\textwidth
22306 * The panes adds a dragable bar between two contents. When dragged
22307 * this bar will resize contents size.
22309 * Panes can be displayed vertically or horizontally, and contents
22310 * size proportion can be customized (homogeneous by default).
22312 * Smart callbacks one can listen to:
22313 * - "press" - The panes has been pressed (button wasn't released yet).
22314 * - "unpressed" - The panes was released after being pressed.
22315 * - "clicked" - The panes has been clicked>
22316 * - "clicked,double" - The panes has been double clicked
22318 * Available styles for it:
22321 * Here is an example on its usage:
22322 * @li @ref panes_example
22326 * @addtogroup Panes
22331 * Add a new panes widget to the given parent Elementary
22332 * (container) object.
22334 * @param parent The parent object.
22335 * @return a new panes widget handle or @c NULL, on errors.
22337 * This function inserts a new panes widget on the canvas.
22341 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22344 * Set the left content of the panes widget.
22346 * @param obj The panes object.
22347 * @param content The new left content object.
22349 * Once the content object is set, a previously set one will be deleted.
22350 * If you want to keep that old content object, use the
22351 * elm_panes_content_left_unset() function.
22353 * If panes is displayed vertically, left content will be displayed at
22356 * @see elm_panes_content_left_get()
22357 * @see elm_panes_content_right_set() to set content on the other side.
22361 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22364 * Set the right content of the panes widget.
22366 * @param obj The panes object.
22367 * @param content The new right content object.
22369 * Once the content object is set, a previously set one will be deleted.
22370 * If you want to keep that old content object, use the
22371 * elm_panes_content_right_unset() function.
22373 * If panes is displayed vertically, left content will be displayed at
22376 * @see elm_panes_content_right_get()
22377 * @see elm_panes_content_left_set() to set content on the other side.
22381 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22384 * Get the left content of the panes.
22386 * @param obj The panes object.
22387 * @return The left content object that is being used.
22389 * Return the left content object which is set for this widget.
22391 * @see elm_panes_content_left_set() for details.
22395 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22398 * Get the right content of the panes.
22400 * @param obj The panes object
22401 * @return The right content object that is being used
22403 * Return the right content object which is set for this widget.
22405 * @see elm_panes_content_right_set() for details.
22409 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22412 * Unset the left content used for the panes.
22414 * @param obj The panes object.
22415 * @return The left content object that was being used.
22417 * Unparent and return the left content object which was set for this widget.
22419 * @see elm_panes_content_left_set() for details.
22420 * @see elm_panes_content_left_get().
22424 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22427 * Unset the right content used for the panes.
22429 * @param obj The panes object.
22430 * @return The right content object that was being used.
22432 * Unparent and return the right content object which was set for this
22435 * @see elm_panes_content_right_set() for details.
22436 * @see elm_panes_content_right_get().
22440 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22443 * Get the size proportion of panes widget's left side.
22445 * @param obj The panes object.
22446 * @return float value between 0.0 and 1.0 representing size proportion
22449 * @see elm_panes_content_left_size_set() for more details.
22453 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22456 * Set the size proportion of panes widget's left side.
22458 * @param obj The panes object.
22459 * @param size Value between 0.0 and 1.0 representing size proportion
22462 * By default it's homogeneous, i.e., both sides have the same size.
22464 * If something different is required, it can be set with this function.
22465 * For example, if the left content should be displayed over
22466 * 75% of the panes size, @p size should be passed as @c 0.75.
22467 * This way, right content will be resized to 25% of panes size.
22469 * If displayed vertically, left content is displayed at top, and
22470 * right content at bottom.
22472 * @note This proportion will change when user drags the panes bar.
22474 * @see elm_panes_content_left_size_get()
22478 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22481 * Set the orientation of a given panes widget.
22483 * @param obj The panes object.
22484 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22485 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22487 * Use this function to change how your panes is to be
22488 * disposed: vertically or horizontally.
22490 * By default it's displayed horizontally.
22492 * @see elm_panes_horizontal_get()
22496 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22499 * Retrieve the orientation of a given panes widget.
22501 * @param obj The panes object.
22502 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22503 * @c EINA_FALSE if it's @b vertical (and on errors).
22505 * @see elm_panes_horizontal_set() for more details.
22509 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22516 * @defgroup Flip Flip
22518 * @image html img/widget/flip/preview-00.png
22519 * @image latex img/widget/flip/preview-00.eps
22521 * This widget holds 2 content objects(Evas_Object): one on the front and one
22522 * on the back. It allows you to flip from front to back and vice-versa using
22523 * various animations.
22525 * If either the front or back contents are not set the flip will treat that
22526 * as transparent. So if you wore to set the front content but not the back,
22527 * and then call elm_flip_go() you would see whatever is below the flip.
22529 * For a list of supported animations see elm_flip_go().
22531 * Signals that you can add callbacks for are:
22532 * "animate,begin" - when a flip animation was started
22533 * "animate,done" - when a flip animation is finished
22535 * @ref tutorial_flip show how to use most of the API.
22539 typedef enum _Elm_Flip_Mode
22541 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22542 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22543 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22544 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22545 ELM_FLIP_CUBE_LEFT,
22546 ELM_FLIP_CUBE_RIGHT,
22548 ELM_FLIP_CUBE_DOWN,
22549 ELM_FLIP_PAGE_LEFT,
22550 ELM_FLIP_PAGE_RIGHT,
22554 typedef enum _Elm_Flip_Interaction
22556 ELM_FLIP_INTERACTION_NONE,
22557 ELM_FLIP_INTERACTION_ROTATE,
22558 ELM_FLIP_INTERACTION_CUBE,
22559 ELM_FLIP_INTERACTION_PAGE
22560 } Elm_Flip_Interaction;
22561 typedef enum _Elm_Flip_Direction
22563 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22564 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22565 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22566 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22567 } Elm_Flip_Direction;
22569 * @brief Add a new flip to the parent
22571 * @param parent The parent object
22572 * @return The new object or NULL if it cannot be created
22574 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22576 * @brief Set the front content of the flip widget.
22578 * @param obj The flip object
22579 * @param content The new front content object
22581 * Once the content object is set, a previously set one will be deleted.
22582 * If you want to keep that old content object, use the
22583 * elm_flip_content_front_unset() function.
22585 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22587 * @brief Set the back content of the flip widget.
22589 * @param obj The flip object
22590 * @param content The new back content object
22592 * Once the content object is set, a previously set one will be deleted.
22593 * If you want to keep that old content object, use the
22594 * elm_flip_content_back_unset() function.
22596 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22598 * @brief Get the front content used for the flip
22600 * @param obj The flip object
22601 * @return The front content object that is being used
22603 * Return the front content object which is set for this widget.
22605 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22607 * @brief Get the back content used for the flip
22609 * @param obj The flip object
22610 * @return The back content object that is being used
22612 * Return the back content object which is set for this widget.
22614 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22616 * @brief Unset the front content used for the flip
22618 * @param obj The flip object
22619 * @return The front content object that was being used
22621 * Unparent and return the front content object which was set for this widget.
22623 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22625 * @brief Unset the back content used for the flip
22627 * @param obj The flip object
22628 * @return The back content object that was being used
22630 * Unparent and return the back content object which was set for this widget.
22632 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22634 * @brief Get flip front visibility state
22636 * @param obj The flip objct
22637 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22640 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22642 * @brief Set flip perspective
22644 * @param obj The flip object
22645 * @param foc The coordinate to set the focus on
22646 * @param x The X coordinate
22647 * @param y The Y coordinate
22649 * @warning This function currently does nothing.
22651 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22653 * @brief Runs the flip animation
22655 * @param obj The flip object
22656 * @param mode The mode type
22658 * Flips the front and back contents using the @p mode animation. This
22659 * efectively hides the currently visible content and shows the hidden one.
22661 * There a number of possible animations to use for the flipping:
22662 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22663 * around a horizontal axis in the middle of its height, the other content
22664 * is shown as the other side of the flip.
22665 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22666 * around a vertical axis in the middle of its width, the other content is
22667 * shown as the other side of the flip.
22668 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22669 * around a diagonal axis in the middle of its width, the other content is
22670 * shown as the other side of the flip.
22671 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22672 * around a diagonal axis in the middle of its height, the other content is
22673 * shown as the other side of the flip.
22674 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22675 * as if the flip was a cube, the other content is show as the right face of
22677 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22678 * right as if the flip was a cube, the other content is show as the left
22679 * face of the cube.
22680 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22681 * flip was a cube, the other content is show as the bottom face of the cube.
22682 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22683 * the flip was a cube, the other content is show as the upper face of the
22685 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22686 * if the flip was a book, the other content is shown as the page below that.
22687 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22688 * as if the flip was a book, the other content is shown as the page below
22690 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22691 * flip was a book, the other content is shown as the page below that.
22692 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22693 * flip was a book, the other content is shown as the page below that.
22695 * @image html elm_flip.png
22696 * @image latex elm_flip.eps width=\textwidth
22698 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22700 * @brief Set the interactive flip mode
22702 * @param obj The flip object
22703 * @param mode The interactive flip mode to use
22705 * This sets if the flip should be interactive (allow user to click and
22706 * drag a side of the flip to reveal the back page and cause it to flip).
22707 * By default a flip is not interactive. You may also need to set which
22708 * sides of the flip are "active" for flipping and how much space they use
22709 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22710 * and elm_flip_interacton_direction_hitsize_set()
22712 * The four avilable mode of interaction are:
22713 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22714 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22715 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22716 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22718 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22719 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22720 * happen, those can only be acheived with elm_flip_go();
22722 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22724 * @brief Get the interactive flip mode
22726 * @param obj The flip object
22727 * @return The interactive flip mode
22729 * Returns the interactive flip mode set by elm_flip_interaction_set()
22731 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22733 * @brief Set which directions of the flip respond to interactive flip
22735 * @param obj The flip object
22736 * @param dir The direction to change
22737 * @param enabled If that direction is enabled or not
22739 * By default all directions are disabled, so you may want to enable the
22740 * desired directions for flipping if you need interactive flipping. You must
22741 * call this function once for each direction that should be enabled.
22743 * @see elm_flip_interaction_set()
22745 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22747 * @brief Get the enabled state of that flip direction
22749 * @param obj The flip object
22750 * @param dir The direction to check
22751 * @return If that direction is enabled or not
22753 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22755 * @see elm_flip_interaction_set()
22757 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22759 * @brief Set the amount of the flip that is sensitive to interactive flip
22761 * @param obj The flip object
22762 * @param dir The direction to modify
22763 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22765 * Set the amount of the flip that is sensitive to interactive flip, with 0
22766 * representing no area in the flip and 1 representing the entire flip. There
22767 * is however a consideration to be made in that the area will never be
22768 * smaller than the finger size set(as set in your Elementary configuration).
22770 * @see elm_flip_interaction_set()
22772 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22774 * @brief Get the amount of the flip that is sensitive to interactive flip
22776 * @param obj The flip object
22777 * @param dir The direction to check
22778 * @return The size set for that direction
22780 * Returns the amount os sensitive area set by
22781 * elm_flip_interacton_direction_hitsize_set().
22783 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22788 /* scrolledentry */
22789 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22790 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22791 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22792 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22793 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22794 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22795 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22796 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22797 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22798 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22799 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22800 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22801 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22802 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22803 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22804 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22805 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22806 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22807 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22808 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22809 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22810 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22811 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22812 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22813 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22814 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22815 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22816 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22817 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22818 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22819 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22820 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22821 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22822 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22823 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22824 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);
22825 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22826 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22827 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);
22828 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22829 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);
22830 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22831 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22832 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22833 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22834 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22835 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22836 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22837 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22838 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);
22839 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);
22840 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);
22841 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);
22842 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);
22843 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);
22844 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22845 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22846 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22847 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22848 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22849 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22850 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22853 * @defgroup Conformant Conformant
22854 * @ingroup Elementary
22856 * @image html img/widget/conformant/preview-00.png
22857 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22859 * @image html img/conformant.png
22860 * @image latex img/conformant.eps width=\textwidth
22862 * The aim is to provide a widget that can be used in elementary apps to
22863 * account for space taken up by the indicator, virtual keypad & softkey
22864 * windows when running the illume2 module of E17.
22866 * So conformant content will be sized and positioned considering the
22867 * space required for such stuff, and when they popup, as a keyboard
22868 * shows when an entry is selected, conformant content won't change.
22870 * Available styles for it:
22873 * See how to use this widget in this example:
22874 * @ref conformant_example
22878 * @addtogroup Conformant
22883 * Add a new conformant widget to the given parent Elementary
22884 * (container) object.
22886 * @param parent The parent object.
22887 * @return A new conformant widget handle or @c NULL, on errors.
22889 * This function inserts a new conformant widget on the canvas.
22891 * @ingroup Conformant
22893 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22896 * Set the content of the conformant widget.
22898 * @param obj The conformant object.
22899 * @param content The content to be displayed by the conformant.
22901 * Content will be sized and positioned considering the space required
22902 * to display a virtual keyboard. So it won't fill all the conformant
22903 * size. This way is possible to be sure that content won't resize
22904 * or be re-positioned after the keyboard is displayed.
22906 * Once the content object is set, a previously set one will be deleted.
22907 * If you want to keep that old content object, use the
22908 * elm_conformat_content_unset() function.
22910 * @see elm_conformant_content_unset()
22911 * @see elm_conformant_content_get()
22913 * @ingroup Conformant
22915 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22918 * Get the content of the conformant widget.
22920 * @param obj The conformant object.
22921 * @return The content that is being used.
22923 * Return the content object which is set for this widget.
22924 * It won't be unparent from conformant. For that, use
22925 * elm_conformant_content_unset().
22927 * @see elm_conformant_content_set() for more details.
22928 * @see elm_conformant_content_unset()
22930 * @ingroup Conformant
22932 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22935 * Unset the content of the conformant widget.
22937 * @param obj The conformant object.
22938 * @return The content that was being used.
22940 * Unparent and return the content object which was set for this widget.
22942 * @see elm_conformant_content_set() for more details.
22944 * @ingroup Conformant
22946 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22949 * Returns the Evas_Object that represents the content area.
22951 * @param obj The conformant object.
22952 * @return The content area of the widget.
22954 * @ingroup Conformant
22956 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22963 * @defgroup Mapbuf Mapbuf
22964 * @ingroup Elementary
22966 * @image html img/widget/mapbuf/preview-00.png
22967 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22969 * This holds one content object and uses an Evas Map of transformation
22970 * points to be later used with this content. So the content will be
22971 * moved, resized, etc as a single image. So it will improve performance
22972 * when you have a complex interafce, with a lot of elements, and will
22973 * need to resize or move it frequently (the content object and its
22976 * See how to use this widget in this example:
22977 * @ref mapbuf_example
22981 * @addtogroup Mapbuf
22986 * Add a new mapbuf widget to the given parent Elementary
22987 * (container) object.
22989 * @param parent The parent object.
22990 * @return A new mapbuf widget handle or @c NULL, on errors.
22992 * This function inserts a new mapbuf widget on the canvas.
22996 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22999 * Set the content of the mapbuf.
23001 * @param obj The mapbuf object.
23002 * @param content The content that will be filled in this mapbuf object.
23004 * Once the content object is set, a previously set one will be deleted.
23005 * If you want to keep that old content object, use the
23006 * elm_mapbuf_content_unset() function.
23008 * To enable map, elm_mapbuf_enabled_set() should be used.
23012 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23015 * Get the content of the mapbuf.
23017 * @param obj The mapbuf object.
23018 * @return The content that is being used.
23020 * Return the content object which is set for this widget.
23022 * @see elm_mapbuf_content_set() for details.
23026 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23029 * Unset the content of the mapbuf.
23031 * @param obj The mapbuf object.
23032 * @return The content that was being used.
23034 * Unparent and return the content object which was set for this widget.
23036 * @see elm_mapbuf_content_set() for details.
23040 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23043 * Enable or disable the map.
23045 * @param obj The mapbuf object.
23046 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23048 * This enables the map that is set or disables it. On enable, the object
23049 * geometry will be saved, and the new geometry will change (position and
23050 * size) to reflect the map geometry set.
23052 * Also, when enabled, alpha and smooth states will be used, so if the
23053 * content isn't solid, alpha should be enabled, for example, otherwise
23054 * a black retangle will fill the content.
23056 * When disabled, the stored map will be freed and geometry prior to
23057 * enabling the map will be restored.
23059 * It's disabled by default.
23061 * @see elm_mapbuf_alpha_set()
23062 * @see elm_mapbuf_smooth_set()
23066 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23069 * Get a value whether map is enabled or not.
23071 * @param obj The mapbuf object.
23072 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23073 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23075 * @see elm_mapbuf_enabled_set() for details.
23079 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23082 * Enable or disable smooth map rendering.
23084 * @param obj The mapbuf object.
23085 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23088 * This sets smoothing for map rendering. If the object is a type that has
23089 * its own smoothing settings, then both the smooth settings for this object
23090 * and the map must be turned off.
23092 * By default smooth maps are enabled.
23096 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23099 * Get a value whether smooth map rendering is enabled or not.
23101 * @param obj The mapbuf object.
23102 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23103 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23105 * @see elm_mapbuf_smooth_set() for details.
23109 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23112 * Set or unset alpha flag for map rendering.
23114 * @param obj The mapbuf object.
23115 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23118 * This sets alpha flag for map rendering. If the object is a type that has
23119 * its own alpha settings, then this will take precedence. Only image objects
23120 * have this currently. It stops alpha blending of the map area, and is
23121 * useful if you know the object and/or all sub-objects is 100% solid.
23123 * Alpha is enabled by default.
23127 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23130 * Get a value whether alpha blending is enabled or not.
23132 * @param obj The mapbuf object.
23133 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23134 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23136 * @see elm_mapbuf_alpha_set() for details.
23140 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23147 * @defgroup Flipselector Flip Selector
23149 * @image html img/widget/flipselector/preview-00.png
23150 * @image latex img/widget/flipselector/preview-00.eps
23152 * A flip selector is a widget to show a set of @b text items, one
23153 * at a time, with the same sheet switching style as the @ref Clock
23154 * "clock" widget, when one changes the current displaying sheet
23155 * (thus, the "flip" in the name).
23157 * User clicks to flip sheets which are @b held for some time will
23158 * make the flip selector to flip continuosly and automatically for
23159 * the user. The interval between flips will keep growing in time,
23160 * so that it helps the user to reach an item which is distant from
23161 * the current selection.
23163 * Smart callbacks one can register to:
23164 * - @c "selected" - when the widget's selected text item is changed
23165 * - @c "overflowed" - when the widget's current selection is changed
23166 * from the first item in its list to the last
23167 * - @c "underflowed" - when the widget's current selection is changed
23168 * from the last item in its list to the first
23170 * Available styles for it:
23173 * Here is an example on its usage:
23174 * @li @ref flipselector_example
23178 * @addtogroup Flipselector
23182 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23185 * Add a new flip selector widget to the given parent Elementary
23186 * (container) widget
23188 * @param parent The parent object
23189 * @return a new flip selector widget handle or @c NULL, on errors
23191 * This function inserts a new flip selector widget on the canvas.
23193 * @ingroup Flipselector
23195 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23198 * Programmatically select the next item of a flip selector widget
23200 * @param obj The flipselector object
23202 * @note The selection will be animated. Also, if it reaches the
23203 * end of its list of member items, it will continue with the first
23206 * @ingroup Flipselector
23208 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23211 * Programmatically select the previous item of a flip selector
23214 * @param obj The flipselector object
23216 * @note The selection will be animated. Also, if it reaches the
23217 * beginning of its list of member items, it will continue with the
23218 * last one backwards.
23220 * @ingroup Flipselector
23222 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23225 * Append a (text) item to a flip selector widget
23227 * @param obj The flipselector object
23228 * @param label The (text) label of the new item
23229 * @param func Convenience callback function to take place when
23231 * @param data Data passed to @p func, above
23232 * @return A handle to the item added or @c NULL, on errors
23234 * The widget's list of labels to show will be appended with the
23235 * given value. If the user wishes so, a callback function pointer
23236 * can be passed, which will get called when this same item is
23239 * @note The current selection @b won't be modified by appending an
23240 * element to the list.
23242 * @note The maximum length of the text label is going to be
23243 * determined <b>by the widget's theme</b>. Strings larger than
23244 * that value are going to be @b truncated.
23246 * @ingroup Flipselector
23248 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23251 * Prepend a (text) item to a flip selector widget
23253 * @param obj The flipselector object
23254 * @param label The (text) label of the new item
23255 * @param func Convenience callback function to take place when
23257 * @param data Data passed to @p func, above
23258 * @return A handle to the item added or @c NULL, on errors
23260 * The widget's list of labels to show will be prepended with the
23261 * given value. If the user wishes so, a callback function pointer
23262 * can be passed, which will get called when this same item is
23265 * @note The current selection @b won't be modified by prepending
23266 * an element to the list.
23268 * @note The maximum length of the text label is going to be
23269 * determined <b>by the widget's theme</b>. Strings larger than
23270 * that value are going to be @b truncated.
23272 * @ingroup Flipselector
23274 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23277 * Get the internal list of items in a given flip selector widget.
23279 * @param obj The flipselector object
23280 * @return The list of items (#Elm_Flipselector_Item as data) or
23281 * @c NULL on errors.
23283 * This list is @b not to be modified in any way and must not be
23284 * freed. Use the list members with functions like
23285 * elm_flipselector_item_label_set(),
23286 * elm_flipselector_item_label_get(),
23287 * elm_flipselector_item_del(),
23288 * elm_flipselector_item_selected_get(),
23289 * elm_flipselector_item_selected_set().
23291 * @warning This list is only valid until @p obj object's internal
23292 * items list is changed. It should be fetched again with another
23293 * call to this function when changes happen.
23295 * @ingroup Flipselector
23297 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23300 * Get the first item in the given flip selector widget's list of
23303 * @param obj The flipselector object
23304 * @return The first item or @c NULL, if it has no items (and on
23307 * @see elm_flipselector_item_append()
23308 * @see elm_flipselector_last_item_get()
23310 * @ingroup Flipselector
23312 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23315 * Get the last item in the given flip selector widget's list of
23318 * @param obj The flipselector object
23319 * @return The last item or @c NULL, if it has no items (and on
23322 * @see elm_flipselector_item_prepend()
23323 * @see elm_flipselector_first_item_get()
23325 * @ingroup Flipselector
23327 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23330 * Get the currently selected item in a flip selector widget.
23332 * @param obj The flipselector object
23333 * @return The selected item or @c NULL, if the widget has no items
23336 * @ingroup Flipselector
23338 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23341 * Set whether a given flip selector widget's item should be the
23342 * currently selected one.
23344 * @param item The flip selector item
23345 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23347 * This sets whether @p item is or not the selected (thus, under
23348 * display) one. If @p item is different than one under display,
23349 * the latter will be unselected. If the @p item is set to be
23350 * unselected, on the other hand, the @b first item in the widget's
23351 * internal members list will be the new selected one.
23353 * @see elm_flipselector_item_selected_get()
23355 * @ingroup Flipselector
23357 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23360 * Get whether a given flip selector widget's item is the currently
23363 * @param item The flip selector item
23364 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23367 * @see elm_flipselector_item_selected_set()
23369 * @ingroup Flipselector
23371 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23374 * Delete a given item from a flip selector widget.
23376 * @param item The item to delete
23378 * @ingroup Flipselector
23380 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23383 * Get the label of a given flip selector widget's item.
23385 * @param item The item to get label from
23386 * @return The text label of @p item or @c NULL, on errors
23388 * @see elm_flipselector_item_label_set()
23390 * @ingroup Flipselector
23392 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23395 * Set the label of a given flip selector widget's item.
23397 * @param item The item to set label on
23398 * @param label The text label string, in UTF-8 encoding
23400 * @see elm_flipselector_item_label_get()
23402 * @ingroup Flipselector
23404 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23407 * Gets the item before @p item in a flip selector widget's
23408 * internal list of items.
23410 * @param item The item to fetch previous from
23411 * @return The item before the @p item, in its parent's list. If
23412 * there is no previous item for @p item or there's an
23413 * error, @c NULL is returned.
23415 * @see elm_flipselector_item_next_get()
23417 * @ingroup Flipselector
23419 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23422 * Gets the item after @p item in a flip selector widget's
23423 * internal list of items.
23425 * @param item The item to fetch next from
23426 * @return The item after the @p item, in its parent's list. If
23427 * there is no next item for @p item or there's an
23428 * error, @c NULL is returned.
23430 * @see elm_flipselector_item_next_get()
23432 * @ingroup Flipselector
23434 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23437 * Set the interval on time updates for an user mouse button hold
23438 * on a flip selector widget.
23440 * @param obj The flip selector object
23441 * @param interval The (first) interval value in seconds
23443 * This interval value is @b decreased while the user holds the
23444 * mouse pointer either flipping up or flipping doww a given flip
23447 * This helps the user to get to a given item distant from the
23448 * current one easier/faster, as it will start to flip quicker and
23449 * quicker on mouse button holds.
23451 * The calculation for the next flip interval value, starting from
23452 * the one set with this call, is the previous interval divided by
23453 * 1.05, so it decreases a little bit.
23455 * The default starting interval value for automatic flips is
23458 * @see elm_flipselector_interval_get()
23460 * @ingroup Flipselector
23462 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23465 * Get the interval on time updates for an user mouse button hold
23466 * on a flip selector widget.
23468 * @param obj The flip selector object
23469 * @return The (first) interval value, in seconds, set on it
23471 * @see elm_flipselector_interval_set() for more details
23473 * @ingroup Flipselector
23475 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23481 * @addtogroup Calendar
23486 * @enum _Elm_Calendar_Mark_Repeat
23487 * @typedef Elm_Calendar_Mark_Repeat
23489 * Event periodicity, used to define if a mark should be repeated
23490 * @b beyond event's day. It's set when a mark is added.
23492 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23493 * there will be marks every week after this date. Marks will be displayed
23494 * at 13th, 20th, 27th, 3rd June ...
23496 * Values don't work as bitmask, only one can be choosen.
23498 * @see elm_calendar_mark_add()
23500 * @ingroup Calendar
23502 typedef enum _Elm_Calendar_Mark_Repeat
23504 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23505 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23506 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23507 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*/
23508 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. */
23509 } Elm_Calendar_Mark_Repeat;
23511 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(). */
23514 * Add a new calendar widget to the given parent Elementary
23515 * (container) object.
23517 * @param parent The parent object.
23518 * @return a new calendar widget handle or @c NULL, on errors.
23520 * This function inserts a new calendar widget on the canvas.
23522 * @ref calendar_example_01
23524 * @ingroup Calendar
23526 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23529 * Get weekdays names displayed by the calendar.
23531 * @param obj The calendar object.
23532 * @return Array of seven strings to be used as weekday names.
23534 * By default, weekdays abbreviations get from system are displayed:
23535 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23536 * The first string is related to Sunday, the second to Monday...
23538 * @see elm_calendar_weekdays_name_set()
23540 * @ref calendar_example_05
23542 * @ingroup Calendar
23544 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23547 * Set weekdays names to be displayed by the calendar.
23549 * @param obj The calendar object.
23550 * @param weekdays Array of seven strings to be used as weekday names.
23551 * @warning It must have 7 elements, or it will access invalid memory.
23552 * @warning The strings must be NULL terminated ('@\0').
23554 * By default, weekdays abbreviations get from system are displayed:
23555 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23557 * The first string should be related to Sunday, the second to Monday...
23559 * The usage should be like this:
23561 * const char *weekdays[] =
23563 * "Sunday", "Monday", "Tuesday", "Wednesday",
23564 * "Thursday", "Friday", "Saturday"
23566 * elm_calendar_weekdays_names_set(calendar, weekdays);
23569 * @see elm_calendar_weekdays_name_get()
23571 * @ref calendar_example_02
23573 * @ingroup Calendar
23575 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23578 * Set the minimum and maximum values for the year
23580 * @param obj The calendar object
23581 * @param min The minimum year, greater than 1901;
23582 * @param max The maximum year;
23584 * Maximum must be greater than minimum, except if you don't wan't to set
23586 * Default values are 1902 and -1.
23588 * If the maximum year is a negative value, it will be limited depending
23589 * on the platform architecture (year 2037 for 32 bits);
23591 * @see elm_calendar_min_max_year_get()
23593 * @ref calendar_example_03
23595 * @ingroup Calendar
23597 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23600 * Get the minimum and maximum values for the year
23602 * @param obj The calendar object.
23603 * @param min The minimum year.
23604 * @param max The maximum year.
23606 * Default values are 1902 and -1.
23608 * @see elm_calendar_min_max_year_get() for more details.
23610 * @ref calendar_example_05
23612 * @ingroup Calendar
23614 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23617 * Enable or disable day selection
23619 * @param obj The calendar object.
23620 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23623 * Enabled by default. If disabled, the user still can select months,
23624 * but not days. Selected days are highlighted on calendar.
23625 * It should be used if you won't need such selection for the widget usage.
23627 * When a day is selected, or month is changed, smart callbacks for
23628 * signal "changed" will be called.
23630 * @see elm_calendar_day_selection_enable_get()
23632 * @ref calendar_example_04
23634 * @ingroup Calendar
23636 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23639 * Get a value whether day selection is enabled or not.
23641 * @see elm_calendar_day_selection_enable_set() for details.
23643 * @param obj The calendar object.
23644 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23645 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23647 * @ref calendar_example_05
23649 * @ingroup Calendar
23651 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23655 * Set selected date to be highlighted on calendar.
23657 * @param obj The calendar object.
23658 * @param selected_time A @b tm struct to represent the selected date.
23660 * Set the selected date, changing the displayed month if needed.
23661 * Selected date changes when the user goes to next/previous month or
23662 * select a day pressing over it on calendar.
23664 * @see elm_calendar_selected_time_get()
23666 * @ref calendar_example_04
23668 * @ingroup Calendar
23670 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23673 * Get selected date.
23675 * @param obj The calendar object
23676 * @param selected_time A @b tm struct to point to selected date
23677 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23680 * Get date selected by the user or set by function
23681 * elm_calendar_selected_time_set().
23682 * Selected date changes when the user goes to next/previous month or
23683 * select a day pressing over it on calendar.
23685 * @see elm_calendar_selected_time_get()
23687 * @ref calendar_example_05
23689 * @ingroup Calendar
23691 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23694 * Set a function to format the string that will be used to display
23697 * @param obj The calendar object
23698 * @param format_function Function to set the month-year string given
23699 * the selected date
23701 * By default it uses strftime with "%B %Y" format string.
23702 * It should allocate the memory that will be used by the string,
23703 * that will be freed by the widget after usage.
23704 * A pointer to the string and a pointer to the time struct will be provided.
23709 * _format_month_year(struct tm *selected_time)
23712 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23713 * return strdup(buf);
23716 * elm_calendar_format_function_set(calendar, _format_month_year);
23719 * @ref calendar_example_02
23721 * @ingroup Calendar
23723 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23726 * Add a new mark to the calendar
23728 * @param obj The calendar object
23729 * @param mark_type A string used to define the type of mark. It will be
23730 * emitted to the theme, that should display a related modification on these
23731 * days representation.
23732 * @param mark_time A time struct to represent the date of inclusion of the
23733 * mark. For marks that repeats it will just be displayed after the inclusion
23734 * date in the calendar.
23735 * @param repeat Repeat the event following this periodicity. Can be a unique
23736 * mark (that don't repeat), daily, weekly, monthly or annually.
23737 * @return The created mark or @p NULL upon failure.
23739 * Add a mark that will be drawn in the calendar respecting the insertion
23740 * time and periodicity. It will emit the type as signal to the widget theme.
23741 * Default theme supports "holiday" and "checked", but it can be extended.
23743 * It won't immediately update the calendar, drawing the marks.
23744 * For this, call elm_calendar_marks_draw(). However, when user selects
23745 * next or previous month calendar forces marks drawn.
23747 * Marks created with this method can be deleted with
23748 * elm_calendar_mark_del().
23752 * struct tm selected_time;
23753 * time_t current_time;
23755 * current_time = time(NULL) + 5 * 84600;
23756 * localtime_r(¤t_time, &selected_time);
23757 * elm_calendar_mark_add(cal, "holiday", selected_time,
23758 * ELM_CALENDAR_ANNUALLY);
23760 * current_time = time(NULL) + 1 * 84600;
23761 * localtime_r(¤t_time, &selected_time);
23762 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23764 * elm_calendar_marks_draw(cal);
23767 * @see elm_calendar_marks_draw()
23768 * @see elm_calendar_mark_del()
23770 * @ref calendar_example_06
23772 * @ingroup Calendar
23774 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);
23777 * Delete mark from the calendar.
23779 * @param mark The mark to be deleted.
23781 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23782 * should be used instead of getting marks list and deleting each one.
23784 * @see elm_calendar_mark_add()
23786 * @ref calendar_example_06
23788 * @ingroup Calendar
23790 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23793 * Remove all calendar's marks
23795 * @param obj The calendar object.
23797 * @see elm_calendar_mark_add()
23798 * @see elm_calendar_mark_del()
23800 * @ingroup Calendar
23802 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23806 * Get a list of all the calendar marks.
23808 * @param obj The calendar object.
23809 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23811 * @see elm_calendar_mark_add()
23812 * @see elm_calendar_mark_del()
23813 * @see elm_calendar_marks_clear()
23815 * @ingroup Calendar
23817 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23820 * Draw calendar marks.
23822 * @param obj The calendar object.
23824 * Should be used after adding, removing or clearing marks.
23825 * It will go through the entire marks list updating the calendar.
23826 * If lots of marks will be added, add all the marks and then call
23829 * When the month is changed, i.e. user selects next or previous month,
23830 * marks will be drawed.
23832 * @see elm_calendar_mark_add()
23833 * @see elm_calendar_mark_del()
23834 * @see elm_calendar_marks_clear()
23836 * @ref calendar_example_06
23838 * @ingroup Calendar
23840 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23843 * Set a day text color to the same that represents Saturdays.
23845 * @param obj The calendar object.
23846 * @param pos The text position. Position is the cell counter, from left
23847 * to right, up to down. It starts on 0 and ends on 41.
23849 * @deprecated use elm_calendar_mark_add() instead like:
23852 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23853 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23856 * @see elm_calendar_mark_add()
23858 * @ingroup Calendar
23860 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23863 * Set a day text color to the same that represents Sundays.
23865 * @param obj The calendar object.
23866 * @param pos The text position. Position is the cell counter, from left
23867 * to right, up to down. It starts on 0 and ends on 41.
23869 * @deprecated use elm_calendar_mark_add() instead like:
23872 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23873 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23876 * @see elm_calendar_mark_add()
23878 * @ingroup Calendar
23880 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23883 * Set a day text color to the same that represents Weekdays.
23885 * @param obj The calendar object
23886 * @param pos The text position. Position is the cell counter, from left
23887 * to right, up to down. It starts on 0 and ends on 41.
23889 * @deprecated use elm_calendar_mark_add() instead like:
23892 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23894 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23895 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23896 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23897 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23898 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23899 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23900 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23901 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23902 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23905 * @see elm_calendar_mark_add()
23907 * @ingroup Calendar
23909 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23912 * Set the interval on time updates for an user mouse button hold
23913 * on calendar widgets' month selection.
23915 * @param obj The calendar object
23916 * @param interval The (first) interval value in seconds
23918 * This interval value is @b decreased while the user holds the
23919 * mouse pointer either selecting next or previous month.
23921 * This helps the user to get to a given month distant from the
23922 * current one easier/faster, as it will start to change quicker and
23923 * quicker on mouse button holds.
23925 * The calculation for the next change interval value, starting from
23926 * the one set with this call, is the previous interval divided by
23927 * 1.05, so it decreases a little bit.
23929 * The default starting interval value for automatic changes is
23932 * @see elm_calendar_interval_get()
23934 * @ingroup Calendar
23936 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23939 * Get the interval on time updates for an user mouse button hold
23940 * on calendar widgets' month selection.
23942 * @param obj The calendar object
23943 * @return The (first) interval value, in seconds, set on it
23945 * @see elm_calendar_interval_set() for more details
23947 * @ingroup Calendar
23949 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23956 * @defgroup Diskselector Diskselector
23957 * @ingroup Elementary
23959 * @image html img/widget/diskselector/preview-00.png
23960 * @image latex img/widget/diskselector/preview-00.eps
23962 * A diskselector is a kind of list widget. It scrolls horizontally,
23963 * and can contain label and icon objects. Three items are displayed
23964 * with the selected one in the middle.
23966 * It can act like a circular list with round mode and labels can be
23967 * reduced for a defined length for side items.
23969 * Smart callbacks one can listen to:
23970 * - "selected" - when item is selected, i.e. scroller stops.
23972 * Available styles for it:
23975 * List of examples:
23976 * @li @ref diskselector_example_01
23977 * @li @ref diskselector_example_02
23981 * @addtogroup Diskselector
23985 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(). */
23988 * Add a new diskselector widget to the given parent Elementary
23989 * (container) object.
23991 * @param parent The parent object.
23992 * @return a new diskselector widget handle or @c NULL, on errors.
23994 * This function inserts a new diskselector widget on the canvas.
23996 * @ingroup Diskselector
23998 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24001 * Enable or disable round mode.
24003 * @param obj The diskselector object.
24004 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24007 * Disabled by default. If round mode is enabled the items list will
24008 * work like a circle list, so when the user reaches the last item,
24009 * the first one will popup.
24011 * @see elm_diskselector_round_get()
24013 * @ingroup Diskselector
24015 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24018 * Get a value whether round mode is enabled or not.
24020 * @see elm_diskselector_round_set() for details.
24022 * @param obj The diskselector object.
24023 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24024 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24026 * @ingroup Diskselector
24028 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24031 * Get the side labels max length.
24033 * @deprecated use elm_diskselector_side_label_length_get() instead:
24035 * @param obj The diskselector object.
24036 * @return The max length defined for side labels, or 0 if not a valid
24039 * @ingroup Diskselector
24041 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24044 * Set the side labels max length.
24046 * @deprecated use elm_diskselector_side_label_length_set() instead:
24048 * @param obj The diskselector object.
24049 * @param len The max length defined for side labels.
24051 * @ingroup Diskselector
24053 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24056 * Get the side labels max length.
24058 * @see elm_diskselector_side_label_length_set() for details.
24060 * @param obj The diskselector object.
24061 * @return The max length defined for side labels, or 0 if not a valid
24064 * @ingroup Diskselector
24066 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24069 * Set the side labels max length.
24071 * @param obj The diskselector object.
24072 * @param len The max length defined for side labels.
24074 * Length is the number of characters of items' label that will be
24075 * visible when it's set on side positions. It will just crop
24076 * the string after defined size. E.g.:
24078 * An item with label "January" would be displayed on side position as
24079 * "Jan" if max length is set to 3, or "Janu", if this property
24082 * When it's selected, the entire label will be displayed, except for
24083 * width restrictions. In this case label will be cropped and "..."
24084 * will be concatenated.
24086 * Default side label max length is 3.
24088 * This property will be applyed over all items, included before or
24089 * later this function call.
24091 * @ingroup Diskselector
24093 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24096 * Set the number of items to be displayed.
24098 * @param obj The diskselector object.
24099 * @param num The number of items the diskselector will display.
24101 * Default value is 3, and also it's the minimun. If @p num is less
24102 * than 3, it will be set to 3.
24104 * Also, it can be set on theme, using data item @c display_item_num
24105 * on group "elm/diskselector/item/X", where X is style set.
24108 * group { name: "elm/diskselector/item/X";
24110 * item: "display_item_num" "5";
24113 * @ingroup Diskselector
24115 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24118 * Set bouncing behaviour when the scrolled content reaches an edge.
24120 * Tell the internal scroller object whether it should bounce or not
24121 * when it reaches the respective edges for each axis.
24123 * @param obj The diskselector object.
24124 * @param h_bounce Whether to bounce or not in the horizontal axis.
24125 * @param v_bounce Whether to bounce or not in the vertical axis.
24127 * @see elm_scroller_bounce_set()
24129 * @ingroup Diskselector
24131 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24134 * Get the bouncing behaviour of the internal scroller.
24136 * Get whether the internal scroller should bounce when the edge of each
24137 * axis is reached scrolling.
24139 * @param obj The diskselector object.
24140 * @param h_bounce Pointer where to store the bounce state of the horizontal
24142 * @param v_bounce Pointer where to store the bounce state of the vertical
24145 * @see elm_scroller_bounce_get()
24146 * @see elm_diskselector_bounce_set()
24148 * @ingroup Diskselector
24150 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24153 * Get the scrollbar policy.
24155 * @see elm_diskselector_scroller_policy_get() for details.
24157 * @param obj The diskselector object.
24158 * @param policy_h Pointer where to store horizontal scrollbar policy.
24159 * @param policy_v Pointer where to store vertical scrollbar policy.
24161 * @ingroup Diskselector
24163 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);
24166 * Set the scrollbar policy.
24168 * @param obj The diskselector object.
24169 * @param policy_h Horizontal scrollbar policy.
24170 * @param policy_v Vertical scrollbar policy.
24172 * This sets the scrollbar visibility policy for the given scroller.
24173 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24174 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24175 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24176 * This applies respectively for the horizontal and vertical scrollbars.
24178 * The both are disabled by default, i.e., are set to
24179 * #ELM_SCROLLER_POLICY_OFF.
24181 * @ingroup Diskselector
24183 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24186 * Remove all diskselector's items.
24188 * @param obj The diskselector object.
24190 * @see elm_diskselector_item_del()
24191 * @see elm_diskselector_item_append()
24193 * @ingroup Diskselector
24195 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24198 * Get a list of all the diskselector items.
24200 * @param obj The diskselector object.
24201 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24202 * or @c NULL on failure.
24204 * @see elm_diskselector_item_append()
24205 * @see elm_diskselector_item_del()
24206 * @see elm_diskselector_clear()
24208 * @ingroup Diskselector
24210 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24213 * Appends a new item to the diskselector object.
24215 * @param obj The diskselector object.
24216 * @param label The label of the diskselector item.
24217 * @param icon The icon object to use at left side of the item. An
24218 * icon can be any Evas object, but usually it is an icon created
24219 * with elm_icon_add().
24220 * @param func The function to call when the item is selected.
24221 * @param data The data to associate with the item for related callbacks.
24223 * @return The created item or @c NULL upon failure.
24225 * A new item will be created and appended to the diskselector, i.e., will
24226 * be set as last item. Also, if there is no selected item, it will
24227 * be selected. This will always happens for the first appended item.
24229 * If no icon is set, label will be centered on item position, otherwise
24230 * the icon will be placed at left of the label, that will be shifted
24233 * Items created with this method can be deleted with
24234 * elm_diskselector_item_del().
24236 * Associated @p data can be properly freed when item is deleted if a
24237 * callback function is set with elm_diskselector_item_del_cb_set().
24239 * If a function is passed as argument, it will be called everytime this item
24240 * is selected, i.e., the user stops the diskselector with this
24241 * item on center position. If such function isn't needed, just passing
24242 * @c NULL as @p func is enough. The same should be done for @p data.
24244 * Simple example (with no function callback or data associated):
24246 * disk = elm_diskselector_add(win);
24247 * ic = elm_icon_add(win);
24248 * elm_icon_file_set(ic, "path/to/image", NULL);
24249 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24250 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24253 * @see elm_diskselector_item_del()
24254 * @see elm_diskselector_item_del_cb_set()
24255 * @see elm_diskselector_clear()
24256 * @see elm_icon_add()
24258 * @ingroup Diskselector
24260 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);
24264 * Delete them item from the diskselector.
24266 * @param it The item of diskselector to be deleted.
24268 * If deleting all diskselector items is required, elm_diskselector_clear()
24269 * should be used instead of getting items list and deleting each one.
24271 * @see elm_diskselector_clear()
24272 * @see elm_diskselector_item_append()
24273 * @see elm_diskselector_item_del_cb_set()
24275 * @ingroup Diskselector
24277 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24280 * Set the function called when a diskselector item is freed.
24282 * @param it The item to set the callback on
24283 * @param func The function called
24285 * If there is a @p func, then it will be called prior item's memory release.
24286 * That will be called with the following arguments:
24288 * @li item's Evas object;
24291 * This way, a data associated to a diskselector item could be properly
24294 * @ingroup Diskselector
24296 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24299 * Get the data associated to the item.
24301 * @param it The diskselector item
24302 * @return The data associated to @p it
24304 * The return value is a pointer to data associated to @p item when it was
24305 * created, with function elm_diskselector_item_append(). If no data
24306 * was passed as argument, it will return @c NULL.
24308 * @see elm_diskselector_item_append()
24310 * @ingroup Diskselector
24312 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24315 * Set the icon associated to the item.
24317 * @param it The diskselector item
24318 * @param icon The icon object to associate with @p it
24320 * The icon object to use at left side of the item. An
24321 * icon can be any Evas object, but usually it is an icon created
24322 * with elm_icon_add().
24324 * Once the icon object is set, a previously set one will be deleted.
24325 * @warning Setting the same icon for two items will cause the icon to
24326 * dissapear from the first item.
24328 * If an icon was passed as argument on item creation, with function
24329 * elm_diskselector_item_append(), it will be already
24330 * associated to the item.
24332 * @see elm_diskselector_item_append()
24333 * @see elm_diskselector_item_icon_get()
24335 * @ingroup Diskselector
24337 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24340 * Get the icon associated to the item.
24342 * @param it The diskselector item
24343 * @return The icon associated to @p it
24345 * The return value is a pointer to the icon associated to @p item when it was
24346 * created, with function elm_diskselector_item_append(), or later
24347 * with function elm_diskselector_item_icon_set. If no icon
24348 * was passed as argument, it will return @c NULL.
24350 * @see elm_diskselector_item_append()
24351 * @see elm_diskselector_item_icon_set()
24353 * @ingroup Diskselector
24355 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24358 * Set the label of item.
24360 * @param it The item of diskselector.
24361 * @param label The label of item.
24363 * The label to be displayed by the item.
24365 * If no icon is set, label will be centered on item position, otherwise
24366 * the icon will be placed at left of the label, that will be shifted
24369 * An item with label "January" would be displayed on side position as
24370 * "Jan" if max length is set to 3 with function
24371 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24374 * When this @p item is selected, the entire label will be displayed,
24375 * except for width restrictions.
24376 * In this case label will be cropped and "..." will be concatenated,
24377 * but only for display purposes. It will keep the entire string, so
24378 * if diskselector is resized the remaining characters will be displayed.
24380 * If a label was passed as argument on item creation, with function
24381 * elm_diskselector_item_append(), it will be already
24382 * displayed by the item.
24384 * @see elm_diskselector_side_label_lenght_set()
24385 * @see elm_diskselector_item_label_get()
24386 * @see elm_diskselector_item_append()
24388 * @ingroup Diskselector
24390 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24393 * Get the label of item.
24395 * @param it The item of diskselector.
24396 * @return The label of item.
24398 * The return value is a pointer to the label associated to @p item when it was
24399 * created, with function elm_diskselector_item_append(), or later
24400 * with function elm_diskselector_item_label_set. If no label
24401 * was passed as argument, it will return @c NULL.
24403 * @see elm_diskselector_item_label_set() for more details.
24404 * @see elm_diskselector_item_append()
24406 * @ingroup Diskselector
24408 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24411 * Get the selected item.
24413 * @param obj The diskselector object.
24414 * @return The selected diskselector item.
24416 * The selected item can be unselected with function
24417 * elm_diskselector_item_selected_set(), and the first item of
24418 * diskselector will be selected.
24420 * The selected item always will be centered on diskselector, with
24421 * full label displayed, i.e., max lenght set to side labels won't
24422 * apply on the selected item. More details on
24423 * elm_diskselector_side_label_length_set().
24425 * @ingroup Diskselector
24427 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24430 * Set the selected state of an item.
24432 * @param it The diskselector item
24433 * @param selected The selected state
24435 * This sets the selected state of the given item @p it.
24436 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24438 * If a new item is selected the previosly selected will be unselected.
24439 * Previoulsy selected item can be get with function
24440 * elm_diskselector_selected_item_get().
24442 * If the item @p it is unselected, the first item of diskselector will
24445 * Selected items will be visible on center position of diskselector.
24446 * So if it was on another position before selected, or was invisible,
24447 * diskselector will animate items until the selected item reaches center
24450 * @see elm_diskselector_item_selected_get()
24451 * @see elm_diskselector_selected_item_get()
24453 * @ingroup Diskselector
24455 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24458 * Get whether the @p item is selected or not.
24460 * @param it The diskselector item.
24461 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24462 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24464 * @see elm_diskselector_selected_item_set() for details.
24465 * @see elm_diskselector_item_selected_get()
24467 * @ingroup Diskselector
24469 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24472 * Get the first item of the diskselector.
24474 * @param obj The diskselector object.
24475 * @return The first item, or @c NULL if none.
24477 * The list of items follows append order. So it will return the first
24478 * item appended to the widget that wasn't deleted.
24480 * @see elm_diskselector_item_append()
24481 * @see elm_diskselector_items_get()
24483 * @ingroup Diskselector
24485 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24488 * Get the last item of the diskselector.
24490 * @param obj The diskselector object.
24491 * @return The last item, or @c NULL if none.
24493 * The list of items follows append order. So it will return last first
24494 * item appended to the widget that wasn't deleted.
24496 * @see elm_diskselector_item_append()
24497 * @see elm_diskselector_items_get()
24499 * @ingroup Diskselector
24501 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24504 * Get the item before @p item in diskselector.
24506 * @param it The diskselector item.
24507 * @return The item before @p item, or @c NULL if none or on failure.
24509 * The list of items follows append order. So it will return item appended
24510 * just before @p item and that wasn't deleted.
24512 * If it is the first item, @c NULL will be returned.
24513 * First item can be get by elm_diskselector_first_item_get().
24515 * @see elm_diskselector_item_append()
24516 * @see elm_diskselector_items_get()
24518 * @ingroup Diskselector
24520 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24523 * Get the item after @p item in diskselector.
24525 * @param it The diskselector item.
24526 * @return The item after @p item, or @c NULL if none or on failure.
24528 * The list of items follows append order. So it will return item appended
24529 * just after @p item and that wasn't deleted.
24531 * If it is the last item, @c NULL will be returned.
24532 * Last item can be get by elm_diskselector_last_item_get().
24534 * @see elm_diskselector_item_append()
24535 * @see elm_diskselector_items_get()
24537 * @ingroup Diskselector
24539 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24542 * Set the text to be shown in the diskselector item.
24544 * @param item Target item
24545 * @param text The text to set in the content
24547 * Setup the text as tooltip to object. The item can have only one tooltip,
24548 * so any previous tooltip data is removed.
24550 * @see elm_object_tooltip_text_set() for more details.
24552 * @ingroup Diskselector
24554 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24557 * Set the content to be shown in the tooltip item.
24559 * Setup the tooltip to item. The item can have only one tooltip,
24560 * so any previous tooltip data is removed. @p func(with @p data) will
24561 * be called every time that need show the tooltip and it should
24562 * return a valid Evas_Object. This object is then managed fully by
24563 * tooltip system and is deleted when the tooltip is gone.
24565 * @param item the diskselector item being attached a tooltip.
24566 * @param func the function used to create the tooltip contents.
24567 * @param data what to provide to @a func as callback data/context.
24568 * @param del_cb called when data is not needed anymore, either when
24569 * another callback replaces @p func, the tooltip is unset with
24570 * elm_diskselector_item_tooltip_unset() or the owner @a item
24571 * dies. This callback receives as the first parameter the
24572 * given @a data, and @c event_info is the item.
24574 * @see elm_object_tooltip_content_cb_set() for more details.
24576 * @ingroup Diskselector
24578 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);
24581 * Unset tooltip from item.
24583 * @param item diskselector item to remove previously set tooltip.
24585 * Remove tooltip from item. The callback provided as del_cb to
24586 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24587 * it is not used anymore.
24589 * @see elm_object_tooltip_unset() for more details.
24590 * @see elm_diskselector_item_tooltip_content_cb_set()
24592 * @ingroup Diskselector
24594 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24598 * Sets a different style for this item tooltip.
24600 * @note before you set a style you should define a tooltip with
24601 * elm_diskselector_item_tooltip_content_cb_set() or
24602 * elm_diskselector_item_tooltip_text_set()
24604 * @param item diskselector item with tooltip already set.
24605 * @param style the theme style to use (default, transparent, ...)
24607 * @see elm_object_tooltip_style_set() for more details.
24609 * @ingroup Diskselector
24611 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24614 * Get the style for this item tooltip.
24616 * @param item diskselector item with tooltip already set.
24617 * @return style the theme style in use, defaults to "default". If the
24618 * object does not have a tooltip set, then NULL is returned.
24620 * @see elm_object_tooltip_style_get() for more details.
24621 * @see elm_diskselector_item_tooltip_style_set()
24623 * @ingroup Diskselector
24625 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24628 * Set the cursor to be shown when mouse is over the diskselector item
24630 * @param item Target item
24631 * @param cursor the cursor name to be used.
24633 * @see elm_object_cursor_set() for more details.
24635 * @ingroup Diskselector
24637 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24640 * Get the cursor to be shown when mouse is over the diskselector item
24642 * @param item diskselector item with cursor already set.
24643 * @return the cursor name.
24645 * @see elm_object_cursor_get() for more details.
24646 * @see elm_diskselector_cursor_set()
24648 * @ingroup Diskselector
24650 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24654 * Unset the cursor to be shown when mouse is over the diskselector item
24656 * @param item Target item
24658 * @see elm_object_cursor_unset() for more details.
24659 * @see elm_diskselector_cursor_set()
24661 * @ingroup Diskselector
24663 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24666 * Sets a different style for this item cursor.
24668 * @note before you set a style you should define a cursor with
24669 * elm_diskselector_item_cursor_set()
24671 * @param item diskselector item with cursor already set.
24672 * @param style the theme style to use (default, transparent, ...)
24674 * @see elm_object_cursor_style_set() for more details.
24676 * @ingroup Diskselector
24678 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24682 * Get the style for this item cursor.
24684 * @param item diskselector item with cursor already set.
24685 * @return style the theme style in use, defaults to "default". If the
24686 * object does not have a cursor set, then @c NULL is returned.
24688 * @see elm_object_cursor_style_get() for more details.
24689 * @see elm_diskselector_item_cursor_style_set()
24691 * @ingroup Diskselector
24693 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24697 * Set if the cursor set should be searched on the theme or should use
24698 * the provided by the engine, only.
24700 * @note before you set if should look on theme you should define a cursor
24701 * with elm_diskselector_item_cursor_set().
24702 * By default it will only look for cursors provided by the engine.
24704 * @param item widget item with cursor already set.
24705 * @param engine_only boolean to define if cursors set with
24706 * elm_diskselector_item_cursor_set() should be searched only
24707 * between cursors provided by the engine or searched on widget's
24710 * @see elm_object_cursor_engine_only_set() for more details.
24712 * @ingroup Diskselector
24714 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24717 * Get the cursor engine only usage for this item cursor.
24719 * @param item widget item with cursor already set.
24720 * @return engine_only boolean to define it cursors should be looked only
24721 * between the provided by the engine or searched on widget's theme as well.
24722 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24724 * @see elm_object_cursor_engine_only_get() for more details.
24725 * @see elm_diskselector_item_cursor_engine_only_set()
24727 * @ingroup Diskselector
24729 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24736 * @defgroup Colorselector Colorselector
24740 * @image html img/widget/colorselector/preview-00.png
24741 * @image latex img/widget/colorselector/preview-00.eps
24743 * @brief Widget for user to select a color.
24745 * Signals that you can add callbacks for are:
24746 * "changed" - When the color value changes(event_info is NULL).
24748 * See @ref tutorial_colorselector.
24751 * @brief Add a new colorselector to the parent
24753 * @param parent The parent object
24754 * @return The new object or NULL if it cannot be created
24756 * @ingroup Colorselector
24758 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24760 * Set a color for the colorselector
24762 * @param obj Colorselector object
24763 * @param r r-value of color
24764 * @param g g-value of color
24765 * @param b b-value of color
24766 * @param a a-value of color
24768 * @ingroup Colorselector
24770 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24772 * Get a color from the colorselector
24774 * @param obj Colorselector object
24775 * @param r integer pointer for r-value of color
24776 * @param g integer pointer for g-value of color
24777 * @param b integer pointer for b-value of color
24778 * @param a integer pointer for a-value of color
24780 * @ingroup Colorselector
24782 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24788 * @defgroup Ctxpopup Ctxpopup
24790 * @image html img/widget/ctxpopup/preview-00.png
24791 * @image latex img/widget/ctxpopup/preview-00.eps
24793 * @brief Context popup widet.
24795 * A ctxpopup is a widget that, when shown, pops up a list of items.
24796 * It automatically chooses an area inside its parent object's view
24797 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24798 * optimally fit into it. In the default theme, it will also point an
24799 * arrow to it's top left position at the time one shows it. Ctxpopup
24800 * items have a label and/or an icon. It is intended for a small
24801 * number of items (hence the use of list, not genlist).
24803 * @note Ctxpopup is a especialization of @ref Hover.
24805 * Signals that you can add callbacks for are:
24806 * "dismissed" - the ctxpopup was dismissed
24808 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24811 typedef enum _Elm_Ctxpopup_Direction
24813 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24815 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24816 the clicked area */
24817 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24818 the clicked area */
24819 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24821 } Elm_Ctxpopup_Direction;
24824 * @brief Add a new Ctxpopup object to the parent.
24826 * @param parent Parent object
24827 * @return New object or @c NULL, if it cannot be created
24829 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24831 * @brief Set the Ctxpopup's parent
24833 * @param obj The ctxpopup object
24834 * @param area The parent to use
24836 * Set the parent object.
24838 * @note elm_ctxpopup_add() will automatically call this function
24839 * with its @c parent argument.
24841 * @see elm_ctxpopup_add()
24842 * @see elm_hover_parent_set()
24844 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24846 * @brief Get the Ctxpopup's parent
24848 * @param obj The ctxpopup object
24850 * @see elm_ctxpopup_hover_parent_set() for more information
24852 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24854 * @brief Clear all items in the given ctxpopup object.
24856 * @param obj Ctxpopup object
24858 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24860 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24862 * @param obj Ctxpopup object
24863 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24865 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24867 * @brief Get the value of current ctxpopup object's orientation.
24869 * @param obj Ctxpopup object
24870 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24872 * @see elm_ctxpopup_horizontal_set()
24874 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24876 * @brief Add a new item to a ctxpopup object.
24878 * @param obj Ctxpopup object
24879 * @param icon Icon to be set on new item
24880 * @param label The Label of the new item
24881 * @param func Convenience function called when item selected
24882 * @param data Data passed to @p func
24883 * @return A handle to the item added or @c NULL, on errors
24885 * @warning Ctxpopup can't hold both an item list and a content at the same
24886 * time. When an item is added, any previous content will be removed.
24888 * @see elm_ctxpopup_content_set()
24890 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);
24892 * @brief Delete the given item in a ctxpopup object.
24894 * @param it Ctxpopup item to be deleted
24896 * @see elm_ctxpopup_item_append()
24898 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24900 * @brief Set the ctxpopup item's state as disabled or enabled.
24902 * @param it Ctxpopup item to be enabled/disabled
24903 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24905 * When disabled the item is greyed out to indicate it's state.
24907 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24909 * @brief Get the ctxpopup item's disabled/enabled state.
24911 * @param it Ctxpopup item to be enabled/disabled
24912 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24914 * @see elm_ctxpopup_item_disabled_set()
24916 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24918 * @brief Get the icon object for the given ctxpopup item.
24920 * @param it Ctxpopup item
24921 * @return icon object or @c NULL, if the item does not have icon or an error
24924 * @see elm_ctxpopup_item_append()
24925 * @see elm_ctxpopup_item_icon_set()
24927 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24929 * @brief Sets the side icon associated with the ctxpopup item
24931 * @param it Ctxpopup item
24932 * @param icon Icon object to be set
24934 * Once the icon object is set, a previously set one will be deleted.
24935 * @warning Setting the same icon for two items will cause the icon to
24936 * dissapear from the first item.
24938 * @see elm_ctxpopup_item_append()
24940 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24942 * @brief Get the label for the given ctxpopup item.
24944 * @param it Ctxpopup item
24945 * @return label string or @c NULL, if the item does not have label or an
24948 * @see elm_ctxpopup_item_append()
24949 * @see elm_ctxpopup_item_label_set()
24951 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24953 * @brief (Re)set the label on the given ctxpopup item.
24955 * @param it Ctxpopup item
24956 * @param label String to set as label
24958 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24960 * @brief Set an elm widget as the content of the ctxpopup.
24962 * @param obj Ctxpopup object
24963 * @param content Content to be swallowed
24965 * If the content object is already set, a previous one will bedeleted. If
24966 * you want to keep that old content object, use the
24967 * elm_ctxpopup_content_unset() function.
24969 * @deprecated use elm_object_content_set()
24971 * @warning Ctxpopup can't hold both a item list and a content at the same
24972 * time. When a content is set, any previous items will be removed.
24974 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24976 * @brief Unset the ctxpopup content
24978 * @param obj Ctxpopup object
24979 * @return The content that was being used
24981 * Unparent and return the content object which was set for this widget.
24983 * @deprecated use elm_object_content_unset()
24985 * @see elm_ctxpopup_content_set()
24987 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24989 * @brief Set the direction priority of a ctxpopup.
24991 * @param obj Ctxpopup object
24992 * @param first 1st priority of direction
24993 * @param second 2nd priority of direction
24994 * @param third 3th priority of direction
24995 * @param fourth 4th priority of direction
24997 * This functions gives a chance to user to set the priority of ctxpopup
24998 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24999 * requested direction.
25001 * @see Elm_Ctxpopup_Direction
25003 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);
25005 * @brief Get the direction priority of a ctxpopup.
25007 * @param obj Ctxpopup object
25008 * @param first 1st priority of direction to be returned
25009 * @param second 2nd priority of direction to be returned
25010 * @param third 3th priority of direction to be returned
25011 * @param fourth 4th priority of direction to be returned
25013 * @see elm_ctxpopup_direction_priority_set() for more information.
25015 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);
25023 * @defgroup Transit Transit
25024 * @ingroup Elementary
25026 * Transit is designed to apply various animated transition effects to @c
25027 * Evas_Object, such like translation, rotation, etc. For using these
25028 * effects, create an @ref Elm_Transit and add the desired transition effects.
25030 * Once the effects are added into transit, they will be automatically
25031 * managed (their callback will be called until the duration is ended, and
25032 * they will be deleted on completion).
25036 * Elm_Transit *trans = elm_transit_add();
25037 * elm_transit_object_add(trans, obj);
25038 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25039 * elm_transit_duration_set(transit, 1);
25040 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25041 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25042 * elm_transit_repeat_times_set(transit, 3);
25045 * Some transition effects are used to change the properties of objects. They
25047 * @li @ref elm_transit_effect_translation_add
25048 * @li @ref elm_transit_effect_color_add
25049 * @li @ref elm_transit_effect_rotation_add
25050 * @li @ref elm_transit_effect_wipe_add
25051 * @li @ref elm_transit_effect_zoom_add
25052 * @li @ref elm_transit_effect_resizing_add
25054 * Other transition effects are used to make one object disappear and another
25055 * object appear on its old place. These effects are:
25057 * @li @ref elm_transit_effect_flip_add
25058 * @li @ref elm_transit_effect_resizable_flip_add
25059 * @li @ref elm_transit_effect_fade_add
25060 * @li @ref elm_transit_effect_blend_add
25062 * It's also possible to make a transition chain with @ref
25063 * elm_transit_chain_transit_add.
25065 * @warning We strongly recommend to use elm_transit just when edje can not do
25066 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25067 * animations can be manipulated inside the theme.
25069 * List of examples:
25070 * @li @ref transit_example_01_explained
25071 * @li @ref transit_example_02_explained
25072 * @li @ref transit_example_03_c
25073 * @li @ref transit_example_04_c
25079 * @enum Elm_Transit_Tween_Mode
25081 * The type of acceleration used in the transition.
25085 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25086 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25087 over time, then decrease again
25089 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25091 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25093 } Elm_Transit_Tween_Mode;
25096 * @enum Elm_Transit_Effect_Flip_Axis
25098 * The axis where flip effect should be applied.
25102 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25103 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25104 } Elm_Transit_Effect_Flip_Axis;
25106 * @enum Elm_Transit_Effect_Wipe_Dir
25108 * The direction where the wipe effect should occur.
25112 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25113 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25114 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25115 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25116 } Elm_Transit_Effect_Wipe_Dir;
25117 /** @enum Elm_Transit_Effect_Wipe_Type
25119 * Whether the wipe effect should show or hide the object.
25123 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25125 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25127 } Elm_Transit_Effect_Wipe_Type;
25130 * @typedef Elm_Transit
25132 * The Transit created with elm_transit_add(). This type has the information
25133 * about the objects which the transition will be applied, and the
25134 * transition effects that will be used. It also contains info about
25135 * duration, number of repetitions, auto-reverse, etc.
25137 typedef struct _Elm_Transit Elm_Transit;
25138 typedef void Elm_Transit_Effect;
25140 * @typedef Elm_Transit_Effect_Transition_Cb
25142 * Transition callback called for this effect on each transition iteration.
25144 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25146 * Elm_Transit_Effect_End_Cb
25148 * Transition callback called for this effect when the transition is over.
25150 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25153 * Elm_Transit_Del_Cb
25155 * A callback called when the transit is deleted.
25157 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25162 * @note Is not necessary to delete the transit object, it will be deleted at
25163 * the end of its operation.
25164 * @note The transit will start playing when the program enter in the main loop, is not
25165 * necessary to give a start to the transit.
25167 * @return The transit object.
25171 EAPI Elm_Transit *elm_transit_add(void);
25174 * Stops the animation and delete the @p transit object.
25176 * Call this function if you wants to stop the animation before the duration
25177 * time. Make sure the @p transit object is still alive with
25178 * elm_transit_del_cb_set() function.
25179 * All added effects will be deleted, calling its repective data_free_cb
25180 * functions. The function setted by elm_transit_del_cb_set() will be called.
25182 * @see elm_transit_del_cb_set()
25184 * @param transit The transit object to be deleted.
25187 * @warning Just call this function if you are sure the transit is alive.
25189 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25192 * Add a new effect to the transit.
25194 * @note The cb function and the data are the key to the effect. If you try to
25195 * add an already added effect, nothing is done.
25196 * @note After the first addition of an effect in @p transit, if its
25197 * effect list become empty again, the @p transit will be killed by
25198 * elm_transit_del(transit) function.
25202 * Elm_Transit *transit = elm_transit_add();
25203 * elm_transit_effect_add(transit,
25204 * elm_transit_effect_blend_op,
25205 * elm_transit_effect_blend_context_new(),
25206 * elm_transit_effect_blend_context_free);
25209 * @param transit The transit object.
25210 * @param transition_cb The operation function. It is called when the
25211 * animation begins, it is the function that actually performs the animation.
25212 * It is called with the @p data, @p transit and the time progression of the
25213 * animation (a double value between 0.0 and 1.0).
25214 * @param effect The context data of the effect.
25215 * @param end_cb The function to free the context data, it will be called
25216 * at the end of the effect, it must finalize the animation and free the
25220 * @warning The transit free the context data at the and of the transition with
25221 * the data_free_cb function, do not use the context data in another transit.
25223 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);
25226 * Delete an added effect.
25228 * This function will remove the effect from the @p transit, calling the
25229 * data_free_cb to free the @p data.
25231 * @see elm_transit_effect_add()
25233 * @note If the effect is not found, nothing is done.
25234 * @note If the effect list become empty, this function will call
25235 * elm_transit_del(transit), that is, it will kill the @p transit.
25237 * @param transit The transit object.
25238 * @param transition_cb The operation function.
25239 * @param effect The context data of the effect.
25243 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);
25246 * Add new object to apply the effects.
25248 * @note After the first addition of an object in @p transit, if its
25249 * object list become empty again, the @p transit will be killed by
25250 * elm_transit_del(transit) function.
25251 * @note If the @p obj belongs to another transit, the @p obj will be
25252 * removed from it and it will only belong to the @p transit. If the old
25253 * transit stays without objects, it will die.
25254 * @note When you add an object into the @p transit, its state from
25255 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25256 * transit ends, if you change this state whith evas_object_pass_events_set()
25257 * after add the object, this state will change again when @p transit stops to
25260 * @param transit The transit object.
25261 * @param obj Object to be animated.
25264 * @warning It is not allowed to add a new object after transit begins to go.
25266 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25269 * Removes an added object from the transit.
25271 * @note If the @p obj is not in the @p transit, nothing is done.
25272 * @note If the list become empty, this function will call
25273 * elm_transit_del(transit), that is, it will kill the @p transit.
25275 * @param transit The transit object.
25276 * @param obj Object to be removed from @p transit.
25279 * @warning It is not allowed to remove objects after transit begins to go.
25281 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25284 * Get the objects of the transit.
25286 * @param transit The transit object.
25287 * @return a Eina_List with the objects from the transit.
25291 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25294 * Enable/disable keeping up the objects states.
25295 * If it is not kept, the objects states will be reset when transition ends.
25297 * @note @p transit can not be NULL.
25298 * @note One state includes geometry, color, map data.
25300 * @param transit The transit object.
25301 * @param state_keep Keeping or Non Keeping.
25305 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25308 * Get a value whether the objects states will be reset or not.
25310 * @note @p transit can not be NULL
25312 * @see elm_transit_objects_final_state_keep_set()
25314 * @param transit The transit object.
25315 * @return EINA_TRUE means the states of the objects will be reset.
25316 * If @p transit is NULL, EINA_FALSE is returned
25320 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25323 * Set the event enabled when transit is operating.
25325 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25326 * events from mouse and keyboard during the animation.
25327 * @note When you add an object with elm_transit_object_add(), its state from
25328 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25329 * transit ends, if you change this state with evas_object_pass_events_set()
25330 * after adding the object, this state will change again when @p transit stops
25333 * @param transit The transit object.
25334 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25335 * ignored otherwise.
25339 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25342 * Get the value of event enabled status.
25344 * @see elm_transit_event_enabled_set()
25346 * @param transit The Transit object
25347 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25348 * EINA_FALSE is returned
25352 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25355 * Set the user-callback function when the transit is deleted.
25357 * @note Using this function twice will overwrite the first function setted.
25358 * @note the @p transit object will be deleted after call @p cb function.
25360 * @param transit The transit object.
25361 * @param cb Callback function pointer. This function will be called before
25362 * the deletion of the transit.
25363 * @param data Callback funtion user data. It is the @p op parameter.
25367 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25370 * Set reverse effect automatically.
25372 * If auto reverse is setted, after running the effects with the progress
25373 * parameter from 0 to 1, it will call the effecs again with the progress
25374 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25375 * where the duration was setted with the function elm_transit_add and
25376 * the repeat with the function elm_transit_repeat_times_set().
25378 * @param transit The transit object.
25379 * @param reverse EINA_TRUE means the auto_reverse is on.
25383 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25386 * Get if the auto reverse is on.
25388 * @see elm_transit_auto_reverse_set()
25390 * @param transit The transit object.
25391 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25392 * EINA_FALSE is returned
25396 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25399 * Set the transit repeat count. Effect will be repeated by repeat count.
25401 * This function sets the number of repetition the transit will run after
25402 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25403 * If the @p repeat is a negative number, it will repeat infinite times.
25405 * @note If this function is called during the transit execution, the transit
25406 * will run @p repeat times, ignoring the times it already performed.
25408 * @param transit The transit object
25409 * @param repeat Repeat count
25413 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25416 * Get the transit repeat count.
25418 * @see elm_transit_repeat_times_set()
25420 * @param transit The Transit object.
25421 * @return The repeat count. If @p transit is NULL
25426 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25429 * Set the transit animation acceleration type.
25431 * This function sets the tween mode of the transit that can be:
25432 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25433 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25434 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25435 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25437 * @param transit The transit object.
25438 * @param tween_mode The tween type.
25442 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25445 * Get the transit animation acceleration type.
25447 * @note @p transit can not be NULL
25449 * @param transit The transit object.
25450 * @return The tween type. If @p transit is NULL
25451 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25455 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25458 * Set the transit animation time
25460 * @note @p transit can not be NULL
25462 * @param transit The transit object.
25463 * @param duration The animation time.
25467 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25470 * Get the transit animation time
25472 * @note @p transit can not be NULL
25474 * @param transit The transit object.
25476 * @return The transit animation time.
25480 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25483 * Starts the transition.
25484 * Once this API is called, the transit begins to measure the time.
25486 * @note @p transit can not be NULL
25488 * @param transit The transit object.
25492 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25495 * Pause/Resume the transition.
25497 * If you call elm_transit_go again, the transit will be started from the
25498 * beginning, and will be unpaused.
25500 * @note @p transit can not be NULL
25502 * @param transit The transit object.
25503 * @param paused Whether the transition should be paused or not.
25507 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25510 * Get the value of paused status.
25512 * @see elm_transit_paused_set()
25514 * @note @p transit can not be NULL
25516 * @param transit The transit object.
25517 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25518 * EINA_FALSE is returned
25522 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25525 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25527 * The value returned is a fraction (current time / total time). It
25528 * represents the progression position relative to the total.
25530 * @note @p transit can not be NULL
25532 * @param transit The transit object.
25534 * @return The time progression value. If @p transit is NULL
25539 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25542 * Makes the chain relationship between two transits.
25544 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25545 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25547 * @param transit The transit object.
25548 * @param chain_transit The chain transit object. This transit will be operated
25549 * after transit is done.
25551 * This function adds @p chain_transit transition to a chain after the @p
25552 * transit, and will be started as soon as @p transit ends. See @ref
25553 * transit_example_02_explained for a full example.
25557 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25560 * Cut off the chain relationship between two transits.
25562 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25563 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25565 * @param transit The transit object.
25566 * @param chain_transit The chain transit object.
25568 * This function remove the @p chain_transit transition from the @p transit.
25572 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25575 * Get the current chain transit list.
25577 * @note @p transit can not be NULL.
25579 * @param transit The transit object.
25580 * @return chain transit list.
25584 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25587 * Add the Resizing Effect to Elm_Transit.
25589 * @note This API is one of the facades. It creates resizing effect context
25590 * and add it's required APIs to elm_transit_effect_add.
25592 * @see elm_transit_effect_add()
25594 * @param transit Transit object.
25595 * @param from_w Object width size when effect begins.
25596 * @param from_h Object height size when effect begins.
25597 * @param to_w Object width size when effect ends.
25598 * @param to_h Object height size when effect ends.
25599 * @return Resizing effect context data.
25603 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);
25606 * Add the Translation Effect to Elm_Transit.
25608 * @note This API is one of the facades. It creates translation effect context
25609 * and add it's required APIs to elm_transit_effect_add.
25611 * @see elm_transit_effect_add()
25613 * @param transit Transit object.
25614 * @param from_dx X Position variation when effect begins.
25615 * @param from_dy Y Position variation when effect begins.
25616 * @param to_dx X Position variation when effect ends.
25617 * @param to_dy Y Position variation when effect ends.
25618 * @return Translation effect context data.
25621 * @warning It is highly recommended just create a transit with this effect when
25622 * the window that the objects of the transit belongs has already been created.
25623 * This is because this effect needs the geometry information about the objects,
25624 * and if the window was not created yet, it can get a wrong information.
25626 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);
25629 * Add the Zoom Effect to Elm_Transit.
25631 * @note This API is one of the facades. It creates zoom effect context
25632 * and add it's required APIs to elm_transit_effect_add.
25634 * @see elm_transit_effect_add()
25636 * @param transit Transit object.
25637 * @param from_rate Scale rate when effect begins (1 is current rate).
25638 * @param to_rate Scale rate when effect ends.
25639 * @return Zoom effect context data.
25642 * @warning It is highly recommended just create a transit with this effect when
25643 * the window that the objects of the transit belongs has already been created.
25644 * This is because this effect needs the geometry information about the objects,
25645 * and if the window was not created yet, it can get a wrong information.
25647 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25650 * Add the Flip Effect to Elm_Transit.
25652 * @note This API is one of the facades. It creates flip effect context
25653 * and add it's required APIs to elm_transit_effect_add.
25654 * @note This effect is applied to each pair of objects in the order they are listed
25655 * in the transit list of objects. The first object in the pair will be the
25656 * "front" object and the second will be the "back" object.
25658 * @see elm_transit_effect_add()
25660 * @param transit Transit object.
25661 * @param axis Flipping Axis(X or Y).
25662 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25663 * @return Flip effect context data.
25666 * @warning It is highly recommended just create a transit with this effect when
25667 * the window that the objects of the transit belongs has already been created.
25668 * This is because this effect needs the geometry information about the objects,
25669 * and if the window was not created yet, it can get a wrong information.
25671 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25674 * Add the Resizable Flip Effect to Elm_Transit.
25676 * @note This API is one of the facades. It creates resizable flip effect context
25677 * and add it's required APIs to elm_transit_effect_add.
25678 * @note This effect is applied to each pair of objects in the order they are listed
25679 * in the transit list of objects. The first object in the pair will be the
25680 * "front" object and the second will be the "back" object.
25682 * @see elm_transit_effect_add()
25684 * @param transit Transit object.
25685 * @param axis Flipping Axis(X or Y).
25686 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25687 * @return Resizable flip effect context data.
25690 * @warning It is highly recommended just create a transit with this effect when
25691 * the window that the objects of the transit belongs has already been created.
25692 * This is because this effect needs the geometry information about the objects,
25693 * and if the window was not created yet, it can get a wrong information.
25695 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25698 * Add the Wipe Effect to Elm_Transit.
25700 * @note This API is one of the facades. It creates wipe effect context
25701 * and add it's required APIs to elm_transit_effect_add.
25703 * @see elm_transit_effect_add()
25705 * @param transit Transit object.
25706 * @param type Wipe type. Hide or show.
25707 * @param dir Wipe Direction.
25708 * @return Wipe effect context data.
25711 * @warning It is highly recommended just create a transit with this effect when
25712 * the window that the objects of the transit belongs has already been created.
25713 * This is because this effect needs the geometry information about the objects,
25714 * and if the window was not created yet, it can get a wrong information.
25716 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25719 * Add the Color Effect to Elm_Transit.
25721 * @note This API is one of the facades. It creates color effect context
25722 * and add it's required APIs to elm_transit_effect_add.
25724 * @see elm_transit_effect_add()
25726 * @param transit Transit object.
25727 * @param from_r RGB R when effect begins.
25728 * @param from_g RGB G when effect begins.
25729 * @param from_b RGB B when effect begins.
25730 * @param from_a RGB A when effect begins.
25731 * @param to_r RGB R when effect ends.
25732 * @param to_g RGB G when effect ends.
25733 * @param to_b RGB B when effect ends.
25734 * @param to_a RGB A when effect ends.
25735 * @return Color effect context data.
25739 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);
25742 * Add the Fade Effect to Elm_Transit.
25744 * @note This API is one of the facades. It creates fade effect context
25745 * and add it's required APIs to elm_transit_effect_add.
25746 * @note This effect is applied to each pair of objects in the order they are listed
25747 * in the transit list of objects. The first object in the pair will be the
25748 * "before" object and the second will be the "after" object.
25750 * @see elm_transit_effect_add()
25752 * @param transit Transit object.
25753 * @return Fade effect context data.
25756 * @warning It is highly recommended just create a transit with this effect when
25757 * the window that the objects of the transit belongs has already been created.
25758 * This is because this effect needs the color information about the objects,
25759 * and if the window was not created yet, it can get a wrong information.
25761 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25764 * Add the Blend Effect to Elm_Transit.
25766 * @note This API is one of the facades. It creates blend effect context
25767 * and add it's required APIs to elm_transit_effect_add.
25768 * @note This effect is applied to each pair of objects in the order they are listed
25769 * in the transit list of objects. The first object in the pair will be the
25770 * "before" object and the second will be the "after" object.
25772 * @see elm_transit_effect_add()
25774 * @param transit Transit object.
25775 * @return Blend effect context data.
25778 * @warning It is highly recommended just create a transit with this effect when
25779 * the window that the objects of the transit belongs has already been created.
25780 * This is because this effect needs the color information about the objects,
25781 * and if the window was not created yet, it can get a wrong information.
25783 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25786 * Add the Rotation Effect to Elm_Transit.
25788 * @note This API is one of the facades. It creates rotation effect context
25789 * and add it's required APIs to elm_transit_effect_add.
25791 * @see elm_transit_effect_add()
25793 * @param transit Transit object.
25794 * @param from_degree Degree when effect begins.
25795 * @param to_degree Degree when effect is ends.
25796 * @return Rotation effect context data.
25799 * @warning It is highly recommended just create a transit with this effect when
25800 * the window that the objects of the transit belongs has already been created.
25801 * This is because this effect needs the geometry information about the objects,
25802 * and if the window was not created yet, it can get a wrong information.
25804 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25807 * Add the ImageAnimation Effect to Elm_Transit.
25809 * @note This API is one of the facades. It creates image animation effect context
25810 * and add it's required APIs to elm_transit_effect_add.
25811 * The @p images parameter is a list images paths. This list and
25812 * its contents will be deleted at the end of the effect by
25813 * elm_transit_effect_image_animation_context_free() function.
25817 * char buf[PATH_MAX];
25818 * Eina_List *images = NULL;
25819 * Elm_Transit *transi = elm_transit_add();
25821 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25822 * images = eina_list_append(images, eina_stringshare_add(buf));
25824 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25825 * images = eina_list_append(images, eina_stringshare_add(buf));
25826 * elm_transit_effect_image_animation_add(transi, images);
25830 * @see elm_transit_effect_add()
25832 * @param transit Transit object.
25833 * @param images Eina_List of images file paths. This list and
25834 * its contents will be deleted at the end of the effect by
25835 * elm_transit_effect_image_animation_context_free() function.
25836 * @return Image Animation effect context data.
25840 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25845 typedef struct _Elm_Store Elm_Store;
25846 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25847 typedef struct _Elm_Store_Item Elm_Store_Item;
25848 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25849 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25850 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25851 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25852 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25853 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25854 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25855 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25857 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25858 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25859 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25860 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25864 ELM_STORE_ITEM_MAPPING_NONE = 0,
25865 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25866 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25867 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25868 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25869 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25870 // can add more here as needed by common apps
25871 ELM_STORE_ITEM_MAPPING_LAST
25872 } Elm_Store_Item_Mapping_Type;
25874 struct _Elm_Store_Item_Mapping_Icon
25876 // FIXME: allow edje file icons
25878 Elm_Icon_Lookup_Order lookup_order;
25879 Eina_Bool standard_name : 1;
25880 Eina_Bool no_scale : 1;
25881 Eina_Bool smooth : 1;
25882 Eina_Bool scale_up : 1;
25883 Eina_Bool scale_down : 1;
25886 struct _Elm_Store_Item_Mapping_Empty
25891 struct _Elm_Store_Item_Mapping_Photo
25896 struct _Elm_Store_Item_Mapping_Custom
25898 Elm_Store_Item_Mapping_Cb func;
25901 struct _Elm_Store_Item_Mapping
25903 Elm_Store_Item_Mapping_Type type;
25908 Elm_Store_Item_Mapping_Empty empty;
25909 Elm_Store_Item_Mapping_Icon icon;
25910 Elm_Store_Item_Mapping_Photo photo;
25911 Elm_Store_Item_Mapping_Custom custom;
25912 // add more types here
25916 struct _Elm_Store_Item_Info
25918 Elm_Genlist_Item_Class *item_class;
25919 const Elm_Store_Item_Mapping *mapping;
25924 struct _Elm_Store_Item_Info_Filesystem
25926 Elm_Store_Item_Info base;
25930 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25931 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25933 EAPI void elm_store_free(Elm_Store *st);
25935 EAPI Elm_Store *elm_store_filesystem_new(void);
25936 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25937 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25938 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25940 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25942 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25943 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25944 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25945 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25946 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25947 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25949 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25950 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25951 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25952 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25953 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25954 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25955 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25958 * @defgroup SegmentControl SegmentControl
25959 * @ingroup Elementary
25961 * @image html img/widget/segment_control/preview-00.png
25962 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25964 * @image html img/segment_control.png
25965 * @image latex img/segment_control.eps width=\textwidth
25967 * Segment control widget is a horizontal control made of multiple segment
25968 * items, each segment item functioning similar to discrete two state button.
25969 * A segment control groups the items together and provides compact
25970 * single button with multiple equal size segments.
25972 * Segment item size is determined by base widget
25973 * size and the number of items added.
25974 * Only one segment item can be at selected state. A segment item can display
25975 * combination of Text and any Evas_Object like Images or other widget.
25977 * Smart callbacks one can listen to:
25978 * - "changed" - When the user clicks on a segment item which is not
25979 * previously selected and get selected. The event_info parameter is the
25980 * segment item index.
25982 * Available styles for it:
25985 * Here is an example on its usage:
25986 * @li @ref segment_control_example
25990 * @addtogroup SegmentControl
25994 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25997 * Add a new segment control widget to the given parent Elementary
25998 * (container) object.
26000 * @param parent The parent object.
26001 * @return a new segment control widget handle or @c NULL, on errors.
26003 * This function inserts a new segment control widget on the canvas.
26005 * @ingroup SegmentControl
26007 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26010 * Append a new item to the segment control object.
26012 * @param obj The segment control object.
26013 * @param icon The icon object to use for the left side of the item. An
26014 * icon can be any Evas object, but usually it is an icon created
26015 * with elm_icon_add().
26016 * @param label The label of the item.
26017 * Note that, NULL is different from empty string "".
26018 * @return The created item or @c NULL upon failure.
26020 * A new item will be created and appended to the segment control, i.e., will
26021 * be set as @b last item.
26023 * If it should be inserted at another position,
26024 * elm_segment_control_item_insert_at() should be used instead.
26026 * Items created with this function can be deleted with function
26027 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26029 * @note @p label set to @c NULL is different from empty string "".
26031 * only has icon, it will be displayed bigger and centered. If it has
26032 * icon and label, even that an empty string, icon will be smaller and
26033 * positioned at left.
26037 * sc = elm_segment_control_add(win);
26038 * ic = elm_icon_add(win);
26039 * elm_icon_file_set(ic, "path/to/image", NULL);
26040 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26041 * elm_segment_control_item_add(sc, ic, "label");
26042 * evas_object_show(sc);
26045 * @see elm_segment_control_item_insert_at()
26046 * @see elm_segment_control_item_del()
26048 * @ingroup SegmentControl
26050 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26053 * Insert a new item to the segment control object at specified position.
26055 * @param obj The segment control object.
26056 * @param icon The icon object to use for the left side of the item. An
26057 * icon can be any Evas object, but usually it is an icon created
26058 * with elm_icon_add().
26059 * @param label The label of the item.
26060 * @param index Item position. Value should be between 0 and items count.
26061 * @return The created item or @c NULL upon failure.
26063 * Index values must be between @c 0, when item will be prepended to
26064 * segment control, and items count, that can be get with
26065 * elm_segment_control_item_count_get(), case when item will be appended
26066 * to segment control, just like elm_segment_control_item_add().
26068 * Items created with this function can be deleted with function
26069 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26071 * @note @p label set to @c NULL is different from empty string "".
26073 * only has icon, it will be displayed bigger and centered. If it has
26074 * icon and label, even that an empty string, icon will be smaller and
26075 * positioned at left.
26077 * @see elm_segment_control_item_add()
26078 * @see elm_segment_control_count_get()
26079 * @see elm_segment_control_item_del()
26081 * @ingroup SegmentControl
26083 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);
26086 * Remove a segment control item from its parent, deleting it.
26088 * @param it The item to be removed.
26090 * Items can be added with elm_segment_control_item_add() or
26091 * elm_segment_control_item_insert_at().
26093 * @ingroup SegmentControl
26095 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26098 * Remove a segment control item at given index from its parent,
26101 * @param obj The segment control object.
26102 * @param index The position of the segment control item to be deleted.
26104 * Items can be added with elm_segment_control_item_add() or
26105 * elm_segment_control_item_insert_at().
26107 * @ingroup SegmentControl
26109 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26112 * Get the Segment items count from segment control.
26114 * @param obj The segment control object.
26115 * @return Segment items count.
26117 * It will just return the number of items added to segment control @p obj.
26119 * @ingroup SegmentControl
26121 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26124 * Get the item placed at specified index.
26126 * @param obj The segment control object.
26127 * @param index The index of the segment item.
26128 * @return The segment control item or @c NULL on failure.
26130 * Index is the position of an item in segment control widget. Its
26131 * range is from @c 0 to <tt> count - 1 </tt>.
26132 * Count is the number of items, that can be get with
26133 * elm_segment_control_item_count_get().
26135 * @ingroup SegmentControl
26137 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26140 * Get the label of item.
26142 * @param obj The segment control object.
26143 * @param index The index of the segment item.
26144 * @return The label of the item at @p index.
26146 * The return value is a pointer to the label associated to the item when
26147 * it was created, with function elm_segment_control_item_add(), or later
26148 * with function elm_segment_control_item_label_set. If no label
26149 * was passed as argument, it will return @c NULL.
26151 * @see elm_segment_control_item_label_set() for more details.
26152 * @see elm_segment_control_item_add()
26154 * @ingroup SegmentControl
26156 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26159 * Set the label of item.
26161 * @param it The item of segment control.
26162 * @param text The label of item.
26164 * The label to be displayed by the item.
26165 * Label will be at right of the icon (if set).
26167 * If a label was passed as argument on item creation, with function
26168 * elm_control_segment_item_add(), it will be already
26169 * displayed by the item.
26171 * @see elm_segment_control_item_label_get()
26172 * @see elm_segment_control_item_add()
26174 * @ingroup SegmentControl
26176 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26179 * Get the icon associated to the item.
26181 * @param obj The segment control object.
26182 * @param index The index of the segment item.
26183 * @return The left side icon associated to the item at @p index.
26185 * The return value is a pointer to the icon associated to the item when
26186 * it was created, with function elm_segment_control_item_add(), or later
26187 * with function elm_segment_control_item_icon_set(). If no icon
26188 * was passed as argument, it will return @c NULL.
26190 * @see elm_segment_control_item_add()
26191 * @see elm_segment_control_item_icon_set()
26193 * @ingroup SegmentControl
26195 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26198 * Set the icon associated to the item.
26200 * @param it The segment control item.
26201 * @param icon The icon object to associate with @p it.
26203 * The icon object to use at left side of the item. An
26204 * icon can be any Evas object, but usually it is an icon created
26205 * with elm_icon_add().
26207 * Once the icon object is set, a previously set one will be deleted.
26208 * @warning Setting the same icon for two items will cause the icon to
26209 * dissapear from the first item.
26211 * If an icon was passed as argument on item creation, with function
26212 * elm_segment_control_item_add(), it will be already
26213 * associated to the item.
26215 * @see elm_segment_control_item_add()
26216 * @see elm_segment_control_item_icon_get()
26218 * @ingroup SegmentControl
26220 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26223 * Get the index of an item.
26225 * @param it The segment control item.
26226 * @return The position of item in segment control widget.
26228 * Index is the position of an item in segment control widget. Its
26229 * range is from @c 0 to <tt> count - 1 </tt>.
26230 * Count is the number of items, that can be get with
26231 * elm_segment_control_item_count_get().
26233 * @ingroup SegmentControl
26235 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26238 * Get the base object of the item.
26240 * @param it The segment control item.
26241 * @return The base object associated with @p it.
26243 * Base object is the @c Evas_Object that represents that item.
26245 * @ingroup SegmentControl
26247 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26250 * Get the selected item.
26252 * @param obj The segment control object.
26253 * @return The selected item or @c NULL if none of segment items is
26256 * The selected item can be unselected with function
26257 * elm_segment_control_item_selected_set().
26259 * The selected item always will be highlighted on segment control.
26261 * @ingroup SegmentControl
26263 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26266 * Set the selected state of an item.
26268 * @param it The segment control item
26269 * @param select The selected state
26271 * This sets the selected state of the given item @p it.
26272 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26274 * If a new item is selected the previosly selected will be unselected.
26275 * Previoulsy selected item can be get with function
26276 * elm_segment_control_item_selected_get().
26278 * The selected item always will be highlighted on segment control.
26280 * @see elm_segment_control_item_selected_get()
26282 * @ingroup SegmentControl
26284 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26291 * @defgroup Grid Grid
26293 * The grid is a grid layout widget that lays out a series of children as a
26294 * fixed "grid" of widgets using a given percentage of the grid width and
26295 * height each using the child object.
26297 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26298 * widgets size itself. The default is 100 x 100, so that means the
26299 * position and sizes of children will effectively be percentages (0 to 100)
26300 * of the width or height of the grid widget
26306 * Add a new grid to the parent
26308 * @param parent The parent object
26309 * @return The new object or NULL if it cannot be created
26313 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26316 * Set the virtual size of the grid
26318 * @param obj The grid object
26319 * @param w The virtual width of the grid
26320 * @param h The virtual height of the grid
26324 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26327 * Get the virtual size of the grid
26329 * @param obj The grid object
26330 * @param w Pointer to integer to store the virtual width of the grid
26331 * @param h Pointer to integer to store the virtual height of the grid
26335 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26338 * Pack child at given position and size
26340 * @param obj The grid object
26341 * @param subobj The child to pack
26342 * @param x The virtual x coord at which to pack it
26343 * @param y The virtual y coord at which to pack it
26344 * @param w The virtual width at which to pack it
26345 * @param h The virtual height at which to pack it
26349 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26352 * Unpack a child from a grid object
26354 * @param obj The grid object
26355 * @param subobj The child to unpack
26359 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26362 * Faster way to remove all child objects from a grid object.
26364 * @param obj The grid object
26365 * @param clear If true, it will delete just removed children
26369 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26372 * Set packing of an existing child at to position and size
26374 * @param subobj The child to set packing of
26375 * @param x The virtual x coord at which to pack it
26376 * @param y The virtual y coord at which to pack it
26377 * @param w The virtual width at which to pack it
26378 * @param h The virtual height at which to pack it
26382 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26385 * get packing of a child
26387 * @param subobj The child to query
26388 * @param x Pointer to integer to store the virtual x coord
26389 * @param y Pointer to integer to store the virtual y coord
26390 * @param w Pointer to integer to store the virtual width
26391 * @param h Pointer to integer to store the virtual height
26395 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26401 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26402 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26403 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26406 * @defgroup Video Video
26408 * This object display an player that let you control an Elm_Video
26409 * object. It take care of updating it's content according to what is
26410 * going on inside the Emotion object. It does activate the remember
26411 * function on the linked Elm_Video object.
26413 * Signals that you cann add callback for are :
26415 * "forward,clicked" - the user clicked the forward button.
26416 * "info,clicked" - the user clicked the info button.
26417 * "next,clicked" - the user clicked the next button.
26418 * "pause,clicked" - the user clicked the pause button.
26419 * "play,clicked" - the user clicked the play button.
26420 * "prev,clicked" - the user clicked the prev button.
26421 * "rewind,clicked" - the user clicked the rewind button.
26422 * "stop,clicked" - the user clicked the stop button.
26424 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26425 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26426 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26427 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26428 EAPI void elm_video_play(Evas_Object *video);
26429 EAPI void elm_video_pause(Evas_Object *video);
26430 EAPI void elm_video_stop(Evas_Object *video);
26431 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26432 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26433 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26434 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26435 EAPI double elm_video_audio_level_get(Evas_Object *video);
26436 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26437 EAPI double elm_video_play_position_get(Evas_Object *video);
26438 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26439 EAPI double elm_video_play_length_get(Evas_Object *video);
26440 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26441 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26442 EAPI const char *elm_video_title_get(Evas_Object *video);
26444 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26445 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26448 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26449 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);
26450 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26451 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26452 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26453 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26454 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26455 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26456 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26457 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26458 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26459 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26460 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26461 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26462 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);