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);
1479 * @defgroup UI-Mirroring Selective Widget mirroring
1481 * These functions allow you to set ui-mirroring on specific
1482 * widgets or the whole interface. Widgets can be in one of two
1483 * modes, automatic and manual. Automatic means they'll be changed
1484 * according to the system mirroring mode and manual means only
1485 * explicit changes will matter. You are not supposed to change
1486 * mirroring state of a widget set to automatic, will mostly work,
1487 * but the behavior is not really defined.
1492 EAPI Eina_Bool elm_mirrored_get(void);
1493 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1496 * Get the system mirrored mode. This determines the default mirrored mode
1499 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1501 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1504 * Set the system mirrored mode. This determines the default mirrored mode
1507 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1509 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1512 * Returns the widget's mirrored mode setting.
1514 * @param obj The widget.
1515 * @return mirrored mode setting of the object.
1518 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1521 * Sets the widget's mirrored mode setting.
1522 * When widget in automatic mode, it follows the system mirrored mode set by
1523 * elm_mirrored_set().
1524 * @param obj The widget.
1525 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1527 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1534 * Set the style to use by a widget
1536 * Sets the style name that will define the appearance of a widget. Styles
1537 * vary from widget to widget and may also be defined by other themes
1538 * by means of extensions and overlays.
1540 * @param obj The Elementary widget to style
1541 * @param style The style name to use
1543 * @see elm_theme_extension_add()
1544 * @see elm_theme_extension_del()
1545 * @see elm_theme_overlay_add()
1546 * @see elm_theme_overlay_del()
1550 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1552 * Get the style used by the widget
1554 * This gets the style being used for that widget. Note that the string
1555 * pointer is only valid as longas the object is valid and the style doesn't
1558 * @param obj The Elementary widget to query for its style
1559 * @return The style name used
1561 * @see elm_object_style_set()
1565 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1568 * @defgroup Styles Styles
1570 * Widgets can have different styles of look. These generic API's
1571 * set styles of widgets, if they support them (and if the theme(s)
1574 * @ref general_functions_example_page "This" example contemplates
1575 * some of these functions.
1579 * Set the disabled state of an Elementary object.
1581 * @param obj The Elementary object to operate on
1582 * @param disabled The state to put in in: @c EINA_TRUE for
1583 * disabled, @c EINA_FALSE for enabled
1585 * Elementary objects can be @b disabled, in which state they won't
1586 * receive input and, in general, will be themed differently from
1587 * their normal state, usually greyed out. Useful for contexts
1588 * where you don't want your users to interact with some of the
1589 * parts of you interface.
1591 * This sets the state for the widget, either disabling it or
1596 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1599 * Get the disabled state of an Elementary object.
1601 * @param obj The Elementary object to operate on
1602 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1603 * if it's enabled (or on errors)
1605 * This gets the state of the widget, which might be enabled or disabled.
1609 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1612 * @defgroup WidgetNavigation Widget Tree Navigation.
1614 * How to check if an Evas Object is an Elementary widget? How to
1615 * get the first elementary widget that is parent of the given
1616 * object? These are all covered in widget tree navigation.
1618 * @ref general_functions_example_page "This" example contemplates
1619 * some of these functions.
1623 * Check if the given Evas Object is an Elementary widget.
1625 * @param obj the object to query.
1626 * @return @c EINA_TRUE if it is an elementary widget variant,
1627 * @c EINA_FALSE otherwise
1628 * @ingroup WidgetNavigation
1630 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1633 * Get the first parent of the given object that is an Elementary
1636 * @param obj the Elementary object to query parent from.
1637 * @return the parent object that is an Elementary widget, or @c
1638 * NULL, if it was not found.
1640 * Use this to query for an object's parent widget.
1642 * @note Most of Elementary users wouldn't be mixing non-Elementary
1643 * smart objects in the objects tree of an application, as this is
1644 * an advanced usage of Elementary with Evas. So, except for the
1645 * application's window, which is the root of that tree, all other
1646 * objects would have valid Elementary widget parents.
1648 * @ingroup WidgetNavigation
1650 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1653 * Get the top level parent of an Elementary widget.
1655 * @param obj The object to query.
1656 * @return The top level Elementary widget, or @c NULL if parent cannot be
1658 * @ingroup WidgetNavigation
1660 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1663 * Get the string that represents this Elementary widget.
1665 * @note Elementary is weird and exposes itself as a single
1666 * Evas_Object_Smart_Class of type "elm_widget", so
1667 * evas_object_type_get() always return that, making debug and
1668 * language bindings hard. This function tries to mitigate this
1669 * problem, but the solution is to change Elementary to use
1670 * proper inheritance.
1672 * @param obj the object to query.
1673 * @return Elementary widget name, or @c NULL if not a valid widget.
1674 * @ingroup WidgetNavigation
1676 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1679 * @defgroup Config Elementary Config
1681 * Elementary configuration is formed by a set options bounded to a
1682 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1683 * "finger size", etc. These are functions with which one syncronizes
1684 * changes made to those values to the configuration storing files, de
1685 * facto. You most probably don't want to use the functions in this
1686 * group unlees you're writing an elementary configuration manager.
1692 * Save back Elementary's configuration, so that it will persist on
1695 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1698 * This function will take effect -- thus, do I/O -- immediately. Use
1699 * it when you want to apply all configuration changes at once. The
1700 * current configuration set will get saved onto the current profile
1701 * configuration file.
1704 EAPI Eina_Bool elm_config_save(void);
1707 * Reload Elementary's configuration, bounded to current selected
1710 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1713 * Useful when you want to force reloading of configuration values for
1714 * a profile. If one removes user custom configuration directories,
1715 * for example, it will force a reload with system values insted.
1718 EAPI void elm_config_reload(void);
1725 * @defgroup Profile Elementary Profile
1727 * Profiles are pre-set options that affect the whole look-and-feel of
1728 * Elementary-based applications. There are, for example, profiles
1729 * aimed at desktop computer applications and others aimed at mobile,
1730 * touchscreen-based ones. You most probably don't want to use the
1731 * functions in this group unlees you're writing an elementary
1732 * configuration manager.
1738 * Get Elementary's profile in use.
1740 * This gets the global profile that is applied to all Elementary
1743 * @return The profile's name
1746 EAPI const char *elm_profile_current_get(void);
1749 * Get an Elementary's profile directory path in the filesystem. One
1750 * may want to fetch a system profile's dir or an user one (fetched
1753 * @param profile The profile's name
1754 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1755 * or a system one (@c EINA_FALSE)
1756 * @return The profile's directory path.
1759 * @note You must free it with elm_profile_dir_free().
1761 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1764 * Free an Elementary's profile directory path, as returned by
1765 * elm_profile_dir_get().
1767 * @param p_dir The profile's path
1771 EAPI void elm_profile_dir_free(const char *p_dir);
1774 * Get Elementary's list of available profiles.
1776 * @return The profiles list. List node data are the profile name
1780 * @note One must free this list, after usage, with the function
1781 * elm_profile_list_free().
1783 EAPI Eina_List *elm_profile_list_get(void);
1786 * Free Elementary's list of available profiles.
1788 * @param l The profiles list, as returned by elm_profile_list_get().
1792 EAPI void elm_profile_list_free(Eina_List *l);
1795 * Set Elementary's profile.
1797 * This sets the global profile that is applied to Elementary
1798 * applications. Just the process the call comes from will be
1801 * @param profile The profile's name
1805 EAPI void elm_profile_set(const char *profile);
1808 * Set Elementary's profile.
1810 * This sets the global profile that is applied to all Elementary
1811 * applications. All running Elementary windows will be affected.
1813 * @param profile The profile's name
1817 EAPI void elm_profile_all_set(const char *profile);
1824 * @defgroup Engine Elementary Engine
1826 * These are functions setting and querying which rendering engine
1827 * Elementary will use for drawing its windows' pixels.
1829 * The following are the available engines:
1830 * @li "software_x11"
1833 * @li "software_16_x11"
1834 * @li "software_8_x11"
1837 * @li "software_gdi"
1838 * @li "software_16_wince_gdi"
1840 * @li "software_16_sdl"
1848 * @brief Get Elementary's rendering engine in use.
1850 * @return The rendering engine's name
1851 * @note there's no need to free the returned string, here.
1853 * This gets the global rendering engine that is applied to all Elementary
1856 * @see elm_engine_set()
1858 EAPI const char *elm_engine_current_get(void);
1861 * @brief Set Elementary's rendering engine for use.
1863 * @param engine The rendering engine's name
1865 * This sets global rendering engine that is applied to all Elementary
1866 * applications. Note that it will take effect only to Elementary windows
1867 * created after this is called.
1869 * @see elm_win_add()
1871 EAPI void elm_engine_set(const char *engine);
1878 * @defgroup Fonts Elementary Fonts
1880 * These are functions dealing with font rendering, selection and the
1881 * like for Elementary applications. One might fetch which system
1882 * fonts are there to use and set custom fonts for individual classes
1883 * of UI items containing text (text classes).
1888 typedef struct _Elm_Text_Class
1894 typedef struct _Elm_Font_Overlay
1896 const char *text_class;
1898 Evas_Font_Size size;
1901 typedef struct _Elm_Font_Properties
1905 } Elm_Font_Properties;
1908 * Get Elementary's list of supported text classes.
1910 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1913 * Release the list with elm_text_classes_list_free().
1915 EAPI const Eina_List *elm_text_classes_list_get(void);
1918 * Free Elementary's list of supported text classes.
1922 * @see elm_text_classes_list_get().
1924 EAPI void elm_text_classes_list_free(const Eina_List *list);
1927 * Get Elementary's list of font overlays, set with
1928 * elm_font_overlay_set().
1930 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1935 * For each text class, one can set a <b>font overlay</b> for it,
1936 * overriding the default font properties for that class coming from
1937 * the theme in use. There is no need to free this list.
1939 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1941 EAPI const Eina_List *elm_font_overlay_list_get(void);
1944 * Set a font overlay for a given Elementary text class.
1946 * @param text_class Text class name
1947 * @param font Font name and style string
1948 * @param size Font size
1952 * @p font has to be in the format returned by
1953 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1954 * and elm_font_overlay_unset().
1956 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1959 * Unset a font overlay for a given Elementary text class.
1961 * @param text_class Text class name
1965 * This will bring back text elements belonging to text class
1966 * @p text_class back to their default font settings.
1968 EAPI void elm_font_overlay_unset(const char *text_class);
1971 * Apply the changes made with elm_font_overlay_set() and
1972 * elm_font_overlay_unset() on the current Elementary window.
1976 * This applies all font overlays set to all objects in the UI.
1978 EAPI void elm_font_overlay_apply(void);
1981 * Apply the changes made with elm_font_overlay_set() and
1982 * elm_font_overlay_unset() on all Elementary application windows.
1986 * This applies all font overlays set to all objects in the UI.
1988 EAPI void elm_font_overlay_all_apply(void);
1991 * Translate a font (family) name string in fontconfig's font names
1992 * syntax into an @c Elm_Font_Properties struct.
1994 * @param font The font name and styles string
1995 * @return the font properties struct
1999 * @note The reverse translation can be achived with
2000 * elm_font_fontconfig_name_get(), for one style only (single font
2001 * instance, not family).
2003 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2006 * Free font properties return by elm_font_properties_get().
2008 * @param efp the font properties struct
2012 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2015 * Translate a font name, bound to a style, into fontconfig's font names
2018 * @param name The font (family) name
2019 * @param style The given style (may be @c NULL)
2021 * @return the font name and style string
2025 * @note The reverse translation can be achived with
2026 * elm_font_properties_get(), for one style only (single font
2027 * instance, not family).
2029 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2032 * Free the font string return by elm_font_fontconfig_name_get().
2034 * @param efp the font properties struct
2038 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2041 * Create a font hash table of available system fonts.
2043 * One must call it with @p list being the return value of
2044 * evas_font_available_list(). The hash will be indexed by font
2045 * (family) names, being its values @c Elm_Font_Properties blobs.
2047 * @param list The list of available system fonts, as returned by
2048 * evas_font_available_list().
2049 * @return the font hash.
2053 * @note The user is supposed to get it populated at least with 3
2054 * default font families (Sans, Serif, Monospace), which should be
2055 * present on most systems.
2057 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2060 * Free the hash return by elm_font_available_hash_add().
2062 * @param hash the hash to be freed.
2066 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2073 * @defgroup Fingers Fingers
2075 * Elementary is designed to be finger-friendly for touchscreens,
2076 * and so in addition to scaling for display resolution, it can
2077 * also scale based on finger "resolution" (or size). You can then
2078 * customize the granularity of the areas meant to receive clicks
2081 * Different profiles may have pre-set values for finger sizes.
2083 * @ref general_functions_example_page "This" example contemplates
2084 * some of these functions.
2090 * Get the configured "finger size"
2092 * @return The finger size
2094 * This gets the globally configured finger size, <b>in pixels</b>
2098 EAPI Evas_Coord elm_finger_size_get(void);
2101 * Set the configured finger size
2103 * This sets the globally configured finger size in pixels
2105 * @param size The finger size
2108 EAPI void elm_finger_size_set(Evas_Coord size);
2111 * Set the configured finger size for all applications on the display
2113 * This sets the globally configured finger size in pixels for all
2114 * applications on the display
2116 * @param size The finger size
2119 EAPI void elm_finger_size_all_set(Evas_Coord size);
2126 * @defgroup Focus Focus
2128 * An Elementary application has, at all times, one (and only one)
2129 * @b focused object. This is what determines where the input
2130 * events go to within the application's window. Also, focused
2131 * objects can be decorated differently, in order to signal to the
2132 * user where the input is, at a given moment.
2134 * Elementary applications also have the concept of <b>focus
2135 * chain</b>: one can cycle through all the windows' focusable
2136 * objects by input (tab key) or programmatically. The default
2137 * focus chain for an application is the one define by the order in
2138 * which the widgets where added in code. One will cycle through
2139 * top level widgets, and, for each one containg sub-objects, cycle
2140 * through them all, before returning to the level
2141 * above. Elementary also allows one to set @b custom focus chains
2142 * for their applications.
2144 * Besides the focused decoration a widget may exhibit, when it
2145 * gets focus, Elementary has a @b global focus highlight object
2146 * that can be enabled for a window. If one chooses to do so, this
2147 * extra highlight effect will surround the current focused object,
2150 * @note Some Elementary widgets are @b unfocusable, after
2151 * creation, by their very nature: they are not meant to be
2152 * interacted with input events, but are there just for visual
2155 * @ref general_functions_example_page "This" example contemplates
2156 * some of these functions.
2160 * Get the enable status of the focus highlight
2162 * This gets whether the highlight on focused objects is enabled or not
2165 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2168 * Set the enable status of the focus highlight
2170 * Set whether to show or not the highlight on focused objects
2171 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2174 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2177 * Get the enable status of the highlight animation
2179 * Get whether the focus highlight, if enabled, will animate its switch from
2180 * one object to the next
2183 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2186 * Set the enable status of the highlight animation
2188 * Set whether the focus highlight, if enabled, will animate its switch from
2189 * one object to the next
2190 * @param animate Enable animation if EINA_TRUE, disable otherwise
2193 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2196 * Get the whether an Elementary object has the focus or not.
2198 * @param obj The Elementary object to get the information from
2199 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2200 * not (and on errors).
2202 * @see elm_object_focus_set()
2206 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2209 * Set/unset focus to a given Elementary object.
2211 * @param obj The Elementary object to operate on.
2212 * @param enable @c EINA_TRUE Set focus to a given object,
2213 * @c EINA_FALSE Unset focus to a given object.
2215 * @note When you set focus to this object, if it can handle focus, will
2216 * take the focus away from the one who had it previously and will, for
2217 * now on, be the one receiving input events. Unsetting focus will remove
2218 * the focus from @p obj, passing it back to the previous element in the
2221 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2225 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2228 * Make a given Elementary object the focused one.
2230 * @param obj The Elementary object to make focused.
2232 * @note This object, if it can handle focus, will take the focus
2233 * away from the one who had it previously and will, for now on, be
2234 * the one receiving input events.
2236 * @see elm_object_focus_get()
2237 * @deprecated use elm_object_focus_set() instead.
2241 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2244 * Remove the focus from an Elementary object
2246 * @param obj The Elementary to take focus from
2248 * This removes the focus from @p obj, passing it back to the
2249 * previous element in the focus chain list.
2251 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2252 * @deprecated use elm_object_focus_set() instead.
2256 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2259 * Set the ability for an Element object to be focused
2261 * @param obj The Elementary object to operate on
2262 * @param enable @c EINA_TRUE if the object can be focused, @c
2263 * EINA_FALSE if not (and on errors)
2265 * This sets whether the object @p obj is able to take focus or
2266 * not. Unfocusable objects do nothing when programmatically
2267 * focused, being the nearest focusable parent object the one
2268 * really getting focus. Also, when they receive mouse input, they
2269 * will get the event, but not take away the focus from where it
2274 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2277 * Get whether an Elementary object is focusable or not
2279 * @param obj The Elementary object to operate on
2280 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2281 * EINA_FALSE if not (and on errors)
2283 * @note Objects which are meant to be interacted with by input
2284 * events are created able to be focused, by default. All the
2289 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2292 * Set custom focus chain.
2294 * This function overwrites any previous custom focus chain within
2295 * the list of objects. The previous list will be deleted and this list
2296 * will be managed by elementary. After it is set, don't modify it.
2298 * @note On focus cycle, only will be evaluated children of this container.
2300 * @param obj The container object
2301 * @param objs Chain of objects to pass focus
2304 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2307 * Unset a custom focus chain on a given Elementary widget
2309 * @param obj The container object to remove focus chain from
2311 * Any focus chain previously set on @p obj (for its child objects)
2312 * is removed entirely after this call.
2316 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2319 * Get custom focus chain
2321 * @param obj The container object
2324 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2327 * Append object to custom focus chain.
2329 * @note If relative_child equal to NULL or not in custom chain, the object
2330 * will be added in end.
2332 * @note On focus cycle, only will be evaluated children of this container.
2334 * @param obj The container object
2335 * @param child The child to be added in custom chain
2336 * @param relative_child The relative object to position the child
2339 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2342 * Prepend object to custom focus chain.
2344 * @note If relative_child equal to NULL or not in custom chain, the object
2345 * will be added in begin.
2347 * @note On focus cycle, only will be evaluated children of this container.
2349 * @param obj The container object
2350 * @param child The child to be added in custom chain
2351 * @param relative_child The relative object to position the child
2354 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2357 * Give focus to next object in object tree.
2359 * Give focus to next object in focus chain of one object sub-tree.
2360 * If the last object of chain already have focus, the focus will go to the
2361 * first object of chain.
2363 * @param obj The object root of sub-tree
2364 * @param dir Direction to cycle the focus
2368 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2371 * Give focus to near object in one direction.
2373 * Give focus to near object in direction of one object.
2374 * If none focusable object in given direction, the focus will not change.
2376 * @param obj The reference object
2377 * @param x Horizontal component of direction to focus
2378 * @param y Vertical component of direction to focus
2382 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2385 * Make the elementary object and its children to be unfocusable
2388 * @param obj The Elementary object to operate on
2389 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2390 * @c EINA_FALSE for focusable.
2392 * This sets whether the object @p obj and its children objects
2393 * are able to take focus or not. If the tree is set as unfocusable,
2394 * newest focused object which is not in this tree will get focus.
2395 * This API can be helpful for an object to be deleted.
2396 * When an object will be deleted soon, it and its children may not
2397 * want to get focus (by focus reverting or by other focus controls).
2398 * Then, just use this API before deleting.
2400 * @see elm_object_tree_unfocusable_get()
2404 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2407 * Get whether an Elementary object and its children are unfocusable or not.
2409 * @param obj The Elementary object to get the information from
2410 * @return @c EINA_TRUE, if the tree is unfocussable,
2411 * @c EINA_FALSE if not (and on errors).
2413 * @see elm_object_tree_unfocusable_set()
2417 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2420 * @defgroup Scrolling Scrolling
2422 * These are functions setting how scrollable views in Elementary
2423 * widgets should behave on user interaction.
2429 * Get whether scrollers should bounce when they reach their
2430 * viewport's edge during a scroll.
2432 * @return the thumb scroll bouncing state
2434 * This is the default behavior for touch screens, in general.
2435 * @ingroup Scrolling
2437 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2440 * Set whether scrollers should bounce when they reach their
2441 * viewport's edge during a scroll.
2443 * @param enabled the thumb scroll bouncing state
2445 * @see elm_thumbscroll_bounce_enabled_get()
2446 * @ingroup Scrolling
2448 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2451 * Set whether scrollers should bounce when they reach their
2452 * viewport's edge during a scroll, for all Elementary application
2455 * @param enabled the thumb scroll bouncing state
2457 * @see elm_thumbscroll_bounce_enabled_get()
2458 * @ingroup Scrolling
2460 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2463 * Get the amount of inertia a scroller will impose at bounce
2466 * @return the thumb scroll bounce friction
2468 * @ingroup Scrolling
2470 EAPI double elm_scroll_bounce_friction_get(void);
2473 * Set the amount of inertia a scroller will impose at bounce
2476 * @param friction the thumb scroll bounce friction
2478 * @see elm_thumbscroll_bounce_friction_get()
2479 * @ingroup Scrolling
2481 EAPI void elm_scroll_bounce_friction_set(double friction);
2484 * Set the amount of inertia a scroller will impose at bounce
2485 * animations, for all Elementary application windows.
2487 * @param friction the thumb scroll bounce friction
2489 * @see elm_thumbscroll_bounce_friction_get()
2490 * @ingroup Scrolling
2492 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2495 * Get the amount of inertia a <b>paged</b> scroller will impose at
2496 * page fitting animations.
2498 * @return the page scroll friction
2500 * @ingroup Scrolling
2502 EAPI double elm_scroll_page_scroll_friction_get(void);
2505 * Set the amount of inertia a <b>paged</b> scroller will impose at
2506 * page fitting animations.
2508 * @param friction the page scroll friction
2510 * @see elm_thumbscroll_page_scroll_friction_get()
2511 * @ingroup Scrolling
2513 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2516 * Set the amount of inertia a <b>paged</b> scroller will impose at
2517 * page fitting animations, for all Elementary application windows.
2519 * @param friction the page scroll friction
2521 * @see elm_thumbscroll_page_scroll_friction_get()
2522 * @ingroup Scrolling
2524 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2527 * Get the amount of inertia a scroller will impose at region bring
2530 * @return the bring in scroll friction
2532 * @ingroup Scrolling
2534 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2537 * Set the amount of inertia a scroller will impose at region bring
2540 * @param friction the bring in scroll friction
2542 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2543 * @ingroup Scrolling
2545 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2548 * Set the amount of inertia a scroller will impose at region bring
2549 * animations, for all Elementary application windows.
2551 * @param friction the bring in scroll friction
2553 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2554 * @ingroup Scrolling
2556 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2559 * Get the amount of inertia scrollers will impose at animations
2560 * triggered by Elementary widgets' zooming API.
2562 * @return the zoom friction
2564 * @ingroup Scrolling
2566 EAPI double elm_scroll_zoom_friction_get(void);
2569 * Set the amount of inertia scrollers will impose at animations
2570 * triggered by Elementary widgets' zooming API.
2572 * @param friction the zoom friction
2574 * @see elm_thumbscroll_zoom_friction_get()
2575 * @ingroup Scrolling
2577 EAPI void elm_scroll_zoom_friction_set(double friction);
2580 * Set the amount of inertia scrollers will impose at animations
2581 * triggered by Elementary widgets' zooming API, for all Elementary
2582 * application windows.
2584 * @param friction the zoom friction
2586 * @see elm_thumbscroll_zoom_friction_get()
2587 * @ingroup Scrolling
2589 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2592 * Get whether scrollers should be draggable from any point in their
2595 * @return the thumb scroll state
2597 * @note This is the default behavior for touch screens, in general.
2598 * @note All other functions namespaced with "thumbscroll" will only
2599 * have effect if this mode is enabled.
2601 * @ingroup Scrolling
2603 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2606 * Set whether scrollers should be draggable from any point in their
2609 * @param enabled the thumb scroll state
2611 * @see elm_thumbscroll_enabled_get()
2612 * @ingroup Scrolling
2614 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2617 * Set whether scrollers should be draggable from any point in their
2618 * views, for all Elementary application windows.
2620 * @param enabled the thumb scroll state
2622 * @see elm_thumbscroll_enabled_get()
2623 * @ingroup Scrolling
2625 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2628 * Get the number of pixels one should travel while dragging a
2629 * scroller's view to actually trigger scrolling.
2631 * @return the thumb scroll threshould
2633 * One would use higher values for touch screens, in general, because
2634 * of their inherent imprecision.
2635 * @ingroup Scrolling
2637 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2640 * Set the number of pixels one should travel while dragging a
2641 * scroller's view to actually trigger scrolling.
2643 * @param threshold the thumb scroll threshould
2645 * @see elm_thumbscroll_threshould_get()
2646 * @ingroup Scrolling
2648 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2651 * Set the number of pixels one should travel while dragging a
2652 * scroller's view to actually trigger scrolling, for all Elementary
2653 * application windows.
2655 * @param threshold the thumb scroll threshould
2657 * @see elm_thumbscroll_threshould_get()
2658 * @ingroup Scrolling
2660 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2663 * Get the minimum speed of mouse cursor movement which will trigger
2664 * list self scrolling animation after a mouse up event
2667 * @return the thumb scroll momentum threshould
2669 * @ingroup Scrolling
2671 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2674 * Set the minimum speed of mouse cursor movement which will trigger
2675 * list self scrolling animation after a mouse up event
2678 * @param threshold the thumb scroll momentum threshould
2680 * @see elm_thumbscroll_momentum_threshould_get()
2681 * @ingroup Scrolling
2683 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2686 * Set the minimum speed of mouse cursor movement which will trigger
2687 * list self scrolling animation after a mouse up event
2688 * (pixels/second), for all Elementary application windows.
2690 * @param threshold the thumb scroll momentum threshould
2692 * @see elm_thumbscroll_momentum_threshould_get()
2693 * @ingroup Scrolling
2695 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2698 * Get the amount of inertia a scroller will impose at self scrolling
2701 * @return the thumb scroll friction
2703 * @ingroup Scrolling
2705 EAPI double elm_scroll_thumbscroll_friction_get(void);
2708 * Set the amount of inertia a scroller will impose at self scrolling
2711 * @param friction the thumb scroll friction
2713 * @see elm_thumbscroll_friction_get()
2714 * @ingroup Scrolling
2716 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2719 * Set the amount of inertia a scroller will impose at self scrolling
2720 * animations, for all Elementary application windows.
2722 * @param friction the thumb scroll friction
2724 * @see elm_thumbscroll_friction_get()
2725 * @ingroup Scrolling
2727 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2730 * Get the amount of lag between your actual mouse cursor dragging
2731 * movement and a scroller's view movement itself, while pushing it
2732 * into bounce state manually.
2734 * @return the thumb scroll border friction
2736 * @ingroup Scrolling
2738 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2741 * Set the amount of lag between your actual mouse cursor dragging
2742 * movement and a scroller's view movement itself, while pushing it
2743 * into bounce state manually.
2745 * @param friction the thumb scroll border friction. @c 0.0 for
2746 * perfect synchrony between two movements, @c 1.0 for maximum
2749 * @see elm_thumbscroll_border_friction_get()
2750 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2752 * @ingroup Scrolling
2754 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2757 * Set the amount of lag between your actual mouse cursor dragging
2758 * movement and a scroller's view movement itself, while pushing it
2759 * into bounce state manually, for all Elementary application windows.
2761 * @param friction the thumb scroll border friction. @c 0.0 for
2762 * perfect synchrony between two movements, @c 1.0 for maximum
2765 * @see elm_thumbscroll_border_friction_get()
2766 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2768 * @ingroup Scrolling
2770 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2777 * @defgroup Scrollhints Scrollhints
2779 * Objects when inside a scroller can scroll, but this may not always be
2780 * desirable in certain situations. This allows an object to hint to itself
2781 * and parents to "not scroll" in one of 2 ways. If any child object of a
2782 * scroller has pushed a scroll freeze or hold then it affects all parent
2783 * scrollers until all children have released them.
2785 * 1. To hold on scrolling. This means just flicking and dragging may no
2786 * longer scroll, but pressing/dragging near an edge of the scroller will
2787 * still scroll. This is automatically used by the entry object when
2790 * 2. To totally freeze scrolling. This means it stops. until
2797 * Push the scroll hold by 1
2799 * This increments the scroll hold count by one. If it is more than 0 it will
2800 * take effect on the parents of the indicated object.
2802 * @param obj The object
2803 * @ingroup Scrollhints
2805 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2808 * Pop the scroll hold by 1
2810 * This decrements the scroll hold count by one. If it is more than 0 it will
2811 * take effect on the parents of the indicated object.
2813 * @param obj The object
2814 * @ingroup Scrollhints
2816 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2819 * Push the scroll freeze by 1
2821 * This increments the scroll freeze count by one. If it is more
2822 * than 0 it will take effect on the parents of the indicated
2825 * @param obj The object
2826 * @ingroup Scrollhints
2828 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2831 * Pop the scroll freeze by 1
2833 * This decrements the scroll freeze count by one. If it is more
2834 * than 0 it will take effect on the parents of the indicated
2837 * @param obj The object
2838 * @ingroup Scrollhints
2840 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2843 * Lock the scrolling of the given widget (and thus all parents)
2845 * This locks the given object from scrolling in the X axis (and implicitly
2846 * also locks all parent scrollers too from doing the same).
2848 * @param obj The object
2849 * @param lock The lock state (1 == locked, 0 == unlocked)
2850 * @ingroup Scrollhints
2852 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2855 * Lock the scrolling of the given widget (and thus all parents)
2857 * This locks the given object from scrolling in the Y axis (and implicitly
2858 * also locks all parent scrollers too from doing the same).
2860 * @param obj The object
2861 * @param lock The lock state (1 == locked, 0 == unlocked)
2862 * @ingroup Scrollhints
2864 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2867 * Get the scrolling lock of the given widget
2869 * This gets the lock for X axis scrolling.
2871 * @param obj The object
2872 * @ingroup Scrollhints
2874 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2877 * Get the scrolling lock of the given widget
2879 * This gets the lock for X axis scrolling.
2881 * @param obj The object
2882 * @ingroup Scrollhints
2884 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2891 * Send a signal to the widget edje object.
2893 * This function sends a signal to the edje object of the obj. An
2894 * edje program can respond to a signal by specifying matching
2895 * 'signal' and 'source' fields.
2897 * @param obj The object
2898 * @param emission The signal's name.
2899 * @param source The signal's source.
2902 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2905 * Add a callback for a signal emitted by widget edje object.
2907 * This function connects a callback function to a signal emitted by the
2908 * edje object of the obj.
2909 * Globs can occur in either the emission or source name.
2911 * @param obj The object
2912 * @param emission The signal's name.
2913 * @param source The signal's source.
2914 * @param func The callback function to be executed when the signal is
2916 * @param data A pointer to data to pass in to the callback function.
2919 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);
2922 * Remove a signal-triggered callback from a widget edje object.
2924 * This function removes a callback, previoulsy attached to a
2925 * signal emitted by the edje object of the obj. The parameters
2926 * emission, source and func must match exactly those passed to a
2927 * previous call to elm_object_signal_callback_add(). The data
2928 * pointer that was passed to this call will be returned.
2930 * @param obj The object
2931 * @param emission The signal's name.
2932 * @param source The signal's source.
2933 * @param func The callback function to be executed when the signal is
2935 * @return The data pointer
2938 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);
2941 * Add a callback for input events (key up, key down, mouse wheel)
2942 * on a given Elementary widget
2944 * @param obj The widget to add an event callback on
2945 * @param func The callback function to be executed when the event
2947 * @param data Data to pass in to @p func
2949 * Every widget in an Elementary interface set to receive focus,
2950 * with elm_object_focus_allow_set(), will propagate @b all of its
2951 * key up, key down and mouse wheel input events up to its parent
2952 * object, and so on. All of the focusable ones in this chain which
2953 * had an event callback set, with this call, will be able to treat
2954 * those events. There are two ways of making the propagation of
2955 * these event upwards in the tree of widgets to @b cease:
2956 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2957 * the event was @b not processed, so the propagation will go on.
2958 * - The @c event_info pointer passed to @p func will contain the
2959 * event's structure and, if you OR its @c event_flags inner
2960 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2961 * one has already handled it, thus killing the event's
2964 * @note Your event callback will be issued on those events taking
2965 * place only if no other child widget of @obj has consumed the
2968 * @note Not to be confused with @c
2969 * evas_object_event_callback_add(), which will add event callbacks
2970 * per type on general Evas objects (no event propagation
2971 * infrastructure taken in account).
2973 * @note Not to be confused with @c
2974 * elm_object_signal_callback_add(), which will add callbacks to @b
2975 * signals coming from a widget's theme, not input events.
2977 * @note Not to be confused with @c
2978 * edje_object_signal_callback_add(), which does the same as
2979 * elm_object_signal_callback_add(), but directly on an Edje
2982 * @note Not to be confused with @c
2983 * evas_object_smart_callback_add(), which adds callbacks to smart
2984 * objects' <b>smart events</b>, and not input events.
2986 * @see elm_object_event_callback_del()
2990 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2993 * Remove an event callback from a widget.
2995 * This function removes a callback, previoulsy attached to event emission
2997 * The parameters func and data must match exactly those passed to
2998 * a previous call to elm_object_event_callback_add(). The data pointer that
2999 * was passed to this call will be returned.
3001 * @param obj The object
3002 * @param func The callback function to be executed when the event is
3004 * @param data Data to pass in to the callback function.
3005 * @return The data pointer
3008 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3011 * Adjust size of an element for finger usage.
3013 * @param times_w How many fingers should fit horizontally
3014 * @param w Pointer to the width size to adjust
3015 * @param times_h How many fingers should fit vertically
3016 * @param h Pointer to the height size to adjust
3018 * This takes width and height sizes (in pixels) as input and a
3019 * size multiple (which is how many fingers you want to place
3020 * within the area, being "finger" the size set by
3021 * elm_finger_size_set()), and adjusts the size to be large enough
3022 * to accommodate the resulting size -- if it doesn't already
3023 * accommodate it. On return the @p w and @p h sizes pointed to by
3024 * these parameters will be modified, on those conditions.
3026 * @note This is kind of a low level Elementary call, most useful
3027 * on size evaluation times for widgets. An external user wouldn't
3028 * be calling, most of the time.
3032 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3035 * Get the duration for occuring long press event.
3037 * @return Timeout for long press event
3038 * @ingroup Longpress
3040 EAPI double elm_longpress_timeout_get(void);
3043 * Set the duration for occuring long press event.
3045 * @param lonpress_timeout Timeout for long press event
3046 * @ingroup Longpress
3048 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3051 * @defgroup Debug Debug
3052 * don't use it unless you are sure
3058 * Print Tree object hierarchy in stdout
3060 * @param obj The root object
3063 EAPI void elm_object_tree_dump(const Evas_Object *top);
3066 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3068 * @param obj The root object
3069 * @param file The path of output file
3072 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3079 * @defgroup Theme Theme
3081 * Elementary uses Edje to theme its widgets, naturally. But for the most
3082 * part this is hidden behind a simpler interface that lets the user set
3083 * extensions and choose the style of widgets in a much easier way.
3085 * Instead of thinking in terms of paths to Edje files and their groups
3086 * each time you want to change the appearance of a widget, Elementary
3087 * works so you can add any theme file with extensions or replace the
3088 * main theme at one point in the application, and then just set the style
3089 * of widgets with elm_object_style_set() and related functions. Elementary
3090 * will then look in its list of themes for a matching group and apply it,
3091 * and when the theme changes midway through the application, all widgets
3092 * will be updated accordingly.
3094 * There are three concepts you need to know to understand how Elementary
3095 * theming works: default theme, extensions and overlays.
3097 * Default theme, obviously enough, is the one that provides the default
3098 * look of all widgets. End users can change the theme used by Elementary
3099 * by setting the @c ELM_THEME environment variable before running an
3100 * application, or globally for all programs using the @c elementary_config
3101 * utility. Applications can change the default theme using elm_theme_set(),
3102 * but this can go against the user wishes, so it's not an adviced practice.
3104 * Ideally, applications should find everything they need in the already
3105 * provided theme, but there may be occasions when that's not enough and
3106 * custom styles are required to correctly express the idea. For this
3107 * cases, Elementary has extensions.
3109 * Extensions allow the application developer to write styles of its own
3110 * to apply to some widgets. This requires knowledge of how each widget
3111 * is themed, as extensions will always replace the entire group used by
3112 * the widget, so important signals and parts need to be there for the
3113 * object to behave properly (see documentation of Edje for details).
3114 * Once the theme for the extension is done, the application needs to add
3115 * it to the list of themes Elementary will look into, using
3116 * elm_theme_extension_add(), and set the style of the desired widgets as
3117 * he would normally with elm_object_style_set().
3119 * Overlays, on the other hand, can replace the look of all widgets by
3120 * overriding the default style. Like extensions, it's up to the application
3121 * developer to write the theme for the widgets it wants, the difference
3122 * being that when looking for the theme, Elementary will check first the
3123 * list of overlays, then the set theme and lastly the list of extensions,
3124 * so with overlays it's possible to replace the default view and every
3125 * widget will be affected. This is very much alike to setting the whole
3126 * theme for the application and will probably clash with the end user
3127 * options, not to mention the risk of ending up with not matching styles
3128 * across the program. Unless there's a very special reason to use them,
3129 * overlays should be avoided for the resons exposed before.
3131 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3132 * keeps one default internally and every function that receives one of
3133 * these can be called with NULL to refer to this default (except for
3134 * elm_theme_free()). It's possible to create a new instance of a
3135 * ::Elm_Theme to set other theme for a specific widget (and all of its
3136 * children), but this is as discouraged, if not even more so, than using
3137 * overlays. Don't use this unless you really know what you are doing.
3139 * But to be less negative about things, you can look at the following
3141 * @li @ref theme_example_01 "Using extensions"
3142 * @li @ref theme_example_02 "Using overlays"
3147 * @typedef Elm_Theme
3149 * Opaque handler for the list of themes Elementary looks for when
3150 * rendering widgets.
3152 * Stay out of this unless you really know what you are doing. For most
3153 * cases, sticking to the default is all a developer needs.
3155 typedef struct _Elm_Theme Elm_Theme;
3158 * Create a new specific theme
3160 * This creates an empty specific theme that only uses the default theme. A
3161 * specific theme has its own private set of extensions and overlays too
3162 * (which are empty by default). Specific themes do not fall back to themes
3163 * of parent objects. They are not intended for this use. Use styles, overlays
3164 * and extensions when needed, but avoid specific themes unless there is no
3165 * other way (example: you want to have a preview of a new theme you are
3166 * selecting in a "theme selector" window. The preview is inside a scroller
3167 * and should display what the theme you selected will look like, but not
3168 * actually apply it yet. The child of the scroller will have a specific
3169 * theme set to show this preview before the user decides to apply it to all
3172 EAPI Elm_Theme *elm_theme_new(void);
3174 * Free a specific theme
3176 * @param th The theme to free
3178 * This frees a theme created with elm_theme_new().
3180 EAPI void elm_theme_free(Elm_Theme *th);
3182 * Copy the theme fom the source to the destination theme
3184 * @param th The source theme to copy from
3185 * @param thdst The destination theme to copy data to
3187 * This makes a one-time static copy of all the theme config, extensions
3188 * and overlays from @p th to @p thdst. If @p th references a theme, then
3189 * @p thdst is also set to reference it, with all the theme settings,
3190 * overlays and extensions that @p th had.
3192 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3194 * Tell the source theme to reference the ref theme
3196 * @param th The theme that will do the referencing
3197 * @param thref The theme that is the reference source
3199 * This clears @p th to be empty and then sets it to refer to @p thref
3200 * so @p th acts as an override to @p thref, but where its overrides
3201 * don't apply, it will fall through to @p thref for configuration.
3203 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3205 * Return the theme referred to
3207 * @param th The theme to get the reference from
3208 * @return The referenced theme handle
3210 * This gets the theme set as the reference theme by elm_theme_ref_set().
3211 * If no theme is set as a reference, NULL is returned.
3213 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3215 * Return the default theme
3217 * @return The default theme handle
3219 * This returns the internal default theme setup handle that all widgets
3220 * use implicitly unless a specific theme is set. This is also often use
3221 * as a shorthand of NULL.
3223 EAPI Elm_Theme *elm_theme_default_get(void);
3225 * Prepends a theme overlay to the list of overlays
3227 * @param th The theme to add to, or if NULL, the default theme
3228 * @param item The Edje file path to be used
3230 * Use this if your application needs to provide some custom overlay theme
3231 * (An Edje file that replaces some default styles of widgets) where adding
3232 * new styles, or changing system theme configuration is not possible. Do
3233 * NOT use this instead of a proper system theme configuration. Use proper
3234 * configuration files, profiles, environment variables etc. to set a theme
3235 * so that the theme can be altered by simple confiugration by a user. Using
3236 * this call to achieve that effect is abusing the API and will create lots
3239 * @see elm_theme_extension_add()
3241 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3243 * Delete a theme overlay from the list of overlays
3245 * @param th The theme to delete from, or if NULL, the default theme
3246 * @param item The name of the theme overlay
3248 * @see elm_theme_overlay_add()
3250 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3252 * Appends a theme extension to the list of extensions.
3254 * @param th The theme to add to, or if NULL, the default theme
3255 * @param item The Edje file path to be used
3257 * This is intended when an application needs more styles of widgets or new
3258 * widget themes that the default does not provide (or may not provide). The
3259 * application has "extended" usage by coming up with new custom style names
3260 * for widgets for specific uses, but as these are not "standard", they are
3261 * not guaranteed to be provided by a default theme. This means the
3262 * application is required to provide these extra elements itself in specific
3263 * Edje files. This call adds one of those Edje files to the theme search
3264 * path to be search after the default theme. The use of this call is
3265 * encouraged when default styles do not meet the needs of the application.
3266 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3268 * @see elm_object_style_set()
3270 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3272 * Deletes a theme extension from the list of extensions.
3274 * @param th The theme to delete from, or if NULL, the default theme
3275 * @param item The name of the theme extension
3277 * @see elm_theme_extension_add()
3279 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3281 * Set the theme search order for the given theme
3283 * @param th The theme to set the search order, or if NULL, the default theme
3284 * @param theme Theme search string
3286 * This sets the search string for the theme in path-notation from first
3287 * theme to search, to last, delimited by the : character. Example:
3289 * "shiny:/path/to/file.edj:default"
3291 * See the ELM_THEME environment variable for more information.
3293 * @see elm_theme_get()
3294 * @see elm_theme_list_get()
3296 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3298 * Return the theme search order
3300 * @param th The theme to get the search order, or if NULL, the default theme
3301 * @return The internal search order path
3303 * This function returns a colon separated string of theme elements as
3304 * returned by elm_theme_list_get().
3306 * @see elm_theme_set()
3307 * @see elm_theme_list_get()
3309 EAPI const char *elm_theme_get(Elm_Theme *th);
3311 * Return a list of theme elements to be used in a theme.
3313 * @param th Theme to get the list of theme elements from.
3314 * @return The internal list of theme elements
3316 * This returns the internal list of theme elements (will only be valid as
3317 * long as the theme is not modified by elm_theme_set() or theme is not
3318 * freed by elm_theme_free(). This is a list of strings which must not be
3319 * altered as they are also internal. If @p th is NULL, then the default
3320 * theme element list is returned.
3322 * A theme element can consist of a full or relative path to a .edj file,
3323 * or a name, without extension, for a theme to be searched in the known
3324 * theme paths for Elemementary.
3326 * @see elm_theme_set()
3327 * @see elm_theme_get()
3329 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3331 * Return the full patrh for a theme element
3333 * @param f The theme element name
3334 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3335 * @return The full path to the file found.
3337 * This returns a string you should free with free() on success, NULL on
3338 * failure. This will search for the given theme element, and if it is a
3339 * full or relative path element or a simple searchable name. The returned
3340 * path is the full path to the file, if searched, and the file exists, or it
3341 * is simply the full path given in the element or a resolved path if
3342 * relative to home. The @p in_search_path boolean pointed to is set to
3343 * EINA_TRUE if the file was a searchable file andis in the search path,
3344 * and EINA_FALSE otherwise.
3346 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3348 * Flush the current theme.
3350 * @param th Theme to flush
3352 * This flushes caches that let elementary know where to find theme elements
3353 * in the given theme. If @p th is NULL, then the default theme is flushed.
3354 * Call this function if source theme data has changed in such a way as to
3355 * make any caches Elementary kept invalid.
3357 EAPI void elm_theme_flush(Elm_Theme *th);
3359 * This flushes all themes (default and specific ones).
3361 * This will flush all themes in the current application context, by calling
3362 * elm_theme_flush() on each of them.
3364 EAPI void elm_theme_full_flush(void);
3366 * Set the theme for all elementary using applications on the current display
3368 * @param theme The name of the theme to use. Format same as the ELM_THEME
3369 * environment variable.
3371 EAPI void elm_theme_all_set(const char *theme);
3373 * Return a list of theme elements in the theme search path
3375 * @return A list of strings that are the theme element names.
3377 * This lists all available theme files in the standard Elementary search path
3378 * for theme elements, and returns them in alphabetical order as theme
3379 * element names in a list of strings. Free this with
3380 * elm_theme_name_available_list_free() when you are done with the list.
3382 EAPI Eina_List *elm_theme_name_available_list_new(void);
3384 * Free the list returned by elm_theme_name_available_list_new()
3386 * This frees the list of themes returned by
3387 * elm_theme_name_available_list_new(). Once freed the list should no longer
3388 * be used. a new list mys be created.
3390 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3392 * Set a specific theme to be used for this object and its children
3394 * @param obj The object to set the theme on
3395 * @param th The theme to set
3397 * This sets a specific theme that will be used for the given object and any
3398 * child objects it has. If @p th is NULL then the theme to be used is
3399 * cleared and the object will inherit its theme from its parent (which
3400 * ultimately will use the default theme if no specific themes are set).
3402 * Use special themes with great care as this will annoy users and make
3403 * configuration difficult. Avoid any custom themes at all if it can be
3406 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3408 * Get the specific theme to be used
3410 * @param obj The object to get the specific theme from
3411 * @return The specifc theme set.
3413 * This will return a specific theme set, or NULL if no specific theme is
3414 * set on that object. It will not return inherited themes from parents, only
3415 * the specific theme set for that specific object. See elm_object_theme_set()
3416 * for more information.
3418 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3424 /** @defgroup Win Win
3426 * @image html img/widget/win/preview-00.png
3427 * @image latex img/widget/win/preview-00.eps
3429 * The window class of Elementary. Contains functions to manipulate
3430 * windows. The Evas engine used to render the window contents is specified
3431 * in the system or user elementary config files (whichever is found last),
3432 * and can be overridden with the ELM_ENGINE environment variable for
3433 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3434 * compilation setup and modules actually installed at runtime) are (listed
3435 * in order of best supported and most likely to be complete and work to
3438 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3439 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3441 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3443 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3445 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3447 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3448 * rendering using SDL as the buffer)
3449 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3450 * GDI with software)
3451 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3452 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3453 * grayscale using dedicated 8bit software engine in X11)
3454 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3455 * X11 using 16bit software engine)
3456 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3457 * (Windows CE rendering via GDI with 16bit software renderer)
3458 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3459 * buffer with 16bit software renderer)
3461 * All engines use a simple string to select the engine to render, EXCEPT
3462 * the "shot" engine. This actually encodes the output of the virtual
3463 * screenshot and how long to delay in the engine string. The engine string
3464 * is encoded in the following way:
3466 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3468 * Where options are separated by a ":" char if more than one option is
3469 * given, with delay, if provided being the first option and file the last
3470 * (order is important). The delay specifies how long to wait after the
3471 * window is shown before doing the virtual "in memory" rendering and then
3472 * save the output to the file specified by the file option (and then exit).
3473 * If no delay is given, the default is 0.5 seconds. If no file is given the
3474 * default output file is "out.png". Repeat option is for continous
3475 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3476 * fixed to "out001.png" Some examples of using the shot engine:
3478 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3479 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3480 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3481 * ELM_ENGINE="shot:delay=2.0" elementary_test
3482 * ELM_ENGINE="shot:" elementary_test
3484 * Signals that you can add callbacks for are:
3486 * @li "delete,request": the user requested to close the window. See
3487 * elm_win_autodel_set().
3488 * @li "focus,in": window got focus
3489 * @li "focus,out": window lost focus
3490 * @li "moved": window that holds the canvas was moved
3493 * @li @ref win_example_01
3498 * Defines the types of window that can be created
3500 * These are hints set on the window so that a running Window Manager knows
3501 * how the window should be handled and/or what kind of decorations it
3504 * Currently, only the X11 backed engines use them.
3506 typedef enum _Elm_Win_Type
3508 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3509 window. Almost every window will be created with this
3511 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3512 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3513 window holding desktop icons. */
3514 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3515 be kept on top of any other window by the Window
3517 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3519 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3520 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3522 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3523 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3524 entry in a menubar is clicked. Typically used
3525 with elm_win_override_set(). This hint exists
3526 for completion only, as the EFL way of
3527 implementing a menu would not normally use a
3528 separate window for its contents. */
3529 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3530 triggered by right-clicking an object. */
3531 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3532 explanatory text that typically appear after the
3533 mouse cursor hovers over an object for a while.
3534 Typically used with elm_win_override_set() and also
3535 not very commonly used in the EFL. */
3536 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3537 battery life or a new E-Mail received. */
3538 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3539 usually used in the EFL. */
3540 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3541 object being dragged across different windows, or even
3542 applications. Typically used with
3543 elm_win_override_set(). */
3544 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3545 buffer. No actual window is created for this
3546 type, instead the window and all of its
3547 contents will be rendered to an image buffer.
3548 This allows to have children window inside a
3549 parent one just like any other object would
3550 be, and do other things like applying @c
3551 Evas_Map effects to it. This is the only type
3552 of window that requires the @c parent
3553 parameter of elm_win_add() to be a valid @c
3558 * The differents layouts that can be requested for the virtual keyboard.
3560 * When the application window is being managed by Illume, it may request
3561 * any of the following layouts for the virtual keyboard.
3563 typedef enum _Elm_Win_Keyboard_Mode
3565 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3566 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3567 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3568 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3569 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3570 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3571 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3572 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3573 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3574 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3575 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3576 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3577 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3578 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3579 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3580 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3581 } Elm_Win_Keyboard_Mode;
3584 * Available commands that can be sent to the Illume manager.
3586 * When running under an Illume session, a window may send commands to the
3587 * Illume manager to perform different actions.
3589 typedef enum _Elm_Illume_Command
3591 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3593 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3595 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3597 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3598 } Elm_Illume_Command;
3601 * Adds a window object. If this is the first window created, pass NULL as
3604 * @param parent Parent object to add the window to, or NULL
3605 * @param name The name of the window
3606 * @param type The window type, one of #Elm_Win_Type.
3608 * The @p parent paramter can be @c NULL for every window @p type except
3609 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3610 * which the image object will be created.
3612 * @return The created object, or NULL on failure
3614 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3616 * Add @p subobj as a resize object of window @p obj.
3619 * Setting an object as a resize object of the window means that the
3620 * @p subobj child's size and position will be controlled by the window
3621 * directly. That is, the object will be resized to match the window size
3622 * and should never be moved or resized manually by the developer.
3624 * In addition, resize objects of the window control what the minimum size
3625 * of it will be, as well as whether it can or not be resized by the user.
3627 * For the end user to be able to resize a window by dragging the handles
3628 * or borders provided by the Window Manager, or using any other similar
3629 * mechanism, all of the resize objects in the window should have their
3630 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3632 * @param obj The window object
3633 * @param subobj The resize object to add
3635 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3637 * Delete @p subobj as a resize object of window @p obj.
3639 * This function removes the object @p subobj from the resize objects of
3640 * the window @p obj. It will not delete the object itself, which will be
3641 * left unmanaged and should be deleted by the developer, manually handled
3642 * or set as child of some other container.
3644 * @param obj The window object
3645 * @param subobj The resize object to add
3647 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3649 * Set the title of the window
3651 * @param obj The window object
3652 * @param title The title to set
3654 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3656 * Get the title of the window
3658 * The returned string is an internal one and should not be freed or
3659 * modified. It will also be rendered invalid if a new title is set or if
3660 * the window is destroyed.
3662 * @param obj The window object
3665 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3667 * Set the window's autodel state.
3669 * When closing the window in any way outside of the program control, like
3670 * pressing the X button in the titlebar or using a command from the
3671 * Window Manager, a "delete,request" signal is emitted to indicate that
3672 * this event occurred and the developer can take any action, which may
3673 * include, or not, destroying the window object.
3675 * When the @p autodel parameter is set, the window will be automatically
3676 * destroyed when this event occurs, after the signal is emitted.
3677 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3678 * and is up to the program to do so when it's required.
3680 * @param obj The window object
3681 * @param autodel If true, the window will automatically delete itself when
3684 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3686 * Get the window's autodel state.
3688 * @param obj The window object
3689 * @return If the window will automatically delete itself when closed
3691 * @see elm_win_autodel_set()
3693 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3695 * Activate a window object.
3697 * This function sends a request to the Window Manager to activate the
3698 * window pointed by @p obj. If honored by the WM, the window will receive
3699 * the keyboard focus.
3701 * @note This is just a request that a Window Manager may ignore, so calling
3702 * this function does not ensure in any way that the window will be the
3703 * active one after it.
3705 * @param obj The window object
3707 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3709 * Lower a window object.
3711 * Places the window pointed by @p obj at the bottom of the stack, so that
3712 * no other window is covered by it.
3714 * If elm_win_override_set() is not set, the Window Manager may ignore this
3717 * @param obj The window object
3719 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3721 * Raise a window object.
3723 * Places the window pointed by @p obj at the top of the stack, so that it's
3724 * not covered by any other window.
3726 * If elm_win_override_set() is not set, the Window Manager may ignore this
3729 * @param obj The window object
3731 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3733 * Set the borderless state of a window.
3735 * This function requests the Window Manager to not draw any decoration
3736 * around the window.
3738 * @param obj The window object
3739 * @param borderless If true, the window is borderless
3741 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3743 * Get the borderless state of a window.
3745 * @param obj The window object
3746 * @return If true, the window is borderless
3748 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3750 * Set the shaped state of a window.
3752 * Shaped windows, when supported, will render the parts of the window that
3753 * has no content, transparent.
3755 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3756 * background object or cover the entire window in any other way, or the
3757 * parts of the canvas that have no data will show framebuffer artifacts.
3759 * @param obj The window object
3760 * @param shaped If true, the window is shaped
3762 * @see elm_win_alpha_set()
3764 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3766 * Get the shaped state of a window.
3768 * @param obj The window object
3769 * @return If true, the window is shaped
3771 * @see elm_win_shaped_set()
3773 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3775 * Set the alpha channel state of a window.
3777 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3778 * possibly making parts of the window completely or partially transparent.
3779 * This is also subject to the underlying system supporting it, like for
3780 * example, running under a compositing manager. If no compositing is
3781 * available, enabling this option will instead fallback to using shaped
3782 * windows, with elm_win_shaped_set().
3784 * @param obj The window object
3785 * @param alpha If true, the window has an alpha channel
3787 * @see elm_win_alpha_set()
3789 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3791 * Get the transparency state of a window.
3793 * @param obj The window object
3794 * @return If true, the window is transparent
3796 * @see elm_win_transparent_set()
3798 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3800 * Set the transparency state of a window.
3802 * Use elm_win_alpha_set() instead.
3804 * @param obj The window object
3805 * @param transparent If true, the window is transparent
3807 * @see elm_win_alpha_set()
3809 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3811 * Get the alpha channel state of a window.
3813 * @param obj The window object
3814 * @return If true, the window has an alpha channel
3816 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3818 * Set the override state of a window.
3820 * A window with @p override set to EINA_TRUE will not be managed by the
3821 * Window Manager. This means that no decorations of any kind will be shown
3822 * for it, moving and resizing must be handled by the application, as well
3823 * as the window visibility.
3825 * This should not be used for normal windows, and even for not so normal
3826 * ones, it should only be used when there's a good reason and with a lot
3827 * of care. Mishandling override windows may result situations that
3828 * disrupt the normal workflow of the end user.
3830 * @param obj The window object
3831 * @param override If true, the window is overridden
3833 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3835 * Get the override state of a window.
3837 * @param obj The window object
3838 * @return If true, the window is overridden
3840 * @see elm_win_override_set()
3842 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3844 * Set the fullscreen state of a window.
3846 * @param obj The window object
3847 * @param fullscreen If true, the window is fullscreen
3849 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3851 * Get the fullscreen state of a window.
3853 * @param obj The window object
3854 * @return If true, the window is fullscreen
3856 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3858 * Set the maximized state of a window.
3860 * @param obj The window object
3861 * @param maximized If true, the window is maximized
3863 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3865 * Get the maximized state of a window.
3867 * @param obj The window object
3868 * @return If true, the window is maximized
3870 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3872 * Set the iconified state of a window.
3874 * @param obj The window object
3875 * @param iconified If true, the window is iconified
3877 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3879 * Get the iconified state of a window.
3881 * @param obj The window object
3882 * @return If true, the window is iconified
3884 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3886 * Set the layer of the window.
3888 * What this means exactly will depend on the underlying engine used.
3890 * In the case of X11 backed engines, the value in @p layer has the
3891 * following meanings:
3892 * @li < 3: The window will be placed below all others.
3893 * @li > 5: The window will be placed above all others.
3894 * @li other: The window will be placed in the default layer.
3896 * @param obj The window object
3897 * @param layer The layer of the window
3899 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3901 * Get the layer of the window.
3903 * @param obj The window object
3904 * @return The layer of the window
3906 * @see elm_win_layer_set()
3908 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3910 * Set the rotation of the window.
3912 * Most engines only work with multiples of 90.
3914 * This function is used to set the orientation of the window @p obj to
3915 * match that of the screen. The window itself will be resized to adjust
3916 * to the new geometry of its contents. If you want to keep the window size,
3917 * see elm_win_rotation_with_resize_set().
3919 * @param obj The window object
3920 * @param rotation The rotation of the window, in degrees (0-360),
3921 * counter-clockwise.
3923 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3925 * Rotates the window and resizes it.
3927 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3928 * that they fit inside the current window geometry.
3930 * @param obj The window object
3931 * @param layer The rotation of the window in degrees (0-360),
3932 * counter-clockwise.
3934 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3936 * Get the rotation of the window.
3938 * @param obj The window object
3939 * @return The rotation of the window in degrees (0-360)
3941 * @see elm_win_rotation_set()
3942 * @see elm_win_rotation_with_resize_set()
3944 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3946 * Set the sticky state of the window.
3948 * Hints the Window Manager that the window in @p obj should be left fixed
3949 * at its position even when the virtual desktop it's on moves or changes.
3951 * @param obj The window object
3952 * @param sticky If true, the window's sticky state is enabled
3954 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3956 * Get the sticky state of the window.
3958 * @param obj The window object
3959 * @return If true, the window's sticky state is enabled
3961 * @see elm_win_sticky_set()
3963 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3965 * Set if this window is an illume conformant window
3967 * @param obj The window object
3968 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3970 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3972 * Get if this window is an illume conformant window
3974 * @param obj The window object
3975 * @return A boolean if this window is illume conformant or not
3977 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3979 * Set a window to be an illume quickpanel window
3981 * By default window objects are not quickpanel windows.
3983 * @param obj The window object
3984 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3986 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3988 * Get if this window is a quickpanel or not
3990 * @param obj The window object
3991 * @return A boolean if this window is a quickpanel or not
3993 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3995 * Set the major priority of a quickpanel window
3997 * @param obj The window object
3998 * @param priority The major priority for this quickpanel
4000 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4002 * Get the major priority of a quickpanel window
4004 * @param obj The window object
4005 * @return The major priority of this quickpanel
4007 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4009 * Set the minor priority of a quickpanel window
4011 * @param obj The window object
4012 * @param priority The minor priority for this quickpanel
4014 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4016 * Get the minor priority of a quickpanel window
4018 * @param obj The window object
4019 * @return The minor priority of this quickpanel
4021 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4023 * Set which zone this quickpanel should appear in
4025 * @param obj The window object
4026 * @param zone The requested zone for this quickpanel
4028 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4030 * Get which zone this quickpanel should appear in
4032 * @param obj The window object
4033 * @return The requested zone for this quickpanel
4035 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4037 * Set the window to be skipped by keyboard focus
4039 * This sets the window to be skipped by normal keyboard input. This means
4040 * a window manager will be asked to not focus this window as well as omit
4041 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4043 * Call this and enable it on a window BEFORE you show it for the first time,
4044 * otherwise it may have no effect.
4046 * Use this for windows that have only output information or might only be
4047 * interacted with by the mouse or fingers, and never for typing input.
4048 * Be careful that this may have side-effects like making the window
4049 * non-accessible in some cases unless the window is specially handled. Use
4052 * @param obj The window object
4053 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4055 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4057 * Send a command to the windowing environment
4059 * This is intended to work in touchscreen or small screen device
4060 * environments where there is a more simplistic window management policy in
4061 * place. This uses the window object indicated to select which part of the
4062 * environment to control (the part that this window lives in), and provides
4063 * a command and an optional parameter structure (use NULL for this if not
4066 * @param obj The window object that lives in the environment to control
4067 * @param command The command to send
4068 * @param params Optional parameters for the command
4070 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4072 * Get the inlined image object handle
4074 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4075 * then the window is in fact an evas image object inlined in the parent
4076 * canvas. You can get this object (be careful to not manipulate it as it
4077 * is under control of elementary), and use it to do things like get pixel
4078 * data, save the image to a file, etc.
4080 * @param obj The window object to get the inlined image from
4081 * @return The inlined image object, or NULL if none exists
4083 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4085 * Set the enabled status for the focus highlight in a window
4087 * This function will enable or disable the focus highlight only for the
4088 * given window, regardless of the global setting for it
4090 * @param obj The window where to enable the highlight
4091 * @param enabled The enabled value for the highlight
4093 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4095 * Get the enabled value of the focus highlight for this window
4097 * @param obj The window in which to check if the focus highlight is enabled
4099 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4101 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4103 * Set the style for the focus highlight on this window
4105 * Sets the style to use for theming the highlight of focused objects on
4106 * the given window. If @p style is NULL, the default will be used.
4108 * @param obj The window where to set the style
4109 * @param style The style to set
4111 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4113 * Get the style set for the focus highlight object
4115 * Gets the style set for this windows highilght object, or NULL if none
4118 * @param obj The window to retrieve the highlights style from
4120 * @return The style set or NULL if none was. Default is used in that case.
4122 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4124 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4125 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4126 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4127 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4128 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4129 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4130 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4132 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4133 * (blank mouse, private mouse obj, defaultmouse)
4137 * Sets the keyboard mode of the window.
4139 * @param obj The window object
4140 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4142 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4144 * Gets the keyboard mode of the window.
4146 * @param obj The window object
4147 * @return The mode, one of #Elm_Win_Keyboard_Mode
4149 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151 * Sets whether the window is a keyboard.
4153 * @param obj The window object
4154 * @param is_keyboard If true, the window is a virtual keyboard
4156 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4158 * Gets whether the window is a keyboard.
4160 * @param obj The window object
4161 * @return If the window is a virtual keyboard
4163 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4166 * Get the screen position of a window.
4168 * @param obj The window object
4169 * @param x The int to store the x coordinate to
4170 * @param y The int to store the y coordinate to
4172 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4178 * @defgroup Inwin Inwin
4180 * @image html img/widget/inwin/preview-00.png
4181 * @image latex img/widget/inwin/preview-00.eps
4182 * @image html img/widget/inwin/preview-01.png
4183 * @image latex img/widget/inwin/preview-01.eps
4184 * @image html img/widget/inwin/preview-02.png
4185 * @image latex img/widget/inwin/preview-02.eps
4187 * An inwin is a window inside a window that is useful for a quick popup.
4188 * It does not hover.
4190 * It works by creating an object that will occupy the entire window, so it
4191 * must be created using an @ref Win "elm_win" as parent only. The inwin
4192 * object can be hidden or restacked below every other object if it's
4193 * needed to show what's behind it without destroying it. If this is done,
4194 * the elm_win_inwin_activate() function can be used to bring it back to
4195 * full visibility again.
4197 * There are three styles available in the default theme. These are:
4198 * @li default: The inwin is sized to take over most of the window it's
4200 * @li minimal: The size of the inwin will be the minimum necessary to show
4202 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4203 * possible, but it's sized vertically the most it needs to fit its\
4206 * Some examples of Inwin can be found in the following:
4207 * @li @ref inwin_example_01
4212 * Adds an inwin to the current window
4214 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4215 * Never call this function with anything other than the top-most window
4216 * as its parameter, unless you are fond of undefined behavior.
4218 * After creating the object, the widget will set itself as resize object
4219 * for the window with elm_win_resize_object_add(), so when shown it will
4220 * appear to cover almost the entire window (how much of it depends on its
4221 * content and the style used). It must not be added into other container
4222 * objects and it needs not be moved or resized manually.
4224 * @param parent The parent object
4225 * @return The new object or NULL if it cannot be created
4227 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4229 * Activates an inwin object, ensuring its visibility
4231 * This function will make sure that the inwin @p obj is completely visible
4232 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4233 * to the front. It also sets the keyboard focus to it, which will be passed
4236 * The object's theme will also receive the signal "elm,action,show" with
4239 * @param obj The inwin to activate
4241 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4243 * Set the content of an inwin object.
4245 * Once the content object is set, a previously set one will be deleted.
4246 * If you want to keep that old content object, use the
4247 * elm_win_inwin_content_unset() function.
4249 * @param obj The inwin object
4250 * @param content The object to set as content
4252 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4254 * Get the content of an inwin object.
4256 * Return the content object which is set for this widget.
4258 * The returned object is valid as long as the inwin is still alive and no
4259 * other content is set on it. Deleting the object will notify the inwin
4260 * about it and this one will be left empty.
4262 * If you need to remove an inwin's content to be reused somewhere else,
4263 * see elm_win_inwin_content_unset().
4265 * @param obj The inwin object
4266 * @return The content that is being used
4268 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4270 * Unset the content of an inwin object.
4272 * Unparent and return the content object which was set for this widget.
4274 * @param obj The inwin object
4275 * @return The content that was being used
4277 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4281 /* X specific calls - won't work on non-x engines (return 0) */
4284 * Get the Ecore_X_Window of an Evas_Object
4286 * @param obj The object
4288 * @return The Ecore_X_Window of @p obj
4292 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4294 /* smart callbacks called:
4295 * "delete,request" - the user requested to delete the window
4296 * "focus,in" - window got focus
4297 * "focus,out" - window lost focus
4298 * "moved" - window that holds the canvas was moved
4304 * @image html img/widget/bg/preview-00.png
4305 * @image latex img/widget/bg/preview-00.eps
4307 * @brief Background object, used for setting a solid color, image or Edje
4308 * group as background to a window or any container object.
4310 * The bg object is used for setting a solid background to a window or
4311 * packing into any container object. It works just like an image, but has
4312 * some properties useful to a background, like setting it to tiled,
4313 * centered, scaled or stretched.
4315 * Here is some sample code using it:
4316 * @li @ref bg_01_example_page
4317 * @li @ref bg_02_example_page
4318 * @li @ref bg_03_example_page
4322 typedef enum _Elm_Bg_Option
4324 ELM_BG_OPTION_CENTER, /**< center the background */
4325 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4326 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4327 ELM_BG_OPTION_TILE /**< tile background at its original size */
4331 * Add a new background to the parent
4333 * @param parent The parent object
4334 * @return The new object or NULL if it cannot be created
4338 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4341 * Set the file (image or edje) used for the background
4343 * @param obj The bg object
4344 * @param file The file path
4345 * @param group Optional key (group in Edje) within the file
4347 * This sets the image file used in the background object. The image (or edje)
4348 * will be stretched (retaining aspect if its an image file) to completely fill
4349 * the bg object. This may mean some parts are not visible.
4351 * @note Once the image of @p obj is set, a previously set one will be deleted,
4352 * even if @p file is NULL.
4356 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4359 * Get the file (image or edje) used for the background
4361 * @param obj The bg object
4362 * @param file The file path
4363 * @param group Optional key (group in Edje) within the file
4367 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4370 * Set the option used for the background image
4372 * @param obj The bg object
4373 * @param option The desired background option (TILE, SCALE)
4375 * This sets the option used for manipulating the display of the background
4376 * image. The image can be tiled or scaled.
4380 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4383 * Get the option used for the background image
4385 * @param obj The bg object
4386 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4390 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4392 * Set the option used for the background color
4394 * @param obj The bg object
4399 * This sets the color used for the background rectangle. Its range goes
4404 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4406 * Get the option used for the background color
4408 * @param obj The bg object
4415 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4418 * Set the overlay object used for the background object.
4420 * @param obj The bg object
4421 * @param overlay The overlay object
4423 * This provides a way for elm_bg to have an 'overlay' that will be on top
4424 * of the bg. Once the over object is set, a previously set one will be
4425 * deleted, even if you set the new one to NULL. If you want to keep that
4426 * old content object, use the elm_bg_overlay_unset() function.
4431 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4434 * Get the overlay object used for the background object.
4436 * @param obj The bg object
4437 * @return The content that is being used
4439 * Return the content object which is set for this widget
4443 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4446 * Get the overlay object used for the background object.
4448 * @param obj The bg object
4449 * @return The content that was being used
4451 * Unparent and return the overlay object which was set for this widget
4455 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4458 * Set the size of the pixmap representation of the image.
4460 * This option just makes sense if an image is going to be set in the bg.
4462 * @param obj The bg object
4463 * @param w The new width of the image pixmap representation.
4464 * @param h The new height of the image pixmap representation.
4466 * This function sets a new size for pixmap representation of the given bg
4467 * image. It allows the image to be loaded already in the specified size,
4468 * reducing the memory usage and load time when loading a big image with load
4469 * size set to a smaller size.
4471 * NOTE: this is just a hint, the real size of the pixmap may differ
4472 * depending on the type of image being loaded, being bigger than requested.
4476 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4477 /* smart callbacks called:
4481 * @defgroup Icon Icon
4483 * @image html img/widget/icon/preview-00.png
4484 * @image latex img/widget/icon/preview-00.eps
4486 * An object that provides standard icon images (delete, edit, arrows, etc.)
4487 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4489 * The icon image requested can be in the elementary theme, or in the
4490 * freedesktop.org paths. It's possible to set the order of preference from
4491 * where the image will be used.
4493 * This API is very similar to @ref Image, but with ready to use images.
4495 * Default images provided by the theme are described below.
4497 * The first list contains icons that were first intended to be used in
4498 * toolbars, but can be used in many other places too:
4514 * Now some icons that were designed to be used in menus (but again, you can
4515 * use them anywhere else):
4520 * @li menu/arrow_down
4521 * @li menu/arrow_left
4522 * @li menu/arrow_right
4531 * And here we have some media player specific icons:
4532 * @li media_player/forward
4533 * @li media_player/info
4534 * @li media_player/next
4535 * @li media_player/pause
4536 * @li media_player/play
4537 * @li media_player/prev
4538 * @li media_player/rewind
4539 * @li media_player/stop
4541 * Signals that you can add callbacks for are:
4543 * "clicked" - This is called when a user has clicked the icon
4545 * An example of usage for this API follows:
4546 * @li @ref tutorial_icon
4554 typedef enum _Elm_Icon_Type
4561 * @enum _Elm_Icon_Lookup_Order
4562 * @typedef Elm_Icon_Lookup_Order
4564 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4565 * theme, FDO paths, or both?
4569 typedef enum _Elm_Icon_Lookup_Order
4571 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4572 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4573 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4574 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4575 } Elm_Icon_Lookup_Order;
4578 * Add a new icon object to the parent.
4580 * @param parent The parent object
4581 * @return The new object or NULL if it cannot be created
4583 * @see elm_icon_file_set()
4587 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4589 * Set the file that will be used as icon.
4591 * @param obj The icon object
4592 * @param file The path to file that will be used as icon image
4593 * @param group The group that the icon belongs to in edje file
4595 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4597 * @note The icon image set by this function can be changed by
4598 * elm_icon_standard_set().
4600 * @see elm_icon_file_get()
4604 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4606 * Set a location in memory to be used as an icon
4608 * @param obj The icon object
4609 * @param img The binary data that will be used as an image
4610 * @param size The size of binary data @p img
4611 * @param format Optional format of @p img to pass to the image loader
4612 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4614 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4616 * @note The icon image set by this function can be changed by
4617 * elm_icon_standard_set().
4621 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);
4623 * Get the file that will be used as icon.
4625 * @param obj The icon object
4626 * @param file The path to file that will be used as icon icon image
4627 * @param group The group that the icon belongs to in edje file
4629 * @see elm_icon_file_set()
4633 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4634 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4636 * Set the icon by icon standards names.
4638 * @param obj The icon object
4639 * @param name The icon name
4641 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4643 * For example, freedesktop.org defines standard icon names such as "home",
4644 * "network", etc. There can be different icon sets to match those icon
4645 * keys. The @p name given as parameter is one of these "keys", and will be
4646 * used to look in the freedesktop.org paths and elementary theme. One can
4647 * change the lookup order with elm_icon_order_lookup_set().
4649 * If name is not found in any of the expected locations and it is the
4650 * absolute path of an image file, this image will be used.
4652 * @note The icon image set by this function can be changed by
4653 * elm_icon_file_set().
4655 * @see elm_icon_standard_get()
4656 * @see elm_icon_file_set()
4660 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4662 * Get the icon name set by icon standard names.
4664 * @param obj The icon object
4665 * @return The icon name
4667 * If the icon image was set using elm_icon_file_set() instead of
4668 * elm_icon_standard_set(), then this function will return @c NULL.
4670 * @see elm_icon_standard_set()
4674 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4676 * Set the smooth effect for an icon object.
4678 * @param obj The icon object
4679 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4680 * otherwise. Default is @c EINA_TRUE.
4682 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4683 * scaling provides a better resulting image, but is slower.
4685 * The smooth scaling should be disabled when making animations that change
4686 * the icon size, since they will be faster. Animations that don't require
4687 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4688 * is already scaled, since the scaled icon image will be cached).
4690 * @see elm_icon_smooth_get()
4694 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4696 * Get the smooth effect for an icon object.
4698 * @param obj The icon object
4699 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4701 * @see elm_icon_smooth_set()
4705 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4707 * Disable scaling of this object.
4709 * @param obj The icon object.
4710 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4711 * otherwise. Default is @c EINA_FALSE.
4713 * This function disables scaling of the icon object through the function
4714 * elm_object_scale_set(). However, this does not affect the object
4715 * size/resize in any way. For that effect, take a look at
4716 * elm_icon_scale_set().
4718 * @see elm_icon_no_scale_get()
4719 * @see elm_icon_scale_set()
4720 * @see elm_object_scale_set()
4724 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4726 * Get whether scaling is disabled on the object.
4728 * @param obj The icon object
4729 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4731 * @see elm_icon_no_scale_set()
4735 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4737 * Set if the object is (up/down) resizable.
4739 * @param obj The icon object
4740 * @param scale_up A bool to set if the object is resizable up. Default is
4742 * @param scale_down A bool to set if the object is resizable down. Default
4745 * This function limits the icon object resize ability. If @p scale_up is set to
4746 * @c EINA_FALSE, the object can't have its height or width resized to a value
4747 * higher than the original icon size. Same is valid for @p scale_down.
4749 * @see elm_icon_scale_get()
4753 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4755 * Get if the object is (up/down) resizable.
4757 * @param obj The icon object
4758 * @param scale_up A bool to set if the object is resizable up
4759 * @param scale_down A bool to set if the object is resizable down
4761 * @see elm_icon_scale_set()
4765 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4767 * Get the object's image size
4769 * @param obj The icon object
4770 * @param w A pointer to store the width in
4771 * @param h A pointer to store the height in
4775 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4777 * Set if the icon fill the entire object area.
4779 * @param obj The icon object
4780 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4781 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4783 * When the icon object is resized to a different aspect ratio from the
4784 * original icon image, the icon image will still keep its aspect. This flag
4785 * tells how the image should fill the object's area. They are: keep the
4786 * entire icon inside the limits of height and width of the object (@p
4787 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4788 * of the object, and the icon will fill the entire object (@p fill_outside
4791 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4792 * retain property to false. Thus, the icon image will always keep its
4793 * original aspect ratio.
4795 * @see elm_icon_fill_outside_get()
4796 * @see elm_image_fill_outside_set()
4800 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4802 * Get if the object is filled outside.
4804 * @param obj The icon object
4805 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4807 * @see elm_icon_fill_outside_set()
4811 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4813 * Set the prescale size for the icon.
4815 * @param obj The icon object
4816 * @param size The prescale size. This value is used for both width and
4819 * This function sets a new size for pixmap representation of the given
4820 * icon. It allows the icon to be loaded already in the specified size,
4821 * reducing the memory usage and load time when loading a big icon with load
4822 * size set to a smaller size.
4824 * It's equivalent to the elm_bg_load_size_set() function for bg.
4826 * @note this is just a hint, the real size of the pixmap may differ
4827 * depending on the type of icon being loaded, being bigger than requested.
4829 * @see elm_icon_prescale_get()
4830 * @see elm_bg_load_size_set()
4834 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4836 * Get the prescale size for the icon.
4838 * @param obj The icon object
4839 * @return The prescale size
4841 * @see elm_icon_prescale_set()
4845 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4847 * Sets the icon lookup order used by elm_icon_standard_set().
4849 * @param obj The icon object
4850 * @param order The icon lookup order (can be one of
4851 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4852 * or ELM_ICON_LOOKUP_THEME)
4854 * @see elm_icon_order_lookup_get()
4855 * @see Elm_Icon_Lookup_Order
4859 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4861 * Gets the icon lookup order.
4863 * @param obj The icon object
4864 * @return The icon lookup order
4866 * @see elm_icon_order_lookup_set()
4867 * @see Elm_Icon_Lookup_Order
4871 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4873 * Get if the icon supports animation or not.
4875 * @param obj The icon object
4876 * @return @c EINA_TRUE if the icon supports animation,
4877 * @c EINA_FALSE otherwise.
4879 * Return if this elm icon's image can be animated. Currently Evas only
4880 * supports gif animation. If the return value is EINA_FALSE, other
4881 * elm_icon_animated_XXX APIs won't work.
4884 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4886 * Set animation mode of the icon.
4888 * @param obj The icon object
4889 * @param anim @c EINA_TRUE if the object do animation job,
4890 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4892 * Even though elm icon's file can be animated,
4893 * sometimes appication developer want to just first page of image.
4894 * In that time, don't call this function, because default value is EINA_FALSE
4895 * Only when you want icon support anition,
4896 * use this function and set animated to EINA_TURE
4899 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4901 * Get animation mode of the icon.
4903 * @param obj The icon object
4904 * @return The animation mode of the icon object
4905 * @see elm_icon_animated_set
4908 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4910 * Set animation play mode of the icon.
4912 * @param obj The icon object
4913 * @param play @c EINA_TRUE the object play animation images,
4914 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4916 * If you want to play elm icon's animation, you set play to EINA_TURE.
4917 * For example, you make gif player using this set/get API and click event.
4919 * 1. Click event occurs
4920 * 2. Check play flag using elm_icon_animaged_play_get
4921 * 3. If elm icon was playing, set play to EINA_FALSE.
4922 * Then animation will be stopped and vice versa
4925 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4927 * Get animation play mode of the icon.
4929 * @param obj The icon object
4930 * @return The play mode of the icon object
4932 * @see elm_icon_animated_lay_get
4935 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4942 * @defgroup Image Image
4944 * @image html img/widget/image/preview-00.png
4945 * @image latex img/widget/image/preview-00.eps
4948 * An object that allows one to load an image file to it. It can be used
4949 * anywhere like any other elementary widget.
4951 * This widget provides most of the functionality provided from @ref Bg or @ref
4952 * Icon, but with a slightly different API (use the one that fits better your
4955 * The features not provided by those two other image widgets are:
4956 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4957 * @li change the object orientation with elm_image_orient_set();
4958 * @li and turning the image editable with elm_image_editable_set().
4960 * Signals that you can add callbacks for are:
4962 * @li @c "clicked" - This is called when a user has clicked the image
4964 * An example of usage for this API follows:
4965 * @li @ref tutorial_image
4974 * @enum _Elm_Image_Orient
4975 * @typedef Elm_Image_Orient
4977 * Possible orientation options for elm_image_orient_set().
4979 * @image html elm_image_orient_set.png
4980 * @image latex elm_image_orient_set.eps width=\textwidth
4984 typedef enum _Elm_Image_Orient
4986 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4987 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4988 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4989 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4990 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4991 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4992 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4993 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4997 * Add a new image to the parent.
4999 * @param parent The parent object
5000 * @return The new object or NULL if it cannot be created
5002 * @see elm_image_file_set()
5006 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5008 * Set the file that will be used as image.
5010 * @param obj The image object
5011 * @param file The path to file that will be used as image
5012 * @param group The group that the image belongs in edje file (if it's an
5015 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5017 * @see elm_image_file_get()
5021 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5023 * Get the file that will be used as image.
5025 * @param obj The image object
5026 * @param file The path to file
5027 * @param group The group that the image belongs in edje file
5029 * @see elm_image_file_set()
5033 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5035 * Set the smooth effect for an image.
5037 * @param obj The image object
5038 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5039 * otherwise. Default is @c EINA_TRUE.
5041 * Set the scaling algorithm to be used when scaling the image. Smooth
5042 * scaling provides a better resulting image, but is slower.
5044 * The smooth scaling should be disabled when making animations that change
5045 * the image size, since it will be faster. Animations that don't require
5046 * resizing of the image can keep the smooth scaling enabled (even if the
5047 * image is already scaled, since the scaled image will be cached).
5049 * @see elm_image_smooth_get()
5053 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5055 * Get the smooth effect for an image.
5057 * @param obj The image object
5058 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5060 * @see elm_image_smooth_get()
5064 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5066 * Gets the current size of the image.
5068 * @param obj The image object.
5069 * @param w Pointer to store width, or NULL.
5070 * @param h Pointer to store height, or NULL.
5072 * This is the real size of the image, not the size of the object.
5074 * On error, neither w or h will be written.
5078 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5080 * Disable scaling of this object.
5082 * @param obj The image object.
5083 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5084 * otherwise. Default is @c EINA_FALSE.
5086 * This function disables scaling of the elm_image widget through the
5087 * function elm_object_scale_set(). However, this does not affect the widget
5088 * size/resize in any way. For that effect, take a look at
5089 * elm_image_scale_set().
5091 * @see elm_image_no_scale_get()
5092 * @see elm_image_scale_set()
5093 * @see elm_object_scale_set()
5097 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5099 * Get whether scaling is disabled on the object.
5101 * @param obj The image object
5102 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5104 * @see elm_image_no_scale_set()
5108 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5110 * Set if the object is (up/down) resizable.
5112 * @param obj The image object
5113 * @param scale_up A bool to set if the object is resizable up. Default is
5115 * @param scale_down A bool to set if the object is resizable down. Default
5118 * This function limits the image resize ability. If @p scale_up is set to
5119 * @c EINA_FALSE, the object can't have its height or width resized to a value
5120 * higher than the original image size. Same is valid for @p scale_down.
5122 * @see elm_image_scale_get()
5126 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5128 * Get if the object is (up/down) resizable.
5130 * @param obj The image object
5131 * @param scale_up A bool to set if the object is resizable up
5132 * @param scale_down A bool to set if the object is resizable down
5134 * @see elm_image_scale_set()
5138 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5140 * Set if the image fill the entire object area when keeping the aspect ratio.
5142 * @param obj The image object
5143 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5144 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5146 * When the image should keep its aspect ratio even if resized to another
5147 * aspect ratio, there are two possibilities to resize it: keep the entire
5148 * image inside the limits of height and width of the object (@p fill_outside
5149 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5150 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5152 * @note This option will have no effect if
5153 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5155 * @see elm_image_fill_outside_get()
5156 * @see elm_image_aspect_ratio_retained_set()
5160 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5162 * Get if the object is filled outside
5164 * @param obj The image object
5165 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5167 * @see elm_image_fill_outside_set()
5171 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5173 * Set the prescale size for the image
5175 * @param obj The image object
5176 * @param size The prescale size. This value is used for both width and
5179 * This function sets a new size for pixmap representation of the given
5180 * image. It allows the image to be loaded already in the specified size,
5181 * reducing the memory usage and load time when loading a big image with load
5182 * size set to a smaller size.
5184 * It's equivalent to the elm_bg_load_size_set() function for bg.
5186 * @note this is just a hint, the real size of the pixmap may differ
5187 * depending on the type of image being loaded, being bigger than requested.
5189 * @see elm_image_prescale_get()
5190 * @see elm_bg_load_size_set()
5194 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5196 * Get the prescale size for the image
5198 * @param obj The image object
5199 * @return The prescale size
5201 * @see elm_image_prescale_set()
5205 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5207 * Set the image orientation.
5209 * @param obj The image object
5210 * @param orient The image orientation
5211 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5212 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5213 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5214 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5215 * Default is #ELM_IMAGE_ORIENT_NONE.
5217 * This function allows to rotate or flip the given image.
5219 * @see elm_image_orient_get()
5220 * @see @ref Elm_Image_Orient
5224 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5226 * Get the image orientation.
5228 * @param obj The image object
5229 * @return The image orientation
5230 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5231 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5232 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5233 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5235 * @see elm_image_orient_set()
5236 * @see @ref Elm_Image_Orient
5240 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5242 * Make the image 'editable'.
5244 * @param obj Image object.
5245 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5247 * This means the image is a valid drag target for drag and drop, and can be
5248 * cut or pasted too.
5252 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5254 * Make the image 'editable'.
5256 * @param obj Image object.
5257 * @return Editability.
5259 * This means the image is a valid drag target for drag and drop, and can be
5260 * cut or pasted too.
5264 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5266 * Get the basic Evas_Image object from this object (widget).
5268 * @param obj The image object to get the inlined image from
5269 * @return The inlined image object, or NULL if none exists
5271 * This function allows one to get the underlying @c Evas_Object of type
5272 * Image from this elementary widget. It can be useful to do things like get
5273 * the pixel data, save the image to a file, etc.
5275 * @note Be careful to not manipulate it, as it is under control of
5280 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5282 * Set whether the original aspect ratio of the image should be kept on resize.
5284 * @param obj The image object.
5285 * @param retained @c EINA_TRUE if the image should retain the aspect,
5286 * @c EINA_FALSE otherwise.
5288 * The original aspect ratio (width / height) of the image is usually
5289 * distorted to match the object's size. Enabling this option will retain
5290 * this original aspect, and the way that the image is fit into the object's
5291 * area depends on the option set by elm_image_fill_outside_set().
5293 * @see elm_image_aspect_ratio_retained_get()
5294 * @see elm_image_fill_outside_set()
5298 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5300 * Get if the object retains the original aspect ratio.
5302 * @param obj The image object.
5303 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5308 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5310 /* smart callbacks called:
5311 * "clicked" - the user clicked the image
5319 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5321 typedef enum _Elm_GLView_Mode
5323 ELM_GLVIEW_ALPHA = 1,
5324 ELM_GLVIEW_DEPTH = 2,
5325 ELM_GLVIEW_STENCIL = 4
5329 * Defines a policy for the glview resizing.
5331 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5333 typedef enum _Elm_GLView_Resize_Policy
5335 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5336 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5337 } Elm_GLView_Resize_Policy;
5339 typedef enum _Elm_GLView_Render_Policy
5341 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5342 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5343 } Elm_GLView_Render_Policy;
5348 * A simple GLView widget that allows GL rendering.
5350 * Signals that you can add callbacks for are:
5356 * Add a new glview to the parent
5358 * @param parent The parent object
5359 * @return The new object or NULL if it cannot be created
5363 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5366 * Sets the size of the glview
5368 * @param obj The glview object
5369 * @param width width of the glview object
5370 * @param height height of the glview object
5374 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5377 * Gets the size of the glview.
5379 * @param obj The glview object
5380 * @param width width of the glview object
5381 * @param height height of the glview object
5383 * Note that this function returns the actual image size of the
5384 * glview. This means that when the scale policy is set to
5385 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5390 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5393 * Gets the gl api struct for gl rendering
5395 * @param obj The glview object
5396 * @return The api object or NULL if it cannot be created
5400 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5403 * Set the mode of the GLView. Supports Three simple modes.
5405 * @param obj The glview object
5406 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5407 * @return True if set properly.
5411 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5414 * Set the resize policy for the glview object.
5416 * @param obj The glview object.
5417 * @param policy The scaling policy.
5419 * By default, the resize policy is set to
5420 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5421 * destroys the previous surface and recreates the newly specified
5422 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5423 * however, glview only scales the image object and not the underlying
5428 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5431 * Set the render policy for the glview object.
5433 * @param obj The glview object.
5434 * @param policy The render policy.
5436 * By default, the render policy is set to
5437 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5438 * that during the render loop, glview is only redrawn if it needs
5439 * to be redrawn. (i.e. When it is visible) If the policy is set to
5440 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5441 * whether it is visible/need redrawing or not.
5445 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5448 * Set the init function that runs once in the main loop.
5450 * @param obj The glview object.
5451 * @param func The init function to be registered.
5453 * The registered init function gets called once during the render loop.
5457 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5460 * Set the render function that runs in the main loop.
5462 * @param obj The glview object.
5463 * @param func The delete function to be registered.
5465 * The registered del function gets called when GLView object is deleted.
5469 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5472 * Set the resize function that gets called when resize happens.
5474 * @param obj The glview object.
5475 * @param func The resize function to be registered.
5479 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5482 * Set the render function that runs in the main loop.
5484 * @param obj The glview object.
5485 * @param func The render function to be registered.
5489 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5492 * Notifies that there has been changes in the GLView.
5494 * @param obj The glview object.
5498 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5508 * @image html img/widget/box/preview-00.png
5509 * @image latex img/widget/box/preview-00.eps width=\textwidth
5511 * @image html img/box.png
5512 * @image latex img/box.eps width=\textwidth
5514 * A box arranges objects in a linear fashion, governed by a layout function
5515 * that defines the details of this arrangement.
5517 * By default, the box will use an internal function to set the layout to
5518 * a single row, either vertical or horizontal. This layout is affected
5519 * by a number of parameters, such as the homogeneous flag set by
5520 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5521 * elm_box_align_set() and the hints set to each object in the box.
5523 * For this default layout, it's possible to change the orientation with
5524 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5525 * placing its elements ordered from top to bottom. When horizontal is set,
5526 * the order will go from left to right. If the box is set to be
5527 * homogeneous, every object in it will be assigned the same space, that
5528 * of the largest object. Padding can be used to set some spacing between
5529 * the cell given to each object. The alignment of the box, set with
5530 * elm_box_align_set(), determines how the bounding box of all the elements
5531 * will be placed within the space given to the box widget itself.
5533 * The size hints of each object also affect how they are placed and sized
5534 * within the box. evas_object_size_hint_min_set() will give the minimum
5535 * size the object can have, and the box will use it as the basis for all
5536 * latter calculations. Elementary widgets set their own minimum size as
5537 * needed, so there's rarely any need to use it manually.
5539 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5540 * used to tell whether the object will be allocated the minimum size it
5541 * needs or if the space given to it should be expanded. It's important
5542 * to realize that expanding the size given to the object is not the same
5543 * thing as resizing the object. It could very well end being a small
5544 * widget floating in a much larger empty space. If not set, the weight
5545 * for objects will normally be 0.0 for both axis, meaning the widget will
5546 * not be expanded. To take as much space possible, set the weight to
5547 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5549 * Besides how much space each object is allocated, it's possible to control
5550 * how the widget will be placed within that space using
5551 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5552 * for both axis, meaning the object will be centered, but any value from
5553 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5554 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5555 * is -1.0, means the object will be resized to fill the entire space it
5558 * In addition, customized functions to define the layout can be set, which
5559 * allow the application developer to organize the objects within the box
5560 * in any number of ways.
5562 * The special elm_box_layout_transition() function can be used
5563 * to switch from one layout to another, animating the motion of the
5564 * children of the box.
5566 * @note Objects should not be added to box objects using _add() calls.
5568 * Some examples on how to use boxes follow:
5569 * @li @ref box_example_01
5570 * @li @ref box_example_02
5575 * @typedef Elm_Box_Transition
5577 * Opaque handler containing the parameters to perform an animated
5578 * transition of the layout the box uses.
5580 * @see elm_box_transition_new()
5581 * @see elm_box_layout_set()
5582 * @see elm_box_layout_transition()
5584 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5587 * Add a new box to the parent
5589 * By default, the box will be in vertical mode and non-homogeneous.
5591 * @param parent The parent object
5592 * @return The new object or NULL if it cannot be created
5594 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5596 * Set the horizontal orientation
5598 * By default, box object arranges their contents vertically from top to
5600 * By calling this function with @p horizontal as EINA_TRUE, the box will
5601 * become horizontal, arranging contents from left to right.
5603 * @note This flag is ignored if a custom layout function is set.
5605 * @param obj The box object
5606 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5607 * EINA_FALSE = vertical)
5609 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5611 * Get the horizontal orientation
5613 * @param obj The box object
5614 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5616 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5618 * Set the box to arrange its children homogeneously
5620 * If enabled, homogeneous layout makes all items the same size, according
5621 * to the size of the largest of its children.
5623 * @note This flag is ignored if a custom layout function is set.
5625 * @param obj The box object
5626 * @param homogeneous The homogeneous flag
5628 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5630 * Get whether the box is using homogeneous mode or not
5632 * @param obj The box object
5633 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5635 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5636 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5637 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639 * Add an object to the beginning of the pack list
5641 * Pack @p subobj into the box @p obj, placing it first in the list of
5642 * children objects. The actual position the object will get on screen
5643 * depends on the layout used. If no custom layout is set, it will be at
5644 * the top or left, depending if the box is vertical or horizontal,
5647 * @param obj The box object
5648 * @param subobj The object to add to the box
5650 * @see elm_box_pack_end()
5651 * @see elm_box_pack_before()
5652 * @see elm_box_pack_after()
5653 * @see elm_box_unpack()
5654 * @see elm_box_unpack_all()
5655 * @see elm_box_clear()
5657 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5659 * Add an object at the end of the pack list
5661 * Pack @p subobj into the box @p obj, placing it last in the list of
5662 * children objects. The actual position the object will get on screen
5663 * depends on the layout used. If no custom layout is set, it will be at
5664 * the bottom or right, depending if the box is vertical or horizontal,
5667 * @param obj The box object
5668 * @param subobj The object to add to the box
5670 * @see elm_box_pack_start()
5671 * @see elm_box_pack_before()
5672 * @see elm_box_pack_after()
5673 * @see elm_box_unpack()
5674 * @see elm_box_unpack_all()
5675 * @see elm_box_clear()
5677 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5679 * Adds an object to the box before the indicated object
5681 * This will add the @p subobj to the box indicated before the object
5682 * indicated with @p before. If @p before is not already in the box, results
5683 * are undefined. Before means either to the left of the indicated object or
5684 * above it depending on orientation.
5686 * @param obj The box object
5687 * @param subobj The object to add to the box
5688 * @param before The object before which to add it
5690 * @see elm_box_pack_start()
5691 * @see elm_box_pack_end()
5692 * @see elm_box_pack_after()
5693 * @see elm_box_unpack()
5694 * @see elm_box_unpack_all()
5695 * @see elm_box_clear()
5697 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5699 * Adds an object to the box after the indicated object
5701 * This will add the @p subobj to the box indicated after the object
5702 * indicated with @p after. If @p after is not already in the box, results
5703 * are undefined. After means either to the right of the indicated object or
5704 * below it depending on orientation.
5706 * @param obj The box object
5707 * @param subobj The object to add to the box
5708 * @param after The object after which to add it
5710 * @see elm_box_pack_start()
5711 * @see elm_box_pack_end()
5712 * @see elm_box_pack_before()
5713 * @see elm_box_unpack()
5714 * @see elm_box_unpack_all()
5715 * @see elm_box_clear()
5717 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5719 * Clear the box of all children
5721 * Remove all the elements contained by the box, deleting the respective
5724 * @param obj The box object
5726 * @see elm_box_unpack()
5727 * @see elm_box_unpack_all()
5729 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5733 * Remove the object given by @p subobj from the box @p obj without
5736 * @param obj The box object
5738 * @see elm_box_unpack_all()
5739 * @see elm_box_clear()
5741 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5743 * Remove all items from the box, without deleting them
5745 * Clear the box from all children, but don't delete the respective objects.
5746 * If no other references of the box children exist, the objects will never
5747 * be deleted, and thus the application will leak the memory. Make sure
5748 * when using this function that you hold a reference to all the objects
5749 * in the box @p obj.
5751 * @param obj The box object
5753 * @see elm_box_clear()
5754 * @see elm_box_unpack()
5756 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5758 * Retrieve a list of the objects packed into the box
5760 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5761 * The order of the list corresponds to the packing order the box uses.
5763 * You must free this list with eina_list_free() once you are done with it.
5765 * @param obj The box object
5767 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5769 * Set the space (padding) between the box's elements.
5771 * Extra space in pixels that will be added between a box child and its
5772 * neighbors after its containing cell has been calculated. This padding
5773 * is set for all elements in the box, besides any possible padding that
5774 * individual elements may have through their size hints.
5776 * @param obj The box object
5777 * @param horizontal The horizontal space between elements
5778 * @param vertical The vertical space between elements
5780 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5782 * Get the space (padding) between the box's elements.
5784 * @param obj The box object
5785 * @param horizontal The horizontal space between elements
5786 * @param vertical The vertical space between elements
5788 * @see elm_box_padding_set()
5790 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5792 * Set the alignment of the whole bouding box of contents.
5794 * Sets how the bounding box containing all the elements of the box, after
5795 * their sizes and position has been calculated, will be aligned within
5796 * the space given for the whole box widget.
5798 * @param obj The box object
5799 * @param horizontal The horizontal alignment of elements
5800 * @param vertical The vertical alignment of elements
5802 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5804 * Get the alignment of the whole bouding box of contents.
5806 * @param obj The box object
5807 * @param horizontal The horizontal alignment of elements
5808 * @param vertical The vertical alignment of elements
5810 * @see elm_box_align_set()
5812 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5815 * Set the layout defining function to be used by the box
5817 * Whenever anything changes that requires the box in @p obj to recalculate
5818 * the size and position of its elements, the function @p cb will be called
5819 * to determine what the layout of the children will be.
5821 * Once a custom function is set, everything about the children layout
5822 * is defined by it. The flags set by elm_box_horizontal_set() and
5823 * elm_box_homogeneous_set() no longer have any meaning, and the values
5824 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5825 * layout function to decide if they are used and how. These last two
5826 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5827 * passed to @p cb. The @c Evas_Object the function receives is not the
5828 * Elementary widget, but the internal Evas Box it uses, so none of the
5829 * functions described here can be used on it.
5831 * Any of the layout functions in @c Evas can be used here, as well as the
5832 * special elm_box_layout_transition().
5834 * The final @p data argument received by @p cb is the same @p data passed
5835 * here, and the @p free_data function will be called to free it
5836 * whenever the box is destroyed or another layout function is set.
5838 * Setting @p cb to NULL will revert back to the default layout function.
5840 * @param obj The box object
5841 * @param cb The callback function used for layout
5842 * @param data Data that will be passed to layout function
5843 * @param free_data Function called to free @p data
5845 * @see elm_box_layout_transition()
5847 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);
5849 * Special layout function that animates the transition from one layout to another
5851 * Normally, when switching the layout function for a box, this will be
5852 * reflected immediately on screen on the next render, but it's also
5853 * possible to do this through an animated transition.
5855 * This is done by creating an ::Elm_Box_Transition and setting the box
5856 * layout to this function.
5860 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5861 * evas_object_box_layout_vertical, // start
5862 * NULL, // data for initial layout
5863 * NULL, // free function for initial data
5864 * evas_object_box_layout_horizontal, // end
5865 * NULL, // data for final layout
5866 * NULL, // free function for final data
5867 * anim_end, // will be called when animation ends
5868 * NULL); // data for anim_end function\
5869 * elm_box_layout_set(box, elm_box_layout_transition, t,
5870 * elm_box_transition_free);
5873 * @note This function can only be used with elm_box_layout_set(). Calling
5874 * it directly will not have the expected results.
5876 * @see elm_box_transition_new
5877 * @see elm_box_transition_free
5878 * @see elm_box_layout_set
5880 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5882 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5884 * If you want to animate the change from one layout to another, you need
5885 * to set the layout function of the box to elm_box_layout_transition(),
5886 * passing as user data to it an instance of ::Elm_Box_Transition with the
5887 * necessary information to perform this animation. The free function to
5888 * set for the layout is elm_box_transition_free().
5890 * The parameters to create an ::Elm_Box_Transition sum up to how long
5891 * will it be, in seconds, a layout function to describe the initial point,
5892 * another for the final position of the children and one function to be
5893 * called when the whole animation ends. This last function is useful to
5894 * set the definitive layout for the box, usually the same as the end
5895 * layout for the animation, but could be used to start another transition.
5897 * @param start_layout The layout function that will be used to start the animation
5898 * @param start_layout_data The data to be passed the @p start_layout function
5899 * @param start_layout_free_data Function to free @p start_layout_data
5900 * @param end_layout The layout function that will be used to end the animation
5901 * @param end_layout_free_data The data to be passed the @p end_layout function
5902 * @param end_layout_free_data Function to free @p end_layout_data
5903 * @param transition_end_cb Callback function called when animation ends
5904 * @param transition_end_data Data to be passed to @p transition_end_cb
5905 * @return An instance of ::Elm_Box_Transition
5907 * @see elm_box_transition_new
5908 * @see elm_box_layout_transition
5910 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);
5912 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5914 * This function is mostly useful as the @c free_data parameter in
5915 * elm_box_layout_set() when elm_box_layout_transition().
5917 * @param data The Elm_Box_Transition instance to be freed.
5919 * @see elm_box_transition_new
5920 * @see elm_box_layout_transition
5922 EAPI void elm_box_transition_free(void *data);
5929 * @defgroup Button Button
5931 * @image html img/widget/button/preview-00.png
5932 * @image latex img/widget/button/preview-00.eps
5933 * @image html img/widget/button/preview-01.png
5934 * @image latex img/widget/button/preview-01.eps
5935 * @image html img/widget/button/preview-02.png
5936 * @image latex img/widget/button/preview-02.eps
5938 * This is a push-button. Press it and run some function. It can contain
5939 * a simple label and icon object and it also has an autorepeat feature.
5941 * This widgets emits the following signals:
5942 * @li "clicked": the user clicked the button (press/release).
5943 * @li "repeated": the user pressed the button without releasing it.
5944 * @li "pressed": button was pressed.
5945 * @li "unpressed": button was released after being pressed.
5946 * In all three cases, the @c event parameter of the callback will be
5949 * Also, defined in the default theme, the button has the following styles
5951 * @li default: a normal button.
5952 * @li anchor: Like default, but the button fades away when the mouse is not
5953 * over it, leaving only the text or icon.
5954 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5955 * continuous look across its options.
5956 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5958 * Follow through a complete example @ref button_example_01 "here".
5962 * Add a new button to the parent's canvas
5964 * @param parent The parent object
5965 * @return The new object or NULL if it cannot be created
5967 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5969 * Set the label used in the button
5971 * The passed @p label can be NULL to clean any existing text in it and
5972 * leave the button as an icon only object.
5974 * @param obj The button object
5975 * @param label The text will be written on the button
5976 * @deprecated use elm_object_text_set() instead.
5978 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5980 * Get the label set for the button
5982 * The string returned is an internal pointer and should not be freed or
5983 * altered. It will also become invalid when the button is destroyed.
5984 * The string returned, if not NULL, is a stringshare, so if you need to
5985 * keep it around even after the button is destroyed, you can use
5986 * eina_stringshare_ref().
5988 * @param obj The button object
5989 * @return The text set to the label, or NULL if nothing is set
5990 * @deprecated use elm_object_text_set() instead.
5992 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5994 * Set the icon used for the button
5996 * Setting a new icon will delete any other that was previously set, making
5997 * any reference to them invalid. If you need to maintain the previous
5998 * object alive, unset it first with elm_button_icon_unset().
6000 * @param obj The button object
6001 * @param icon The icon object for the button
6003 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6005 * Get the icon used for the button
6007 * Return the icon object which is set for this widget. If the button is
6008 * destroyed or another icon is set, the returned object will be deleted
6009 * and any reference to it will be invalid.
6011 * @param obj The button object
6012 * @return The icon object that is being used
6014 * @see elm_button_icon_unset()
6016 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6018 * Remove the icon set without deleting it and return the object
6020 * This function drops the reference the button holds of the icon object
6021 * and returns this last object. It is used in case you want to remove any
6022 * icon, or set another one, without deleting the actual object. The button
6023 * will be left without an icon set.
6025 * @param obj The button object
6026 * @return The icon object that was being used
6028 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6030 * Turn on/off the autorepeat event generated when the button is kept pressed
6032 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6033 * signal when they are clicked.
6035 * When on, keeping a button pressed will continuously emit a @c repeated
6036 * signal until the button is released. The time it takes until it starts
6037 * emitting the signal is given by
6038 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6039 * new emission by elm_button_autorepeat_gap_timeout_set().
6041 * @param obj The button object
6042 * @param on A bool to turn on/off the event
6044 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6046 * Get whether the autorepeat feature is enabled
6048 * @param obj The button object
6049 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6051 * @see elm_button_autorepeat_set()
6053 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6055 * Set the initial timeout before the autorepeat event is generated
6057 * Sets the timeout, in seconds, since the button is pressed until the
6058 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6059 * won't be any delay and the even will be fired the moment the button is
6062 * @param obj The button object
6063 * @param t Timeout in seconds
6065 * @see elm_button_autorepeat_set()
6066 * @see elm_button_autorepeat_gap_timeout_set()
6068 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6070 * Get the initial timeout before the autorepeat event is generated
6072 * @param obj The button object
6073 * @return Timeout in seconds
6075 * @see elm_button_autorepeat_initial_timeout_set()
6077 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6079 * Set the interval between each generated autorepeat event
6081 * After the first @c repeated event is fired, all subsequent ones will
6082 * follow after a delay of @p t seconds for each.
6084 * @param obj The button object
6085 * @param t Interval in seconds
6087 * @see elm_button_autorepeat_initial_timeout_set()
6089 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6091 * Get the interval between each generated autorepeat event
6093 * @param obj The button object
6094 * @return Interval in seconds
6096 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6102 * @defgroup File_Selector_Button File Selector Button
6104 * @image html img/widget/fileselector_button/preview-00.png
6105 * @image latex img/widget/fileselector_button/preview-00.eps
6106 * @image html img/widget/fileselector_button/preview-01.png
6107 * @image latex img/widget/fileselector_button/preview-01.eps
6108 * @image html img/widget/fileselector_button/preview-02.png
6109 * @image latex img/widget/fileselector_button/preview-02.eps
6111 * This is a button that, when clicked, creates an Elementary
6112 * window (or inner window) <b> with a @ref Fileselector "file
6113 * selector widget" within</b>. When a file is chosen, the (inner)
6114 * window is closed and the button emits a signal having the
6115 * selected file as it's @c event_info.
6117 * This widget encapsulates operations on its internal file
6118 * selector on its own API. There is less control over its file
6119 * selector than that one would have instatiating one directly.
6121 * The following styles are available for this button:
6124 * @li @c "hoversel_vertical"
6125 * @li @c "hoversel_vertical_entry"
6127 * Smart callbacks one can register to:
6128 * - @c "file,chosen" - the user has selected a path, whose string
6129 * pointer comes as the @c event_info data (a stringshared
6132 * Here is an example on its usage:
6133 * @li @ref fileselector_button_example
6135 * @see @ref File_Selector_Entry for a similar widget.
6140 * Add a new file selector button widget to the given parent
6141 * Elementary (container) object
6143 * @param parent The parent object
6144 * @return a new file selector button widget handle or @c NULL, on
6147 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6150 * Set the label for a given file selector button widget
6152 * @param obj The file selector button widget
6153 * @param label The text label to be displayed on @p obj
6155 * @deprecated use elm_object_text_set() instead.
6157 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6160 * Get the label set for a given file selector button widget
6162 * @param obj The file selector button widget
6163 * @return The button label
6165 * @deprecated use elm_object_text_set() instead.
6167 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6170 * Set the icon on a given file selector button widget
6172 * @param obj The file selector button widget
6173 * @param icon The icon object for the button
6175 * Once the icon object is set, a previously set one will be
6176 * deleted. If you want to keep the latter, use the
6177 * elm_fileselector_button_icon_unset() function.
6179 * @see elm_fileselector_button_icon_get()
6181 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6184 * Get the icon set for a given file selector button widget
6186 * @param obj The file selector button widget
6187 * @return The icon object currently set on @p obj or @c NULL, if
6190 * @see elm_fileselector_button_icon_set()
6192 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195 * Unset the icon used in a given file selector button widget
6197 * @param obj The file selector button widget
6198 * @return The icon object that was being used on @p obj or @c
6201 * Unparent and return the icon object which was set for this
6204 * @see elm_fileselector_button_icon_set()
6206 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6209 * Set the title for a given file selector button widget's window
6211 * @param obj The file selector button widget
6212 * @param title The title string
6214 * This will change the window's title, when the file selector pops
6215 * out after a click on the button. Those windows have the default
6216 * (unlocalized) value of @c "Select a file" as titles.
6218 * @note It will only take any effect if the file selector
6219 * button widget is @b not under "inwin mode".
6221 * @see elm_fileselector_button_window_title_get()
6223 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6226 * Get the title set for a given file selector button widget's
6229 * @param obj The file selector button widget
6230 * @return Title of the file selector button's window
6232 * @see elm_fileselector_button_window_title_get() for more details
6234 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6237 * Set the size of a given file selector button widget's window,
6238 * holding the file selector itself.
6240 * @param obj The file selector button widget
6241 * @param width The window's width
6242 * @param height The window's height
6244 * @note it will only take any effect if the file selector button
6245 * widget is @b not under "inwin mode". The default size for the
6246 * window (when applicable) is 400x400 pixels.
6248 * @see elm_fileselector_button_window_size_get()
6250 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6253 * Get the size of a given file selector button widget's window,
6254 * holding the file selector itself.
6256 * @param obj The file selector button widget
6257 * @param width Pointer into which to store the width value
6258 * @param height Pointer into which to store the height value
6260 * @note Use @c NULL pointers on the size values you're not
6261 * interested in: they'll be ignored by the function.
6263 * @see elm_fileselector_button_window_size_set(), for more details
6265 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6268 * Set the initial file system path for a given file selector
6271 * @param obj The file selector button widget
6272 * @param path The path string
6274 * It must be a <b>directory</b> path, which will have the contents
6275 * displayed initially in the file selector's view, when invoked
6276 * from @p obj. The default initial path is the @c "HOME"
6277 * environment variable's value.
6279 * @see elm_fileselector_button_path_get()
6281 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6284 * Get the initial file system path set for a given file selector
6287 * @param obj The file selector button widget
6288 * @return path The path string
6290 * @see elm_fileselector_button_path_set() for more details
6292 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6295 * Enable/disable a tree view in the given file selector button
6296 * widget's internal file selector
6298 * @param obj The file selector button widget
6299 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6302 * This has the same effect as elm_fileselector_expandable_set(),
6303 * but now applied to a file selector button's internal file
6306 * @note There's no way to put a file selector button's internal
6307 * file selector in "grid mode", as one may do with "pure" file
6310 * @see elm_fileselector_expandable_get()
6312 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6315 * Get whether tree view is enabled for the given file selector
6316 * button widget's internal file selector
6318 * @param obj The file selector button widget
6319 * @return @c EINA_TRUE if @p obj widget's internal file selector
6320 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6322 * @see elm_fileselector_expandable_set() for more details
6324 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6327 * Set whether a given file selector button widget's internal file
6328 * selector is to display folders only or the directory contents,
6331 * @param obj The file selector button widget
6332 * @param only @c EINA_TRUE to make @p obj widget's internal file
6333 * selector only display directories, @c EINA_FALSE to make files
6334 * to be displayed in it too
6336 * This has the same effect as elm_fileselector_folder_only_set(),
6337 * but now applied to a file selector button's internal file
6340 * @see elm_fileselector_folder_only_get()
6342 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6345 * Get whether a given file selector button widget's internal file
6346 * selector is displaying folders only or the directory contents,
6349 * @param obj The file selector button widget
6350 * @return @c EINA_TRUE if @p obj widget's internal file
6351 * selector is only displaying directories, @c EINA_FALSE if files
6352 * are being displayed in it too (and on errors)
6354 * @see elm_fileselector_button_folder_only_set() for more details
6356 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6359 * Enable/disable the file name entry box where the user can type
6360 * in a name for a file, in a given file selector button widget's
6361 * internal file selector.
6363 * @param obj The file selector button widget
6364 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6365 * file selector a "saving dialog", @c EINA_FALSE otherwise
6367 * This has the same effect as elm_fileselector_is_save_set(),
6368 * but now applied to a file selector button's internal file
6371 * @see elm_fileselector_is_save_get()
6373 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6376 * Get whether the given file selector button widget's internal
6377 * file selector is in "saving dialog" mode
6379 * @param obj The file selector button widget
6380 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6381 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6384 * @see elm_fileselector_button_is_save_set() for more details
6386 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6389 * Set whether a given file selector button widget's internal file
6390 * selector will raise an Elementary "inner window", instead of a
6391 * dedicated Elementary window. By default, it won't.
6393 * @param obj The file selector button widget
6394 * @param value @c EINA_TRUE to make it use an inner window, @c
6395 * EINA_TRUE to make it use a dedicated window
6397 * @see elm_win_inwin_add() for more information on inner windows
6398 * @see elm_fileselector_button_inwin_mode_get()
6400 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6403 * Get whether a given file selector button widget's internal file
6404 * selector will raise an Elementary "inner window", instead of a
6405 * dedicated Elementary window.
6407 * @param obj The file selector button widget
6408 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6409 * if it will use a dedicated window
6411 * @see elm_fileselector_button_inwin_mode_set() for more details
6413 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6420 * @defgroup File_Selector_Entry File Selector Entry
6422 * @image html img/widget/fileselector_entry/preview-00.png
6423 * @image latex img/widget/fileselector_entry/preview-00.eps
6425 * This is an entry made to be filled with or display a <b>file
6426 * system path string</b>. Besides the entry itself, the widget has
6427 * a @ref File_Selector_Button "file selector button" on its side,
6428 * which will raise an internal @ref Fileselector "file selector widget",
6429 * when clicked, for path selection aided by file system
6432 * This file selector may appear in an Elementary window or in an
6433 * inner window. When a file is chosen from it, the (inner) window
6434 * is closed and the selected file's path string is exposed both as
6435 * an smart event and as the new text on the entry.
6437 * This widget encapsulates operations on its internal file
6438 * selector on its own API. There is less control over its file
6439 * selector than that one would have instatiating one directly.
6441 * Smart callbacks one can register to:
6442 * - @c "changed" - The text within the entry was changed
6443 * - @c "activated" - The entry has had editing finished and
6444 * changes are to be "committed"
6445 * - @c "press" - The entry has been clicked
6446 * - @c "longpressed" - The entry has been clicked (and held) for a
6448 * - @c "clicked" - The entry has been clicked
6449 * - @c "clicked,double" - The entry has been double clicked
6450 * - @c "focused" - The entry has received focus
6451 * - @c "unfocused" - The entry has lost focus
6452 * - @c "selection,paste" - A paste action has occurred on the
6454 * - @c "selection,copy" - A copy action has occurred on the entry
6455 * - @c "selection,cut" - A cut action has occurred on the entry
6456 * - @c "unpressed" - The file selector entry's button was released
6457 * after being pressed.
6458 * - @c "file,chosen" - The user has selected a path via the file
6459 * selector entry's internal file selector, whose string pointer
6460 * comes as the @c event_info data (a stringshared string)
6462 * Here is an example on its usage:
6463 * @li @ref fileselector_entry_example
6465 * @see @ref File_Selector_Button for a similar widget.
6470 * Add a new file selector entry widget to the given parent
6471 * Elementary (container) object
6473 * @param parent The parent object
6474 * @return a new file selector entry widget handle or @c NULL, on
6477 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6480 * Set the label for a given file selector entry widget's button
6482 * @param obj The file selector entry widget
6483 * @param label The text label to be displayed on @p obj widget's
6486 * @deprecated use elm_object_text_set() instead.
6488 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6491 * Get the label set for a given file selector entry widget's button
6493 * @param obj The file selector entry widget
6494 * @return The widget button's label
6496 * @deprecated use elm_object_text_set() instead.
6498 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6501 * Set the icon on a given file selector entry widget's button
6503 * @param obj The file selector entry widget
6504 * @param icon The icon object for the entry's button
6506 * Once the icon object is set, a previously set one will be
6507 * deleted. If you want to keep the latter, use the
6508 * elm_fileselector_entry_button_icon_unset() function.
6510 * @see elm_fileselector_entry_button_icon_get()
6512 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6515 * Get the icon set for a given file selector entry widget's button
6517 * @param obj The file selector entry widget
6518 * @return The icon object currently set on @p obj widget's button
6519 * or @c NULL, if none is
6521 * @see elm_fileselector_entry_button_icon_set()
6523 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6526 * Unset the icon used in a given file selector entry widget's
6529 * @param obj The file selector entry widget
6530 * @return The icon object that was being used on @p obj widget's
6531 * button or @c NULL, on errors
6533 * Unparent and return the icon object which was set for this
6536 * @see elm_fileselector_entry_button_icon_set()
6538 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6541 * Set the title for a given file selector entry widget's window
6543 * @param obj The file selector entry widget
6544 * @param title The title string
6546 * This will change the window's title, when the file selector pops
6547 * out after a click on the entry's button. Those windows have the
6548 * default (unlocalized) value of @c "Select a file" as titles.
6550 * @note It will only take any effect if the file selector
6551 * entry widget is @b not under "inwin mode".
6553 * @see elm_fileselector_entry_window_title_get()
6555 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6558 * Get the title set for a given file selector entry widget's
6561 * @param obj The file selector entry widget
6562 * @return Title of the file selector entry's window
6564 * @see elm_fileselector_entry_window_title_get() for more details
6566 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569 * Set the size of a given file selector entry widget's window,
6570 * holding the file selector itself.
6572 * @param obj The file selector entry widget
6573 * @param width The window's width
6574 * @param height The window's height
6576 * @note it will only take any effect if the file selector entry
6577 * widget is @b not under "inwin mode". The default size for the
6578 * window (when applicable) is 400x400 pixels.
6580 * @see elm_fileselector_entry_window_size_get()
6582 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6585 * Get the size of a given file selector entry widget's window,
6586 * holding the file selector itself.
6588 * @param obj The file selector entry widget
6589 * @param width Pointer into which to store the width value
6590 * @param height Pointer into which to store the height value
6592 * @note Use @c NULL pointers on the size values you're not
6593 * interested in: they'll be ignored by the function.
6595 * @see elm_fileselector_entry_window_size_set(), for more details
6597 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6600 * Set the initial file system path and the entry's path string for
6601 * a given file selector entry widget
6603 * @param obj The file selector entry widget
6604 * @param path The path string
6606 * It must be a <b>directory</b> path, which will have the contents
6607 * displayed initially in the file selector's view, when invoked
6608 * from @p obj. The default initial path is the @c "HOME"
6609 * environment variable's value.
6611 * @see elm_fileselector_entry_path_get()
6613 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6616 * Get the entry's path string for a given file selector entry
6619 * @param obj The file selector entry widget
6620 * @return path The path string
6622 * @see elm_fileselector_entry_path_set() for more details
6624 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6627 * Enable/disable a tree view in the given file selector entry
6628 * widget's internal file selector
6630 * @param obj The file selector entry widget
6631 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6634 * This has the same effect as elm_fileselector_expandable_set(),
6635 * but now applied to a file selector entry's internal file
6638 * @note There's no way to put a file selector entry's internal
6639 * file selector in "grid mode", as one may do with "pure" file
6642 * @see elm_fileselector_expandable_get()
6644 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6647 * Get whether tree view is enabled for the given file selector
6648 * entry widget's internal file selector
6650 * @param obj The file selector entry widget
6651 * @return @c EINA_TRUE if @p obj widget's internal file selector
6652 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6654 * @see elm_fileselector_expandable_set() for more details
6656 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6659 * Set whether a given file selector entry widget's internal file
6660 * selector is to display folders only or the directory contents,
6663 * @param obj The file selector entry widget
6664 * @param only @c EINA_TRUE to make @p obj widget's internal file
6665 * selector only display directories, @c EINA_FALSE to make files
6666 * to be displayed in it too
6668 * This has the same effect as elm_fileselector_folder_only_set(),
6669 * but now applied to a file selector entry's internal file
6672 * @see elm_fileselector_folder_only_get()
6674 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6677 * Get whether a given file selector entry widget's internal file
6678 * selector is displaying folders only or the directory contents,
6681 * @param obj The file selector entry widget
6682 * @return @c EINA_TRUE if @p obj widget's internal file
6683 * selector is only displaying directories, @c EINA_FALSE if files
6684 * are being displayed in it too (and on errors)
6686 * @see elm_fileselector_entry_folder_only_set() for more details
6688 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6691 * Enable/disable the file name entry box where the user can type
6692 * in a name for a file, in a given file selector entry widget's
6693 * internal file selector.
6695 * @param obj The file selector entry widget
6696 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6697 * file selector a "saving dialog", @c EINA_FALSE otherwise
6699 * This has the same effect as elm_fileselector_is_save_set(),
6700 * but now applied to a file selector entry's internal file
6703 * @see elm_fileselector_is_save_get()
6705 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6708 * Get whether the given file selector entry widget's internal
6709 * file selector is in "saving dialog" mode
6711 * @param obj The file selector entry widget
6712 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6713 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6716 * @see elm_fileselector_entry_is_save_set() for more details
6718 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6721 * Set whether a given file selector entry widget's internal file
6722 * selector will raise an Elementary "inner window", instead of a
6723 * dedicated Elementary window. By default, it won't.
6725 * @param obj The file selector entry widget
6726 * @param value @c EINA_TRUE to make it use an inner window, @c
6727 * EINA_TRUE to make it use a dedicated window
6729 * @see elm_win_inwin_add() for more information on inner windows
6730 * @see elm_fileselector_entry_inwin_mode_get()
6732 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6735 * Get whether a given file selector entry widget's internal file
6736 * selector will raise an Elementary "inner window", instead of a
6737 * dedicated Elementary window.
6739 * @param obj The file selector entry widget
6740 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6741 * if it will use a dedicated window
6743 * @see elm_fileselector_entry_inwin_mode_set() for more details
6745 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6748 * Set the initial file system path for a given file selector entry
6751 * @param obj The file selector entry widget
6752 * @param path The path string
6754 * It must be a <b>directory</b> path, which will have the contents
6755 * displayed initially in the file selector's view, when invoked
6756 * from @p obj. The default initial path is the @c "HOME"
6757 * environment variable's value.
6759 * @see elm_fileselector_entry_path_get()
6761 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6764 * Get the parent directory's path to the latest file selection on
6765 * a given filer selector entry widget
6767 * @param obj The file selector object
6768 * @return The (full) path of the directory of the last selection
6769 * on @p obj widget, a @b stringshared string
6771 * @see elm_fileselector_entry_path_set()
6773 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6780 * @defgroup Scroller Scroller
6782 * A scroller holds a single object and "scrolls it around". This means that
6783 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6784 * region around, allowing to move through a much larger object that is
6785 * contained in the scroller. The scroiller will always have a small minimum
6786 * size by default as it won't be limited by the contents of the scroller.
6788 * Signals that you can add callbacks for are:
6789 * @li "edge,left" - the left edge of the content has been reached
6790 * @li "edge,right" - the right edge of the content has been reached
6791 * @li "edge,top" - the top edge of the content has been reached
6792 * @li "edge,bottom" - the bottom edge of the content has been reached
6793 * @li "scroll" - the content has been scrolled (moved)
6794 * @li "scroll,anim,start" - scrolling animation has started
6795 * @li "scroll,anim,stop" - scrolling animation has stopped
6796 * @li "scroll,drag,start" - dragging the contents around has started
6797 * @li "scroll,drag,stop" - dragging the contents around has stopped
6798 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6801 * @note When Elemementary is in embedded mode the scrollbars will not be
6802 * dragable, they appear merely as indicators of how much has been scrolled.
6803 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6804 * fingerscroll) won't work.
6806 * In @ref tutorial_scroller you'll find an example of how to use most of
6811 * @brief Type that controls when scrollbars should appear.
6813 * @see elm_scroller_policy_set()
6815 typedef enum _Elm_Scroller_Policy
6817 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6818 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6819 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6820 ELM_SCROLLER_POLICY_LAST
6821 } Elm_Scroller_Policy;
6823 * @brief Add a new scroller to the parent
6825 * @param parent The parent object
6826 * @return The new object or NULL if it cannot be created
6828 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6830 * @brief Set the content of the scroller widget (the object to be scrolled around).
6832 * @param obj The scroller object
6833 * @param content The new content object
6835 * Once the content object is set, a previously set one will be deleted.
6836 * If you want to keep that old content object, use the
6837 * elm_scroller_content_unset() function.
6839 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6841 * @brief Get the content of the scroller widget
6843 * @param obj The slider object
6844 * @return The content that is being used
6846 * Return the content object which is set for this widget
6848 * @see elm_scroller_content_set()
6850 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6852 * @brief Unset the content of the scroller widget
6854 * @param obj The slider object
6855 * @return The content that was being used
6857 * Unparent and return the content object which was set for this widget
6859 * @see elm_scroller_content_set()
6861 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6863 * @brief Set custom theme elements for the scroller
6865 * @param obj The scroller object
6866 * @param widget The widget name to use (default is "scroller")
6867 * @param base The base name to use (default is "base")
6869 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6871 * @brief Make the scroller minimum size limited to the minimum size of the content
6873 * @param obj The scroller object
6874 * @param w Enable limiting minimum size horizontally
6875 * @param h Enable limiting minimum size vertically
6877 * By default the scroller will be as small as its design allows,
6878 * irrespective of its content. This will make the scroller minimum size the
6879 * right size horizontally and/or vertically to perfectly fit its content in
6882 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6884 * @brief Show a specific virtual region within the scroller content object
6886 * @param obj The scroller object
6887 * @param x X coordinate of the region
6888 * @param y Y coordinate of the region
6889 * @param w Width of the region
6890 * @param h Height of the region
6892 * This will ensure all (or part if it does not fit) of the designated
6893 * region in the virtual content object (0, 0 starting at the top-left of the
6894 * virtual content object) is shown within the scroller.
6896 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);
6898 * @brief Set the scrollbar visibility policy
6900 * @param obj The scroller object
6901 * @param policy_h Horizontal scrollbar policy
6902 * @param policy_v Vertical scrollbar policy
6904 * This sets the scrollbar visibility policy for the given scroller.
6905 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6906 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6907 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6908 * respectively for the horizontal and vertical scrollbars.
6910 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6912 * @brief Gets scrollbar visibility policy
6914 * @param obj The scroller object
6915 * @param policy_h Horizontal scrollbar policy
6916 * @param policy_v Vertical scrollbar policy
6918 * @see elm_scroller_policy_set()
6920 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6922 * @brief Get the currently visible content region
6924 * @param obj The scroller object
6925 * @param x X coordinate of the region
6926 * @param y Y coordinate of the region
6927 * @param w Width of the region
6928 * @param h Height of the region
6930 * This gets the current region in the content object that is visible through
6931 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6932 * w, @p h values pointed to.
6934 * @note All coordinates are relative to the content.
6936 * @see elm_scroller_region_show()
6938 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);
6940 * @brief Get the size of the content object
6942 * @param obj The scroller object
6943 * @param w Width return
6944 * @param h Height return
6946 * This gets the size of the content object of the scroller.
6948 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6950 * @brief Set bouncing behavior
6952 * @param obj The scroller object
6953 * @param h_bounce Will the scroller bounce horizontally or not
6954 * @param v_bounce Will the scroller bounce vertically or not
6956 * When scrolling, the scroller may "bounce" when reaching an edge of the
6957 * content object. This is a visual way to indicate the end has been reached.
6958 * This is enabled by default for both axis. This will set if it is enabled
6959 * for that axis with the boolean parameters for each axis.
6961 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6963 * @brief Get the bounce mode
6965 * @param obj The Scroller object
6966 * @param h_bounce Allow bounce horizontally
6967 * @param v_bounce Allow bounce vertically
6969 * @see elm_scroller_bounce_set()
6971 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6973 * @brief Set scroll page size relative to viewport size.
6975 * @param obj The scroller object
6976 * @param h_pagerel The horizontal page relative size
6977 * @param v_pagerel The vertical page relative size
6979 * The scroller is capable of limiting scrolling by the user to "pages". That
6980 * is to jump by and only show a "whole page" at a time as if the continuous
6981 * area of the scroller content is split into page sized pieces. This sets
6982 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6983 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6984 * axis. This is mutually exclusive with page size
6985 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6986 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6987 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6990 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6992 * @brief Set scroll page size.
6994 * @param obj The scroller object
6995 * @param h_pagesize The horizontal page size
6996 * @param v_pagesize The vertical page size
6998 * This sets the page size to an absolute fixed value, with 0 turning it off
7001 * @see elm_scroller_page_relative_set()
7003 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7005 * @brief Get scroll current page number.
7007 * @param obj The scroller object
7008 * @param h_pagenumber The horizoptal page number
7009 * @param v_pagenumber The vertical page number
7011 * The page number starts from 0. 0 is the first page.
7012 * Current page means the page which meet the top-left of the viewport.
7013 * If there are two or more pages in the viewport, it returns the number of page
7014 * which meet the top-left of the viewport.
7016 * @see elm_scroller_last_page_get()
7017 * @see elm_scroller_page_show()
7018 * @see elm_scroller_page_brint_in()
7020 EAPI void elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7022 * @brief Get scroll last page number.
7024 * @param obj The scroller object
7025 * @param h_pagenumber The horizoptal page number
7026 * @param v_pagenumber The vertical page number
7028 * The page number starts from 0. 0 is the first page.
7029 * This returns the last page number among the pages.
7031 * @see elm_scroller_current_page_get()
7032 * @see elm_scroller_page_show()
7033 * @see elm_scroller_page_brint_in()
7035 EAPI void elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7037 * Show a specific virtual region within the scroller content object by page number.
7039 * @param obj The scroller object
7040 * @param h_pagenumber The horizoptal page number
7041 * @param v_pagenumber The vertical page number
7043 * 0, 0 of the indicated page is located at the top-left of the viewport.
7044 * This will jump to the page directly without animation.
7049 * sc = elm_scroller_add(win);
7050 * elm_scroller_content_set(sc, content);
7051 * elm_scroller_page_relative_set(sc, 1, 0);
7052 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7053 * elm_scroller_page_show(sc, h_page + 1, v_page);
7056 * @see elm_scroller_page_bring_in()
7058 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7060 * Show a specific virtual region within the scroller content object by page number.
7062 * @param obj The scroller object
7063 * @param h_pagenumber The horizoptal page number
7064 * @param v_pagenumber The vertical page number
7066 * 0, 0 of the indicated page is located at the top-left of the viewport.
7067 * This will slide to the page with animation.
7072 * sc = elm_scroller_add(win);
7073 * elm_scroller_content_set(sc, content);
7074 * elm_scroller_page_relative_set(sc, 1, 0);
7075 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7076 * elm_scroller_page_bring_in(sc, h_page, v_page);
7079 * @see elm_scroller_page_show()
7081 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7083 * @brief Show a specific virtual region within the scroller content object.
7085 * @param obj The scroller object
7086 * @param x X coordinate of the region
7087 * @param y Y coordinate of the region
7088 * @param w Width of the region
7089 * @param h Height of the region
7091 * This will ensure all (or part if it does not fit) of the designated
7092 * region in the virtual content object (0, 0 starting at the top-left of the
7093 * virtual content object) is shown within the scroller. Unlike
7094 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7095 * to this location (if configuration in general calls for transitions). It
7096 * may not jump immediately to the new location and make take a while and
7097 * show other content along the way.
7099 * @see elm_scroller_region_show()
7101 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);
7103 * @brief Set event propagation on a scroller
7105 * @param obj The scroller object
7106 * @param propagation If propagation is enabled or not
7108 * This enables or disabled event propagation from the scroller content to
7109 * the scroller and its parent. By default event propagation is disabled.
7111 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7113 * @brief Get event propagation for a scroller
7115 * @param obj The scroller object
7116 * @return The propagation state
7118 * This gets the event propagation for a scroller.
7120 * @see elm_scroller_propagate_events_set()
7122 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7128 * @defgroup Label Label
7130 * @image html img/widget/label/preview-00.png
7131 * @image latex img/widget/label/preview-00.eps
7133 * @brief Widget to display text, with simple html-like markup.
7135 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7136 * text doesn't fit the geometry of the label it will be ellipsized or be
7137 * cut. Elementary provides several themes for this widget:
7138 * @li default - No animation
7139 * @li marker - Centers the text in the label and make it bold by default
7140 * @li slide_long - The entire text appears from the right of the screen and
7141 * slides until it disappears in the left of the screen(reappering on the
7143 * @li slide_short - The text appears in the left of the label and slides to
7144 * the right to show the overflow. When all of the text has been shown the
7145 * position is reset.
7146 * @li slide_bounce - The text appears in the left of the label and slides to
7147 * the right to show the overflow. When all of the text has been shown the
7148 * animation reverses, moving the text to the left.
7150 * Custom themes can of course invent new markup tags and style them any way
7153 * See @ref tutorial_label for a demonstration of how to use a label widget.
7157 * @brief Add a new label to the parent
7159 * @param parent The parent object
7160 * @return The new object or NULL if it cannot be created
7162 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7164 * @brief Set the label on the label object
7166 * @param obj The label object
7167 * @param label The label will be used on the label object
7168 * @deprecated See elm_object_text_set()
7170 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 */
7172 * @brief Get the label used on the label object
7174 * @param obj The label object
7175 * @return The string inside the label
7176 * @deprecated See elm_object_text_get()
7178 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7180 * @brief Set the wrapping behavior of the label
7182 * @param obj The label object
7183 * @param wrap To wrap text or not
7185 * By default no wrapping is done. Possible values for @p wrap are:
7186 * @li ELM_WRAP_NONE - No wrapping
7187 * @li ELM_WRAP_CHAR - wrap between characters
7188 * @li ELM_WRAP_WORD - wrap between words
7189 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7191 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7193 * @brief Get the wrapping behavior of the label
7195 * @param obj The label object
7198 * @see elm_label_line_wrap_set()
7200 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7202 * @brief Set wrap width of the label
7204 * @param obj The label object
7205 * @param w The wrap width in pixels at a minimum where words need to wrap
7207 * This function sets the maximum width size hint of the label.
7209 * @warning This is only relevant if the label is inside a container.
7211 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7213 * @brief Get wrap width of the label
7215 * @param obj The label object
7216 * @return The wrap width in pixels at a minimum where words need to wrap
7218 * @see elm_label_wrap_width_set()
7220 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7222 * @brief Set wrap height of the label
7224 * @param obj The label object
7225 * @param h The wrap height in pixels at a minimum where words need to wrap
7227 * This function sets the maximum height size hint of the label.
7229 * @warning This is only relevant if the label is inside a container.
7231 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7233 * @brief get wrap width of the label
7235 * @param obj The label object
7236 * @return The wrap height in pixels at a minimum where words need to wrap
7238 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7240 * @brief Set the font size on the label object.
7242 * @param obj The label object
7243 * @param size font size
7245 * @warning NEVER use this. It is for hyper-special cases only. use styles
7246 * instead. e.g. "big", "medium", "small" - or better name them by use:
7247 * "title", "footnote", "quote" etc.
7249 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7251 * @brief Set the text color on the label object
7253 * @param obj The label object
7254 * @param r Red property background color of The label object
7255 * @param g Green property background color of The label object
7256 * @param b Blue property background color of The label object
7257 * @param a Alpha property background color of The label object
7259 * @warning NEVER use this. It is for hyper-special cases only. use styles
7260 * instead. e.g. "big", "medium", "small" - or better name them by use:
7261 * "title", "footnote", "quote" etc.
7263 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);
7265 * @brief Set the text align on the label object
7267 * @param obj The label object
7268 * @param align align mode ("left", "center", "right")
7270 * @warning NEVER use this. It is for hyper-special cases only. use styles
7271 * instead. e.g. "big", "medium", "small" - or better name them by use:
7272 * "title", "footnote", "quote" etc.
7274 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7276 * @brief Set background color of the label
7278 * @param obj The label object
7279 * @param r Red property background color of The label object
7280 * @param g Green property background color of The label object
7281 * @param b Blue property background color of The label object
7282 * @param a Alpha property background alpha of The label object
7284 * @warning NEVER use this. It is for hyper-special cases only. use styles
7285 * instead. e.g. "big", "medium", "small" - or better name them by use:
7286 * "title", "footnote", "quote" etc.
7288 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);
7290 * @brief Set the ellipsis behavior of the label
7292 * @param obj The label object
7293 * @param ellipsis To ellipsis text or not
7295 * If set to true and the text doesn't fit in the label an ellipsis("...")
7296 * will be shown at the end of the widget.
7298 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7299 * choosen wrap method was ELM_WRAP_WORD.
7301 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7303 * @brief Set the text slide of the label
7305 * @param obj The label object
7306 * @param slide To start slide or stop
7308 * If set to true the text of the label will slide throught the length of
7311 * @warning This only work with the themes "slide_short", "slide_long" and
7314 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7316 * @brief Get the text slide mode of the label
7318 * @param obj The label object
7319 * @return slide slide mode value
7321 * @see elm_label_slide_set()
7323 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7325 * @brief Set the slide duration(speed) of the label
7327 * @param obj The label object
7328 * @return The duration in seconds in moving text from slide begin position
7329 * to slide end position
7331 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7333 * @brief Get the slide duration(speed) of the label
7335 * @param obj The label object
7336 * @return The duration time in moving text from slide begin position to slide end position
7338 * @see elm_label_slide_duration_set()
7340 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7346 * @defgroup Toggle Toggle
7348 * @image html img/widget/toggle/preview-00.png
7349 * @image latex img/widget/toggle/preview-00.eps
7351 * @brief A toggle is a slider which can be used to toggle between
7352 * two values. It has two states: on and off.
7354 * Signals that you can add callbacks for are:
7355 * @li "changed" - Whenever the toggle value has been changed. Is not called
7356 * until the toggle is released by the cursor (assuming it
7357 * has been triggered by the cursor in the first place).
7359 * @ref tutorial_toggle show how to use a toggle.
7363 * @brief Add a toggle to @p parent.
7365 * @param parent The parent object
7367 * @return The toggle object
7369 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7371 * @brief Sets the label to be displayed with the toggle.
7373 * @param obj The toggle object
7374 * @param label The label to be displayed
7376 * @deprecated use elm_object_text_set() instead.
7378 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7380 * @brief Gets the label of the toggle
7382 * @param obj toggle object
7383 * @return The label of the toggle
7385 * @deprecated use elm_object_text_get() instead.
7387 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7389 * @brief Set the icon used for the toggle
7391 * @param obj The toggle object
7392 * @param icon The icon object for the button
7394 * Once the icon object is set, a previously set one will be deleted
7395 * If you want to keep that old content object, use the
7396 * elm_toggle_icon_unset() function.
7398 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7400 * @brief Get the icon used for the toggle
7402 * @param obj The toggle object
7403 * @return The icon object that is being used
7405 * Return the icon object which is set for this widget.
7407 * @see elm_toggle_icon_set()
7409 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7411 * @brief Unset the icon used for the toggle
7413 * @param obj The toggle object
7414 * @return The icon object that was being used
7416 * Unparent and return the icon object which was set for this widget.
7418 * @see elm_toggle_icon_set()
7420 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7422 * @brief Sets the labels to be associated with the on and off states of the toggle.
7424 * @param obj The toggle object
7425 * @param onlabel The label displayed when the toggle is in the "on" state
7426 * @param offlabel The label displayed when the toggle is in the "off" state
7428 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7430 * @brief Gets the labels associated with the on and off states of the toggle.
7432 * @param obj The toggle object
7433 * @param onlabel A char** to place the onlabel of @p obj into
7434 * @param offlabel A char** to place the offlabel of @p obj into
7436 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7438 * @brief Sets the state of the toggle to @p state.
7440 * @param obj The toggle object
7441 * @param state The state of @p obj
7443 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7445 * @brief Gets the state of the toggle to @p state.
7447 * @param obj The toggle object
7448 * @return The state of @p obj
7450 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7452 * @brief Sets the state pointer of the toggle to @p statep.
7454 * @param obj The toggle object
7455 * @param statep The state pointer of @p obj
7457 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7463 * @defgroup Frame Frame
7465 * @image html img/widget/frame/preview-00.png
7466 * @image latex img/widget/frame/preview-00.eps
7468 * @brief Frame is a widget that holds some content and has a title.
7470 * The default look is a frame with a title, but Frame supports multple
7478 * @li outdent_bottom
7480 * Of all this styles only default shows the title. Frame emits no signals.
7482 * For a detailed example see the @ref tutorial_frame.
7487 * @brief Add a new frame to the parent
7489 * @param parent The parent object
7490 * @return The new object or NULL if it cannot be created
7492 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7494 * @brief Set the frame label
7496 * @param obj The frame object
7497 * @param label The label of this frame object
7499 * @deprecated use elm_object_text_set() instead.
7501 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7503 * @brief Get the frame label
7505 * @param obj The frame object
7507 * @return The label of this frame objet or NULL if unable to get frame
7509 * @deprecated use elm_object_text_get() instead.
7511 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7513 * @brief Set the content of the frame widget
7515 * Once the content object is set, a previously set one will be deleted.
7516 * If you want to keep that old content object, use the
7517 * elm_frame_content_unset() function.
7519 * @param obj The frame object
7520 * @param content The content will be filled in this frame object
7522 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7524 * @brief Get the content of the frame widget
7526 * Return the content object which is set for this widget
7528 * @param obj The frame object
7529 * @return The content that is being used
7531 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7533 * @brief Unset the content of the frame widget
7535 * Unparent and return the content object which was set for this widget
7537 * @param obj The frame object
7538 * @return The content that was being used
7540 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7546 * @defgroup Table Table
7548 * A container widget to arrange other widgets in a table where items can
7549 * also span multiple columns or rows - even overlap (and then be raised or
7550 * lowered accordingly to adjust stacking if they do overlap).
7552 * The followin are examples of how to use a table:
7553 * @li @ref tutorial_table_01
7554 * @li @ref tutorial_table_02
7559 * @brief Add a new table to the parent
7561 * @param parent The parent object
7562 * @return The new object or NULL if it cannot be created
7564 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7566 * @brief Set the homogeneous layout in the table
7568 * @param obj The layout object
7569 * @param homogeneous A boolean to set if the layout is homogeneous in the
7570 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7572 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7574 * @brief Get the current table homogeneous mode.
7576 * @param obj The table object
7577 * @return A boolean to indicating if the layout is homogeneous in the table
7578 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7580 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7582 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7584 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7586 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7588 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7590 * @brief Set padding between cells.
7592 * @param obj The layout object.
7593 * @param horizontal set the horizontal padding.
7594 * @param vertical set the vertical padding.
7596 * Default value is 0.
7598 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7600 * @brief Get padding between cells.
7602 * @param obj The layout object.
7603 * @param horizontal set the horizontal padding.
7604 * @param vertical set the vertical padding.
7606 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7608 * @brief Add a subobject on the table with the coordinates passed
7610 * @param obj The table object
7611 * @param subobj The subobject to be added to the table
7612 * @param x Row number
7613 * @param y Column number
7617 * @note All positioning inside the table is relative to rows and columns, so
7618 * a value of 0 for x and y, means the top left cell of the table, and a
7619 * value of 1 for w and h means @p subobj only takes that 1 cell.
7621 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7623 * @brief Remove child from table.
7625 * @param obj The table object
7626 * @param subobj The subobject
7628 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7630 * @brief Faster way to remove all child objects from a table object.
7632 * @param obj The table object
7633 * @param clear If true, will delete children, else just remove from table.
7635 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7637 * @brief Set the packing location of an existing child of the table
7639 * @param subobj The subobject to be modified in the table
7640 * @param x Row number
7641 * @param y Column number
7645 * Modifies the position of an object already in the table.
7647 * @note All positioning inside the table is relative to rows and columns, so
7648 * a value of 0 for x and y, means the top left cell of the table, and a
7649 * value of 1 for w and h means @p subobj only takes that 1 cell.
7651 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7653 * @brief Get the packing location of an existing child of the table
7655 * @param subobj The subobject to be modified in the table
7656 * @param x Row number
7657 * @param y Column number
7661 * @see elm_table_pack_set()
7663 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7669 * @defgroup Gengrid Gengrid (Generic grid)
7671 * This widget aims to position objects in a grid layout while
7672 * actually creating and rendering only the visible ones, using the
7673 * same idea as the @ref Genlist "genlist": the user defines a @b
7674 * class for each item, specifying functions that will be called at
7675 * object creation, deletion, etc. When those items are selected by
7676 * the user, a callback function is issued. Users may interact with
7677 * a gengrid via the mouse (by clicking on items to select them and
7678 * clicking on the grid's viewport and swiping to pan the whole
7679 * view) or via the keyboard, navigating through item with the
7682 * @section Gengrid_Layouts Gengrid layouts
7684 * Gengrids may layout its items in one of two possible layouts:
7688 * When in "horizontal mode", items will be placed in @b columns,
7689 * from top to bottom and, when the space for a column is filled,
7690 * another one is started on the right, thus expanding the grid
7691 * horizontally, making for horizontal scrolling. When in "vertical
7692 * mode" , though, items will be placed in @b rows, from left to
7693 * right and, when the space for a row is filled, another one is
7694 * started below, thus expanding the grid vertically (and making
7695 * for vertical scrolling).
7697 * @section Gengrid_Items Gengrid items
7699 * An item in a gengrid can have 0 or more text labels (they can be
7700 * regular text or textblock Evas objects - that's up to the style
7701 * to determine), 0 or more icons (which are simply objects
7702 * swallowed into the gengrid item's theming Edje object) and 0 or
7703 * more <b>boolean states</b>, which have the behavior left to the
7704 * user to define. The Edje part names for each of these properties
7705 * will be looked up, in the theme file for the gengrid, under the
7706 * Edje (string) data items named @c "labels", @c "icons" and @c
7707 * "states", respectively. For each of those properties, if more
7708 * than one part is provided, they must have names listed separated
7709 * by spaces in the data fields. For the default gengrid item
7710 * theme, we have @b one label part (@c "elm.text"), @b two icon
7711 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7714 * A gengrid item may be at one of several styles. Elementary
7715 * provides one by default - "default", but this can be extended by
7716 * system or application custom themes/overlays/extensions (see
7717 * @ref Theme "themes" for more details).
7719 * @section Gengrid_Item_Class Gengrid item classes
7721 * In order to have the ability to add and delete items on the fly,
7722 * gengrid implements a class (callback) system where the
7723 * application provides a structure with information about that
7724 * type of item (gengrid may contain multiple different items with
7725 * different classes, states and styles). Gengrid will call the
7726 * functions in this struct (methods) when an item is "realized"
7727 * (i.e., created dynamically, while the user is scrolling the
7728 * grid). All objects will simply be deleted when no longer needed
7729 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7730 * contains the following members:
7731 * - @c item_style - This is a constant string and simply defines
7732 * the name of the item style. It @b must be specified and the
7733 * default should be @c "default".
7734 * - @c func.label_get - This function is called when an item
7735 * object is actually created. The @c data parameter will point to
7736 * the same data passed to elm_gengrid_item_append() and related
7737 * item creation functions. The @c obj parameter is the gengrid
7738 * object itself, while the @c part one is the name string of one
7739 * of the existing text parts in the Edje group implementing the
7740 * item's theme. This function @b must return a strdup'()ed string,
7741 * as the caller will free() it when done. See
7742 * #Elm_Gengrid_Item_Label_Get_Cb.
7743 * - @c func.icon_get - This function is called when an item object
7744 * is actually created. The @c data parameter will point to the
7745 * same data passed to elm_gengrid_item_append() and related item
7746 * creation functions. The @c obj parameter is the gengrid object
7747 * itself, while the @c part one is the name string of one of the
7748 * existing (icon) swallow parts in the Edje group implementing the
7749 * item's theme. It must return @c NULL, when no icon is desired,
7750 * or a valid object handle, otherwise. The object will be deleted
7751 * by the gengrid on its deletion or when the item is "unrealized".
7752 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7753 * - @c func.state_get - This function is called when an item
7754 * object is actually created. The @c data parameter will point to
7755 * the same data passed to elm_gengrid_item_append() and related
7756 * item creation functions. The @c obj parameter is the gengrid
7757 * object itself, while the @c part one is the name string of one
7758 * of the state parts in the Edje group implementing the item's
7759 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7760 * true/on. Gengrids will emit a signal to its theming Edje object
7761 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7762 * "source" arguments, respectively, when the state is true (the
7763 * default is false), where @c XXX is the name of the (state) part.
7764 * See #Elm_Gengrid_Item_State_Get_Cb.
7765 * - @c func.del - This is called when elm_gengrid_item_del() is
7766 * called on an item or elm_gengrid_clear() is called on the
7767 * gengrid. This is intended for use when gengrid items are
7768 * deleted, so any data attached to the item (e.g. its data
7769 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7771 * @section Gengrid_Usage_Hints Usage hints
7773 * If the user wants to have multiple items selected at the same
7774 * time, elm_gengrid_multi_select_set() will permit it. If the
7775 * gengrid is single-selection only (the default), then
7776 * elm_gengrid_select_item_get() will return the selected item or
7777 * @c NULL, if none is selected. If the gengrid is under
7778 * multi-selection, then elm_gengrid_selected_items_get() will
7779 * return a list (that is only valid as long as no items are
7780 * modified (added, deleted, selected or unselected) of child items
7783 * If an item changes (internal (boolean) state, label or icon
7784 * changes), then use elm_gengrid_item_update() to have gengrid
7785 * update the item with the new state. A gengrid will re-"realize"
7786 * the item, thus calling the functions in the
7787 * #Elm_Gengrid_Item_Class set for that item.
7789 * To programmatically (un)select an item, use
7790 * elm_gengrid_item_selected_set(). To get its selected state use
7791 * elm_gengrid_item_selected_get(). To make an item disabled
7792 * (unable to be selected and appear differently) use
7793 * elm_gengrid_item_disabled_set() to set this and
7794 * elm_gengrid_item_disabled_get() to get the disabled state.
7796 * Grid cells will only have their selection smart callbacks called
7797 * when firstly getting selected. Any further clicks will do
7798 * nothing, unless you enable the "always select mode", with
7799 * elm_gengrid_always_select_mode_set(), thus making every click to
7800 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7801 * turn off the ability to select items entirely in the widget and
7802 * they will neither appear selected nor call the selection smart
7805 * Remember that you can create new styles and add your own theme
7806 * augmentation per application with elm_theme_extension_add(). If
7807 * you absolutely must have a specific style that overrides any
7808 * theme the user or system sets up you can use
7809 * elm_theme_overlay_add() to add such a file.
7811 * @section Gengrid_Smart_Events Gengrid smart events
7813 * Smart events that you can add callbacks for are:
7814 * - @c "activated" - The user has double-clicked or pressed
7815 * (enter|return|spacebar) on an item. The @c event_info parameter
7816 * is the gengrid item that was activated.
7817 * - @c "clicked,double" - The user has double-clicked an item.
7818 * The @c event_info parameter is the gengrid item that was double-clicked.
7819 * - @c "selected" - The user has made an item selected. The
7820 * @c event_info parameter is the gengrid item that was selected.
7821 * - @c "unselected" - The user has made an item unselected. The
7822 * @c event_info parameter is the gengrid item that was unselected.
7823 * - @c "realized" - This is called when the item in the gengrid
7824 * has its implementing Evas object instantiated, de facto. @c
7825 * event_info is the gengrid item that was created. The object
7826 * may be deleted at any time, so it is highly advised to the
7827 * caller @b not to use the object pointer returned from
7828 * elm_gengrid_item_object_get(), because it may point to freed
7830 * - @c "unrealized" - This is called when the implementing Evas
7831 * object for this item is deleted. @c event_info is the gengrid
7832 * item that was deleted.
7833 * - @c "changed" - Called when an item is added, removed, resized
7834 * or moved and when the gengrid is resized or gets "horizontal"
7836 * - @c "scroll,anim,start" - This is called when scrolling animation has
7838 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7840 * - @c "drag,start,up" - Called when the item in the gengrid has
7841 * been dragged (not scrolled) up.
7842 * - @c "drag,start,down" - Called when the item in the gengrid has
7843 * been dragged (not scrolled) down.
7844 * - @c "drag,start,left" - Called when the item in the gengrid has
7845 * been dragged (not scrolled) left.
7846 * - @c "drag,start,right" - Called when the item in the gengrid has
7847 * been dragged (not scrolled) right.
7848 * - @c "drag,stop" - Called when the item in the gengrid has
7849 * stopped being dragged.
7850 * - @c "drag" - Called when the item in the gengrid is being
7852 * - @c "scroll" - called when the content has been scrolled
7854 * - @c "scroll,drag,start" - called when dragging the content has
7856 * - @c "scroll,drag,stop" - called when dragging the content has
7859 * List of gendrid examples:
7860 * @li @ref gengrid_example
7864 * @addtogroup Gengrid
7868 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7869 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7870 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7871 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7872 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. */
7873 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. */
7874 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7876 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7877 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7878 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7879 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7882 * @struct _Elm_Gengrid_Item_Class
7884 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7887 struct _Elm_Gengrid_Item_Class
7889 const char *item_style;
7890 struct _Elm_Gengrid_Item_Class_Func
7892 Elm_Gengrid_Item_Label_Get_Cb label_get;
7893 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7894 Elm_Gengrid_Item_State_Get_Cb state_get;
7895 Elm_Gengrid_Item_Del_Cb del;
7897 }; /**< #Elm_Gengrid_Item_Class member definitions */
7900 * Add a new gengrid widget to the given parent Elementary
7901 * (container) object
7903 * @param parent The parent object
7904 * @return a new gengrid widget handle or @c NULL, on errors
7906 * This function inserts a new gengrid widget on the canvas.
7908 * @see elm_gengrid_item_size_set()
7909 * @see elm_gengrid_horizontal_set()
7910 * @see elm_gengrid_item_append()
7911 * @see elm_gengrid_item_del()
7912 * @see elm_gengrid_clear()
7916 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7919 * Set the size for the items of a given gengrid widget
7921 * @param obj The gengrid object.
7922 * @param w The items' width.
7923 * @param h The items' height;
7925 * A gengrid, after creation, has still no information on the size
7926 * to give to each of its cells. So, you most probably will end up
7927 * with squares one @ref Fingers "finger" wide, the default
7928 * size. Use this function to force a custom size for you items,
7929 * making them as big as you wish.
7931 * @see elm_gengrid_item_size_get()
7935 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7938 * Get the size set for the items of a given gengrid widget
7940 * @param obj The gengrid object.
7941 * @param w Pointer to a variable where to store the items' width.
7942 * @param h Pointer to a variable where to store the items' height.
7944 * @note Use @c NULL pointers on the size values you're not
7945 * interested in: they'll be ignored by the function.
7947 * @see elm_gengrid_item_size_get() for more details
7951 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7954 * Set the items grid's alignment within a given gengrid widget
7956 * @param obj The gengrid object.
7957 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7958 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7960 * This sets the alignment of the whole grid of items of a gengrid
7961 * within its given viewport. By default, those values are both
7962 * 0.5, meaning that the gengrid will have its items grid placed
7963 * exactly in the middle of its viewport.
7965 * @note If given alignment values are out of the cited ranges,
7966 * they'll be changed to the nearest boundary values on the valid
7969 * @see elm_gengrid_align_get()
7973 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7976 * Get the items grid's alignment values within a given gengrid
7979 * @param obj The gengrid object.
7980 * @param align_x Pointer to a variable where to store the
7981 * horizontal alignment.
7982 * @param align_y Pointer to a variable where to store the vertical
7985 * @note Use @c NULL pointers on the alignment values you're not
7986 * interested in: they'll be ignored by the function.
7988 * @see elm_gengrid_align_set() for more details
7992 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7995 * Set whether a given gengrid widget is or not able have items
7998 * @param obj The gengrid object
7999 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8000 * @c EINA_FALSE to turn it off
8002 * If a gengrid is set to allow reordering, a click held for more
8003 * than 0.5 over a given item will highlight it specially,
8004 * signalling the gengrid has entered the reordering state. From
8005 * that time on, the user will be able to, while still holding the
8006 * mouse button down, move the item freely in the gengrid's
8007 * viewport, replacing to said item to the locations it goes to.
8008 * The replacements will be animated and, whenever the user
8009 * releases the mouse button, the item being replaced gets a new
8010 * definitive place in the grid.
8012 * @see elm_gengrid_reorder_mode_get()
8016 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8019 * Get whether a given gengrid widget is or not able have items
8022 * @param obj The gengrid object
8023 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8026 * @see elm_gengrid_reorder_mode_set() for more details
8030 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8033 * Append a new item in a given gengrid widget.
8035 * @param obj The gengrid object.
8036 * @param gic The item class for the item.
8037 * @param data The item data.
8038 * @param func Convenience function called when the item is
8040 * @param func_data Data to be passed to @p func.
8041 * @return A handle to the item added or @c NULL, on errors.
8043 * This adds an item to the beginning of the gengrid.
8045 * @see elm_gengrid_item_prepend()
8046 * @see elm_gengrid_item_insert_before()
8047 * @see elm_gengrid_item_insert_after()
8048 * @see elm_gengrid_item_del()
8052 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);
8055 * Prepend a new item in a given gengrid widget.
8057 * @param obj The gengrid object.
8058 * @param gic The item class for the item.
8059 * @param data The item data.
8060 * @param func Convenience function called when the item is
8062 * @param func_data Data to be passed to @p func.
8063 * @return A handle to the item added or @c NULL, on errors.
8065 * This adds an item to the end of the gengrid.
8067 * @see elm_gengrid_item_append()
8068 * @see elm_gengrid_item_insert_before()
8069 * @see elm_gengrid_item_insert_after()
8070 * @see elm_gengrid_item_del()
8074 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);
8077 * Insert an item before another in a gengrid widget
8079 * @param obj The gengrid object.
8080 * @param gic The item class for the item.
8081 * @param data The item data.
8082 * @param relative The item to place this new one before.
8083 * @param func Convenience function called when the item is
8085 * @param func_data Data to be passed to @p func.
8086 * @return A handle to the item added or @c NULL, on errors.
8088 * This inserts an item before another in the gengrid.
8090 * @see elm_gengrid_item_append()
8091 * @see elm_gengrid_item_prepend()
8092 * @see elm_gengrid_item_insert_after()
8093 * @see elm_gengrid_item_del()
8097 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);
8100 * Insert an item after another in a gengrid widget
8102 * @param obj The gengrid object.
8103 * @param gic The item class for the item.
8104 * @param data The item data.
8105 * @param relative The item to place this new one after.
8106 * @param func Convenience function called when the item is
8108 * @param func_data Data to be passed to @p func.
8109 * @return A handle to the item added or @c NULL, on errors.
8111 * This inserts an item after another in the gengrid.
8113 * @see elm_gengrid_item_append()
8114 * @see elm_gengrid_item_prepend()
8115 * @see elm_gengrid_item_insert_after()
8116 * @see elm_gengrid_item_del()
8120 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);
8122 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);
8124 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);
8127 * Set whether items on a given gengrid widget are to get their
8128 * selection callbacks issued for @b every subsequent selection
8129 * click on them or just for the first click.
8131 * @param obj The gengrid object
8132 * @param always_select @c EINA_TRUE to make items "always
8133 * selected", @c EINA_FALSE, otherwise
8135 * By default, grid items will only call their selection callback
8136 * function when firstly getting selected, any subsequent further
8137 * clicks will do nothing. With this call, you make those
8138 * subsequent clicks also to issue the selection callbacks.
8140 * @note <b>Double clicks</b> will @b always be reported on items.
8142 * @see elm_gengrid_always_select_mode_get()
8146 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8149 * Get whether items on a given gengrid widget have their selection
8150 * callbacks issued for @b every subsequent selection click on them
8151 * or just for the first click.
8153 * @param obj The gengrid object.
8154 * @return @c EINA_TRUE if the gengrid items are "always selected",
8155 * @c EINA_FALSE, otherwise
8157 * @see elm_gengrid_always_select_mode_set() for more details
8161 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8164 * Set whether items on a given gengrid widget can be selected or not.
8166 * @param obj The gengrid object
8167 * @param no_select @c EINA_TRUE to make items selectable,
8168 * @c EINA_FALSE otherwise
8170 * This will make items in @p obj selectable or not. In the latter
8171 * case, any user interacion on the gendrid items will neither make
8172 * them appear selected nor them call their selection callback
8175 * @see elm_gengrid_no_select_mode_get()
8179 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8182 * Get whether items on a given gengrid widget can be selected or
8185 * @param obj The gengrid object
8186 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8189 * @see elm_gengrid_no_select_mode_set() for more details
8193 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8196 * Enable or disable multi-selection in a given gengrid widget
8198 * @param obj The gengrid object.
8199 * @param multi @c EINA_TRUE, to enable multi-selection,
8200 * @c EINA_FALSE to disable it.
8202 * Multi-selection is the ability for one to have @b more than one
8203 * item selected, on a given gengrid, simultaneously. When it is
8204 * enabled, a sequence of clicks on different items will make them
8205 * all selected, progressively. A click on an already selected item
8206 * will unselect it. If interecting via the keyboard,
8207 * multi-selection is enabled while holding the "Shift" key.
8209 * @note By default, multi-selection is @b disabled on gengrids
8211 * @see elm_gengrid_multi_select_get()
8215 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8218 * Get whether multi-selection is enabled or disabled for a given
8221 * @param obj The gengrid object.
8222 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8223 * EINA_FALSE otherwise
8225 * @see elm_gengrid_multi_select_set() for more details
8229 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8232 * Enable or disable bouncing effect for a given gengrid widget
8234 * @param obj The gengrid object
8235 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8236 * @c EINA_FALSE to disable it
8237 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8238 * @c EINA_FALSE to disable it
8240 * The bouncing effect occurs whenever one reaches the gengrid's
8241 * edge's while panning it -- it will scroll past its limits a
8242 * little bit and return to the edge again, in a animated for,
8245 * @note By default, gengrids have bouncing enabled on both axis
8247 * @see elm_gengrid_bounce_get()
8251 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8254 * Get whether bouncing effects are enabled or disabled, for a
8255 * given gengrid widget, on each axis
8257 * @param obj The gengrid object
8258 * @param h_bounce Pointer to a variable where to store the
8259 * horizontal bouncing flag.
8260 * @param v_bounce Pointer to a variable where to store the
8261 * vertical bouncing flag.
8263 * @see elm_gengrid_bounce_set() for more details
8267 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8270 * Set a given gengrid widget's scrolling page size, relative to
8271 * its viewport size.
8273 * @param obj The gengrid object
8274 * @param h_pagerel The horizontal page (relative) size
8275 * @param v_pagerel The vertical page (relative) size
8277 * The gengrid's scroller is capable of binding scrolling by the
8278 * user to "pages". It means that, while scrolling and, specially
8279 * after releasing the mouse button, the grid will @b snap to the
8280 * nearest displaying page's area. When page sizes are set, the
8281 * grid's continuous content area is split into (equal) page sized
8284 * This function sets the size of a page <b>relatively to the
8285 * viewport dimensions</b> of the gengrid, for each axis. A value
8286 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8287 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8288 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8289 * 1.0. Values beyond those will make it behave behave
8290 * inconsistently. If you only want one axis to snap to pages, use
8291 * the value @c 0.0 for the other one.
8293 * There is a function setting page size values in @b absolute
8294 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8295 * is mutually exclusive to this one.
8297 * @see elm_gengrid_page_relative_get()
8301 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8304 * Get a given gengrid widget's scrolling page size, relative to
8305 * its viewport size.
8307 * @param obj The gengrid object
8308 * @param h_pagerel Pointer to a variable where to store the
8309 * horizontal page (relative) size
8310 * @param v_pagerel Pointer to a variable where to store the
8311 * vertical page (relative) size
8313 * @see elm_gengrid_page_relative_set() for more details
8317 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8320 * Set a given gengrid widget's scrolling page size
8322 * @param obj The gengrid object
8323 * @param h_pagerel The horizontal page size, in pixels
8324 * @param v_pagerel The vertical page size, in pixels
8326 * The gengrid's scroller is capable of binding scrolling by the
8327 * user to "pages". It means that, while scrolling and, specially
8328 * after releasing the mouse button, the grid will @b snap to the
8329 * nearest displaying page's area. When page sizes are set, the
8330 * grid's continuous content area is split into (equal) page sized
8333 * This function sets the size of a page of the gengrid, in pixels,
8334 * for each axis. Sane usable values are, between @c 0 and the
8335 * dimensions of @p obj, for each axis. Values beyond those will
8336 * make it behave behave inconsistently. If you only want one axis
8337 * to snap to pages, use the value @c 0 for the other one.
8339 * There is a function setting page size values in @b relative
8340 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8341 * use is mutually exclusive to this one.
8345 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8348 * Set for what direction a given gengrid widget will expand while
8349 * placing its items.
8351 * @param obj The gengrid object.
8352 * @param setting @c EINA_TRUE to make the gengrid expand
8353 * horizontally, @c EINA_FALSE to expand vertically.
8355 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8356 * in @b columns, from top to bottom and, when the space for a
8357 * column is filled, another one is started on the right, thus
8358 * expanding the grid horizontally. When in "vertical mode"
8359 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8360 * to right and, when the space for a row is filled, another one is
8361 * started below, thus expanding the grid vertically.
8363 * @see elm_gengrid_horizontal_get()
8367 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8370 * Get for what direction a given gengrid widget will expand while
8371 * placing its items.
8373 * @param obj The gengrid object.
8374 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8375 * @c EINA_FALSE if it's set to expand vertically.
8377 * @see elm_gengrid_horizontal_set() for more detais
8381 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8384 * Get the first item in a given gengrid widget
8386 * @param obj The gengrid object
8387 * @return The first item's handle or @c NULL, if there are no
8388 * items in @p obj (and on errors)
8390 * This returns the first item in the @p obj's internal list of
8393 * @see elm_gengrid_last_item_get()
8397 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8400 * Get the last item in a given gengrid widget
8402 * @param obj The gengrid object
8403 * @return The last item's handle or @c NULL, if there are no
8404 * items in @p obj (and on errors)
8406 * This returns the last item in the @p obj's internal list of
8409 * @see elm_gengrid_first_item_get()
8413 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8416 * Get the @b next item in a gengrid widget's internal list of items,
8417 * given a handle to one of those items.
8419 * @param item The gengrid item to fetch next from
8420 * @return The item after @p item, or @c NULL if there's none (and
8423 * This returns the item placed after the @p item, on the container
8426 * @see elm_gengrid_item_prev_get()
8430 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8433 * Get the @b previous item in a gengrid widget's internal list of items,
8434 * given a handle to one of those items.
8436 * @param item The gengrid item to fetch previous from
8437 * @return The item before @p item, or @c NULL if there's none (and
8440 * This returns the item placed before the @p item, on the container
8443 * @see elm_gengrid_item_next_get()
8447 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8450 * Get the gengrid object's handle which contains a given gengrid
8453 * @param item The item to fetch the container from
8454 * @return The gengrid (parent) object
8456 * This returns the gengrid object itself that an item belongs to.
8460 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8463 * Remove a gengrid item from the its parent, deleting it.
8465 * @param item The item to be removed.
8466 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8468 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8473 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8476 * Update the contents of a given gengrid item
8478 * @param item The gengrid item
8480 * This updates an item by calling all the item class functions
8481 * again to get the icons, labels and states. Use this when the
8482 * original item data has changed and you want thta changes to be
8487 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8488 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8489 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8492 * Return the data associated to a given gengrid item
8494 * @param item The gengrid item.
8495 * @return the data associated to this item.
8497 * This returns the @c data value passed on the
8498 * elm_gengrid_item_append() and related item addition calls.
8500 * @see elm_gengrid_item_append()
8501 * @see elm_gengrid_item_data_set()
8505 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8508 * Set the data associated to a given gengrid item
8510 * @param item The gengrid item
8511 * @param data The new data pointer to set on it
8513 * This @b overrides the @c data value passed on the
8514 * elm_gengrid_item_append() and related item addition calls. This
8515 * function @b won't call elm_gengrid_item_update() automatically,
8516 * so you'd issue it afterwards if you want to hove the item
8517 * updated to reflect the that new data.
8519 * @see elm_gengrid_item_data_get()
8523 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8526 * Get a given gengrid item's position, relative to the whole
8527 * gengrid's grid area.
8529 * @param item The Gengrid item.
8530 * @param x Pointer to variable where to store the item's <b>row
8532 * @param y Pointer to variable where to store the item's <b>column
8535 * This returns the "logical" position of the item whithin the
8536 * gengrid. For example, @c (0, 1) would stand for first row,
8541 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8544 * Set whether a given gengrid item is selected or not
8546 * @param item The gengrid item
8547 * @param selected Use @c EINA_TRUE, to make it selected, @c
8548 * EINA_FALSE to make it unselected
8550 * This sets the selected state of an item. If multi selection is
8551 * not enabled on the containing gengrid and @p selected is @c
8552 * EINA_TRUE, any other previously selected items will get
8553 * unselected in favor of this new one.
8555 * @see elm_gengrid_item_selected_get()
8559 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8562 * Get whether a given gengrid item is selected or not
8564 * @param item The gengrid item
8565 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8567 * @see elm_gengrid_item_selected_set() for more details
8571 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8574 * Get the real Evas object created to implement the view of a
8575 * given gengrid item
8577 * @param item The gengrid item.
8578 * @return the Evas object implementing this item's view.
8580 * This returns the actual Evas object used to implement the
8581 * specified gengrid item's view. This may be @c NULL, as it may
8582 * not have been created or may have been deleted, at any time, by
8583 * the gengrid. <b>Do not modify this object</b> (move, resize,
8584 * show, hide, etc.), as the gengrid is controlling it. This
8585 * function is for querying, emitting custom signals or hooking
8586 * lower level callbacks for events on that object. Do not delete
8587 * this object under any circumstances.
8589 * @see elm_gengrid_item_data_get()
8593 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8596 * Show the portion of a gengrid's internal grid containing a given
8597 * item, @b immediately.
8599 * @param item The item to display
8601 * This causes gengrid to @b redraw its viewport's contents to the
8602 * region contining the given @p item item, if it is not fully
8605 * @see elm_gengrid_item_bring_in()
8609 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8612 * Animatedly bring in, to the visible are of a gengrid, a given
8615 * @param item The gengrid item to display
8617 * This causes gengrig to jump to the given @p item item and show
8618 * it (by scrolling), if it is not fully visible. This will use
8619 * animation to do so and take a period of time to complete.
8621 * @see elm_gengrid_item_show()
8625 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8628 * Set whether a given gengrid item is disabled or not.
8630 * @param item The gengrid item
8631 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8632 * to enable it back.
8634 * A disabled item cannot be selected or unselected. It will also
8635 * change its appearance, to signal the user it's disabled.
8637 * @see elm_gengrid_item_disabled_get()
8641 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8644 * Get whether a given gengrid item is disabled or not.
8646 * @param item The gengrid item
8647 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8650 * @see elm_gengrid_item_disabled_set() for more details
8654 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8657 * Set the text to be shown in a given gengrid item's tooltips.
8659 * @param item The gengrid item
8660 * @param text The text to set in the content
8662 * This call will setup the text to be used as tooltip to that item
8663 * (analogous to elm_object_tooltip_text_set(), but being item
8664 * tooltips with higher precedence than object tooltips). It can
8665 * have only one tooltip at a time, so any previous tooltip data
8670 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8673 * Set the content to be shown in a given gengrid item's tooltips
8675 * @param item The gengrid item.
8676 * @param func The function returning the tooltip contents.
8677 * @param data What to provide to @a func as callback data/context.
8678 * @param del_cb Called when data is not needed anymore, either when
8679 * another callback replaces @p func, the tooltip is unset with
8680 * elm_gengrid_item_tooltip_unset() or the owner @p item
8681 * dies. This callback receives as its first parameter the
8682 * given @p data, being @c event_info the item handle.
8684 * This call will setup the tooltip's contents to @p item
8685 * (analogous to elm_object_tooltip_content_cb_set(), but being
8686 * item tooltips with higher precedence than object tooltips). It
8687 * can have only one tooltip at a time, so any previous tooltip
8688 * content will get removed. @p func (with @p data) will be called
8689 * every time Elementary needs to show the tooltip and it should
8690 * return a valid Evas object, which will be fully managed by the
8691 * tooltip system, getting deleted when the tooltip is gone.
8695 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);
8698 * Unset a tooltip from a given gengrid item
8700 * @param item gengrid item to remove a previously set tooltip from.
8702 * This call removes any tooltip set on @p item. The callback
8703 * provided as @c del_cb to
8704 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8705 * notify it is not used anymore (and have resources cleaned, if
8708 * @see elm_gengrid_item_tooltip_content_cb_set()
8712 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8715 * Set a different @b style for a given gengrid item's tooltip.
8717 * @param item gengrid item with tooltip set
8718 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8719 * "default", @c "transparent", etc)
8721 * Tooltips can have <b>alternate styles</b> to be displayed on,
8722 * which are defined by the theme set on Elementary. This function
8723 * works analogously as elm_object_tooltip_style_set(), but here
8724 * applied only to gengrid item objects. The default style for
8725 * tooltips is @c "default".
8727 * @note before you set a style you should define a tooltip with
8728 * elm_gengrid_item_tooltip_content_cb_set() or
8729 * elm_gengrid_item_tooltip_text_set()
8731 * @see elm_gengrid_item_tooltip_style_get()
8735 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8738 * Get the style set a given gengrid item's tooltip.
8740 * @param item gengrid item with tooltip already set on.
8741 * @return style the theme style in use, which defaults to
8742 * "default". If the object does not have a tooltip set,
8743 * then @c NULL is returned.
8745 * @see elm_gengrid_item_tooltip_style_set() for more details
8749 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8751 * @brief Disable size restrictions on an object's tooltip
8752 * @param item The tooltip's anchor object
8753 * @param disable If EINA_TRUE, size restrictions are disabled
8754 * @return EINA_FALSE on failure, EINA_TRUE on success
8756 * This function allows a tooltip to expand beyond its parant window's canvas.
8757 * It will instead be limited only by the size of the display.
8759 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8761 * @brief Retrieve size restriction state of an object's tooltip
8762 * @param item The tooltip's anchor object
8763 * @return If EINA_TRUE, size restrictions are disabled
8765 * This function returns whether a tooltip is allowed to expand beyond
8766 * its parant window's canvas.
8767 * It will instead be limited only by the size of the display.
8769 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8771 * Set the type of mouse pointer/cursor decoration to be shown,
8772 * when the mouse pointer is over the given gengrid widget item
8774 * @param item gengrid item to customize cursor on
8775 * @param cursor the cursor type's name
8777 * This function works analogously as elm_object_cursor_set(), but
8778 * here the cursor's changing area is restricted to the item's
8779 * area, and not the whole widget's. Note that that item cursors
8780 * have precedence over widget cursors, so that a mouse over @p
8781 * item will always show cursor @p type.
8783 * If this function is called twice for an object, a previously set
8784 * cursor will be unset on the second call.
8786 * @see elm_object_cursor_set()
8787 * @see elm_gengrid_item_cursor_get()
8788 * @see elm_gengrid_item_cursor_unset()
8792 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8795 * Get the type of mouse pointer/cursor decoration set to be shown,
8796 * when the mouse pointer is over the given gengrid widget item
8798 * @param item gengrid item with custom cursor set
8799 * @return the cursor type's name or @c NULL, if no custom cursors
8800 * were set to @p item (and on errors)
8802 * @see elm_object_cursor_get()
8803 * @see elm_gengrid_item_cursor_set() for more details
8804 * @see elm_gengrid_item_cursor_unset()
8808 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8811 * Unset any custom mouse pointer/cursor decoration set to be
8812 * shown, when the mouse pointer is over the given gengrid widget
8813 * item, thus making it show the @b default cursor again.
8815 * @param item a gengrid item
8817 * Use this call to undo any custom settings on this item's cursor
8818 * decoration, bringing it back to defaults (no custom style set).
8820 * @see elm_object_cursor_unset()
8821 * @see elm_gengrid_item_cursor_set() for more details
8825 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8828 * Set a different @b style for a given custom cursor set for a
8831 * @param item gengrid item with custom cursor set
8832 * @param style the <b>theme style</b> to use (e.g. @c "default",
8833 * @c "transparent", etc)
8835 * This function only makes sense when one is using custom mouse
8836 * cursor decorations <b>defined in a theme file</b> , which can
8837 * have, given a cursor name/type, <b>alternate styles</b> on
8838 * it. It works analogously as elm_object_cursor_style_set(), but
8839 * here applied only to gengrid item objects.
8841 * @warning Before you set a cursor style you should have defined a
8842 * custom cursor previously on the item, with
8843 * elm_gengrid_item_cursor_set()
8845 * @see elm_gengrid_item_cursor_engine_only_set()
8846 * @see elm_gengrid_item_cursor_style_get()
8850 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8853 * Get the current @b style set for a given gengrid item's custom
8856 * @param item gengrid item with custom cursor set.
8857 * @return style the cursor style in use. If the object does not
8858 * have a cursor set, then @c NULL is returned.
8860 * @see elm_gengrid_item_cursor_style_set() for more details
8864 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8867 * Set if the (custom) cursor for a given gengrid item should be
8868 * searched in its theme, also, or should only rely on the
8871 * @param item item with custom (custom) cursor already set on
8872 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8873 * only on those provided by the rendering engine, @c EINA_FALSE to
8874 * have them searched on the widget's theme, as well.
8876 * @note This call is of use only if you've set a custom cursor
8877 * for gengrid items, with elm_gengrid_item_cursor_set().
8879 * @note By default, cursors will only be looked for between those
8880 * provided by the rendering engine.
8884 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8887 * Get if the (custom) cursor for a given gengrid item is being
8888 * searched in its theme, also, or is only relying on the rendering
8891 * @param item a gengrid item
8892 * @return @c EINA_TRUE, if cursors are being looked for only on
8893 * those provided by the rendering engine, @c EINA_FALSE if they
8894 * are being searched on the widget's theme, as well.
8896 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8900 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8903 * Remove all items from a given gengrid widget
8905 * @param obj The gengrid object.
8907 * This removes (and deletes) all items in @p obj, leaving it
8910 * @see elm_gengrid_item_del(), to remove just one item.
8914 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8917 * Get the selected item in a given gengrid widget
8919 * @param obj The gengrid object.
8920 * @return The selected item's handleor @c NULL, if none is
8921 * selected at the moment (and on errors)
8923 * This returns the selected item in @p obj. If multi selection is
8924 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8925 * the first item in the list is selected, which might not be very
8926 * useful. For that case, see elm_gengrid_selected_items_get().
8930 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8933 * Get <b>a list</b> of selected items in a given gengrid
8935 * @param obj The gengrid object.
8936 * @return The list of selected items or @c NULL, if none is
8937 * selected at the moment (and on errors)
8939 * This returns a list of the selected items, in the order that
8940 * they appear in the grid. This list is only valid as long as no
8941 * more items are selected or unselected (or unselected implictly
8942 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8945 * @see elm_gengrid_selected_item_get()
8949 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8956 * @defgroup Clock Clock
8958 * @image html img/widget/clock/preview-00.png
8959 * @image latex img/widget/clock/preview-00.eps
8961 * This is a @b digital clock widget. In its default theme, it has a
8962 * vintage "flipping numbers clock" appearance, which will animate
8963 * sheets of individual algarisms individually as time goes by.
8965 * A newly created clock will fetch system's time (already
8966 * considering local time adjustments) to start with, and will tick
8967 * accondingly. It may or may not show seconds.
8969 * Clocks have an @b edition mode. When in it, the sheets will
8970 * display extra arrow indications on the top and bottom and the
8971 * user may click on them to raise or lower the time values. After
8972 * it's told to exit edition mode, it will keep ticking with that
8973 * new time set (it keeps the difference from local time).
8975 * Also, when under edition mode, user clicks on the cited arrows
8976 * which are @b held for some time will make the clock to flip the
8977 * sheet, thus editing the time, continuosly and automatically for
8978 * the user. The interval between sheet flips will keep growing in
8979 * time, so that it helps the user to reach a time which is distant
8982 * The time display is, by default, in military mode (24h), but an
8983 * am/pm indicator may be optionally shown, too, when it will
8986 * Smart callbacks one can register to:
8987 * - "changed" - the clock's user changed the time
8989 * Here is an example on its usage:
8990 * @li @ref clock_example
8999 * Identifiers for which clock digits should be editable, when a
9000 * clock widget is in edition mode. Values may be ORed together to
9001 * make a mask, naturally.
9003 * @see elm_clock_edit_set()
9004 * @see elm_clock_digit_edit_set()
9006 typedef enum _Elm_Clock_Digedit
9008 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9009 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9010 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9011 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9012 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9013 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9014 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9015 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9016 } Elm_Clock_Digedit;
9019 * Add a new clock widget to the given parent Elementary
9020 * (container) object
9022 * @param parent The parent object
9023 * @return a new clock widget handle or @c NULL, on errors
9025 * This function inserts a new clock widget on the canvas.
9029 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9032 * Set a clock widget's time, programmatically
9034 * @param obj The clock widget object
9035 * @param hrs The hours to set
9036 * @param min The minutes to set
9037 * @param sec The secondes to set
9039 * This function updates the time that is showed by the clock
9042 * Values @b must be set within the following ranges:
9043 * - 0 - 23, for hours
9044 * - 0 - 59, for minutes
9045 * - 0 - 59, for seconds,
9047 * even if the clock is not in "military" mode.
9049 * @warning The behavior for values set out of those ranges is @b
9054 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9057 * Get a clock widget's time values
9059 * @param obj The clock object
9060 * @param[out] hrs Pointer to the variable to get the hours value
9061 * @param[out] min Pointer to the variable to get the minutes value
9062 * @param[out] sec Pointer to the variable to get the seconds value
9064 * This function gets the time set for @p obj, returning
9065 * it on the variables passed as the arguments to function
9067 * @note Use @c NULL pointers on the time values you're not
9068 * interested in: they'll be ignored by the function.
9072 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9075 * Set whether a given clock widget is under <b>edition mode</b> or
9076 * under (default) displaying-only mode.
9078 * @param obj The clock object
9079 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9080 * put it back to "displaying only" mode
9082 * This function makes a clock's time to be editable or not <b>by
9083 * user interaction</b>. When in edition mode, clocks @b stop
9084 * ticking, until one brings them back to canonical mode. The
9085 * elm_clock_digit_edit_set() function will influence which digits
9086 * of the clock will be editable. By default, all of them will be
9087 * (#ELM_CLOCK_NONE).
9089 * @note am/pm sheets, if being shown, will @b always be editable
9090 * under edition mode.
9092 * @see elm_clock_edit_get()
9096 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9099 * Retrieve whether a given clock widget is under <b>edition
9100 * mode</b> or under (default) displaying-only mode.
9102 * @param obj The clock object
9103 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9106 * This function retrieves whether the clock's time can be edited
9107 * or not by user interaction.
9109 * @see elm_clock_edit_set() for more details
9113 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9116 * Set what digits of the given clock widget should be editable
9117 * when in edition mode.
9119 * @param obj The clock object
9120 * @param digedit Bit mask indicating the digits to be editable
9121 * (values in #Elm_Clock_Digedit).
9123 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9124 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9127 * @see elm_clock_digit_edit_get()
9131 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9134 * Retrieve what digits of the given clock widget should be
9135 * editable when in edition mode.
9137 * @param obj The clock object
9138 * @return Bit mask indicating the digits to be editable
9139 * (values in #Elm_Clock_Digedit).
9141 * @see elm_clock_digit_edit_set() for more details
9145 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9148 * Set if the given clock widget must show hours in military or
9151 * @param obj The clock object
9152 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9155 * This function sets if the clock must show hours in military or
9156 * am/pm mode. In some countries like Brazil the military mode
9157 * (00-24h-format) is used, in opposition to the USA, where the
9158 * am/pm mode is more commonly used.
9160 * @see elm_clock_show_am_pm_get()
9164 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9167 * Get if the given clock widget shows hours in military or am/pm
9170 * @param obj The clock object
9171 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9174 * This function gets if the clock shows hours in military or am/pm
9177 * @see elm_clock_show_am_pm_set() for more details
9181 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9184 * Set if the given clock widget must show time with seconds or not
9186 * @param obj The clock object
9187 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9189 * This function sets if the given clock must show or not elapsed
9190 * seconds. By default, they are @b not shown.
9192 * @see elm_clock_show_seconds_get()
9196 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9199 * Get whether the given clock widget is showing time with seconds
9202 * @param obj The clock object
9203 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9205 * This function gets whether @p obj is showing or not the elapsed
9208 * @see elm_clock_show_seconds_set()
9212 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9215 * Set the interval on time updates for an user mouse button hold
9216 * on clock widgets' time edition.
9218 * @param obj The clock object
9219 * @param interval The (first) interval value in seconds
9221 * This interval value is @b decreased while the user holds the
9222 * mouse pointer either incrementing or decrementing a given the
9223 * clock digit's value.
9225 * This helps the user to get to a given time distant from the
9226 * current one easier/faster, as it will start to flip quicker and
9227 * quicker on mouse button holds.
9229 * The calculation for the next flip interval value, starting from
9230 * the one set with this call, is the previous interval divided by
9231 * 1.05, so it decreases a little bit.
9233 * The default starting interval value for automatic flips is
9236 * @see elm_clock_interval_get()
9240 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9243 * Get the interval on time updates for an user mouse button hold
9244 * on clock widgets' time edition.
9246 * @param obj The clock object
9247 * @return The (first) interval value, in seconds, set on it
9249 * @see elm_clock_interval_set() for more details
9253 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9260 * @defgroup Layout Layout
9262 * @image html img/widget/layout/preview-00.png
9263 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9265 * @image html img/layout-predefined.png
9266 * @image latex img/layout-predefined.eps width=\textwidth
9268 * This is a container widget that takes a standard Edje design file and
9269 * wraps it very thinly in a widget.
9271 * An Edje design (theme) file has a very wide range of possibilities to
9272 * describe the behavior of elements added to the Layout. Check out the Edje
9273 * documentation and the EDC reference to get more information about what can
9274 * be done with Edje.
9276 * Just like @ref List, @ref Box, and other container widgets, any
9277 * object added to the Layout will become its child, meaning that it will be
9278 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9280 * The Layout widget can contain as many Contents, Boxes or Tables as
9281 * described in its theme file. For instance, objects can be added to
9282 * different Tables by specifying the respective Table part names. The same
9283 * is valid for Content and Box.
9285 * The objects added as child of the Layout will behave as described in the
9286 * part description where they were added. There are 3 possible types of
9287 * parts where a child can be added:
9289 * @section secContent Content (SWALLOW part)
9291 * Only one object can be added to the @c SWALLOW part (but you still can
9292 * have many @c SWALLOW parts and one object on each of them). Use the @c
9293 * elm_layout_content_* set of functions to set, retrieve and unset objects
9294 * as content of the @c SWALLOW. After being set to this part, the object
9295 * size, position, visibility, clipping and other description properties
9296 * will be totally controled by the description of the given part (inside
9297 * the Edje theme file).
9299 * One can use @c evas_object_size_hint_* functions on the child to have some
9300 * kind of control over its behavior, but the resulting behavior will still
9301 * depend heavily on the @c SWALLOW part description.
9303 * The Edje theme also can change the part description, based on signals or
9304 * scripts running inside the theme. This change can also be animated. All of
9305 * this will affect the child object set as content accordingly. The object
9306 * size will be changed if the part size is changed, it will animate move if
9307 * the part is moving, and so on.
9309 * The following picture demonstrates a Layout widget with a child object
9310 * added to its @c SWALLOW:
9312 * @image html layout_swallow.png
9313 * @image latex layout_swallow.eps width=\textwidth
9315 * @section secBox Box (BOX part)
9317 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9318 * allows one to add objects to the box and have them distributed along its
9319 * area, accordingly to the specified @a layout property (now by @a layout we
9320 * mean the chosen layouting design of the Box, not the Layout widget
9323 * A similar effect for having a box with its position, size and other things
9324 * controled by the Layout theme would be to create an Elementary @ref Box
9325 * widget and add it as a Content in the @c SWALLOW part.
9327 * The main difference of using the Layout Box is that its behavior, the box
9328 * properties like layouting format, padding, align, etc. will be all
9329 * controled by the theme. This means, for example, that a signal could be
9330 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9331 * handled the signal by changing the box padding, or align, or both. Using
9332 * the Elementary @ref Box widget is not necessarily harder or easier, it
9333 * just depends on the circunstances and requirements.
9335 * The Layout Box can be used through the @c elm_layout_box_* set of
9338 * The following picture demonstrates a Layout widget with many child objects
9339 * added to its @c BOX part:
9341 * @image html layout_box.png
9342 * @image latex layout_box.eps width=\textwidth
9344 * @section secTable Table (TABLE part)
9346 * Just like the @ref secBox, the Layout Table is very similar to the
9347 * Elementary @ref Table widget. It allows one to add objects to the Table
9348 * specifying the row and column where the object should be added, and any
9349 * column or row span if necessary.
9351 * Again, we could have this design by adding a @ref Table widget to the @c
9352 * SWALLOW part using elm_layout_content_set(). The same difference happens
9353 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9354 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9356 * The Layout Table can be used through the @c elm_layout_table_* set of
9359 * The following picture demonstrates a Layout widget with many child objects
9360 * added to its @c TABLE part:
9362 * @image html layout_table.png
9363 * @image latex layout_table.eps width=\textwidth
9365 * @section secPredef Predefined Layouts
9367 * Another interesting thing about the Layout widget is that it offers some
9368 * predefined themes that come with the default Elementary theme. These
9369 * themes can be set by the call elm_layout_theme_set(), and provide some
9370 * basic functionality depending on the theme used.
9372 * Most of them already send some signals, some already provide a toolbar or
9373 * back and next buttons.
9375 * These are available predefined theme layouts. All of them have class = @c
9376 * layout, group = @c application, and style = one of the following options:
9378 * @li @c toolbar-content - application with toolbar and main content area
9379 * @li @c toolbar-content-back - application with toolbar and main content
9380 * area with a back button and title area
9381 * @li @c toolbar-content-back-next - application with toolbar and main
9382 * content area with a back and next buttons and title area
9383 * @li @c content-back - application with a main content area with a back
9384 * button and title area
9385 * @li @c content-back-next - application with a main content area with a
9386 * back and next buttons and title area
9387 * @li @c toolbar-vbox - application with toolbar and main content area as a
9389 * @li @c toolbar-table - application with toolbar and main content area as a
9392 * @section secExamples Examples
9394 * Some examples of the Layout widget can be found here:
9395 * @li @ref layout_example_01
9396 * @li @ref layout_example_02
9397 * @li @ref layout_example_03
9398 * @li @ref layout_example_edc
9403 * Add a new layout to the parent
9405 * @param parent The parent object
9406 * @return The new object or NULL if it cannot be created
9408 * @see elm_layout_file_set()
9409 * @see elm_layout_theme_set()
9413 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9415 * Set the file that will be used as layout
9417 * @param obj The layout object
9418 * @param file The path to file (edj) that will be used as layout
9419 * @param group The group that the layout belongs in edje file
9421 * @return (1 = success, 0 = error)
9425 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9427 * Set the edje group from the elementary theme that will be used as layout
9429 * @param obj The layout object
9430 * @param clas the clas of the group
9431 * @param group the group
9432 * @param style the style to used
9434 * @return (1 = success, 0 = error)
9438 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9440 * Set the layout content.
9442 * @param obj The layout object
9443 * @param swallow The swallow part name in the edje file
9444 * @param content The child that will be added in this layout object
9446 * Once the content object is set, a previously set one will be deleted.
9447 * If you want to keep that old content object, use the
9448 * elm_layout_content_unset() function.
9450 * @note In an Edje theme, the part used as a content container is called @c
9451 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9452 * expected to be a part name just like the second parameter of
9453 * elm_layout_box_append().
9455 * @see elm_layout_box_append()
9456 * @see elm_layout_content_get()
9457 * @see elm_layout_content_unset()
9462 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9464 * Get the child object in the given content part.
9466 * @param obj The layout object
9467 * @param swallow The SWALLOW part to get its content
9469 * @return The swallowed object or NULL if none or an error occurred
9471 * @see elm_layout_content_set()
9475 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9477 * Unset the layout content.
9479 * @param obj The layout object
9480 * @param swallow The swallow part name in the edje file
9481 * @return The content that was being used
9483 * Unparent and return the content object which was set for this part.
9485 * @see elm_layout_content_set()
9489 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9491 * Set the text of the given part
9493 * @param obj The layout object
9494 * @param part The TEXT part where to set the text
9495 * @param text The text to set
9498 * @deprecated use elm_object_text_* instead.
9500 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9502 * Get the text set in the given part
9504 * @param obj The layout object
9505 * @param part The TEXT part to retrieve the text off
9507 * @return The text set in @p part
9510 * @deprecated use elm_object_text_* instead.
9512 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9514 * Append child to layout box part.
9516 * @param obj the layout object
9517 * @param part the box part to which the object will be appended.
9518 * @param child the child object to append to box.
9520 * Once the object is appended, it will become child of the layout. Its
9521 * lifetime will be bound to the layout, whenever the layout dies the child
9522 * will be deleted automatically. One should use elm_layout_box_remove() to
9523 * make this layout forget about the object.
9525 * @see elm_layout_box_prepend()
9526 * @see elm_layout_box_insert_before()
9527 * @see elm_layout_box_insert_at()
9528 * @see elm_layout_box_remove()
9532 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9534 * Prepend child to layout box part.
9536 * @param obj the layout object
9537 * @param part the box part to prepend.
9538 * @param child the child object to prepend to box.
9540 * Once the object is prepended, it will become child of the layout. Its
9541 * lifetime will be bound to the layout, whenever the layout dies the child
9542 * will be deleted automatically. One should use elm_layout_box_remove() to
9543 * make this layout forget about the object.
9545 * @see elm_layout_box_append()
9546 * @see elm_layout_box_insert_before()
9547 * @see elm_layout_box_insert_at()
9548 * @see elm_layout_box_remove()
9552 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9554 * Insert child to layout box part before a reference object.
9556 * @param obj the layout object
9557 * @param part the box part to insert.
9558 * @param child the child object to insert into box.
9559 * @param reference another reference object to insert before in box.
9561 * Once the object is inserted, it will become child of the layout. Its
9562 * lifetime will be bound to the layout, whenever the layout dies the child
9563 * will be deleted automatically. One should use elm_layout_box_remove() to
9564 * make this layout forget about the object.
9566 * @see elm_layout_box_append()
9567 * @see elm_layout_box_prepend()
9568 * @see elm_layout_box_insert_before()
9569 * @see elm_layout_box_remove()
9573 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9575 * Insert child to layout box part at a given position.
9577 * @param obj the layout object
9578 * @param part the box part to insert.
9579 * @param child the child object to insert into box.
9580 * @param pos the numeric position >=0 to insert the child.
9582 * Once the object is inserted, it will become child of the layout. Its
9583 * lifetime will be bound to the layout, whenever the layout dies the child
9584 * will be deleted automatically. One should use elm_layout_box_remove() to
9585 * make this layout forget about the object.
9587 * @see elm_layout_box_append()
9588 * @see elm_layout_box_prepend()
9589 * @see elm_layout_box_insert_before()
9590 * @see elm_layout_box_remove()
9594 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9596 * Remove a child of the given part box.
9598 * @param obj The layout object
9599 * @param part The box part name to remove child.
9600 * @param child The object to remove from box.
9601 * @return The object that was being used, or NULL if not found.
9603 * The object will be removed from the box part and its lifetime will
9604 * not be handled by the layout anymore. This is equivalent to
9605 * elm_layout_content_unset() for box.
9607 * @see elm_layout_box_append()
9608 * @see elm_layout_box_remove_all()
9612 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9614 * Remove all child of the given part box.
9616 * @param obj The layout object
9617 * @param part The box part name to remove child.
9618 * @param clear If EINA_TRUE, then all objects will be deleted as
9619 * well, otherwise they will just be removed and will be
9620 * dangling on the canvas.
9622 * The objects will be removed from the box part and their lifetime will
9623 * not be handled by the layout anymore. This is equivalent to
9624 * elm_layout_box_remove() for all box children.
9626 * @see elm_layout_box_append()
9627 * @see elm_layout_box_remove()
9631 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9633 * Insert child to layout table part.
9635 * @param obj the layout object
9636 * @param part the box part to pack child.
9637 * @param child_obj the child object to pack into table.
9638 * @param col the column to which the child should be added. (>= 0)
9639 * @param row the row to which the child should be added. (>= 0)
9640 * @param colspan how many columns should be used to store this object. (>=
9642 * @param rowspan how many rows should be used to store this object. (>= 1)
9644 * Once the object is inserted, it will become child of the table. Its
9645 * lifetime will be bound to the layout, and whenever the layout dies the
9646 * child will be deleted automatically. One should use
9647 * elm_layout_table_remove() to make this layout forget about the object.
9649 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9650 * more space than a single cell. For instance, the following code:
9652 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9655 * Would result in an object being added like the following picture:
9657 * @image html layout_colspan.png
9658 * @image latex layout_colspan.eps width=\textwidth
9660 * @see elm_layout_table_unpack()
9661 * @see elm_layout_table_clear()
9665 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);
9667 * Unpack (remove) a child of the given part table.
9669 * @param obj The layout object
9670 * @param part The table part name to remove child.
9671 * @param child_obj The object to remove from table.
9672 * @return The object that was being used, or NULL if not found.
9674 * The object will be unpacked from the table part and its lifetime
9675 * will not be handled by the layout anymore. This is equivalent to
9676 * elm_layout_content_unset() for table.
9678 * @see elm_layout_table_pack()
9679 * @see elm_layout_table_clear()
9683 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9685 * Remove all child of the given part table.
9687 * @param obj The layout object
9688 * @param part The table part name to remove child.
9689 * @param clear If EINA_TRUE, then all objects will be deleted as
9690 * well, otherwise they will just be removed and will be
9691 * dangling on the canvas.
9693 * The objects will be removed from the table part and their lifetime will
9694 * not be handled by the layout anymore. This is equivalent to
9695 * elm_layout_table_unpack() for all table children.
9697 * @see elm_layout_table_pack()
9698 * @see elm_layout_table_unpack()
9702 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9704 * Get the edje layout
9706 * @param obj The layout object
9708 * @return A Evas_Object with the edje layout settings loaded
9709 * with function elm_layout_file_set
9711 * This returns the edje object. It is not expected to be used to then
9712 * swallow objects via edje_object_part_swallow() for example. Use
9713 * elm_layout_content_set() instead so child object handling and sizing is
9716 * @note This function should only be used if you really need to call some
9717 * low level Edje function on this edje object. All the common stuff (setting
9718 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9719 * with proper elementary functions.
9721 * @see elm_object_signal_callback_add()
9722 * @see elm_object_signal_emit()
9723 * @see elm_object_text_part_set()
9724 * @see elm_layout_content_set()
9725 * @see elm_layout_box_append()
9726 * @see elm_layout_table_pack()
9727 * @see elm_layout_data_get()
9731 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9733 * Get the edje data from the given layout
9735 * @param obj The layout object
9736 * @param key The data key
9738 * @return The edje data string
9740 * This function fetches data specified inside the edje theme of this layout.
9741 * This function return NULL if data is not found.
9743 * In EDC this comes from a data block within the group block that @p
9744 * obj was loaded from. E.g.
9751 * item: "key1" "value1";
9752 * item: "key2" "value2";
9760 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9764 * @param obj The layout object
9766 * Manually forces a sizing re-evaluation. This is useful when the minimum
9767 * size required by the edje theme of this layout has changed. The change on
9768 * the minimum size required by the edje theme is not immediately reported to
9769 * the elementary layout, so one needs to call this function in order to tell
9770 * the widget (layout) that it needs to reevaluate its own size.
9772 * The minimum size of the theme is calculated based on minimum size of
9773 * parts, the size of elements inside containers like box and table, etc. All
9774 * of this can change due to state changes, and that's when this function
9777 * Also note that a standard signal of "size,eval" "elm" emitted from the
9778 * edje object will cause this to happen too.
9782 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9785 * Sets a specific cursor for an edje part.
9787 * @param obj The layout object.
9788 * @param part_name a part from loaded edje group.
9789 * @param cursor cursor name to use, see Elementary_Cursor.h
9791 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9792 * part not exists or it has "mouse_events: 0".
9796 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9799 * Get the cursor to be shown when mouse is over an edje part
9801 * @param obj The layout object.
9802 * @param part_name a part from loaded edje group.
9803 * @return the cursor name.
9807 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9810 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9812 * @param obj The layout object.
9813 * @param part_name a part from loaded edje group, that had a cursor set
9814 * with elm_layout_part_cursor_set().
9818 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9821 * Sets a specific cursor style for an edje part.
9823 * @param obj The layout object.
9824 * @param part_name a part from loaded edje group.
9825 * @param style the theme style to use (default, transparent, ...)
9827 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9828 * part not exists or it did not had a cursor set.
9832 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9835 * Gets a specific cursor style for an edje part.
9837 * @param obj The layout object.
9838 * @param part_name a part from loaded edje group.
9840 * @return the theme style in use, defaults to "default". If the
9841 * object does not have a cursor set, then NULL is returned.
9845 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9848 * Sets if the cursor set should be searched on the theme or should use
9849 * the provided by the engine, only.
9851 * @note before you set if should look on theme you should define a
9852 * cursor with elm_layout_part_cursor_set(). By default it will only
9853 * look for cursors provided by the engine.
9855 * @param obj The layout object.
9856 * @param part_name a part from loaded edje group.
9857 * @param engine_only if cursors should be just provided by the engine
9858 * or should also search on widget's theme as well
9860 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9861 * part not exists or it did not had a cursor set.
9865 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);
9868 * Gets a specific cursor engine_only for an edje part.
9870 * @param obj The layout object.
9871 * @param part_name a part from loaded edje group.
9873 * @return whenever the cursor is just provided by engine or also from theme.
9877 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9880 * @def elm_layout_icon_set
9881 * Convienience macro to set the icon object in a layout that follows the
9882 * Elementary naming convention for its parts.
9886 #define elm_layout_icon_set(_ly, _obj) \
9889 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9890 if ((_obj)) sig = "elm,state,icon,visible"; \
9891 else sig = "elm,state,icon,hidden"; \
9892 elm_object_signal_emit((_ly), sig, "elm"); \
9896 * @def elm_layout_icon_get
9897 * Convienience macro to get the icon object from a layout that follows the
9898 * Elementary naming convention for its parts.
9902 #define elm_layout_icon_get(_ly) \
9903 elm_layout_content_get((_ly), "elm.swallow.icon")
9906 * @def elm_layout_end_set
9907 * Convienience macro to set the end object in a layout that follows the
9908 * Elementary naming convention for its parts.
9912 #define elm_layout_end_set(_ly, _obj) \
9915 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9916 if ((_obj)) sig = "elm,state,end,visible"; \
9917 else sig = "elm,state,end,hidden"; \
9918 elm_object_signal_emit((_ly), sig, "elm"); \
9922 * @def elm_layout_end_get
9923 * Convienience macro to get the end object in a layout that follows the
9924 * Elementary naming convention for its parts.
9928 #define elm_layout_end_get(_ly) \
9929 elm_layout_content_get((_ly), "elm.swallow.end")
9932 * @def elm_layout_label_set
9933 * Convienience macro to set the label in a layout that follows the
9934 * Elementary naming convention for its parts.
9937 * @deprecated use elm_object_text_* instead.
9939 #define elm_layout_label_set(_ly, _txt) \
9940 elm_layout_text_set((_ly), "elm.text", (_txt))
9943 * @def elm_layout_label_get
9944 * Convienience macro to get the label in a layout that follows the
9945 * Elementary naming convention for its parts.
9948 * @deprecated use elm_object_text_* instead.
9950 #define elm_layout_label_get(_ly) \
9951 elm_layout_text_get((_ly), "elm.text")
9953 /* smart callbacks called:
9954 * "theme,changed" - when elm theme is changed.
9958 * @defgroup Notify Notify
9960 * @image html img/widget/notify/preview-00.png
9961 * @image latex img/widget/notify/preview-00.eps
9963 * Display a container in a particular region of the parent(top, bottom,
9964 * etc. A timeout can be set to automatically hide the notify. This is so
9965 * that, after an evas_object_show() on a notify object, if a timeout was set
9966 * on it, it will @b automatically get hidden after that time.
9968 * Signals that you can add callbacks for are:
9969 * @li "timeout" - when timeout happens on notify and it's hidden
9970 * @li "block,clicked" - when a click outside of the notify happens
9972 * @ref tutorial_notify show usage of the API.
9977 * @brief Possible orient values for notify.
9979 * This values should be used in conjunction to elm_notify_orient_set() to
9980 * set the position in which the notify should appear(relative to its parent)
9981 * and in conjunction with elm_notify_orient_get() to know where the notify
9984 typedef enum _Elm_Notify_Orient
9986 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9987 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9988 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9989 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9990 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9991 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9992 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9993 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9994 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9995 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9996 } Elm_Notify_Orient;
9998 * @brief Add a new notify to the parent
10000 * @param parent The parent object
10001 * @return The new object or NULL if it cannot be created
10003 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10005 * @brief Set the content of the notify widget
10007 * @param obj The notify object
10008 * @param content The content will be filled in this notify object
10010 * Once the content object is set, a previously set one will be deleted. If
10011 * you want to keep that old content object, use the
10012 * elm_notify_content_unset() function.
10014 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10016 * @brief Unset the content of the notify widget
10018 * @param obj The notify object
10019 * @return The content that was being used
10021 * Unparent and return the content object which was set for this widget
10023 * @see elm_notify_content_set()
10025 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10027 * @brief Return the content of the notify widget
10029 * @param obj The notify object
10030 * @return The content that is being used
10032 * @see elm_notify_content_set()
10034 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10036 * @brief Set the notify parent
10038 * @param obj The notify object
10039 * @param content The new parent
10041 * Once the parent object is set, a previously set one will be disconnected
10044 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10046 * @brief Get the notify parent
10048 * @param obj The notify object
10049 * @return The parent
10051 * @see elm_notify_parent_set()
10053 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10055 * @brief Set the orientation
10057 * @param obj The notify object
10058 * @param orient The new orientation
10060 * Sets the position in which the notify will appear in its parent.
10062 * @see @ref Elm_Notify_Orient for possible values.
10064 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10066 * @brief Return the orientation
10067 * @param obj The notify object
10068 * @return The orientation of the notification
10070 * @see elm_notify_orient_set()
10071 * @see Elm_Notify_Orient
10073 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10075 * @brief Set the time interval after which the notify window is going to be
10078 * @param obj The notify object
10079 * @param time The timeout in seconds
10081 * This function sets a timeout and starts the timer controlling when the
10082 * notify is hidden. Since calling evas_object_show() on a notify restarts
10083 * the timer controlling when the notify is hidden, setting this before the
10084 * notify is shown will in effect mean starting the timer when the notify is
10087 * @note Set a value <= 0.0 to disable a running timer.
10089 * @note If the value > 0.0 and the notify is previously visible, the
10090 * timer will be started with this value, canceling any running timer.
10092 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10094 * @brief Return the timeout value (in seconds)
10095 * @param obj the notify object
10097 * @see elm_notify_timeout_set()
10099 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10101 * @brief Sets whether events should be passed to by a click outside
10104 * @param obj The notify object
10105 * @param repeats EINA_TRUE Events are repeats, else no
10107 * When true if the user clicks outside the window the events will be caught
10108 * by the others widgets, else the events are blocked.
10110 * @note The default value is EINA_TRUE.
10112 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10114 * @brief Return true if events are repeat below the notify object
10115 * @param obj the notify object
10117 * @see elm_notify_repeat_events_set()
10119 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10125 * @defgroup Hover Hover
10127 * @image html img/widget/hover/preview-00.png
10128 * @image latex img/widget/hover/preview-00.eps
10130 * A Hover object will hover over its @p parent object at the @p target
10131 * location. Anything in the background will be given a darker coloring to
10132 * indicate that the hover object is on top (at the default theme). When the
10133 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10134 * clicked that @b doesn't cause the hover to be dismissed.
10136 * @note The hover object will take up the entire space of @p target
10139 * Elementary has the following styles for the hover widget:
10143 * @li hoversel_vertical
10145 * The following are the available position for content:
10157 * Signals that you can add callbacks for are:
10158 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10159 * @li "smart,changed" - a content object placed under the "smart"
10160 * policy was replaced to a new slot direction.
10162 * See @ref tutorial_hover for more information.
10166 typedef enum _Elm_Hover_Axis
10168 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10169 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10170 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10171 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10174 * @brief Adds a hover object to @p parent
10176 * @param parent The parent object
10177 * @return The hover object or NULL if one could not be created
10179 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10181 * @brief Sets the target object for the hover.
10183 * @param obj The hover object
10184 * @param target The object to center the hover onto. The hover
10186 * This function will cause the hover to be centered on the target object.
10188 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10190 * @brief Gets the target object for the hover.
10192 * @param obj The hover object
10193 * @param parent The object to locate the hover over.
10195 * @see elm_hover_target_set()
10197 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10199 * @brief Sets the parent object for the hover.
10201 * @param obj The hover object
10202 * @param parent The object to locate the hover over.
10204 * This function will cause the hover to take up the entire space that the
10205 * parent object fills.
10207 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10209 * @brief Gets the parent object for the hover.
10211 * @param obj The hover object
10212 * @return The parent object to locate the hover over.
10214 * @see elm_hover_parent_set()
10216 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10218 * @brief Sets the content of the hover object and the direction in which it
10221 * @param obj The hover object
10222 * @param swallow The direction that the object will be displayed
10223 * at. Accepted values are "left", "top-left", "top", "top-right",
10224 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10226 * @param content The content to place at @p swallow
10228 * Once the content object is set for a given direction, a previously
10229 * set one (on the same direction) will be deleted. If you want to
10230 * keep that old content object, use the elm_hover_content_unset()
10233 * All directions may have contents at the same time, except for
10234 * "smart". This is a special placement hint and its use case
10235 * independs of the calculations coming from
10236 * elm_hover_best_content_location_get(). Its use is for cases when
10237 * one desires only one hover content, but with a dinamic special
10238 * placement within the hover area. The content's geometry, whenever
10239 * it changes, will be used to decide on a best location not
10240 * extrapolating the hover's parent object view to show it in (still
10241 * being the hover's target determinant of its medium part -- move and
10242 * resize it to simulate finger sizes, for example). If one of the
10243 * directions other than "smart" are used, a previously content set
10244 * using it will be deleted, and vice-versa.
10246 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10248 * @brief Get the content of the hover object, in a given direction.
10250 * Return the content object which was set for this widget in the
10251 * @p swallow direction.
10253 * @param obj The hover object
10254 * @param swallow The direction that the object was display at.
10255 * @return The content that was being used
10257 * @see elm_hover_content_set()
10259 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10261 * @brief Unset the content of the hover object, in a given direction.
10263 * Unparent and return the content object set at @p swallow direction.
10265 * @param obj The hover object
10266 * @param swallow The direction that the object was display at.
10267 * @return The content that was being used.
10269 * @see elm_hover_content_set()
10271 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10273 * @brief Returns the best swallow location for content in the hover.
10275 * @param obj The hover object
10276 * @param pref_axis The preferred orientation axis for the hover object to use
10277 * @return The edje location to place content into the hover or @c
10280 * Best is defined here as the location at which there is the most available
10283 * @p pref_axis may be one of
10284 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10285 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10286 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10287 * - @c ELM_HOVER_AXIS_BOTH -- both
10289 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10290 * nescessarily be along the horizontal axis("left" or "right"). If
10291 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10292 * be along the vertical axis("top" or "bottom"). Chossing
10293 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10294 * returned position may be in either axis.
10296 * @see elm_hover_content_set()
10298 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10305 * @defgroup Entry Entry
10307 * @image html img/widget/entry/preview-00.png
10308 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10309 * @image html img/widget/entry/preview-01.png
10310 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10311 * @image html img/widget/entry/preview-02.png
10312 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10313 * @image html img/widget/entry/preview-03.png
10314 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10316 * An entry is a convenience widget which shows a box that the user can
10317 * enter text into. Entries by default don't scroll, so they grow to
10318 * accomodate the entire text, resizing the parent window as needed. This
10319 * can be changed with the elm_entry_scrollable_set() function.
10321 * They can also be single line or multi line (the default) and when set
10322 * to multi line mode they support text wrapping in any of the modes
10323 * indicated by #Elm_Wrap_Type.
10325 * Other features include password mode, filtering of inserted text with
10326 * elm_entry_text_filter_append() and related functions, inline "items" and
10327 * formatted markup text.
10329 * @section entry-markup Formatted text
10331 * The markup tags supported by the Entry are defined by the theme, but
10332 * even when writing new themes or extensions it's a good idea to stick to
10333 * a sane default, to maintain coherency and avoid application breakages.
10334 * Currently defined by the default theme are the following tags:
10335 * @li \<br\>: Inserts a line break.
10336 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10338 * @li \<tab\>: Inserts a tab.
10339 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10341 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10342 * @li \<link\>...\</link\>: Underlines the enclosed text.
10343 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10345 * @section entry-special Special markups
10347 * Besides those used to format text, entries support two special markup
10348 * tags used to insert clickable portions of text or items inlined within
10351 * @subsection entry-anchors Anchors
10353 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10354 * \</a\> tags and an event will be generated when this text is clicked,
10358 * This text is outside <a href=anc-01>but this one is an anchor</a>
10361 * The @c href attribute in the opening tag gives the name that will be
10362 * used to identify the anchor and it can be any valid utf8 string.
10364 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10365 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10366 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10367 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10370 * @subsection entry-items Items
10372 * Inlined in the text, any other @c Evas_Object can be inserted by using
10373 * \<item\> tags this way:
10376 * <item size=16x16 vsize=full href=emoticon/haha></item>
10379 * Just like with anchors, the @c href identifies each item, but these need,
10380 * in addition, to indicate their size, which is done using any one of
10381 * @c size, @c absize or @c relsize attributes. These attributes take their
10382 * value in the WxH format, where W is the width and H the height of the
10385 * @li absize: Absolute pixel size for the item. Whatever value is set will
10386 * be the item's size regardless of any scale value the object may have
10387 * been set to. The final line height will be adjusted to fit larger items.
10388 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10390 * @li relsize: Size is adjusted for the item to fit within the current
10393 * Besides their size, items are specificed a @c vsize value that affects
10394 * how their final size and position are calculated. The possible values
10396 * @li ascent: Item will be placed within the line's baseline and its
10397 * ascent. That is, the height between the line where all characters are
10398 * positioned and the highest point in the line. For @c size and @c absize
10399 * items, the descent value will be added to the total line height to make
10400 * them fit. @c relsize items will be adjusted to fit within this space.
10401 * @li full: Items will be placed between the descent and ascent, or the
10402 * lowest point in the line and its highest.
10404 * The next image shows different configurations of items and how they
10405 * are the previously mentioned options affect their sizes. In all cases,
10406 * the green line indicates the ascent, blue for the baseline and red for
10409 * @image html entry_item.png
10410 * @image latex entry_item.eps width=\textwidth
10412 * And another one to show how size differs from absize. In the first one,
10413 * the scale value is set to 1.0, while the second one is using one of 2.0.
10415 * @image html entry_item_scale.png
10416 * @image latex entry_item_scale.eps width=\textwidth
10418 * After the size for an item is calculated, the entry will request an
10419 * object to place in its space. For this, the functions set with
10420 * elm_entry_item_provider_append() and related functions will be called
10421 * in order until one of them returns a @c non-NULL value. If no providers
10422 * are available, or all of them return @c NULL, then the entry falls back
10423 * to one of the internal defaults, provided the name matches with one of
10426 * All of the following are currently supported:
10429 * - emoticon/angry-shout
10430 * - emoticon/crazy-laugh
10431 * - emoticon/evil-laugh
10433 * - emoticon/goggle-smile
10434 * - emoticon/grumpy
10435 * - emoticon/grumpy-smile
10436 * - emoticon/guilty
10437 * - emoticon/guilty-smile
10439 * - emoticon/half-smile
10440 * - emoticon/happy-panting
10442 * - emoticon/indifferent
10444 * - emoticon/knowing-grin
10446 * - emoticon/little-bit-sorry
10447 * - emoticon/love-lots
10449 * - emoticon/minimal-smile
10450 * - emoticon/not-happy
10451 * - emoticon/not-impressed
10453 * - emoticon/opensmile
10456 * - emoticon/squint-laugh
10457 * - emoticon/surprised
10458 * - emoticon/suspicious
10459 * - emoticon/tongue-dangling
10460 * - emoticon/tongue-poke
10462 * - emoticon/unhappy
10463 * - emoticon/very-sorry
10466 * - emoticon/worried
10469 * Alternatively, an item may reference an image by its path, using
10470 * the URI form @c file:///path/to/an/image.png and the entry will then
10471 * use that image for the item.
10473 * @section entry-files Loading and saving files
10475 * Entries have convinience functions to load text from a file and save
10476 * changes back to it after a short delay. The automatic saving is enabled
10477 * by default, but can be disabled with elm_entry_autosave_set() and files
10478 * can be loaded directly as plain text or have any markup in them
10479 * recognized. See elm_entry_file_set() for more details.
10481 * @section entry-signals Emitted signals
10483 * This widget emits the following signals:
10485 * @li "changed": The text within the entry was changed.
10486 * @li "changed,user": The text within the entry was changed because of user interaction.
10487 * @li "activated": The enter key was pressed on a single line entry.
10488 * @li "press": A mouse button has been pressed on the entry.
10489 * @li "longpressed": A mouse button has been pressed and held for a couple
10491 * @li "clicked": The entry has been clicked (mouse press and release).
10492 * @li "clicked,double": The entry has been double clicked.
10493 * @li "clicked,triple": The entry has been triple clicked.
10494 * @li "focused": The entry has received focus.
10495 * @li "unfocused": The entry has lost focus.
10496 * @li "selection,paste": A paste of the clipboard contents was requested.
10497 * @li "selection,copy": A copy of the selected text into the clipboard was
10499 * @li "selection,cut": A cut of the selected text into the clipboard was
10501 * @li "selection,start": A selection has begun and no previous selection
10503 * @li "selection,changed": The current selection has changed.
10504 * @li "selection,cleared": The current selection has been cleared.
10505 * @li "cursor,changed": The cursor has changed position.
10506 * @li "anchor,clicked": An anchor has been clicked. The event_info
10507 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10508 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10509 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10510 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10511 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10512 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10513 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10514 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10515 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10516 * @li "preedit,changed": The preedit string has changed.
10518 * @section entry-examples
10520 * An overview of the Entry API can be seen in @ref entry_example_01
10525 * @typedef Elm_Entry_Anchor_Info
10527 * The info sent in the callback for the "anchor,clicked" signals emitted
10530 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10532 * @struct _Elm_Entry_Anchor_Info
10534 * The info sent in the callback for the "anchor,clicked" signals emitted
10537 struct _Elm_Entry_Anchor_Info
10539 const char *name; /**< The name of the anchor, as stated in its href */
10540 int button; /**< The mouse button used to click on it */
10541 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10542 y, /**< Anchor geometry, relative to canvas */
10543 w, /**< Anchor geometry, relative to canvas */
10544 h; /**< Anchor geometry, relative to canvas */
10547 * @typedef Elm_Entry_Filter_Cb
10548 * This callback type is used by entry filters to modify text.
10549 * @param data The data specified as the last param when adding the filter
10550 * @param entry The entry object
10551 * @param text A pointer to the location of the text being filtered. This data can be modified,
10552 * but any additional allocations must be managed by the user.
10553 * @see elm_entry_text_filter_append
10554 * @see elm_entry_text_filter_prepend
10556 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10559 * This adds an entry to @p parent object.
10561 * By default, entries are:
10565 * @li autosave is enabled
10567 * @param parent The parent object
10568 * @return The new object or NULL if it cannot be created
10570 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10572 * Sets the entry to single line mode.
10574 * In single line mode, entries don't ever wrap when the text reaches the
10575 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10576 * key will generate an @c "activate" event instead of adding a new line.
10578 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10579 * and pressing enter will break the text into a different line
10580 * without generating any events.
10582 * @param obj The entry object
10583 * @param single_line If true, the text in the entry
10584 * will be on a single line.
10586 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10588 * Gets whether the entry is set to be single line.
10590 * @param obj The entry object
10591 * @return single_line If true, the text in the entry is set to display
10592 * on a single line.
10594 * @see elm_entry_single_line_set()
10596 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10598 * Sets the entry to password mode.
10600 * In password mode, entries are implicitly single line and the display of
10601 * any text in them is replaced with asterisks (*).
10603 * @param obj The entry object
10604 * @param password If true, password mode is enabled.
10606 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10608 * Gets whether the entry is set to password mode.
10610 * @param obj The entry object
10611 * @return If true, the entry is set to display all characters
10612 * as asterisks (*).
10614 * @see elm_entry_password_set()
10616 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10618 * This sets the text displayed within the entry to @p entry.
10620 * @param obj The entry object
10621 * @param entry The text to be displayed
10623 * @deprecated Use elm_object_text_set() instead.
10625 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10627 * This returns the text currently shown in object @p entry.
10628 * See also elm_entry_entry_set().
10630 * @param obj The entry object
10631 * @return The currently displayed text or NULL on failure
10633 * @deprecated Use elm_object_text_get() instead.
10635 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10637 * Appends @p entry to the text of the entry.
10639 * Adds the text in @p entry to the end of any text already present in the
10642 * The appended text is subject to any filters set for the widget.
10644 * @param obj The entry object
10645 * @param entry The text to be displayed
10647 * @see elm_entry_text_filter_append()
10649 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10651 * Gets whether the entry is empty.
10653 * Empty means no text at all. If there are any markup tags, like an item
10654 * tag for which no provider finds anything, and no text is displayed, this
10655 * function still returns EINA_FALSE.
10657 * @param obj The entry object
10658 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10660 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10662 * Gets any selected text within the entry.
10664 * If there's any selected text in the entry, this function returns it as
10665 * a string in markup format. NULL is returned if no selection exists or
10666 * if an error occurred.
10668 * The returned value points to an internal string and should not be freed
10669 * or modified in any way. If the @p entry object is deleted or its
10670 * contents are changed, the returned pointer should be considered invalid.
10672 * @param obj The entry object
10673 * @return The selected text within the entry or NULL on failure
10675 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10677 * Inserts the given text into the entry at the current cursor position.
10679 * This inserts text at the cursor position as if it was typed
10680 * by the user (note that this also allows markup which a user
10681 * can't just "type" as it would be converted to escaped text, so this
10682 * call can be used to insert things like emoticon items or bold push/pop
10683 * tags, other font and color change tags etc.)
10685 * If any selection exists, it will be replaced by the inserted text.
10687 * The inserted text is subject to any filters set for the widget.
10689 * @param obj The entry object
10690 * @param entry The text to insert
10692 * @see elm_entry_text_filter_append()
10694 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10696 * Set the line wrap type to use on multi-line entries.
10698 * Sets the wrap type used by the entry to any of the specified in
10699 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10700 * line (without inserting a line break or paragraph separator) when it
10701 * reaches the far edge of the widget.
10703 * Note that this only makes sense for multi-line entries. A widget set
10704 * to be single line will never wrap.
10706 * @param obj The entry object
10707 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10709 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10711 * Gets the wrap mode the entry was set to use.
10713 * @param obj The entry object
10714 * @return Wrap type
10716 * @see also elm_entry_line_wrap_set()
10718 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10720 * Sets if the entry is to be editable or not.
10722 * By default, entries are editable and when focused, any text input by the
10723 * user will be inserted at the current cursor position. But calling this
10724 * function with @p editable as EINA_FALSE will prevent the user from
10725 * inputting text into the entry.
10727 * The only way to change the text of a non-editable entry is to use
10728 * elm_object_text_set(), elm_entry_entry_insert() and other related
10731 * @param obj The entry object
10732 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10733 * if not, the entry is read-only and no user input is allowed.
10735 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10737 * Gets whether the entry is editable or not.
10739 * @param obj The entry object
10740 * @return If true, the entry is editable by the user.
10741 * If false, it is not editable by the user
10743 * @see elm_entry_editable_set()
10745 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10747 * This drops any existing text selection within the entry.
10749 * @param obj The entry object
10751 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10753 * This selects all text within the entry.
10755 * @param obj The entry object
10757 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10759 * This moves the cursor one place to the right within the entry.
10761 * @param obj The entry object
10762 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10764 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10766 * This moves the cursor one place to the left within the entry.
10768 * @param obj The entry object
10769 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10771 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10773 * This moves the cursor one line up within the entry.
10775 * @param obj The entry object
10776 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10778 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10780 * This moves the cursor one line down within the entry.
10782 * @param obj The entry object
10783 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10785 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10787 * This moves the cursor to the beginning of the entry.
10789 * @param obj The entry object
10791 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10793 * This moves the cursor to the end of the entry.
10795 * @param obj The entry object
10797 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10799 * This moves the cursor to the beginning of the current line.
10801 * @param obj The entry object
10803 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10805 * This moves the cursor to the end of the current line.
10807 * @param obj The entry object
10809 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10811 * This begins a selection within the entry as though
10812 * the user were holding down the mouse button to make a selection.
10814 * @param obj The entry object
10816 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10818 * This ends a selection within the entry as though
10819 * the user had just released the mouse button while making a selection.
10821 * @param obj The entry object
10823 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10825 * Gets whether a format node exists at the current cursor position.
10827 * A format node is anything that defines how the text is rendered. It can
10828 * be a visible format node, such as a line break or a paragraph separator,
10829 * or an invisible one, such as bold begin or end tag.
10830 * This function returns whether any format node exists at the current
10833 * @param obj The entry object
10834 * @return EINA_TRUE if the current cursor position contains a format node,
10835 * EINA_FALSE otherwise.
10837 * @see elm_entry_cursor_is_visible_format_get()
10839 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10841 * Gets if the current cursor position holds a visible format node.
10843 * @param obj The entry object
10844 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10845 * if it's an invisible one or no format exists.
10847 * @see elm_entry_cursor_is_format_get()
10849 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10851 * Gets the character pointed by the cursor at its current position.
10853 * This function returns a string with the utf8 character stored at the
10854 * current cursor position.
10855 * Only the text is returned, any format that may exist will not be part
10856 * of the return value.
10858 * @param obj The entry object
10859 * @return The text pointed by the cursors.
10861 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10863 * This function returns the geometry of the cursor.
10865 * It's useful if you want to draw something on the cursor (or where it is),
10866 * or for example in the case of scrolled entry where you want to show the
10869 * @param obj The entry object
10870 * @param x returned geometry
10871 * @param y returned geometry
10872 * @param w returned geometry
10873 * @param h returned geometry
10874 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10876 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);
10878 * Sets the cursor position in the entry to the given value
10880 * The value in @p pos is the index of the character position within the
10881 * contents of the string as returned by elm_entry_cursor_pos_get().
10883 * @param obj The entry object
10884 * @param pos The position of the cursor
10886 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10888 * Retrieves the current position of the cursor in the entry
10890 * @param obj The entry object
10891 * @return The cursor position
10893 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10895 * This executes a "cut" action on the selected text in the entry.
10897 * @param obj The entry object
10899 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10901 * This executes a "copy" action on the selected text in the entry.
10903 * @param obj The entry object
10905 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10907 * This executes a "paste" action in the entry.
10909 * @param obj The entry object
10911 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10913 * This clears and frees the items in a entry's contextual (longpress)
10916 * @param obj The entry object
10918 * @see elm_entry_context_menu_item_add()
10920 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10922 * This adds an item to the entry's contextual menu.
10924 * A longpress on an entry will make the contextual menu show up, if this
10925 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10926 * By default, this menu provides a few options like enabling selection mode,
10927 * which is useful on embedded devices that need to be explicit about it,
10928 * and when a selection exists it also shows the copy and cut actions.
10930 * With this function, developers can add other options to this menu to
10931 * perform any action they deem necessary.
10933 * @param obj The entry object
10934 * @param label The item's text label
10935 * @param icon_file The item's icon file
10936 * @param icon_type The item's icon type
10937 * @param func The callback to execute when the item is clicked
10938 * @param data The data to associate with the item for related functions
10940 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);
10942 * This disables the entry's contextual (longpress) menu.
10944 * @param obj The entry object
10945 * @param disabled If true, the menu is disabled
10947 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10949 * This returns whether the entry's contextual (longpress) menu is
10952 * @param obj The entry object
10953 * @return If true, the menu is disabled
10955 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10957 * This appends a custom item provider to the list for that entry
10959 * This appends the given callback. The list is walked from beginning to end
10960 * with each function called given the item href string in the text. If the
10961 * function returns an object handle other than NULL (it should create an
10962 * object to do this), then this object is used to replace that item. If
10963 * not the next provider is called until one provides an item object, or the
10964 * default provider in entry does.
10966 * @param obj The entry object
10967 * @param func The function called to provide the item object
10968 * @param data The data passed to @p func
10970 * @see @ref entry-items
10972 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);
10974 * This prepends a custom item provider to the list for that entry
10976 * This prepends the given callback. See elm_entry_item_provider_append() for
10979 * @param obj The entry object
10980 * @param func The function called to provide the item object
10981 * @param data The data passed to @p func
10983 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);
10985 * This removes a custom item provider to the list for that entry
10987 * This removes the given callback. See elm_entry_item_provider_append() for
10990 * @param obj The entry object
10991 * @param func The function called to provide the item object
10992 * @param data The data passed to @p func
10994 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);
10996 * Append a filter function for text inserted in the entry
10998 * Append the given callback to the list. This functions will be called
10999 * whenever any text is inserted into the entry, with the text to be inserted
11000 * as a parameter. The callback function is free to alter the text in any way
11001 * it wants, but it must remember to free the given pointer and update it.
11002 * If the new text is to be discarded, the function can free it and set its
11003 * text parameter to NULL. This will also prevent any following filters from
11006 * @param obj The entry object
11007 * @param func The function to use as text filter
11008 * @param data User data to pass to @p func
11010 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11012 * Prepend a filter function for text insdrted in the entry
11014 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11015 * for more information
11017 * @param obj The entry object
11018 * @param func The function to use as text filter
11019 * @param data User data to pass to @p func
11021 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11023 * Remove a filter from the list
11025 * Removes the given callback from the filter list. See
11026 * elm_entry_text_filter_append() for more information.
11028 * @param obj The entry object
11029 * @param func The filter function to remove
11030 * @param data The user data passed when adding the function
11032 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11034 * This converts a markup (HTML-like) string into UTF-8.
11036 * The returned string is a malloc'ed buffer and it should be freed when
11037 * not needed anymore.
11039 * @param s The string (in markup) to be converted
11040 * @return The converted string (in UTF-8). It should be freed.
11042 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11044 * This converts a UTF-8 string into markup (HTML-like).
11046 * The returned string is a malloc'ed buffer and it should be freed when
11047 * not needed anymore.
11049 * @param s The string (in UTF-8) to be converted
11050 * @return The converted string (in markup). It should be freed.
11052 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11054 * This sets the file (and implicitly loads it) for the text to display and
11055 * then edit. All changes are written back to the file after a short delay if
11056 * the entry object is set to autosave (which is the default).
11058 * If the entry had any other file set previously, any changes made to it
11059 * will be saved if the autosave feature is enabled, otherwise, the file
11060 * will be silently discarded and any non-saved changes will be lost.
11062 * @param obj The entry object
11063 * @param file The path to the file to load and save
11064 * @param format The file format
11066 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11068 * Gets the file being edited by the entry.
11070 * This function can be used to retrieve any file set on the entry for
11071 * edition, along with the format used to load and save it.
11073 * @param obj The entry object
11074 * @param file The path to the file to load and save
11075 * @param format The file format
11077 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11079 * This function writes any changes made to the file set with
11080 * elm_entry_file_set()
11082 * @param obj The entry object
11084 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11086 * This sets the entry object to 'autosave' the loaded text file or not.
11088 * @param obj The entry object
11089 * @param autosave Autosave the loaded file or not
11091 * @see elm_entry_file_set()
11093 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11095 * This gets the entry object's 'autosave' status.
11097 * @param obj The entry object
11098 * @return Autosave the loaded file or not
11100 * @see elm_entry_file_set()
11102 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11104 * Control pasting of text and images for the widget.
11106 * Normally the entry allows both text and images to be pasted. By setting
11107 * textonly to be true, this prevents images from being pasted.
11109 * Note this only changes the behaviour of text.
11111 * @param obj The entry object
11112 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11113 * text+image+other.
11115 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11117 * Getting elm_entry text paste/drop mode.
11119 * In textonly mode, only text may be pasted or dropped into the widget.
11121 * @param obj The entry object
11122 * @return If the widget only accepts text from pastes.
11124 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11126 * Enable or disable scrolling in entry
11128 * Normally the entry is not scrollable unless you enable it with this call.
11130 * @param obj The entry object
11131 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11133 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11135 * Get the scrollable state of the entry
11137 * Normally the entry is not scrollable. This gets the scrollable state
11138 * of the entry. See elm_entry_scrollable_set() for more information.
11140 * @param obj The entry object
11141 * @return The scrollable state
11143 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11145 * This sets a widget to be displayed to the left of a scrolled entry.
11147 * @param obj The scrolled entry object
11148 * @param icon The widget to display on the left side of the scrolled
11151 * @note A previously set widget will be destroyed.
11152 * @note If the object being set does not have minimum size hints set,
11153 * it won't get properly displayed.
11155 * @see elm_entry_end_set()
11157 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11159 * Gets the leftmost widget of the scrolled entry. This object is
11160 * owned by the scrolled entry and should not be modified.
11162 * @param obj The scrolled entry object
11163 * @return the left widget inside the scroller
11165 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11167 * Unset the leftmost widget of the scrolled entry, unparenting and
11170 * @param obj The scrolled entry object
11171 * @return the previously set icon sub-object of this entry, on
11174 * @see elm_entry_icon_set()
11176 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11178 * Sets the visibility of the left-side widget of the scrolled entry,
11179 * set by elm_entry_icon_set().
11181 * @param obj The scrolled entry object
11182 * @param setting EINA_TRUE if the object should be displayed,
11183 * EINA_FALSE if not.
11185 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11187 * This sets a widget to be displayed to the end of a scrolled entry.
11189 * @param obj The scrolled entry object
11190 * @param end The widget to display on the right side of the scrolled
11193 * @note A previously set widget will be destroyed.
11194 * @note If the object being set does not have minimum size hints set,
11195 * it won't get properly displayed.
11197 * @see elm_entry_icon_set
11199 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11201 * Gets the endmost widget of the scrolled entry. This object is owned
11202 * by the scrolled entry and should not be modified.
11204 * @param obj The scrolled entry object
11205 * @return the right widget inside the scroller
11207 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11209 * Unset the endmost widget of the scrolled entry, unparenting and
11212 * @param obj The scrolled entry object
11213 * @return the previously set icon sub-object of this entry, on
11216 * @see elm_entry_icon_set()
11218 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11220 * Sets the visibility of the end widget of the scrolled entry, set by
11221 * elm_entry_end_set().
11223 * @param obj The scrolled entry object
11224 * @param setting EINA_TRUE if the object should be displayed,
11225 * EINA_FALSE if not.
11227 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11229 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11232 * Setting an entry to single-line mode with elm_entry_single_line_set()
11233 * will automatically disable the display of scrollbars when the entry
11234 * moves inside its scroller.
11236 * @param obj The scrolled entry object
11237 * @param h The horizontal scrollbar policy to apply
11238 * @param v The vertical scrollbar policy to apply
11240 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11242 * This enables/disables bouncing within the entry.
11244 * This function sets whether the entry will bounce when scrolling reaches
11245 * the end of the contained entry.
11247 * @param obj The scrolled entry object
11248 * @param h The horizontal bounce state
11249 * @param v The vertical bounce state
11251 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11253 * Get the bounce mode
11255 * @param obj The Entry object
11256 * @param h_bounce Allow bounce horizontally
11257 * @param v_bounce Allow bounce vertically
11259 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11261 /* pre-made filters for entries */
11263 * @typedef Elm_Entry_Filter_Limit_Size
11265 * Data for the elm_entry_filter_limit_size() entry filter.
11267 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11269 * @struct _Elm_Entry_Filter_Limit_Size
11271 * Data for the elm_entry_filter_limit_size() entry filter.
11273 struct _Elm_Entry_Filter_Limit_Size
11275 int max_char_count; /**< The maximum number of characters allowed. */
11276 int max_byte_count; /**< The maximum number of bytes allowed*/
11279 * Filter inserted text based on user defined character and byte limits
11281 * Add this filter to an entry to limit the characters that it will accept
11282 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11283 * The funtion works on the UTF-8 representation of the string, converting
11284 * it from the set markup, thus not accounting for any format in it.
11286 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11287 * it as data when setting the filter. In it, it's possible to set limits
11288 * by character count or bytes (any of them is disabled if 0), and both can
11289 * be set at the same time. In that case, it first checks for characters,
11292 * The function will cut the inserted text in order to allow only the first
11293 * number of characters that are still allowed. The cut is made in
11294 * characters, even when limiting by bytes, in order to always contain
11295 * valid ones and avoid half unicode characters making it in.
11297 * This filter, like any others, does not apply when setting the entry text
11298 * directly with elm_object_text_set() (or the deprecated
11299 * elm_entry_entry_set()).
11301 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11303 * @typedef Elm_Entry_Filter_Accept_Set
11305 * Data for the elm_entry_filter_accept_set() entry filter.
11307 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11309 * @struct _Elm_Entry_Filter_Accept_Set
11311 * Data for the elm_entry_filter_accept_set() entry filter.
11313 struct _Elm_Entry_Filter_Accept_Set
11315 const char *accepted; /**< Set of characters accepted in the entry. */
11316 const char *rejected; /**< Set of characters rejected from the entry. */
11319 * Filter inserted text based on accepted or rejected sets of characters
11321 * Add this filter to an entry to restrict the set of accepted characters
11322 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11323 * This structure contains both accepted and rejected sets, but they are
11324 * mutually exclusive.
11326 * The @c accepted set takes preference, so if it is set, the filter will
11327 * only work based on the accepted characters, ignoring anything in the
11328 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11330 * In both cases, the function filters by matching utf8 characters to the
11331 * raw markup text, so it can be used to remove formatting tags.
11333 * This filter, like any others, does not apply when setting the entry text
11334 * directly with elm_object_text_set() (or the deprecated
11335 * elm_entry_entry_set()).
11337 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11339 * Set the input panel layout of the entry
11341 * @param obj The entry object
11342 * @param layout layout type
11344 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11346 * Get the input panel layout of the entry
11348 * @param obj The entry object
11349 * @return layout type
11351 * @see elm_entry_input_panel_layout_set
11353 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11358 /* composite widgets - these basically put together basic widgets above
11359 * in convenient packages that do more than basic stuff */
11363 * @defgroup Anchorview Anchorview
11365 * @image html img/widget/anchorview/preview-00.png
11366 * @image latex img/widget/anchorview/preview-00.eps
11368 * Anchorview is for displaying text that contains markup with anchors
11369 * like <c>\<a href=1234\>something\</\></c> in it.
11371 * Besides being styled differently, the anchorview widget provides the
11372 * necessary functionality so that clicking on these anchors brings up a
11373 * popup with user defined content such as "call", "add to contacts" or
11374 * "open web page". This popup is provided using the @ref Hover widget.
11376 * This widget is very similar to @ref Anchorblock, so refer to that
11377 * widget for an example. The only difference Anchorview has is that the
11378 * widget is already provided with scrolling functionality, so if the
11379 * text set to it is too large to fit in the given space, it will scroll,
11380 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11381 * text can be displayed.
11383 * This widget emits the following signals:
11384 * @li "anchor,clicked": will be called when an anchor is clicked. The
11385 * @p event_info parameter on the callback will be a pointer of type
11386 * ::Elm_Entry_Anchorview_Info.
11388 * See @ref Anchorblock for an example on how to use both of them.
11397 * @typedef Elm_Entry_Anchorview_Info
11399 * The info sent in the callback for "anchor,clicked" signals emitted by
11400 * the Anchorview widget.
11402 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11404 * @struct _Elm_Entry_Anchorview_Info
11406 * The info sent in the callback for "anchor,clicked" signals emitted by
11407 * the Anchorview widget.
11409 struct _Elm_Entry_Anchorview_Info
11411 const char *name; /**< Name of the anchor, as indicated in its href
11413 int button; /**< The mouse button used to click on it */
11414 Evas_Object *hover; /**< The hover object to use for the popup */
11416 Evas_Coord x, y, w, h;
11417 } anchor, /**< Geometry selection of text used as anchor */
11418 hover_parent; /**< Geometry of the object used as parent by the
11420 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11421 for content on the left side of
11422 the hover. Before calling the
11423 callback, the widget will make the
11424 necessary calculations to check
11425 which sides are fit to be set with
11426 content, based on the position the
11427 hover is activated and its distance
11428 to the edges of its parent object
11430 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11431 the right side of the hover.
11432 See @ref hover_left */
11433 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11434 of the hover. See @ref hover_left */
11435 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11436 below the hover. See @ref
11440 * Add a new Anchorview object
11442 * @param parent The parent object
11443 * @return The new object or NULL if it cannot be created
11445 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11447 * Set the text to show in the anchorview
11449 * Sets the text of the anchorview to @p text. This text can include markup
11450 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11451 * text that will be specially styled and react to click events, ended with
11452 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11453 * "anchor,clicked" signal that you can attach a callback to with
11454 * evas_object_smart_callback_add(). The name of the anchor given in the
11455 * event info struct will be the one set in the href attribute, in this
11456 * case, anchorname.
11458 * Other markup can be used to style the text in different ways, but it's
11459 * up to the style defined in the theme which tags do what.
11460 * @deprecated use elm_object_text_set() instead.
11462 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11464 * Get the markup text set for the anchorview
11466 * Retrieves the text set on the anchorview, with markup tags included.
11468 * @param obj The anchorview object
11469 * @return The markup text set or @c NULL if nothing was set or an error
11471 * @deprecated use elm_object_text_set() instead.
11473 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11475 * Set the parent of the hover popup
11477 * Sets the parent object to use by the hover created by the anchorview
11478 * when an anchor is clicked. See @ref Hover for more details on this.
11479 * If no parent is set, the same anchorview object will be used.
11481 * @param obj The anchorview object
11482 * @param parent The object to use as parent for the hover
11484 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11486 * Get the parent of the hover popup
11488 * Get the object used as parent for the hover created by the anchorview
11489 * widget. See @ref Hover for more details on this.
11491 * @param obj The anchorview object
11492 * @return The object used as parent for the hover, NULL if none is set.
11494 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11496 * Set the style that the hover should use
11498 * When creating the popup hover, anchorview will request that it's
11499 * themed according to @p style.
11501 * @param obj The anchorview object
11502 * @param style The style to use for the underlying hover
11504 * @see elm_object_style_set()
11506 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11508 * Get the style that the hover should use
11510 * Get the style the hover created by anchorview will use.
11512 * @param obj The anchorview object
11513 * @return The style to use by the hover. NULL means the default is used.
11515 * @see elm_object_style_set()
11517 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11519 * Ends the hover popup in the anchorview
11521 * When an anchor is clicked, the anchorview widget will create a hover
11522 * object to use as a popup with user provided content. This function
11523 * terminates this popup, returning the anchorview to its normal state.
11525 * @param obj The anchorview object
11527 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11529 * Set bouncing behaviour when the scrolled content reaches an edge
11531 * Tell the internal scroller object whether it should bounce or not
11532 * when it reaches the respective edges for each axis.
11534 * @param obj The anchorview object
11535 * @param h_bounce Whether to bounce or not in the horizontal axis
11536 * @param v_bounce Whether to bounce or not in the vertical axis
11538 * @see elm_scroller_bounce_set()
11540 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11542 * Get the set bouncing behaviour of the internal scroller
11544 * Get whether the internal scroller should bounce when the edge of each
11545 * axis is reached scrolling.
11547 * @param obj The anchorview object
11548 * @param h_bounce Pointer where to store the bounce state of the horizontal
11550 * @param v_bounce Pointer where to store the bounce state of the vertical
11553 * @see elm_scroller_bounce_get()
11555 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11557 * Appends a custom item provider to the given anchorview
11559 * Appends the given function to the list of items providers. This list is
11560 * called, one function at a time, with the given @p data pointer, the
11561 * anchorview object and, in the @p item parameter, the item name as
11562 * referenced in its href string. Following functions in the list will be
11563 * called in order until one of them returns something different to NULL,
11564 * which should be an Evas_Object which will be used in place of the item
11567 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11568 * href=item/name\>\</item\>
11570 * @param obj The anchorview object
11571 * @param func The function to add to the list of providers
11572 * @param data User data that will be passed to the callback function
11574 * @see elm_entry_item_provider_append()
11576 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);
11578 * Prepend a custom item provider to the given anchorview
11580 * Like elm_anchorview_item_provider_append(), but it adds the function
11581 * @p func to the beginning of the list, instead of the end.
11583 * @param obj The anchorview object
11584 * @param func The function to add to the list of providers
11585 * @param data User data that will be passed to the callback function
11587 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);
11589 * Remove a custom item provider from the list of the given anchorview
11591 * Removes the function and data pairing that matches @p func and @p data.
11592 * That is, unless the same function and same user data are given, the
11593 * function will not be removed from the list. This allows us to add the
11594 * same callback several times, with different @p data pointers and be
11595 * able to remove them later without conflicts.
11597 * @param obj The anchorview object
11598 * @param func The function to remove from the list
11599 * @param data The data matching the function to remove from the list
11601 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);
11608 * @defgroup Anchorblock Anchorblock
11610 * @image html img/widget/anchorblock/preview-00.png
11611 * @image latex img/widget/anchorblock/preview-00.eps
11613 * Anchorblock is for displaying text that contains markup with anchors
11614 * like <c>\<a href=1234\>something\</\></c> in it.
11616 * Besides being styled differently, the anchorblock widget provides the
11617 * necessary functionality so that clicking on these anchors brings up a
11618 * popup with user defined content such as "call", "add to contacts" or
11619 * "open web page". This popup is provided using the @ref Hover widget.
11621 * This widget emits the following signals:
11622 * @li "anchor,clicked": will be called when an anchor is clicked. The
11623 * @p event_info parameter on the callback will be a pointer of type
11624 * ::Elm_Entry_Anchorblock_Info.
11630 * Since examples are usually better than plain words, we might as well
11631 * try @ref tutorial_anchorblock_example "one".
11634 * @addtogroup Anchorblock
11638 * @typedef Elm_Entry_Anchorblock_Info
11640 * The info sent in the callback for "anchor,clicked" signals emitted by
11641 * the Anchorblock widget.
11643 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11645 * @struct _Elm_Entry_Anchorblock_Info
11647 * The info sent in the callback for "anchor,clicked" signals emitted by
11648 * the Anchorblock widget.
11650 struct _Elm_Entry_Anchorblock_Info
11652 const char *name; /**< Name of the anchor, as indicated in its href
11654 int button; /**< The mouse button used to click on it */
11655 Evas_Object *hover; /**< The hover object to use for the popup */
11657 Evas_Coord x, y, w, h;
11658 } anchor, /**< Geometry selection of text used as anchor */
11659 hover_parent; /**< Geometry of the object used as parent by the
11661 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11662 for content on the left side of
11663 the hover. Before calling the
11664 callback, the widget will make the
11665 necessary calculations to check
11666 which sides are fit to be set with
11667 content, based on the position the
11668 hover is activated and its distance
11669 to the edges of its parent object
11671 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11672 the right side of the hover.
11673 See @ref hover_left */
11674 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11675 of the hover. See @ref hover_left */
11676 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11677 below the hover. See @ref
11681 * Add a new Anchorblock object
11683 * @param parent The parent object
11684 * @return The new object or NULL if it cannot be created
11686 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11688 * Set the text to show in the anchorblock
11690 * Sets the text of the anchorblock to @p text. This text can include markup
11691 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11692 * of text that will be specially styled and react to click events, ended
11693 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11694 * "anchor,clicked" signal that you can attach a callback to with
11695 * evas_object_smart_callback_add(). The name of the anchor given in the
11696 * event info struct will be the one set in the href attribute, in this
11697 * case, anchorname.
11699 * Other markup can be used to style the text in different ways, but it's
11700 * up to the style defined in the theme which tags do what.
11701 * @deprecated use elm_object_text_set() instead.
11703 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11705 * Get the markup text set for the anchorblock
11707 * Retrieves the text set on the anchorblock, with markup tags included.
11709 * @param obj The anchorblock object
11710 * @return The markup text set or @c NULL if nothing was set or an error
11712 * @deprecated use elm_object_text_set() instead.
11714 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11716 * Set the parent of the hover popup
11718 * Sets the parent object to use by the hover created by the anchorblock
11719 * when an anchor is clicked. See @ref Hover for more details on this.
11721 * @param obj The anchorblock object
11722 * @param parent The object to use as parent for the hover
11724 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11726 * Get the parent of the hover popup
11728 * Get the object used as parent for the hover created by the anchorblock
11729 * widget. See @ref Hover for more details on this.
11730 * If no parent is set, the same anchorblock object will be used.
11732 * @param obj The anchorblock object
11733 * @return The object used as parent for the hover, NULL if none is set.
11735 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11737 * Set the style that the hover should use
11739 * When creating the popup hover, anchorblock will request that it's
11740 * themed according to @p style.
11742 * @param obj The anchorblock object
11743 * @param style The style to use for the underlying hover
11745 * @see elm_object_style_set()
11747 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11749 * Get the style that the hover should use
11751 * Get the style the hover created by anchorblock will use.
11753 * @param obj The anchorblock object
11754 * @return The style to use by the hover. NULL means the default is used.
11756 * @see elm_object_style_set()
11758 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11760 * Ends the hover popup in the anchorblock
11762 * When an anchor is clicked, the anchorblock widget will create a hover
11763 * object to use as a popup with user provided content. This function
11764 * terminates this popup, returning the anchorblock to its normal state.
11766 * @param obj The anchorblock object
11768 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11770 * Appends a custom item provider to the given anchorblock
11772 * Appends the given function to the list of items providers. This list is
11773 * called, one function at a time, with the given @p data pointer, the
11774 * anchorblock object and, in the @p item parameter, the item name as
11775 * referenced in its href string. Following functions in the list will be
11776 * called in order until one of them returns something different to NULL,
11777 * which should be an Evas_Object which will be used in place of the item
11780 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11781 * href=item/name\>\</item\>
11783 * @param obj The anchorblock object
11784 * @param func The function to add to the list of providers
11785 * @param data User data that will be passed to the callback function
11787 * @see elm_entry_item_provider_append()
11789 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);
11791 * Prepend a custom item provider to the given anchorblock
11793 * Like elm_anchorblock_item_provider_append(), but it adds the function
11794 * @p func to the beginning of the list, instead of the end.
11796 * @param obj The anchorblock object
11797 * @param func The function to add to the list of providers
11798 * @param data User data that will be passed to the callback function
11800 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);
11802 * Remove a custom item provider from the list of the given anchorblock
11804 * Removes the function and data pairing that matches @p func and @p data.
11805 * That is, unless the same function and same user data are given, the
11806 * function will not be removed from the list. This allows us to add the
11807 * same callback several times, with different @p data pointers and be
11808 * able to remove them later without conflicts.
11810 * @param obj The anchorblock object
11811 * @param func The function to remove from the list
11812 * @param data The data matching the function to remove from the list
11814 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);
11820 * @defgroup Bubble Bubble
11822 * @image html img/widget/bubble/preview-00.png
11823 * @image latex img/widget/bubble/preview-00.eps
11824 * @image html img/widget/bubble/preview-01.png
11825 * @image latex img/widget/bubble/preview-01.eps
11826 * @image html img/widget/bubble/preview-02.png
11827 * @image latex img/widget/bubble/preview-02.eps
11829 * @brief The Bubble is a widget to show text similarly to how speech is
11830 * represented in comics.
11832 * The bubble widget contains 5 important visual elements:
11833 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11834 * @li The @p icon is an image to which the frame's arrow points to.
11835 * @li The @p label is a text which appears to the right of the icon if the
11836 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11838 * @li The @p info is a text which appears to the right of the label. Info's
11839 * font is of a ligther color than label.
11840 * @li The @p content is an evas object that is shown inside the frame.
11842 * The position of the arrow, icon, label and info depends on which corner is
11843 * selected. The four available corners are:
11844 * @li "top_left" - Default
11846 * @li "bottom_left"
11847 * @li "bottom_right"
11849 * Signals that you can add callbacks for are:
11850 * @li "clicked" - This is called when a user has clicked the bubble.
11852 * For an example of using a buble see @ref bubble_01_example_page "this".
11857 * Add a new bubble to the parent
11859 * @param parent The parent object
11860 * @return The new object or NULL if it cannot be created
11862 * This function adds a text bubble to the given parent evas object.
11864 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11866 * Set the label of the bubble
11868 * @param obj The bubble object
11869 * @param label The string to set in the label
11871 * This function sets the title of the bubble. Where this appears depends on
11872 * the selected corner.
11873 * @deprecated use elm_object_text_set() instead.
11875 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11877 * Get the label of the bubble
11879 * @param obj The bubble object
11880 * @return The string of set in the label
11882 * This function gets the title of the bubble.
11883 * @deprecated use elm_object_text_get() instead.
11885 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11887 * Set the info of the bubble
11889 * @param obj The bubble object
11890 * @param info The given info about the bubble
11892 * This function sets the info of the bubble. Where this appears depends on
11893 * the selected corner.
11894 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11896 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11898 * Get the info of the bubble
11900 * @param obj The bubble object
11902 * @return The "info" string of the bubble
11904 * This function gets the info text.
11905 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11907 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11909 * Set the content to be shown in the bubble
11911 * Once the content object is set, a previously set one will be deleted.
11912 * If you want to keep the old content object, use the
11913 * elm_bubble_content_unset() function.
11915 * @param obj The bubble object
11916 * @param content The given content of the bubble
11918 * This function sets the content shown on the middle of the bubble.
11920 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11922 * Get the content shown in the bubble
11924 * Return the content object which is set for this widget.
11926 * @param obj The bubble object
11927 * @return The content that is being used
11929 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11931 * Unset the content shown in the bubble
11933 * Unparent and return the content object which was set for this widget.
11935 * @param obj The bubble object
11936 * @return The content that was being used
11938 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11940 * Set the icon of the bubble
11942 * Once the icon object is set, a previously set one will be deleted.
11943 * If you want to keep the old content object, use the
11944 * elm_icon_content_unset() function.
11946 * @param obj The bubble object
11947 * @param icon The given icon for the bubble
11949 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11951 * Get the icon of the bubble
11953 * @param obj The bubble object
11954 * @return The icon for the bubble
11956 * This function gets the icon shown on the top left of bubble.
11958 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11960 * Unset the icon of the bubble
11962 * Unparent and return the icon object which was set for this widget.
11964 * @param obj The bubble object
11965 * @return The icon that was being used
11967 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11969 * Set the corner of the bubble
11971 * @param obj The bubble object.
11972 * @param corner The given corner for the bubble.
11974 * This function sets the corner of the bubble. The corner will be used to
11975 * determine where the arrow in the frame points to and where label, icon and
11978 * Possible values for corner are:
11979 * @li "top_left" - Default
11981 * @li "bottom_left"
11982 * @li "bottom_right"
11984 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11986 * Get the corner of the bubble
11988 * @param obj The bubble object.
11989 * @return The given corner for the bubble.
11991 * This function gets the selected corner of the bubble.
11993 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11999 * @defgroup Photo Photo
12001 * For displaying the photo of a person (contact). Simple yet
12002 * with a very specific purpose.
12004 * Signals that you can add callbacks for are:
12006 * "clicked" - This is called when a user has clicked the photo
12007 * "drag,start" - Someone started dragging the image out of the object
12008 * "drag,end" - Dragged item was dropped (somewhere)
12014 * Add a new photo to the parent
12016 * @param parent The parent object
12017 * @return The new object or NULL if it cannot be created
12021 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12024 * Set the file that will be used as photo
12026 * @param obj The photo object
12027 * @param file The path to file that will be used as photo
12029 * @return (1 = success, 0 = error)
12033 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12036 * Set the size that will be used on the photo
12038 * @param obj The photo object
12039 * @param size The size that the photo will be
12043 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12046 * Set if the photo should be completely visible or not.
12048 * @param obj The photo object
12049 * @param fill if true the photo will be completely visible
12053 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12056 * Set editability of the photo.
12058 * An editable photo can be dragged to or from, and can be cut or
12059 * pasted too. Note that pasting an image or dropping an item on
12060 * the image will delete the existing content.
12062 * @param obj The photo object.
12063 * @param set To set of clear editablity.
12065 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12071 /* gesture layer */
12073 * @defgroup Elm_Gesture_Layer Gesture Layer
12074 * Gesture Layer Usage:
12076 * Use Gesture Layer to detect gestures.
12077 * The advantage is that you don't have to implement
12078 * gesture detection, just set callbacks of gesture state.
12079 * By using gesture layer we make standard interface.
12081 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12082 * with a parent object parameter.
12083 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12084 * call. Usually with same object as target (2nd parameter).
12086 * Now you need to tell gesture layer what gestures you follow.
12087 * This is done with @ref elm_gesture_layer_cb_set call.
12088 * By setting the callback you actually saying to gesture layer:
12089 * I would like to know when the gesture @ref Elm_Gesture_Types
12090 * switches to state @ref Elm_Gesture_State.
12092 * Next, you need to implement the actual action that follows the input
12093 * in your callback.
12095 * Note that if you like to stop being reported about a gesture, just set
12096 * all callbacks referring this gesture to NULL.
12097 * (again with @ref elm_gesture_layer_cb_set)
12099 * The information reported by gesture layer to your callback is depending
12100 * on @ref Elm_Gesture_Types:
12101 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12102 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12103 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12105 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12106 * @ref ELM_GESTURE_MOMENTUM.
12108 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12109 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12110 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12111 * Note that we consider a flick as a line-gesture that should be completed
12112 * in flick-time-limit as defined in @ref Config.
12114 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12116 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12120 * @enum _Elm_Gesture_Types
12121 * Enum of supported gesture types.
12122 * @ingroup Elm_Gesture_Layer
12124 enum _Elm_Gesture_Types
12126 ELM_GESTURE_FIRST = 0,
12128 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12129 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12130 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12131 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12133 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12135 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12136 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12138 ELM_GESTURE_ZOOM, /**< Zoom */
12139 ELM_GESTURE_ROTATE, /**< Rotate */
12145 * @typedef Elm_Gesture_Types
12146 * gesture types enum
12147 * @ingroup Elm_Gesture_Layer
12149 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12152 * @enum _Elm_Gesture_State
12153 * Enum of gesture states.
12154 * @ingroup Elm_Gesture_Layer
12156 enum _Elm_Gesture_State
12158 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12159 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12160 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12161 ELM_GESTURE_STATE_END, /**< Gesture completed */
12162 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12166 * @typedef Elm_Gesture_State
12167 * gesture states enum
12168 * @ingroup Elm_Gesture_Layer
12170 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12173 * @struct _Elm_Gesture_Taps_Info
12174 * Struct holds taps info for user
12175 * @ingroup Elm_Gesture_Layer
12177 struct _Elm_Gesture_Taps_Info
12179 Evas_Coord x, y; /**< Holds center point between fingers */
12180 unsigned int n; /**< Number of fingers tapped */
12181 unsigned int timestamp; /**< event timestamp */
12185 * @typedef Elm_Gesture_Taps_Info
12186 * holds taps info for user
12187 * @ingroup Elm_Gesture_Layer
12189 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12192 * @struct _Elm_Gesture_Momentum_Info
12193 * Struct holds momentum info for user
12194 * x1 and y1 are not necessarily in sync
12195 * x1 holds x value of x direction starting point
12196 * and same holds for y1.
12197 * This is noticeable when doing V-shape movement
12198 * @ingroup Elm_Gesture_Layer
12200 struct _Elm_Gesture_Momentum_Info
12201 { /* Report line ends, timestamps, and momentum computed */
12202 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12203 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12204 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12205 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12207 unsigned int tx; /**< Timestamp of start of final x-swipe */
12208 unsigned int ty; /**< Timestamp of start of final y-swipe */
12210 Evas_Coord mx; /**< Momentum on X */
12211 Evas_Coord my; /**< Momentum on Y */
12215 * @typedef Elm_Gesture_Momentum_Info
12216 * holds momentum info for user
12217 * @ingroup Elm_Gesture_Layer
12219 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12222 * @struct _Elm_Gesture_Line_Info
12223 * Struct holds line info for user
12224 * @ingroup Elm_Gesture_Layer
12226 struct _Elm_Gesture_Line_Info
12227 { /* Report line ends, timestamps, and momentum computed */
12228 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12229 unsigned int n; /**< Number of fingers (lines) */
12230 /* FIXME should be radians, bot degrees */
12231 double angle; /**< Angle (direction) of lines */
12235 * @typedef Elm_Gesture_Line_Info
12236 * Holds line info for user
12237 * @ingroup Elm_Gesture_Layer
12239 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12242 * @struct _Elm_Gesture_Zoom_Info
12243 * Struct holds zoom info for user
12244 * @ingroup Elm_Gesture_Layer
12246 struct _Elm_Gesture_Zoom_Info
12248 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12249 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12250 double zoom; /**< Zoom value: 1.0 means no zoom */
12251 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12255 * @typedef Elm_Gesture_Zoom_Info
12256 * Holds zoom info for user
12257 * @ingroup Elm_Gesture_Layer
12259 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12262 * @struct _Elm_Gesture_Rotate_Info
12263 * Struct holds rotation info for user
12264 * @ingroup Elm_Gesture_Layer
12266 struct _Elm_Gesture_Rotate_Info
12268 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12269 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12270 double base_angle; /**< Holds start-angle */
12271 double angle; /**< Rotation value: 0.0 means no rotation */
12272 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12276 * @typedef Elm_Gesture_Rotate_Info
12277 * Holds rotation info for user
12278 * @ingroup Elm_Gesture_Layer
12280 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12283 * @typedef Elm_Gesture_Event_Cb
12284 * User callback used to stream gesture info from gesture layer
12285 * @param data user data
12286 * @param event_info gesture report info
12287 * Returns a flag field to be applied on the causing event.
12288 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12289 * upon the event, in an irreversible way.
12291 * @ingroup Elm_Gesture_Layer
12293 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12296 * Use function to set callbacks to be notified about
12297 * change of state of gesture.
12298 * When a user registers a callback with this function
12299 * this means this gesture has to be tested.
12301 * When ALL callbacks for a gesture are set to NULL
12302 * it means user isn't interested in gesture-state
12303 * and it will not be tested.
12305 * @param obj Pointer to gesture-layer.
12306 * @param idx The gesture you would like to track its state.
12307 * @param cb callback function pointer.
12308 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12309 * @param data user info to be sent to callback (usually, Smart Data)
12311 * @ingroup Elm_Gesture_Layer
12313 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);
12316 * Call this function to get repeat-events settings.
12318 * @param obj Pointer to gesture-layer.
12320 * @return repeat events settings.
12321 * @see elm_gesture_layer_hold_events_set()
12322 * @ingroup Elm_Gesture_Layer
12324 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12327 * This function called in order to make gesture-layer repeat events.
12328 * Set this of you like to get the raw events only if gestures were not detected.
12329 * Clear this if you like gesture layer to fwd events as testing gestures.
12331 * @param obj Pointer to gesture-layer.
12332 * @param r Repeat: TRUE/FALSE
12334 * @ingroup Elm_Gesture_Layer
12336 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12339 * This function sets step-value for zoom action.
12340 * Set step to any positive value.
12341 * Cancel step setting by setting to 0.0
12343 * @param obj Pointer to gesture-layer.
12344 * @param s new zoom step value.
12346 * @ingroup Elm_Gesture_Layer
12348 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12351 * This function sets step-value for rotate action.
12352 * Set step to any positive value.
12353 * Cancel step setting by setting to 0.0
12355 * @param obj Pointer to gesture-layer.
12356 * @param s new roatate step value.
12358 * @ingroup Elm_Gesture_Layer
12360 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12363 * This function called to attach gesture-layer to an Evas_Object.
12364 * @param obj Pointer to gesture-layer.
12365 * @param t Pointer to underlying object (AKA Target)
12367 * @return TRUE, FALSE on success, failure.
12369 * @ingroup Elm_Gesture_Layer
12371 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12374 * Call this function to construct a new gesture-layer object.
12375 * This does not activate the gesture layer. You have to
12376 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12378 * @param parent the parent object.
12380 * @return Pointer to new gesture-layer object.
12382 * @ingroup Elm_Gesture_Layer
12384 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12387 * @defgroup Thumb Thumb
12389 * @image html img/widget/thumb/preview-00.png
12390 * @image latex img/widget/thumb/preview-00.eps
12392 * A thumb object is used for displaying the thumbnail of an image or video.
12393 * You must have compiled Elementary with Ethumb_Client support and the DBus
12394 * service must be present and auto-activated in order to have thumbnails to
12397 * Once the thumbnail object becomes visible, it will check if there is a
12398 * previously generated thumbnail image for the file set on it. If not, it
12399 * will start generating this thumbnail.
12401 * Different config settings will cause different thumbnails to be generated
12402 * even on the same file.
12404 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12405 * Ethumb documentation to change this path, and to see other configuration
12408 * Signals that you can add callbacks for are:
12410 * - "clicked" - This is called when a user has clicked the thumb without dragging
12412 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12413 * - "press" - This is called when a user has pressed down the thumb.
12414 * - "generate,start" - The thumbnail generation started.
12415 * - "generate,stop" - The generation process stopped.
12416 * - "generate,error" - The generation failed.
12417 * - "load,error" - The thumbnail image loading failed.
12419 * available styles:
12423 * An example of use of thumbnail:
12425 * - @ref thumb_example_01
12429 * @addtogroup Thumb
12434 * @enum _Elm_Thumb_Animation_Setting
12435 * @typedef Elm_Thumb_Animation_Setting
12437 * Used to set if a video thumbnail is animating or not.
12441 typedef enum _Elm_Thumb_Animation_Setting
12443 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12444 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12445 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12446 ELM_THUMB_ANIMATION_LAST
12447 } Elm_Thumb_Animation_Setting;
12450 * Add a new thumb object to the parent.
12452 * @param parent The parent object.
12453 * @return The new object or NULL if it cannot be created.
12455 * @see elm_thumb_file_set()
12456 * @see elm_thumb_ethumb_client_get()
12460 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12462 * Reload thumbnail if it was generated before.
12464 * @param obj The thumb object to reload
12466 * This is useful if the ethumb client configuration changed, like its
12467 * size, aspect or any other property one set in the handle returned
12468 * by elm_thumb_ethumb_client_get().
12470 * If the options didn't change, the thumbnail won't be generated again, but
12471 * the old one will still be used.
12473 * @see elm_thumb_file_set()
12477 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12479 * Set the file that will be used as thumbnail.
12481 * @param obj The thumb object.
12482 * @param file The path to file that will be used as thumb.
12483 * @param key The key used in case of an EET file.
12485 * The file can be an image or a video (in that case, acceptable extensions are:
12486 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12487 * function elm_thumb_animate().
12489 * @see elm_thumb_file_get()
12490 * @see elm_thumb_reload()
12491 * @see elm_thumb_animate()
12495 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12497 * Get the image or video path and key used to generate the thumbnail.
12499 * @param obj The thumb object.
12500 * @param file Pointer to filename.
12501 * @param key Pointer to key.
12503 * @see elm_thumb_file_set()
12504 * @see elm_thumb_path_get()
12508 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12510 * Get the path and key to the image or video generated by ethumb.
12512 * One just need to make sure that the thumbnail was generated before getting
12513 * its path; otherwise, the path will be NULL. One way to do that is by asking
12514 * for the path when/after the "generate,stop" smart callback is called.
12516 * @param obj The thumb object.
12517 * @param file Pointer to thumb path.
12518 * @param key Pointer to thumb key.
12520 * @see elm_thumb_file_get()
12524 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12526 * Set the animation state for the thumb object. If its content is an animated
12527 * video, you may start/stop the animation or tell it to play continuously and
12530 * @param obj The thumb object.
12531 * @param setting The animation setting.
12533 * @see elm_thumb_file_set()
12537 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12539 * Get the animation state for the thumb object.
12541 * @param obj The thumb object.
12542 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12545 * @see elm_thumb_animate_set()
12549 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12551 * Get the ethumb_client handle so custom configuration can be made.
12553 * @return Ethumb_Client instance or NULL.
12555 * This must be called before the objects are created to be sure no object is
12556 * visible and no generation started.
12558 * Example of usage:
12561 * #include <Elementary.h>
12562 * #ifndef ELM_LIB_QUICKLAUNCH
12564 * elm_main(int argc, char **argv)
12566 * Ethumb_Client *client;
12568 * elm_need_ethumb();
12572 * client = elm_thumb_ethumb_client_get();
12575 * ERR("could not get ethumb_client");
12578 * ethumb_client_size_set(client, 100, 100);
12579 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12582 * // Create elm_thumb objects here
12592 * @note There's only one client handle for Ethumb, so once a configuration
12593 * change is done to it, any other request for thumbnails (for any thumbnail
12594 * object) will use that configuration. Thus, this configuration is global.
12598 EAPI void *elm_thumb_ethumb_client_get(void);
12600 * Get the ethumb_client connection state.
12602 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12605 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12607 * Make the thumbnail 'editable'.
12609 * @param obj Thumb object.
12610 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12612 * This means the thumbnail is a valid drag target for drag and drop, and can be
12613 * cut or pasted too.
12615 * @see elm_thumb_editable_get()
12619 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12621 * Make the thumbnail 'editable'.
12623 * @param obj Thumb object.
12624 * @return Editability.
12626 * This means the thumbnail is a valid drag target for drag and drop, and can be
12627 * cut or pasted too.
12629 * @see elm_thumb_editable_set()
12633 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12640 * @defgroup Hoversel Hoversel
12642 * @image html img/widget/hoversel/preview-00.png
12643 * @image latex img/widget/hoversel/preview-00.eps
12645 * A hoversel is a button that pops up a list of items (automatically
12646 * choosing the direction to display) that have a label and, optionally, an
12647 * icon to select from. It is a convenience widget to avoid the need to do
12648 * all the piecing together yourself. It is intended for a small number of
12649 * items in the hoversel menu (no more than 8), though is capable of many
12652 * Signals that you can add callbacks for are:
12653 * "clicked" - the user clicked the hoversel button and popped up the sel
12654 * "selected" - an item in the hoversel list is selected. event_info is the item
12655 * "dismissed" - the hover is dismissed
12657 * See @ref tutorial_hoversel for an example.
12660 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12662 * @brief Add a new Hoversel object
12664 * @param parent The parent object
12665 * @return The new object or NULL if it cannot be created
12667 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12669 * @brief This sets the hoversel to expand horizontally.
12671 * @param obj The hoversel object
12672 * @param horizontal If true, the hover will expand horizontally to the
12675 * @note The initial button will display horizontally regardless of this
12678 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12680 * @brief This returns whether the hoversel is set to expand horizontally.
12682 * @param obj The hoversel object
12683 * @return If true, the hover will expand horizontally to the right.
12685 * @see elm_hoversel_horizontal_set()
12687 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12689 * @brief Set the Hover parent
12691 * @param obj The hoversel object
12692 * @param parent The parent to use
12694 * Sets the hover parent object, the area that will be darkened when the
12695 * hoversel is clicked. Should probably be the window that the hoversel is
12696 * in. See @ref Hover objects for more information.
12698 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12700 * @brief Get the Hover parent
12702 * @param obj The hoversel object
12703 * @return The used parent
12705 * Gets the hover parent object.
12707 * @see elm_hoversel_hover_parent_set()
12709 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12711 * @brief Set the hoversel button label
12713 * @param obj The hoversel object
12714 * @param label The label text.
12716 * This sets the label of the button that is always visible (before it is
12717 * clicked and expanded).
12719 * @deprecated elm_object_text_set()
12721 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12723 * @brief Get the hoversel button label
12725 * @param obj The hoversel object
12726 * @return The label text.
12728 * @deprecated elm_object_text_get()
12730 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12732 * @brief Set the icon of the hoversel button
12734 * @param obj The hoversel object
12735 * @param icon The icon object
12737 * Sets the icon of the button that is always visible (before it is clicked
12738 * and expanded). Once the icon object is set, a previously set one will be
12739 * deleted, if you want to keep that old content object, use the
12740 * elm_hoversel_icon_unset() function.
12742 * @see elm_button_icon_set()
12744 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12746 * @brief Get the icon of the hoversel button
12748 * @param obj The hoversel object
12749 * @return The icon object
12751 * Get the icon of the button that is always visible (before it is clicked
12752 * and expanded). Also see elm_button_icon_get().
12754 * @see elm_hoversel_icon_set()
12756 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12758 * @brief Get and unparent the icon of the hoversel button
12760 * @param obj The hoversel object
12761 * @return The icon object that was being used
12763 * Unparent and return the icon of the button that is always visible
12764 * (before it is clicked and expanded).
12766 * @see elm_hoversel_icon_set()
12767 * @see elm_button_icon_unset()
12769 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12771 * @brief This triggers the hoversel popup from code, the same as if the user
12772 * had clicked the button.
12774 * @param obj The hoversel object
12776 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12778 * @brief This dismisses the hoversel popup as if the user had clicked
12779 * outside the hover.
12781 * @param obj The hoversel object
12783 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12785 * @brief Returns whether the hoversel is expanded.
12787 * @param obj The hoversel object
12788 * @return This will return EINA_TRUE if the hoversel is expanded or
12789 * EINA_FALSE if it is not expanded.
12791 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12793 * @brief This will remove all the children items from the hoversel.
12795 * @param obj The hoversel object
12797 * @warning Should @b not be called while the hoversel is active; use
12798 * elm_hoversel_expanded_get() to check first.
12800 * @see elm_hoversel_item_del_cb_set()
12801 * @see elm_hoversel_item_del()
12803 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12805 * @brief Get the list of items within the given hoversel.
12807 * @param obj The hoversel object
12808 * @return Returns a list of Elm_Hoversel_Item*
12810 * @see elm_hoversel_item_add()
12812 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12814 * @brief Add an item to the hoversel button
12816 * @param obj The hoversel object
12817 * @param label The text label to use for the item (NULL if not desired)
12818 * @param icon_file An image file path on disk to use for the icon or standard
12819 * icon name (NULL if not desired)
12820 * @param icon_type The icon type if relevant
12821 * @param func Convenience function to call when this item is selected
12822 * @param data Data to pass to item-related functions
12823 * @return A handle to the item added.
12825 * This adds an item to the hoversel to show when it is clicked. Note: if you
12826 * need to use an icon from an edje file then use
12827 * elm_hoversel_item_icon_set() right after the this function, and set
12828 * icon_file to NULL here.
12830 * For more information on what @p icon_file and @p icon_type are see the
12831 * @ref Icon "icon documentation".
12833 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);
12835 * @brief Delete an item from the hoversel
12837 * @param item The item to delete
12839 * This deletes the item from the hoversel (should not be called while the
12840 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12842 * @see elm_hoversel_item_add()
12843 * @see elm_hoversel_item_del_cb_set()
12845 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12847 * @brief Set the function to be called when an item from the hoversel is
12850 * @param item The item to set the callback on
12851 * @param func The function called
12853 * That function will receive these parameters:
12854 * @li void *item_data
12855 * @li Evas_Object *the_item_object
12856 * @li Elm_Hoversel_Item *the_object_struct
12858 * @see elm_hoversel_item_add()
12860 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12862 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12863 * that will be passed to associated function callbacks.
12865 * @param item The item to get the data from
12866 * @return The data pointer set with elm_hoversel_item_add()
12868 * @see elm_hoversel_item_add()
12870 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12872 * @brief This returns the label text of the given hoversel item.
12874 * @param item The item to get the label
12875 * @return The label text of the hoversel item
12877 * @see elm_hoversel_item_add()
12879 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12881 * @brief This sets the icon for the given hoversel item.
12883 * @param item The item to set the icon
12884 * @param icon_file An image file path on disk to use for the icon or standard
12886 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12887 * to NULL if the icon is not an edje file
12888 * @param icon_type The icon type
12890 * The icon can be loaded from the standard set, from an image file, or from
12893 * @see elm_hoversel_item_add()
12895 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);
12897 * @brief Get the icon object of the hoversel item
12899 * @param item The item to get the icon from
12900 * @param icon_file The image file path on disk used for the icon or standard
12902 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12903 * if the icon is not an edje file
12904 * @param icon_type The icon type
12906 * @see elm_hoversel_item_icon_set()
12907 * @see elm_hoversel_item_add()
12909 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);
12915 * @defgroup Toolbar Toolbar
12916 * @ingroup Elementary
12918 * @image html img/widget/toolbar/preview-00.png
12919 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12921 * @image html img/toolbar.png
12922 * @image latex img/toolbar.eps width=\textwidth
12924 * A toolbar is a widget that displays a list of items inside
12925 * a box. It can be scrollable, show a menu with items that don't fit
12926 * to toolbar size or even crop them.
12928 * Only one item can be selected at a time.
12930 * Items can have multiple states, or show menus when selected by the user.
12932 * Smart callbacks one can listen to:
12933 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12935 * Available styles for it:
12937 * - @c "transparent" - no background or shadow, just show the content
12939 * List of examples:
12940 * @li @ref toolbar_example_01
12941 * @li @ref toolbar_example_02
12942 * @li @ref toolbar_example_03
12946 * @addtogroup Toolbar
12951 * @enum _Elm_Toolbar_Shrink_Mode
12952 * @typedef Elm_Toolbar_Shrink_Mode
12954 * Set toolbar's items display behavior, it can be scrollabel,
12955 * show a menu with exceeding items, or simply hide them.
12957 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12960 * Values <b> don't </b> work as bitmask, only one can be choosen.
12962 * @see elm_toolbar_mode_shrink_set()
12963 * @see elm_toolbar_mode_shrink_get()
12967 typedef enum _Elm_Toolbar_Shrink_Mode
12969 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12970 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12971 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12972 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12973 } Elm_Toolbar_Shrink_Mode;
12975 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(). */
12977 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(). */
12980 * Add a new toolbar widget to the given parent Elementary
12981 * (container) object.
12983 * @param parent The parent object.
12984 * @return a new toolbar widget handle or @c NULL, on errors.
12986 * This function inserts a new toolbar widget on the canvas.
12990 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12993 * Set the icon size, in pixels, to be used by toolbar items.
12995 * @param obj The toolbar object
12996 * @param icon_size The icon size in pixels
12998 * @note Default value is @c 32. It reads value from elm config.
13000 * @see elm_toolbar_icon_size_get()
13004 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13007 * Get the icon size, in pixels, to be used by toolbar items.
13009 * @param obj The toolbar object.
13010 * @return The icon size in pixels.
13012 * @see elm_toolbar_icon_size_set() for details.
13016 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13019 * Sets icon lookup order, for toolbar items' icons.
13021 * @param obj The toolbar object.
13022 * @param order The icon lookup order.
13024 * Icons added before calling this function will not be affected.
13025 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13027 * @see elm_toolbar_icon_order_lookup_get()
13031 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13034 * Gets the icon lookup order.
13036 * @param obj The toolbar object.
13037 * @return The icon lookup order.
13039 * @see elm_toolbar_icon_order_lookup_set() for details.
13043 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13046 * Set whether the toolbar items' should be selected by the user or not.
13048 * @param obj The toolbar object.
13049 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13052 * This will turn off the ability to select items entirely and they will
13053 * neither appear selected nor emit selected signals. The clicked
13054 * callback function will still be called.
13056 * Selection is enabled by default.
13058 * @see elm_toolbar_no_select_mode_get().
13062 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13065 * Set whether the toolbar items' should be selected by the user or not.
13067 * @param obj The toolbar object.
13068 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13069 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13071 * @see elm_toolbar_no_select_mode_set() for details.
13075 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13078 * Append item to the toolbar.
13080 * @param obj The toolbar object.
13081 * @param icon A string with icon name or the absolute path of an image file.
13082 * @param label The label of the item.
13083 * @param func The function to call when the item is clicked.
13084 * @param data The data to associate with the item for related callbacks.
13085 * @return The created item or @c NULL upon failure.
13087 * A new item will be created and appended to the toolbar, i.e., will
13088 * be set as @b last item.
13090 * Items created with this method can be deleted with
13091 * elm_toolbar_item_del().
13093 * Associated @p data can be properly freed when item is deleted if a
13094 * callback function is set with elm_toolbar_item_del_cb_set().
13096 * If a function is passed as argument, it will be called everytime this item
13097 * is selected, i.e., the user clicks over an unselected item.
13098 * If such function isn't needed, just passing
13099 * @c NULL as @p func is enough. The same should be done for @p data.
13101 * Toolbar will load icon image from fdo or current theme.
13102 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13103 * If an absolute path is provided it will load it direct from a file.
13105 * @see elm_toolbar_item_icon_set()
13106 * @see elm_toolbar_item_del()
13107 * @see elm_toolbar_item_del_cb_set()
13111 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);
13114 * Prepend item to the toolbar.
13116 * @param obj The toolbar object.
13117 * @param icon A string with icon name or the absolute path of an image file.
13118 * @param label The label of the item.
13119 * @param func The function to call when the item is clicked.
13120 * @param data The data to associate with the item for related callbacks.
13121 * @return The created item or @c NULL upon failure.
13123 * A new item will be created and prepended to the toolbar, i.e., will
13124 * be set as @b first item.
13126 * Items created with this method can be deleted with
13127 * elm_toolbar_item_del().
13129 * Associated @p data can be properly freed when item is deleted if a
13130 * callback function is set with elm_toolbar_item_del_cb_set().
13132 * If a function is passed as argument, it will be called everytime this item
13133 * is selected, i.e., the user clicks over an unselected item.
13134 * If such function isn't needed, just passing
13135 * @c NULL as @p func is enough. The same should be done for @p data.
13137 * Toolbar will load icon image from fdo or current theme.
13138 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13139 * If an absolute path is provided it will load it direct from a file.
13141 * @see elm_toolbar_item_icon_set()
13142 * @see elm_toolbar_item_del()
13143 * @see elm_toolbar_item_del_cb_set()
13147 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);
13150 * Insert a new item into the toolbar object before item @p before.
13152 * @param obj The toolbar object.
13153 * @param before The toolbar item to insert before.
13154 * @param icon A string with icon name or the absolute path of an image file.
13155 * @param label The label of the item.
13156 * @param func The function to call when the item is clicked.
13157 * @param data The data to associate with the item for related callbacks.
13158 * @return The created item or @c NULL upon failure.
13160 * A new item will be created and added to the toolbar. Its position in
13161 * this toolbar will be just before item @p before.
13163 * Items created with this method can be deleted with
13164 * elm_toolbar_item_del().
13166 * Associated @p data can be properly freed when item is deleted if a
13167 * callback function is set with elm_toolbar_item_del_cb_set().
13169 * If a function is passed as argument, it will be called everytime this item
13170 * is selected, i.e., the user clicks over an unselected item.
13171 * If such function isn't needed, just passing
13172 * @c NULL as @p func is enough. The same should be done for @p data.
13174 * Toolbar will load icon image from fdo or current theme.
13175 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13176 * If an absolute path is provided it will load it direct from a file.
13178 * @see elm_toolbar_item_icon_set()
13179 * @see elm_toolbar_item_del()
13180 * @see elm_toolbar_item_del_cb_set()
13184 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);
13187 * Insert a new item into the toolbar object after item @p after.
13189 * @param obj The toolbar object.
13190 * @param before The toolbar item to insert before.
13191 * @param icon A string with icon name or the absolute path of an image file.
13192 * @param label The label of the item.
13193 * @param func The function to call when the item is clicked.
13194 * @param data The data to associate with the item for related callbacks.
13195 * @return The created item or @c NULL upon failure.
13197 * A new item will be created and added to the toolbar. Its position in
13198 * this toolbar will be just after item @p after.
13200 * Items created with this method can be deleted with
13201 * elm_toolbar_item_del().
13203 * Associated @p data can be properly freed when item is deleted if a
13204 * callback function is set with elm_toolbar_item_del_cb_set().
13206 * If a function is passed as argument, it will be called everytime this item
13207 * is selected, i.e., the user clicks over an unselected item.
13208 * If such function isn't needed, just passing
13209 * @c NULL as @p func is enough. The same should be done for @p data.
13211 * Toolbar will load icon image from fdo or current theme.
13212 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13213 * If an absolute path is provided it will load it direct from a file.
13215 * @see elm_toolbar_item_icon_set()
13216 * @see elm_toolbar_item_del()
13217 * @see elm_toolbar_item_del_cb_set()
13221 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);
13224 * Get the first item in the given toolbar widget's list of
13227 * @param obj The toolbar object
13228 * @return The first item or @c NULL, if it has no items (and on
13231 * @see elm_toolbar_item_append()
13232 * @see elm_toolbar_last_item_get()
13236 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13239 * Get the last item in the given toolbar widget's list of
13242 * @param obj The toolbar object
13243 * @return The last item or @c NULL, if it has no items (and on
13246 * @see elm_toolbar_item_prepend()
13247 * @see elm_toolbar_first_item_get()
13251 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13254 * Get the item after @p item in toolbar.
13256 * @param item The toolbar item.
13257 * @return The item after @p item, or @c NULL if none or on failure.
13259 * @note If it is the last item, @c NULL will be returned.
13261 * @see elm_toolbar_item_append()
13265 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13268 * Get the item before @p item in toolbar.
13270 * @param item The toolbar item.
13271 * @return The item before @p item, or @c NULL if none or on failure.
13273 * @note If it is the first item, @c NULL will be returned.
13275 * @see elm_toolbar_item_prepend()
13279 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13282 * Get the toolbar object from an item.
13284 * @param item The item.
13285 * @return The toolbar object.
13287 * This returns the toolbar object itself that an item belongs to.
13291 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13294 * Set the priority of a toolbar item.
13296 * @param item The toolbar item.
13297 * @param priority The item priority. The default is zero.
13299 * This is used only when the toolbar shrink mode is set to
13300 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13301 * When space is less than required, items with low priority
13302 * will be removed from the toolbar and added to a dynamically-created menu,
13303 * while items with higher priority will remain on the toolbar,
13304 * with the same order they were added.
13306 * @see elm_toolbar_item_priority_get()
13310 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13313 * Get the priority of a toolbar item.
13315 * @param item The toolbar item.
13316 * @return The @p item priority, or @c 0 on failure.
13318 * @see elm_toolbar_item_priority_set() for details.
13322 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13325 * Get the label of item.
13327 * @param item The item of toolbar.
13328 * @return The label of item.
13330 * The return value is a pointer to the label associated to @p item when
13331 * it was created, with function elm_toolbar_item_append() or similar,
13333 * with function elm_toolbar_item_label_set. If no label
13334 * was passed as argument, it will return @c NULL.
13336 * @see elm_toolbar_item_label_set() for more details.
13337 * @see elm_toolbar_item_append()
13341 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13344 * Set the label of item.
13346 * @param item The item of toolbar.
13347 * @param text The label of item.
13349 * The label to be displayed by the item.
13350 * Label will be placed at icons bottom (if set).
13352 * If a label was passed as argument on item creation, with function
13353 * elm_toolbar_item_append() or similar, it will be already
13354 * displayed by the item.
13356 * @see elm_toolbar_item_label_get()
13357 * @see elm_toolbar_item_append()
13361 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13364 * Return the data associated with a given toolbar widget item.
13366 * @param item The toolbar widget item handle.
13367 * @return The data associated with @p item.
13369 * @see elm_toolbar_item_data_set()
13373 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13376 * Set the data associated with a given toolbar widget item.
13378 * @param item The toolbar widget item handle.
13379 * @param data The new data pointer to set to @p item.
13381 * This sets new item data on @p item.
13383 * @warning The old data pointer won't be touched by this function, so
13384 * the user had better to free that old data himself/herself.
13388 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13391 * Returns a pointer to a toolbar item by its label.
13393 * @param obj The toolbar object.
13394 * @param label The label of the item to find.
13396 * @return The pointer to the toolbar item matching @p label or @c NULL
13401 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13404 * Get whether the @p item is selected or not.
13406 * @param item The toolbar item.
13407 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13408 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13410 * @see elm_toolbar_selected_item_set() for details.
13411 * @see elm_toolbar_item_selected_get()
13415 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13418 * Set the selected state of an item.
13420 * @param item The toolbar item
13421 * @param selected The selected state
13423 * This sets the selected state of the given item @p it.
13424 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13426 * If a new item is selected the previosly selected will be unselected.
13427 * Previoulsy selected item can be get with function
13428 * elm_toolbar_selected_item_get().
13430 * Selected items will be highlighted.
13432 * @see elm_toolbar_item_selected_get()
13433 * @see elm_toolbar_selected_item_get()
13437 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13440 * Get the selected item.
13442 * @param obj The toolbar object.
13443 * @return The selected toolbar item.
13445 * The selected item can be unselected with function
13446 * elm_toolbar_item_selected_set().
13448 * The selected item always will be highlighted on toolbar.
13450 * @see elm_toolbar_selected_items_get()
13454 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13457 * Set the icon associated with @p item.
13459 * @param obj The parent of this item.
13460 * @param item The toolbar item.
13461 * @param icon A string with icon name or the absolute path of an image file.
13463 * Toolbar will load icon image from fdo or current theme.
13464 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13465 * If an absolute path is provided it will load it direct from a file.
13467 * @see elm_toolbar_icon_order_lookup_set()
13468 * @see elm_toolbar_icon_order_lookup_get()
13472 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13475 * Get the string used to set the icon of @p item.
13477 * @param item The toolbar item.
13478 * @return The string associated with the icon object.
13480 * @see elm_toolbar_item_icon_set() for details.
13484 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13487 * Delete them item from the toolbar.
13489 * @param item The item of toolbar to be deleted.
13491 * @see elm_toolbar_item_append()
13492 * @see elm_toolbar_item_del_cb_set()
13496 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13499 * Set the function called when a toolbar item is freed.
13501 * @param item The item to set the callback on.
13502 * @param func The function called.
13504 * If there is a @p func, then it will be called prior item's memory release.
13505 * That will be called with the following arguments:
13507 * @li item's Evas object;
13510 * This way, a data associated to a toolbar item could be properly freed.
13514 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13517 * Get a value whether toolbar item is disabled or not.
13519 * @param item The item.
13520 * @return The disabled state.
13522 * @see elm_toolbar_item_disabled_set() for more details.
13526 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13529 * Sets the disabled/enabled state of a toolbar item.
13531 * @param item The item.
13532 * @param disabled The disabled state.
13534 * A disabled item cannot be selected or unselected. It will also
13535 * change its appearance (generally greyed out). This sets the
13536 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13541 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13544 * Set or unset item as a separator.
13546 * @param item The toolbar item.
13547 * @param setting @c EINA_TRUE to set item @p item as separator or
13548 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13550 * Items aren't set as separator by default.
13552 * If set as separator it will display separator theme, so won't display
13555 * @see elm_toolbar_item_separator_get()
13559 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13562 * Get a value whether item is a separator or not.
13564 * @param item The toolbar item.
13565 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13566 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13568 * @see elm_toolbar_item_separator_set() for details.
13572 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13575 * Set the shrink state of toolbar @p obj.
13577 * @param obj The toolbar object.
13578 * @param shrink_mode Toolbar's items display behavior.
13580 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13581 * but will enforce a minimun size so all the items will fit, won't scroll
13582 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13583 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13584 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13588 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13591 * Get the shrink mode of toolbar @p obj.
13593 * @param obj The toolbar object.
13594 * @return Toolbar's items display behavior.
13596 * @see elm_toolbar_mode_shrink_set() for details.
13600 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13603 * Enable/disable homogenous mode.
13605 * @param obj The toolbar object
13606 * @param homogeneous Assume the items within the toolbar are of the
13607 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13609 * This will enable the homogeneous mode where items are of the same size.
13610 * @see elm_toolbar_homogeneous_get()
13614 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13617 * Get whether the homogenous mode is enabled.
13619 * @param obj The toolbar object.
13620 * @return Assume the items within the toolbar are of the same height
13621 * and width (EINA_TRUE = on, EINA_FALSE = off).
13623 * @see elm_toolbar_homogeneous_set()
13627 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13630 * Enable/disable homogenous mode.
13632 * @param obj The toolbar object
13633 * @param homogeneous Assume the items within the toolbar are of the
13634 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13636 * This will enable the homogeneous mode where items are of the same size.
13637 * @see elm_toolbar_homogeneous_get()
13639 * @deprecated use elm_toolbar_homogeneous_set() instead.
13643 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13646 * Get whether the homogenous mode is enabled.
13648 * @param obj The toolbar object.
13649 * @return Assume the items within the toolbar are of the same height
13650 * and width (EINA_TRUE = on, EINA_FALSE = off).
13652 * @see elm_toolbar_homogeneous_set()
13653 * @deprecated use elm_toolbar_homogeneous_get() instead.
13657 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13660 * Set the parent object of the toolbar items' menus.
13662 * @param obj The toolbar object.
13663 * @param parent The parent of the menu objects.
13665 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13667 * For more details about setting the parent for toolbar menus, see
13668 * elm_menu_parent_set().
13670 * @see elm_menu_parent_set() for details.
13671 * @see elm_toolbar_item_menu_set() for details.
13675 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13678 * Get the parent object of the toolbar items' menus.
13680 * @param obj The toolbar object.
13681 * @return The parent of the menu objects.
13683 * @see elm_toolbar_menu_parent_set() for details.
13687 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13690 * Set the alignment of the items.
13692 * @param obj The toolbar object.
13693 * @param align The new alignment, a float between <tt> 0.0 </tt>
13694 * and <tt> 1.0 </tt>.
13696 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13697 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13700 * Centered items by default.
13702 * @see elm_toolbar_align_get()
13706 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13709 * Get the alignment of the items.
13711 * @param obj The toolbar object.
13712 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13715 * @see elm_toolbar_align_set() for details.
13719 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13722 * Set whether the toolbar item opens a menu.
13724 * @param item The toolbar item.
13725 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13727 * A toolbar item can be set to be a menu, using this function.
13729 * Once it is set to be a menu, it can be manipulated through the
13730 * menu-like function elm_toolbar_menu_parent_set() and the other
13731 * elm_menu functions, using the Evas_Object @c menu returned by
13732 * elm_toolbar_item_menu_get().
13734 * So, items to be displayed in this item's menu should be added with
13735 * elm_menu_item_add().
13737 * The following code exemplifies the most basic usage:
13739 * tb = elm_toolbar_add(win)
13740 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13741 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13742 * elm_toolbar_menu_parent_set(tb, win);
13743 * menu = elm_toolbar_item_menu_get(item);
13744 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13745 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13749 * @see elm_toolbar_item_menu_get()
13753 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13756 * Get toolbar item's menu.
13758 * @param item The toolbar item.
13759 * @return Item's menu object or @c NULL on failure.
13761 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13762 * this function will set it.
13764 * @see elm_toolbar_item_menu_set() for details.
13768 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13771 * Add a new state to @p item.
13773 * @param item The item.
13774 * @param icon A string with icon name or the absolute path of an image file.
13775 * @param label The label of the new state.
13776 * @param func The function to call when the item is clicked when this
13777 * state is selected.
13778 * @param data The data to associate with the state.
13779 * @return The toolbar item state, or @c NULL upon failure.
13781 * Toolbar will load icon image from fdo or current theme.
13782 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13783 * If an absolute path is provided it will load it direct from a file.
13785 * States created with this function can be removed with
13786 * elm_toolbar_item_state_del().
13788 * @see elm_toolbar_item_state_del()
13789 * @see elm_toolbar_item_state_sel()
13790 * @see elm_toolbar_item_state_get()
13794 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);
13797 * Delete a previoulsy added state to @p item.
13799 * @param item The toolbar item.
13800 * @param state The state to be deleted.
13801 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13803 * @see elm_toolbar_item_state_add()
13805 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13808 * Set @p state as the current state of @p it.
13810 * @param it The item.
13811 * @param state The state to use.
13812 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13814 * If @p state is @c NULL, it won't select any state and the default item's
13815 * icon and label will be used. It's the same behaviour than
13816 * elm_toolbar_item_state_unser().
13818 * @see elm_toolbar_item_state_unset()
13822 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13825 * Unset the state of @p it.
13827 * @param it The item.
13829 * The default icon and label from this item will be displayed.
13831 * @see elm_toolbar_item_state_set() for more details.
13835 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13838 * Get the current state of @p it.
13840 * @param item The item.
13841 * @return The selected state or @c NULL if none is selected or on failure.
13843 * @see elm_toolbar_item_state_set() for details.
13844 * @see elm_toolbar_item_state_unset()
13845 * @see elm_toolbar_item_state_add()
13849 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13852 * Get the state after selected state in toolbar's @p item.
13854 * @param it The toolbar item to change state.
13855 * @return The state after current state, or @c NULL on failure.
13857 * If last state is selected, this function will return first state.
13859 * @see elm_toolbar_item_state_set()
13860 * @see elm_toolbar_item_state_add()
13864 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13867 * Get the state before selected state in toolbar's @p item.
13869 * @param it The toolbar item to change state.
13870 * @return The state before current state, or @c NULL on failure.
13872 * If first state is selected, this function will return last state.
13874 * @see elm_toolbar_item_state_set()
13875 * @see elm_toolbar_item_state_add()
13879 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13882 * Set the text to be shown in a given toolbar item's tooltips.
13884 * @param item Target item.
13885 * @param text The text to set in the content.
13887 * Setup the text as tooltip to object. The item can have only one tooltip,
13888 * so any previous tooltip data - set with this function or
13889 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13891 * @see elm_object_tooltip_text_set() for more details.
13895 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13898 * Set the content to be shown in the tooltip item.
13900 * Setup the tooltip to item. The item can have only one tooltip,
13901 * so any previous tooltip data is removed. @p func(with @p data) will
13902 * be called every time that need show the tooltip and it should
13903 * return a valid Evas_Object. This object is then managed fully by
13904 * tooltip system and is deleted when the tooltip is gone.
13906 * @param item the toolbar item being attached a tooltip.
13907 * @param func the function used to create the tooltip contents.
13908 * @param data what to provide to @a func as callback data/context.
13909 * @param del_cb called when data is not needed anymore, either when
13910 * another callback replaces @a func, the tooltip is unset with
13911 * elm_toolbar_item_tooltip_unset() or the owner @a item
13912 * dies. This callback receives as the first parameter the
13913 * given @a data, and @c event_info is the item.
13915 * @see elm_object_tooltip_content_cb_set() for more details.
13919 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);
13922 * Unset tooltip from item.
13924 * @param item toolbar item to remove previously set tooltip.
13926 * Remove tooltip from item. The callback provided as del_cb to
13927 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13928 * it is not used anymore.
13930 * @see elm_object_tooltip_unset() for more details.
13931 * @see elm_toolbar_item_tooltip_content_cb_set()
13935 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13938 * Sets a different style for this item tooltip.
13940 * @note before you set a style you should define a tooltip with
13941 * elm_toolbar_item_tooltip_content_cb_set() or
13942 * elm_toolbar_item_tooltip_text_set()
13944 * @param item toolbar item with tooltip already set.
13945 * @param style the theme style to use (default, transparent, ...)
13947 * @see elm_object_tooltip_style_set() for more details.
13951 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13954 * Get the style for this item tooltip.
13956 * @param item toolbar item with tooltip already set.
13957 * @return style the theme style in use, defaults to "default". If the
13958 * object does not have a tooltip set, then NULL is returned.
13960 * @see elm_object_tooltip_style_get() for more details.
13961 * @see elm_toolbar_item_tooltip_style_set()
13965 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13968 * Set the type of mouse pointer/cursor decoration to be shown,
13969 * when the mouse pointer is over the given toolbar widget item
13971 * @param item toolbar item to customize cursor on
13972 * @param cursor the cursor type's name
13974 * This function works analogously as elm_object_cursor_set(), but
13975 * here the cursor's changing area is restricted to the item's
13976 * area, and not the whole widget's. Note that that item cursors
13977 * have precedence over widget cursors, so that a mouse over an
13978 * item with custom cursor set will always show @b that cursor.
13980 * If this function is called twice for an object, a previously set
13981 * cursor will be unset on the second call.
13983 * @see elm_object_cursor_set()
13984 * @see elm_toolbar_item_cursor_get()
13985 * @see elm_toolbar_item_cursor_unset()
13989 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13992 * Get the type of mouse pointer/cursor decoration set to be shown,
13993 * when the mouse pointer is over the given toolbar widget item
13995 * @param item toolbar item with custom cursor set
13996 * @return the cursor type's name or @c NULL, if no custom cursors
13997 * were set to @p item (and on errors)
13999 * @see elm_object_cursor_get()
14000 * @see elm_toolbar_item_cursor_set()
14001 * @see elm_toolbar_item_cursor_unset()
14005 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14008 * Unset any custom mouse pointer/cursor decoration set to be
14009 * shown, when the mouse pointer is over the given toolbar widget
14010 * item, thus making it show the @b default cursor again.
14012 * @param item a toolbar item
14014 * Use this call to undo any custom settings on this item's cursor
14015 * decoration, bringing it back to defaults (no custom style set).
14017 * @see elm_object_cursor_unset()
14018 * @see elm_toolbar_item_cursor_set()
14022 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14025 * Set a different @b style for a given custom cursor set for a
14028 * @param item toolbar item with custom cursor set
14029 * @param style the <b>theme style</b> to use (e.g. @c "default",
14030 * @c "transparent", etc)
14032 * This function only makes sense when one is using custom mouse
14033 * cursor decorations <b>defined in a theme file</b>, which can have,
14034 * given a cursor name/type, <b>alternate styles</b> on it. It
14035 * works analogously as elm_object_cursor_style_set(), but here
14036 * applyed only to toolbar item objects.
14038 * @warning Before you set a cursor style you should have definen a
14039 * custom cursor previously on the item, with
14040 * elm_toolbar_item_cursor_set()
14042 * @see elm_toolbar_item_cursor_engine_only_set()
14043 * @see elm_toolbar_item_cursor_style_get()
14047 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14050 * Get the current @b style set for a given toolbar item's custom
14053 * @param item toolbar item with custom cursor set.
14054 * @return style the cursor style in use. If the object does not
14055 * have a cursor set, then @c NULL is returned.
14057 * @see elm_toolbar_item_cursor_style_set() for more details
14061 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14064 * Set if the (custom)cursor for a given toolbar item should be
14065 * searched in its theme, also, or should only rely on the
14066 * rendering engine.
14068 * @param item item with custom (custom) cursor already set on
14069 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14070 * only on those provided by the rendering engine, @c EINA_FALSE to
14071 * have them searched on the widget's theme, as well.
14073 * @note This call is of use only if you've set a custom cursor
14074 * for toolbar items, with elm_toolbar_item_cursor_set().
14076 * @note By default, cursors will only be looked for between those
14077 * provided by the rendering engine.
14081 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14084 * Get if the (custom) cursor for a given toolbar item is being
14085 * searched in its theme, also, or is only relying on the rendering
14088 * @param item a toolbar item
14089 * @return @c EINA_TRUE, if cursors are being looked for only on
14090 * those provided by the rendering engine, @c EINA_FALSE if they
14091 * are being searched on the widget's theme, as well.
14093 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14097 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14100 * Change a toolbar's orientation
14101 * @param obj The toolbar object
14102 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14103 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14106 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14109 * Get a toolbar's orientation
14110 * @param obj The toolbar object
14111 * @return If @c EINA_TRUE, the toolbar is vertical
14112 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14115 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14122 * @defgroup Tooltips Tooltips
14124 * The Tooltip is an (internal, for now) smart object used to show a
14125 * content in a frame on mouse hover of objects(or widgets), with
14126 * tips/information about them.
14131 EAPI double elm_tooltip_delay_get(void);
14132 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14133 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14134 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14135 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14136 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);
14137 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14138 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14139 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14140 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14141 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14148 * @defgroup Cursors Cursors
14150 * The Elementary cursor is an internal smart object used to
14151 * customize the mouse cursor displayed over objects (or
14152 * widgets). In the most common scenario, the cursor decoration
14153 * comes from the graphical @b engine Elementary is running
14154 * on. Those engines may provide different decorations for cursors,
14155 * and Elementary provides functions to choose them (think of X11
14156 * cursors, as an example).
14158 * There's also the possibility of, besides using engine provided
14159 * cursors, also use ones coming from Edje theming files. Both
14160 * globally and per widget, Elementary makes it possible for one to
14161 * make the cursors lookup to be held on engines only or on
14162 * Elementary's theme file, too.
14168 * Set the cursor to be shown when mouse is over the object
14170 * Set the cursor that will be displayed when mouse is over the
14171 * object. The object can have only one cursor set to it, so if
14172 * this function is called twice for an object, the previous set
14174 * If using X cursors, a definition of all the valid cursor names
14175 * is listed on Elementary_Cursors.h. If an invalid name is set
14176 * the default cursor will be used.
14178 * @param obj the object being set a cursor.
14179 * @param cursor the cursor name to be used.
14183 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14186 * Get the cursor to be shown when mouse is over the object
14188 * @param obj an object with cursor already set.
14189 * @return the cursor name.
14193 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14196 * Unset cursor for object
14198 * Unset cursor for object, and set the cursor to default if the mouse
14199 * was over this object.
14201 * @param obj Target object
14202 * @see elm_object_cursor_set()
14206 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14209 * Sets a different style for this object cursor.
14211 * @note before you set a style you should define a cursor with
14212 * elm_object_cursor_set()
14214 * @param obj an object with cursor already set.
14215 * @param style the theme style to use (default, transparent, ...)
14219 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14222 * Get the style for this object cursor.
14224 * @param obj an object with cursor already set.
14225 * @return style the theme style in use, defaults to "default". If the
14226 * object does not have a cursor set, then NULL is returned.
14230 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14233 * Set if the cursor set should be searched on the theme or should use
14234 * the provided by the engine, only.
14236 * @note before you set if should look on theme you should define a cursor
14237 * with elm_object_cursor_set(). By default it will only look for cursors
14238 * provided by the engine.
14240 * @param obj an object with cursor already set.
14241 * @param engine_only boolean to define it cursors should be looked only
14242 * between the provided by the engine or searched on widget's theme as well.
14246 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14249 * Get the cursor engine only usage for this object cursor.
14251 * @param obj an object with cursor already set.
14252 * @return engine_only boolean to define it cursors should be
14253 * looked only between the provided by the engine or searched on
14254 * widget's theme as well. If the object does not have a cursor
14255 * set, then EINA_FALSE is returned.
14259 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14262 * Get the configured cursor engine only usage
14264 * This gets the globally configured exclusive usage of engine cursors.
14266 * @return 1 if only engine cursors should be used
14269 EAPI int elm_cursor_engine_only_get(void);
14272 * Set the configured cursor engine only usage
14274 * This sets the globally configured exclusive usage of engine cursors.
14275 * It won't affect cursors set before changing this value.
14277 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14278 * look for them on theme before.
14279 * @return EINA_TRUE if value is valid and setted (0 or 1)
14282 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14289 * @defgroup Menu Menu
14291 * @image html img/widget/menu/preview-00.png
14292 * @image latex img/widget/menu/preview-00.eps
14294 * A menu is a list of items displayed above its parent. When the menu is
14295 * showing its parent is darkened. Each item can have a sub-menu. The menu
14296 * object can be used to display a menu on a right click event, in a toolbar,
14299 * Signals that you can add callbacks for are:
14300 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14301 * event_info is NULL.
14303 * @see @ref tutorial_menu
14306 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14308 * @brief Add a new menu to the parent
14310 * @param parent The parent object.
14311 * @return The new object or NULL if it cannot be created.
14313 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14315 * @brief Set the parent for the given menu widget
14317 * @param obj The menu object.
14318 * @param parent The new parent.
14320 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14322 * @brief Get the parent for the given menu widget
14324 * @param obj The menu object.
14325 * @return The parent.
14327 * @see elm_menu_parent_set()
14329 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14331 * @brief Move the menu to a new position
14333 * @param obj The menu object.
14334 * @param x The new position.
14335 * @param y The new position.
14337 * Sets the top-left position of the menu to (@p x,@p y).
14339 * @note @p x and @p y coordinates are relative to parent.
14341 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14343 * @brief Close a opened menu
14345 * @param obj the menu object
14348 * Hides the menu and all it's sub-menus.
14350 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14352 * @brief Returns a list of @p item's items.
14354 * @param obj The menu object
14355 * @return An Eina_List* of @p item's items
14357 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14359 * @brief Get the Evas_Object of an Elm_Menu_Item
14361 * @param item The menu item object.
14362 * @return The edje object containing the swallowed content
14364 * @warning Don't manipulate this object!
14366 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14368 * @brief Add an item at the end of the given menu widget
14370 * @param obj The menu object.
14371 * @param parent The parent menu item (optional)
14372 * @param icon A icon display on the item. The icon will be destryed by the menu.
14373 * @param label The label of the item.
14374 * @param func Function called when the user select the item.
14375 * @param data Data sent by the callback.
14376 * @return Returns the new item.
14378 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);
14380 * @brief Add an object swallowed in an item at the end of the given menu
14383 * @param obj The menu object.
14384 * @param parent The parent menu item (optional)
14385 * @param subobj The object to swallow
14386 * @param func Function called when the user select the item.
14387 * @param data Data sent by the callback.
14388 * @return Returns the new item.
14390 * Add an evas object as an item to the menu.
14392 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);
14394 * @brief Set the label of a menu item
14396 * @param item The menu item object.
14397 * @param label The label to set for @p item
14399 * @warning Don't use this funcion on items created with
14400 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14402 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14404 * @brief Get the label of a menu item
14406 * @param item The menu item object.
14407 * @return The label of @p item
14409 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14411 * @brief Set the icon of a menu item to the standard icon with name @p icon
14413 * @param item The menu item object.
14414 * @param icon The icon object to set for the content of @p item
14416 * Once this icon is set, any previously set icon will be deleted.
14418 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14420 * @brief Get the string representation from the icon of a menu item
14422 * @param item The menu item object.
14423 * @return The string representation of @p item's icon or NULL
14425 * @see elm_menu_item_object_icon_name_set()
14427 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14429 * @brief Set the content object of a menu item
14431 * @param item The menu item object
14432 * @param The content object or NULL
14433 * @return EINA_TRUE on success, else EINA_FALSE
14435 * Use this function to change the object swallowed by a menu item, deleting
14436 * any previously swallowed object.
14438 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14440 * @brief Get the content object of a menu item
14442 * @param item The menu item object
14443 * @return The content object or NULL
14444 * @note If @p item was added with elm_menu_item_add_object, this
14445 * function will return the object passed, else it will return the
14448 * @see elm_menu_item_object_content_set()
14450 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14452 * @brief Set the selected state of @p item.
14454 * @param item The menu item object.
14455 * @param selected The selected/unselected state of the item
14457 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14459 * @brief Get the selected state of @p item.
14461 * @param item The menu item object.
14462 * @return The selected/unselected state of the item
14464 * @see elm_menu_item_selected_set()
14466 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14468 * @brief Set the disabled state of @p item.
14470 * @param item The menu item object.
14471 * @param disabled The enabled/disabled state of the item
14473 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14475 * @brief Get the disabled state of @p item.
14477 * @param item The menu item object.
14478 * @return The enabled/disabled state of the item
14480 * @see elm_menu_item_disabled_set()
14482 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14484 * @brief Add a separator item to menu @p obj under @p parent.
14486 * @param obj The menu object
14487 * @param parent The item to add the separator under
14488 * @return The created item or NULL on failure
14490 * This is item is a @ref Separator.
14492 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14494 * @brief Returns whether @p item is a separator.
14496 * @param item The item to check
14497 * @return If true, @p item is a separator
14499 * @see elm_menu_item_separator_add()
14501 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14503 * @brief Deletes an item from the menu.
14505 * @param item The item to delete.
14507 * @see elm_menu_item_add()
14509 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14511 * @brief Set the function called when a menu item is deleted.
14513 * @param item The item to set the callback on
14514 * @param func The function called
14516 * @see elm_menu_item_add()
14517 * @see elm_menu_item_del()
14519 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14521 * @brief Returns the data associated with menu item @p item.
14523 * @param item The item
14524 * @return The data associated with @p item or NULL if none was set.
14526 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14528 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14530 * @brief Sets the data to be associated with menu item @p item.
14532 * @param item The item
14533 * @param data The data to be associated with @p item
14535 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14537 * @brief Returns a list of @p item's subitems.
14539 * @param item The item
14540 * @return An Eina_List* of @p item's subitems
14542 * @see elm_menu_add()
14544 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14546 * @brief Get the position of a menu item
14548 * @param item The menu item
14549 * @return The item's index
14551 * This function returns the index position of a menu item in a menu.
14552 * For a sub-menu, this number is relative to the first item in the sub-menu.
14554 * @note Index values begin with 0
14556 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14558 * @brief @brief Return a menu item's owner menu
14560 * @param item The menu item
14561 * @return The menu object owning @p item, or NULL on failure
14563 * Use this function to get the menu object owning an item.
14565 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14567 * @brief Get the selected item in the menu
14569 * @param obj The menu object
14570 * @return The selected item, or NULL if none
14572 * @see elm_menu_item_selected_get()
14573 * @see elm_menu_item_selected_set()
14575 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14577 * @brief Get the last item in the menu
14579 * @param obj The menu object
14580 * @return The last item, or NULL if none
14582 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14584 * @brief Get the first item in the menu
14586 * @param obj The menu object
14587 * @return The first item, or NULL if none
14589 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14591 * @brief Get the next item in the menu.
14593 * @param item The menu item object.
14594 * @return The item after it, or NULL if none
14596 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14598 * @brief Get the previous item in the menu.
14600 * @param item The menu item object.
14601 * @return The item before it, or NULL if none
14603 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14609 * @defgroup List List
14610 * @ingroup Elementary
14612 * @image html img/widget/list/preview-00.png
14613 * @image latex img/widget/list/preview-00.eps width=\textwidth
14615 * @image html img/list.png
14616 * @image latex img/list.eps width=\textwidth
14618 * A list widget is a container whose children are displayed vertically or
14619 * horizontally, in order, and can be selected.
14620 * The list can accept only one or multiple items selection. Also has many
14621 * modes of items displaying.
14623 * A list is a very simple type of list widget. For more robust
14624 * lists, @ref Genlist should probably be used.
14626 * Smart callbacks one can listen to:
14627 * - @c "activated" - The user has double-clicked or pressed
14628 * (enter|return|spacebar) on an item. The @c event_info parameter
14629 * is the item that was activated.
14630 * - @c "clicked,double" - The user has double-clicked an item.
14631 * The @c event_info parameter is the item that was double-clicked.
14632 * - "selected" - when the user selected an item
14633 * - "unselected" - when the user unselected an item
14634 * - "longpressed" - an item in the list is long-pressed
14635 * - "scroll,edge,top" - the list is scrolled until the top edge
14636 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14637 * - "scroll,edge,left" - the list is scrolled until the left edge
14638 * - "scroll,edge,right" - the list is scrolled until the right edge
14640 * Available styles for it:
14643 * List of examples:
14644 * @li @ref list_example_01
14645 * @li @ref list_example_02
14646 * @li @ref list_example_03
14655 * @enum _Elm_List_Mode
14656 * @typedef Elm_List_Mode
14658 * Set list's resize behavior, transverse axis scroll and
14659 * items cropping. See each mode's description for more details.
14661 * @note Default value is #ELM_LIST_SCROLL.
14663 * Values <b> don't </b> work as bitmask, only one can be choosen.
14665 * @see elm_list_mode_set()
14666 * @see elm_list_mode_get()
14670 typedef enum _Elm_List_Mode
14672 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. */
14673 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). */
14674 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. */
14675 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. */
14676 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14679 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(). */
14682 * Add a new list widget to the given parent Elementary
14683 * (container) object.
14685 * @param parent The parent object.
14686 * @return a new list widget handle or @c NULL, on errors.
14688 * This function inserts a new list widget on the canvas.
14692 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14697 * @param obj The list object
14699 * @note Call before running show() on the list object.
14700 * @warning If not called, it won't display the list properly.
14703 * li = elm_list_add(win);
14704 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14705 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14707 * evas_object_show(li);
14712 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14715 * Enable or disable multiple items selection on the list object.
14717 * @param obj The list object
14718 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14721 * Disabled by default. If disabled, the user can select a single item of
14722 * the list each time. Selected items are highlighted on list.
14723 * If enabled, many items can be selected.
14725 * If a selected item is selected again, it will be unselected.
14727 * @see elm_list_multi_select_get()
14731 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14734 * Get a value whether multiple items selection is enabled or not.
14736 * @see elm_list_multi_select_set() for details.
14738 * @param obj The list object.
14739 * @return @c EINA_TRUE means multiple items selection is enabled.
14740 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14741 * @c EINA_FALSE is returned.
14745 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14748 * Set which mode to use for the list object.
14750 * @param obj The list object
14751 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14752 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14754 * Set list's resize behavior, transverse axis scroll and
14755 * items cropping. See each mode's description for more details.
14757 * @note Default value is #ELM_LIST_SCROLL.
14759 * Only one can be set, if a previous one was set, it will be changed
14760 * by the new mode set. Bitmask won't work as well.
14762 * @see elm_list_mode_get()
14766 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14769 * Get the mode the list is at.
14771 * @param obj The list object
14772 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14773 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14775 * @note see elm_list_mode_set() for more information.
14779 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14782 * Enable or disable horizontal mode on the list object.
14784 * @param obj The list object.
14785 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14786 * disable it, i.e., to enable vertical mode.
14788 * @note Vertical mode is set by default.
14790 * On horizontal mode items are displayed on list from left to right,
14791 * instead of from top to bottom. Also, the list will scroll horizontally.
14792 * Each item will presents left icon on top and right icon, or end, at
14795 * @see elm_list_horizontal_get()
14799 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14802 * Get a value whether horizontal mode is enabled or not.
14804 * @param obj The list object.
14805 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14806 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14807 * @c EINA_FALSE is returned.
14809 * @see elm_list_horizontal_set() for details.
14813 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14816 * Enable or disable always select mode on the list object.
14818 * @param obj The list object
14819 * @param always_select @c EINA_TRUE to enable always select mode or
14820 * @c EINA_FALSE to disable it.
14822 * @note Always select mode is disabled by default.
14824 * Default behavior of list items is to only call its callback function
14825 * the first time it's pressed, i.e., when it is selected. If a selected
14826 * item is pressed again, and multi-select is disabled, it won't call
14827 * this function (if multi-select is enabled it will unselect the item).
14829 * If always select is enabled, it will call the callback function
14830 * everytime a item is pressed, so it will call when the item is selected,
14831 * and again when a selected item is pressed.
14833 * @see elm_list_always_select_mode_get()
14834 * @see elm_list_multi_select_set()
14838 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14841 * Get a value whether always select mode is enabled or not, meaning that
14842 * an item will always call its callback function, even if already selected.
14844 * @param obj The list object
14845 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14846 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14847 * @c EINA_FALSE is returned.
14849 * @see elm_list_always_select_mode_set() for details.
14853 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14856 * Set bouncing behaviour when the scrolled content reaches an edge.
14858 * Tell the internal scroller object whether it should bounce or not
14859 * when it reaches the respective edges for each axis.
14861 * @param obj The list object
14862 * @param h_bounce Whether to bounce or not in the horizontal axis.
14863 * @param v_bounce Whether to bounce or not in the vertical axis.
14865 * @see elm_scroller_bounce_set()
14869 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14872 * Get the bouncing behaviour of the internal scroller.
14874 * Get whether the internal scroller should bounce when the edge of each
14875 * axis is reached scrolling.
14877 * @param obj The list object.
14878 * @param h_bounce Pointer where to store the bounce state of the horizontal
14880 * @param v_bounce Pointer where to store the bounce state of the vertical
14883 * @see elm_scroller_bounce_get()
14884 * @see elm_list_bounce_set()
14888 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14891 * Set the scrollbar policy.
14893 * @param obj The list object
14894 * @param policy_h Horizontal scrollbar policy.
14895 * @param policy_v Vertical scrollbar policy.
14897 * This sets the scrollbar visibility policy for the given scroller.
14898 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14899 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14900 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14901 * This applies respectively for the horizontal and vertical scrollbars.
14903 * The both are disabled by default, i.e., are set to
14904 * #ELM_SCROLLER_POLICY_OFF.
14908 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14911 * Get the scrollbar policy.
14913 * @see elm_list_scroller_policy_get() for details.
14915 * @param obj The list object.
14916 * @param policy_h Pointer where to store horizontal scrollbar policy.
14917 * @param policy_v Pointer where to store vertical scrollbar policy.
14921 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);
14924 * Append a new item to the list object.
14926 * @param obj The list object.
14927 * @param label The label of the list item.
14928 * @param icon The icon object to use for the left side of the item. An
14929 * icon can be any Evas object, but usually it is an icon created
14930 * with elm_icon_add().
14931 * @param end The icon object to use for the right side of the item. An
14932 * icon can be any Evas object.
14933 * @param func The function to call when the item is clicked.
14934 * @param data The data to associate with the item for related callbacks.
14936 * @return The created item or @c NULL upon failure.
14938 * A new item will be created and appended to the list, i.e., will
14939 * be set as @b last item.
14941 * Items created with this method can be deleted with
14942 * elm_list_item_del().
14944 * Associated @p data can be properly freed when item is deleted if a
14945 * callback function is set with elm_list_item_del_cb_set().
14947 * If a function is passed as argument, it will be called everytime this item
14948 * is selected, i.e., the user clicks over an unselected item.
14949 * If always select is enabled it will call this function every time
14950 * user clicks over an item (already selected or not).
14951 * If such function isn't needed, just passing
14952 * @c NULL as @p func is enough. The same should be done for @p data.
14954 * Simple example (with no function callback or data associated):
14956 * li = elm_list_add(win);
14957 * ic = elm_icon_add(win);
14958 * elm_icon_file_set(ic, "path/to/image", NULL);
14959 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14960 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14962 * evas_object_show(li);
14965 * @see elm_list_always_select_mode_set()
14966 * @see elm_list_item_del()
14967 * @see elm_list_item_del_cb_set()
14968 * @see elm_list_clear()
14969 * @see elm_icon_add()
14973 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);
14976 * Prepend a new item to the list object.
14978 * @param obj The list object.
14979 * @param label The label of the list item.
14980 * @param icon The icon object to use for the left side of the item. An
14981 * icon can be any Evas object, but usually it is an icon created
14982 * with elm_icon_add().
14983 * @param end The icon object to use for the right side of the item. An
14984 * icon can be any Evas object.
14985 * @param func The function to call when the item is clicked.
14986 * @param data The data to associate with the item for related callbacks.
14988 * @return The created item or @c NULL upon failure.
14990 * A new item will be created and prepended to the list, i.e., will
14991 * be set as @b first item.
14993 * Items created with this method can be deleted with
14994 * elm_list_item_del().
14996 * Associated @p data can be properly freed when item is deleted if a
14997 * callback function is set with elm_list_item_del_cb_set().
14999 * If a function is passed as argument, it will be called everytime this item
15000 * is selected, i.e., the user clicks over an unselected item.
15001 * If always select is enabled it will call this function every time
15002 * user clicks over an item (already selected or not).
15003 * If such function isn't needed, just passing
15004 * @c NULL as @p func is enough. The same should be done for @p data.
15006 * @see elm_list_item_append() for a simple code example.
15007 * @see elm_list_always_select_mode_set()
15008 * @see elm_list_item_del()
15009 * @see elm_list_item_del_cb_set()
15010 * @see elm_list_clear()
15011 * @see elm_icon_add()
15015 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);
15018 * Insert a new item into the list object before item @p before.
15020 * @param obj The list object.
15021 * @param before The list item to insert before.
15022 * @param label The label of the list item.
15023 * @param icon The icon object to use for the left side of the item. An
15024 * icon can be any Evas object, but usually it is an icon created
15025 * with elm_icon_add().
15026 * @param end The icon object to use for the right side of the item. An
15027 * icon can be any Evas object.
15028 * @param func The function to call when the item is clicked.
15029 * @param data The data to associate with the item for related callbacks.
15031 * @return The created item or @c NULL upon failure.
15033 * A new item will be created and added to the list. Its position in
15034 * this list will be just before item @p before.
15036 * Items created with this method can be deleted with
15037 * elm_list_item_del().
15039 * Associated @p data can be properly freed when item is deleted if a
15040 * callback function is set with elm_list_item_del_cb_set().
15042 * If a function is passed as argument, it will be called everytime this item
15043 * is selected, i.e., the user clicks over an unselected item.
15044 * If always select is enabled it will call this function every time
15045 * user clicks over an item (already selected or not).
15046 * If such function isn't needed, just passing
15047 * @c NULL as @p func is enough. The same should be done for @p data.
15049 * @see elm_list_item_append() for a simple code example.
15050 * @see elm_list_always_select_mode_set()
15051 * @see elm_list_item_del()
15052 * @see elm_list_item_del_cb_set()
15053 * @see elm_list_clear()
15054 * @see elm_icon_add()
15058 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);
15061 * Insert a new item into the list object after item @p after.
15063 * @param obj The list object.
15064 * @param after The list item to insert after.
15065 * @param label The label of the list item.
15066 * @param icon The icon object to use for the left side of the item. An
15067 * icon can be any Evas object, but usually it is an icon created
15068 * with elm_icon_add().
15069 * @param end The icon object to use for the right side of the item. An
15070 * icon can be any Evas object.
15071 * @param func The function to call when the item is clicked.
15072 * @param data The data to associate with the item for related callbacks.
15074 * @return The created item or @c NULL upon failure.
15076 * A new item will be created and added to the list. Its position in
15077 * this list will be just after item @p after.
15079 * Items created with this method can be deleted with
15080 * elm_list_item_del().
15082 * Associated @p data can be properly freed when item is deleted if a
15083 * callback function is set with elm_list_item_del_cb_set().
15085 * If a function is passed as argument, it will be called everytime this item
15086 * is selected, i.e., the user clicks over an unselected item.
15087 * If always select is enabled it will call this function every time
15088 * user clicks over an item (already selected or not).
15089 * If such function isn't needed, just passing
15090 * @c NULL as @p func is enough. The same should be done for @p data.
15092 * @see elm_list_item_append() for a simple code example.
15093 * @see elm_list_always_select_mode_set()
15094 * @see elm_list_item_del()
15095 * @see elm_list_item_del_cb_set()
15096 * @see elm_list_clear()
15097 * @see elm_icon_add()
15101 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);
15104 * Insert a new item into the sorted list object.
15106 * @param obj The list object.
15107 * @param label The label of the list item.
15108 * @param icon The icon object to use for the left side of the item. An
15109 * icon can be any Evas object, but usually it is an icon created
15110 * with elm_icon_add().
15111 * @param end The icon object to use for the right side of the item. An
15112 * icon can be any Evas object.
15113 * @param func The function to call when the item is clicked.
15114 * @param data The data to associate with the item for related callbacks.
15115 * @param cmp_func The comparing function to be used to sort list
15116 * items <b>by #Elm_List_Item item handles</b>. This function will
15117 * receive two items and compare them, returning a non-negative integer
15118 * if the second item should be place after the first, or negative value
15119 * if should be placed before.
15121 * @return The created item or @c NULL upon failure.
15123 * @note This function inserts values into a list object assuming it was
15124 * sorted and the result will be sorted.
15126 * A new item will be created and added to the list. Its position in
15127 * this list will be found comparing the new item with previously inserted
15128 * items using function @p cmp_func.
15130 * Items created with this method can be deleted with
15131 * elm_list_item_del().
15133 * Associated @p data can be properly freed when item is deleted if a
15134 * callback function is set with elm_list_item_del_cb_set().
15136 * If a function is passed as argument, it will be called everytime this item
15137 * is selected, i.e., the user clicks over an unselected item.
15138 * If always select is enabled it will call this function every time
15139 * user clicks over an item (already selected or not).
15140 * If such function isn't needed, just passing
15141 * @c NULL as @p func is enough. The same should be done for @p data.
15143 * @see elm_list_item_append() for a simple code example.
15144 * @see elm_list_always_select_mode_set()
15145 * @see elm_list_item_del()
15146 * @see elm_list_item_del_cb_set()
15147 * @see elm_list_clear()
15148 * @see elm_icon_add()
15152 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);
15155 * Remove all list's items.
15157 * @param obj The list object
15159 * @see elm_list_item_del()
15160 * @see elm_list_item_append()
15164 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15167 * Get a list of all the list items.
15169 * @param obj The list object
15170 * @return An @c Eina_List of list items, #Elm_List_Item,
15171 * or @c NULL on failure.
15173 * @see elm_list_item_append()
15174 * @see elm_list_item_del()
15175 * @see elm_list_clear()
15179 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15182 * Get the selected item.
15184 * @param obj The list object.
15185 * @return The selected list item.
15187 * The selected item can be unselected with function
15188 * elm_list_item_selected_set().
15190 * The selected item always will be highlighted on list.
15192 * @see elm_list_selected_items_get()
15196 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15199 * Return a list of the currently selected list items.
15201 * @param obj The list object.
15202 * @return An @c Eina_List of list items, #Elm_List_Item,
15203 * or @c NULL on failure.
15205 * Multiple items can be selected if multi select is enabled. It can be
15206 * done with elm_list_multi_select_set().
15208 * @see elm_list_selected_item_get()
15209 * @see elm_list_multi_select_set()
15213 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15216 * Set the selected state of an item.
15218 * @param item The list item
15219 * @param selected The selected state
15221 * This sets the selected state of the given item @p it.
15222 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15224 * If a new item is selected the previosly selected will be unselected,
15225 * unless multiple selection is enabled with elm_list_multi_select_set().
15226 * Previoulsy selected item can be get with function
15227 * elm_list_selected_item_get().
15229 * Selected items will be highlighted.
15231 * @see elm_list_item_selected_get()
15232 * @see elm_list_selected_item_get()
15233 * @see elm_list_multi_select_set()
15237 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15240 * Get whether the @p item is selected or not.
15242 * @param item The list item.
15243 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15244 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15246 * @see elm_list_selected_item_set() for details.
15247 * @see elm_list_item_selected_get()
15251 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15254 * Set or unset item as a separator.
15256 * @param it The list item.
15257 * @param setting @c EINA_TRUE to set item @p it as separator or
15258 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15260 * Items aren't set as separator by default.
15262 * If set as separator it will display separator theme, so won't display
15265 * @see elm_list_item_separator_get()
15269 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15272 * Get a value whether item is a separator or not.
15274 * @see elm_list_item_separator_set() for details.
15276 * @param it The list item.
15277 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15278 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15282 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15285 * Show @p item in the list view.
15287 * @param item The list item to be shown.
15289 * It won't animate list until item is visible. If such behavior is wanted,
15290 * use elm_list_bring_in() intead.
15294 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15297 * Bring in the given item to list view.
15299 * @param item The item.
15301 * This causes list to jump to the given item @p item and show it
15302 * (by scrolling), if it is not fully visible.
15304 * This may use animation to do so and take a period of time.
15306 * If animation isn't wanted, elm_list_item_show() can be used.
15310 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15313 * Delete them item from the list.
15315 * @param item The item of list to be deleted.
15317 * If deleting all list items is required, elm_list_clear()
15318 * should be used instead of getting items list and deleting each one.
15320 * @see elm_list_clear()
15321 * @see elm_list_item_append()
15322 * @see elm_list_item_del_cb_set()
15326 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15329 * Set the function called when a list item is freed.
15331 * @param item The item to set the callback on
15332 * @param func The function called
15334 * If there is a @p func, then it will be called prior item's memory release.
15335 * That will be called with the following arguments:
15337 * @li item's Evas object;
15340 * This way, a data associated to a list item could be properly freed.
15344 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15347 * Get the data associated to the item.
15349 * @param item The list item
15350 * @return The data associated to @p item
15352 * The return value is a pointer to data associated to @p item when it was
15353 * created, with function elm_list_item_append() or similar. If no data
15354 * was passed as argument, it will return @c NULL.
15356 * @see elm_list_item_append()
15360 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15363 * Get the left side icon associated to the item.
15365 * @param item The list item
15366 * @return The left side icon associated to @p item
15368 * The return value is a pointer to the icon associated to @p item when
15370 * created, with function elm_list_item_append() or similar, or later
15371 * with function elm_list_item_icon_set(). If no icon
15372 * was passed as argument, it will return @c NULL.
15374 * @see elm_list_item_append()
15375 * @see elm_list_item_icon_set()
15379 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15382 * Set the left side icon associated to the item.
15384 * @param item The list item
15385 * @param icon The left side icon object to associate with @p item
15387 * The icon object to use at left side of the item. An
15388 * icon can be any Evas object, but usually it is an icon created
15389 * with elm_icon_add().
15391 * Once the icon object is set, a previously set one will be deleted.
15392 * @warning Setting the same icon for two items will cause the icon to
15393 * dissapear from the first item.
15395 * If an icon was passed as argument on item creation, with function
15396 * elm_list_item_append() or similar, it will be already
15397 * associated to the item.
15399 * @see elm_list_item_append()
15400 * @see elm_list_item_icon_get()
15404 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15407 * Get the right side icon associated to the item.
15409 * @param item The list item
15410 * @return The right side icon associated to @p item
15412 * The return value is a pointer to the icon associated to @p item when
15414 * created, with function elm_list_item_append() or similar, or later
15415 * with function elm_list_item_icon_set(). If no icon
15416 * was passed as argument, it will return @c NULL.
15418 * @see elm_list_item_append()
15419 * @see elm_list_item_icon_set()
15423 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15426 * Set the right side icon associated to the item.
15428 * @param item The list item
15429 * @param end The right side icon object to associate with @p item
15431 * The icon object to use at right side of the item. An
15432 * icon can be any Evas object, but usually it is an icon created
15433 * with elm_icon_add().
15435 * Once the icon object is set, a previously set one will be deleted.
15436 * @warning Setting the same icon for two items will cause the icon to
15437 * dissapear from the first item.
15439 * If an icon was passed as argument on item creation, with function
15440 * elm_list_item_append() or similar, it will be already
15441 * associated to the item.
15443 * @see elm_list_item_append()
15444 * @see elm_list_item_end_get()
15448 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15451 * Gets the base object of the item.
15453 * @param item The list item
15454 * @return The base object associated with @p item
15456 * Base object is the @c Evas_Object that represents that item.
15460 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15461 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15464 * Get the label of item.
15466 * @param item The item of list.
15467 * @return The label of item.
15469 * The return value is a pointer to the label associated to @p item when
15470 * it was created, with function elm_list_item_append(), or later
15471 * with function elm_list_item_label_set. If no label
15472 * was passed as argument, it will return @c NULL.
15474 * @see elm_list_item_label_set() for more details.
15475 * @see elm_list_item_append()
15479 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15482 * Set the label of item.
15484 * @param item The item of list.
15485 * @param text The label of item.
15487 * The label to be displayed by the item.
15488 * Label will be placed between left and right side icons (if set).
15490 * If a label was passed as argument on item creation, with function
15491 * elm_list_item_append() or similar, it will be already
15492 * displayed by the item.
15494 * @see elm_list_item_label_get()
15495 * @see elm_list_item_append()
15499 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15503 * Get the item before @p it in list.
15505 * @param it The list item.
15506 * @return The item before @p it, or @c NULL if none or on failure.
15508 * @note If it is the first item, @c NULL will be returned.
15510 * @see elm_list_item_append()
15511 * @see elm_list_items_get()
15515 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15518 * Get the item after @p it in list.
15520 * @param it The list item.
15521 * @return The item after @p it, or @c NULL if none or on failure.
15523 * @note If it is the last item, @c NULL will be returned.
15525 * @see elm_list_item_append()
15526 * @see elm_list_items_get()
15530 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15533 * Sets the disabled/enabled state of a list item.
15535 * @param it The item.
15536 * @param disabled The disabled state.
15538 * A disabled item cannot be selected or unselected. It will also
15539 * change its appearance (generally greyed out). This sets the
15540 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15545 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15548 * Get a value whether list item is disabled or not.
15550 * @param it The item.
15551 * @return The disabled state.
15553 * @see elm_list_item_disabled_set() for more details.
15557 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15560 * Set the text to be shown in a given list item's tooltips.
15562 * @param item Target item.
15563 * @param text The text to set in the content.
15565 * Setup the text as tooltip to object. The item can have only one tooltip,
15566 * so any previous tooltip data - set with this function or
15567 * elm_list_item_tooltip_content_cb_set() - is removed.
15569 * @see elm_object_tooltip_text_set() for more details.
15573 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15577 * @brief Disable size restrictions on an object's tooltip
15578 * @param item The tooltip's anchor object
15579 * @param disable If EINA_TRUE, size restrictions are disabled
15580 * @return EINA_FALSE on failure, EINA_TRUE on success
15582 * This function allows a tooltip to expand beyond its parant window's canvas.
15583 * It will instead be limited only by the size of the display.
15585 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15587 * @brief Retrieve size restriction state of an object's tooltip
15588 * @param obj The tooltip's anchor object
15589 * @return If EINA_TRUE, size restrictions are disabled
15591 * This function returns whether a tooltip is allowed to expand beyond
15592 * its parant window's canvas.
15593 * It will instead be limited only by the size of the display.
15595 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15598 * Set the content to be shown in the tooltip item.
15600 * Setup the tooltip to item. The item can have only one tooltip,
15601 * so any previous tooltip data is removed. @p func(with @p data) will
15602 * be called every time that need show the tooltip and it should
15603 * return a valid Evas_Object. This object is then managed fully by
15604 * tooltip system and is deleted when the tooltip is gone.
15606 * @param item the list item being attached a tooltip.
15607 * @param func the function used to create the tooltip contents.
15608 * @param data what to provide to @a func as callback data/context.
15609 * @param del_cb called when data is not needed anymore, either when
15610 * another callback replaces @a func, the tooltip is unset with
15611 * elm_list_item_tooltip_unset() or the owner @a item
15612 * dies. This callback receives as the first parameter the
15613 * given @a data, and @c event_info is the item.
15615 * @see elm_object_tooltip_content_cb_set() for more details.
15619 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);
15622 * Unset tooltip from item.
15624 * @param item list item to remove previously set tooltip.
15626 * Remove tooltip from item. The callback provided as del_cb to
15627 * elm_list_item_tooltip_content_cb_set() will be called to notify
15628 * it is not used anymore.
15630 * @see elm_object_tooltip_unset() for more details.
15631 * @see elm_list_item_tooltip_content_cb_set()
15635 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15638 * Sets a different style for this item tooltip.
15640 * @note before you set a style you should define a tooltip with
15641 * elm_list_item_tooltip_content_cb_set() or
15642 * elm_list_item_tooltip_text_set()
15644 * @param item list item with tooltip already set.
15645 * @param style the theme style to use (default, transparent, ...)
15647 * @see elm_object_tooltip_style_set() for more details.
15651 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15654 * Get the style for this item tooltip.
15656 * @param item list item with tooltip already set.
15657 * @return style the theme style in use, defaults to "default". If the
15658 * object does not have a tooltip set, then NULL is returned.
15660 * @see elm_object_tooltip_style_get() for more details.
15661 * @see elm_list_item_tooltip_style_set()
15665 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15668 * Set the type of mouse pointer/cursor decoration to be shown,
15669 * when the mouse pointer is over the given list widget item
15671 * @param item list item to customize cursor on
15672 * @param cursor the cursor type's name
15674 * This function works analogously as elm_object_cursor_set(), but
15675 * here the cursor's changing area is restricted to the item's
15676 * area, and not the whole widget's. Note that that item cursors
15677 * have precedence over widget cursors, so that a mouse over an
15678 * item with custom cursor set will always show @b that cursor.
15680 * If this function is called twice for an object, a previously set
15681 * cursor will be unset on the second call.
15683 * @see elm_object_cursor_set()
15684 * @see elm_list_item_cursor_get()
15685 * @see elm_list_item_cursor_unset()
15689 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15692 * Get the type of mouse pointer/cursor decoration set to be shown,
15693 * when the mouse pointer is over the given list widget item
15695 * @param item list item with custom cursor set
15696 * @return the cursor type's name or @c NULL, if no custom cursors
15697 * were set to @p item (and on errors)
15699 * @see elm_object_cursor_get()
15700 * @see elm_list_item_cursor_set()
15701 * @see elm_list_item_cursor_unset()
15705 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15708 * Unset any custom mouse pointer/cursor decoration set to be
15709 * shown, when the mouse pointer is over the given list widget
15710 * item, thus making it show the @b default cursor again.
15712 * @param item a list item
15714 * Use this call to undo any custom settings on this item's cursor
15715 * decoration, bringing it back to defaults (no custom style set).
15717 * @see elm_object_cursor_unset()
15718 * @see elm_list_item_cursor_set()
15722 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15725 * Set a different @b style for a given custom cursor set for a
15728 * @param item list item with custom cursor set
15729 * @param style the <b>theme style</b> to use (e.g. @c "default",
15730 * @c "transparent", etc)
15732 * This function only makes sense when one is using custom mouse
15733 * cursor decorations <b>defined in a theme file</b>, which can have,
15734 * given a cursor name/type, <b>alternate styles</b> on it. It
15735 * works analogously as elm_object_cursor_style_set(), but here
15736 * applyed only to list item objects.
15738 * @warning Before you set a cursor style you should have definen a
15739 * custom cursor previously on the item, with
15740 * elm_list_item_cursor_set()
15742 * @see elm_list_item_cursor_engine_only_set()
15743 * @see elm_list_item_cursor_style_get()
15747 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15750 * Get the current @b style set for a given list item's custom
15753 * @param item list item with custom cursor set.
15754 * @return style the cursor style in use. If the object does not
15755 * have a cursor set, then @c NULL is returned.
15757 * @see elm_list_item_cursor_style_set() for more details
15761 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15764 * Set if the (custom)cursor for a given list item should be
15765 * searched in its theme, also, or should only rely on the
15766 * rendering engine.
15768 * @param item item with custom (custom) cursor already set on
15769 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15770 * only on those provided by the rendering engine, @c EINA_FALSE to
15771 * have them searched on the widget's theme, as well.
15773 * @note This call is of use only if you've set a custom cursor
15774 * for list items, with elm_list_item_cursor_set().
15776 * @note By default, cursors will only be looked for between those
15777 * provided by the rendering engine.
15781 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15784 * Get if the (custom) cursor for a given list item is being
15785 * searched in its theme, also, or is only relying on the rendering
15788 * @param item a list item
15789 * @return @c EINA_TRUE, if cursors are being looked for only on
15790 * those provided by the rendering engine, @c EINA_FALSE if they
15791 * are being searched on the widget's theme, as well.
15793 * @see elm_list_item_cursor_engine_only_set(), for more details
15797 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15804 * @defgroup Slider Slider
15805 * @ingroup Elementary
15807 * @image html img/widget/slider/preview-00.png
15808 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15810 * The slider adds a dragable “slider” widget for selecting the value of
15811 * something within a range.
15813 * A slider can be horizontal or vertical. It can contain an Icon and has a
15814 * primary label as well as a units label (that is formatted with floating
15815 * point values and thus accepts a printf-style format string, like
15816 * “%1.2f units”. There is also an indicator string that may be somewhere
15817 * else (like on the slider itself) that also accepts a format string like
15818 * units. Label, Icon Unit and Indicator strings/objects are optional.
15820 * A slider may be inverted which means values invert, with high vales being
15821 * on the left or top and low values on the right or bottom (as opposed to
15822 * normally being low on the left or top and high on the bottom and right).
15824 * The slider should have its minimum and maximum values set by the
15825 * application with elm_slider_min_max_set() and value should also be set by
15826 * the application before use with elm_slider_value_set(). The span of the
15827 * slider is its length (horizontally or vertically). This will be scaled by
15828 * the object or applications scaling factor. At any point code can query the
15829 * slider for its value with elm_slider_value_get().
15831 * Smart callbacks one can listen to:
15832 * - "changed" - Whenever the slider value is changed by the user.
15833 * - "slider,drag,start" - dragging the slider indicator around has started.
15834 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15835 * - "delay,changed" - A short time after the value is changed by the user.
15836 * This will be called only when the user stops dragging for
15837 * a very short period or when they release their
15838 * finger/mouse, so it avoids possibly expensive reactions to
15839 * the value change.
15841 * Available styles for it:
15844 * Here is an example on its usage:
15845 * @li @ref slider_example
15849 * @addtogroup Slider
15854 * Add a new slider widget to the given parent Elementary
15855 * (container) object.
15857 * @param parent The parent object.
15858 * @return a new slider widget handle or @c NULL, on errors.
15860 * This function inserts a new slider widget on the canvas.
15864 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15867 * Set the label of a given slider widget
15869 * @param obj The progress bar object
15870 * @param label The text label string, in UTF-8
15873 * @deprecated use elm_object_text_set() instead.
15875 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15878 * Get the label of a given slider widget
15880 * @param obj The progressbar object
15881 * @return The text label string, in UTF-8
15884 * @deprecated use elm_object_text_get() instead.
15886 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15889 * Set the icon object of the slider object.
15891 * @param obj The slider object.
15892 * @param icon The icon object.
15894 * On horizontal mode, icon is placed at left, and on vertical mode,
15897 * @note Once the icon object is set, a previously set one will be deleted.
15898 * If you want to keep that old content object, use the
15899 * elm_slider_icon_unset() function.
15901 * @warning If the object being set does not have minimum size hints set,
15902 * it won't get properly displayed.
15906 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15909 * Unset an icon set on a given slider widget.
15911 * @param obj The slider object.
15912 * @return The icon object that was being used, if any was set, or
15913 * @c NULL, otherwise (and on errors).
15915 * On horizontal mode, icon is placed at left, and on vertical mode,
15918 * This call will unparent and return the icon object which was set
15919 * for this widget, previously, on success.
15921 * @see elm_slider_icon_set() for more details
15922 * @see elm_slider_icon_get()
15926 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15929 * Retrieve the icon object set for a given slider widget.
15931 * @param obj The slider object.
15932 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15933 * otherwise (and on errors).
15935 * On horizontal mode, icon is placed at left, and on vertical mode,
15938 * @see elm_slider_icon_set() for more details
15939 * @see elm_slider_icon_unset()
15943 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15946 * Set the end object of the slider object.
15948 * @param obj The slider object.
15949 * @param end The end object.
15951 * On horizontal mode, end is placed at left, and on vertical mode,
15952 * placed at bottom.
15954 * @note Once the icon object is set, a previously set one will be deleted.
15955 * If you want to keep that old content object, use the
15956 * elm_slider_end_unset() function.
15958 * @warning If the object being set does not have minimum size hints set,
15959 * it won't get properly displayed.
15963 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15966 * Unset an end object set on a given slider widget.
15968 * @param obj The slider object.
15969 * @return The end object that was being used, if any was set, or
15970 * @c NULL, otherwise (and on errors).
15972 * On horizontal mode, end is placed at left, and on vertical mode,
15973 * placed at bottom.
15975 * This call will unparent and return the icon object which was set
15976 * for this widget, previously, on success.
15978 * @see elm_slider_end_set() for more details.
15979 * @see elm_slider_end_get()
15983 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15986 * Retrieve the end object set for a given slider widget.
15988 * @param obj The slider object.
15989 * @return The end object's handle, if @p obj had one set, or @c NULL,
15990 * otherwise (and on errors).
15992 * On horizontal mode, icon is placed at right, and on vertical mode,
15993 * placed at bottom.
15995 * @see elm_slider_end_set() for more details.
15996 * @see elm_slider_end_unset()
16000 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16003 * Set the (exact) length of the bar region of a given slider widget.
16005 * @param obj The slider object.
16006 * @param size The length of the slider's bar region.
16008 * This sets the minimum width (when in horizontal mode) or height
16009 * (when in vertical mode) of the actual bar area of the slider
16010 * @p obj. This in turn affects the object's minimum size. Use
16011 * this when you're not setting other size hints expanding on the
16012 * given direction (like weight and alignment hints) and you would
16013 * like it to have a specific size.
16015 * @note Icon, end, label, indicator and unit text around @p obj
16016 * will require their
16017 * own space, which will make @p obj to require more the @p size,
16020 * @see elm_slider_span_size_get()
16024 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16027 * Get the length set for the bar region of a given slider widget
16029 * @param obj The slider object.
16030 * @return The length of the slider's bar region.
16032 * If that size was not set previously, with
16033 * elm_slider_span_size_set(), this call will return @c 0.
16037 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16040 * Set the format string for the unit label.
16042 * @param obj The slider object.
16043 * @param format The format string for the unit display.
16045 * Unit label is displayed all the time, if set, after slider's bar.
16046 * In horizontal mode, at right and in vertical mode, at bottom.
16048 * If @c NULL, unit label won't be visible. If not it sets the format
16049 * string for the label text. To the label text is provided a floating point
16050 * value, so the label text can display up to 1 floating point value.
16051 * Note that this is optional.
16053 * Use a format string such as "%1.2f meters" for example, and it will
16054 * display values like: "3.14 meters" for a value equal to 3.14159.
16056 * Default is unit label disabled.
16058 * @see elm_slider_indicator_format_get()
16062 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16065 * Get the unit label format of the slider.
16067 * @param obj The slider object.
16068 * @return The unit label format string in UTF-8.
16070 * Unit label is displayed all the time, if set, after slider's bar.
16071 * In horizontal mode, at right and in vertical mode, at bottom.
16073 * @see elm_slider_unit_format_set() for more
16074 * information on how this works.
16078 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16081 * Set the format string for the indicator label.
16083 * @param obj The slider object.
16084 * @param indicator The format string for the indicator display.
16086 * The slider may display its value somewhere else then unit label,
16087 * for example, above the slider knob that is dragged around. This function
16088 * sets the format string used for this.
16090 * If @c NULL, indicator label won't be visible. If not it sets the format
16091 * string for the label text. To the label text is provided a floating point
16092 * value, so the label text can display up to 1 floating point value.
16093 * Note that this is optional.
16095 * Use a format string such as "%1.2f meters" for example, and it will
16096 * display values like: "3.14 meters" for a value equal to 3.14159.
16098 * Default is indicator label disabled.
16100 * @see elm_slider_indicator_format_get()
16104 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16107 * Get the indicator label format of the slider.
16109 * @param obj The slider object.
16110 * @return The indicator label format string in UTF-8.
16112 * The slider may display its value somewhere else then unit label,
16113 * for example, above the slider knob that is dragged around. This function
16114 * gets the format string used for this.
16116 * @see elm_slider_indicator_format_set() for more
16117 * information on how this works.
16121 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16124 * Set the format function pointer for the indicator label
16126 * @param obj The slider object.
16127 * @param func The indicator format function.
16128 * @param free_func The freeing function for the format string.
16130 * Set the callback function to format the indicator string.
16132 * @see elm_slider_indicator_format_set() for more info on how this works.
16136 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);
16139 * Set the format function pointer for the units label
16141 * @param obj The slider object.
16142 * @param func The units format function.
16143 * @param free_func The freeing function for the format string.
16145 * Set the callback function to format the indicator string.
16147 * @see elm_slider_units_format_set() for more info on how this works.
16151 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);
16154 * Set the orientation of a given slider widget.
16156 * @param obj The slider object.
16157 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16158 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16160 * Use this function to change how your slider is to be
16161 * disposed: vertically or horizontally.
16163 * By default it's displayed horizontally.
16165 * @see elm_slider_horizontal_get()
16169 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16172 * Retrieve the orientation of a given slider widget
16174 * @param obj The slider object.
16175 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16176 * @c EINA_FALSE if it's @b vertical (and on errors).
16178 * @see elm_slider_horizontal_set() for more details.
16182 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16185 * Set the minimum and maximum values for the slider.
16187 * @param obj The slider object.
16188 * @param min The minimum value.
16189 * @param max The maximum value.
16191 * Define the allowed range of values to be selected by the user.
16193 * If actual value is less than @p min, it will be updated to @p min. If it
16194 * is bigger then @p max, will be updated to @p max. Actual value can be
16195 * get with elm_slider_value_get().
16197 * By default, min is equal to 0.0, and max is equal to 1.0.
16199 * @warning Maximum must be greater than minimum, otherwise behavior
16202 * @see elm_slider_min_max_get()
16206 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16209 * Get the minimum and maximum values of the slider.
16211 * @param obj The slider object.
16212 * @param min Pointer where to store the minimum value.
16213 * @param max Pointer where to store the maximum value.
16215 * @note If only one value is needed, the other pointer can be passed
16218 * @see elm_slider_min_max_set() for details.
16222 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16225 * Set the value the slider displays.
16227 * @param obj The slider object.
16228 * @param val The value to be displayed.
16230 * Value will be presented on the unit label following format specified with
16231 * elm_slider_unit_format_set() and on indicator with
16232 * elm_slider_indicator_format_set().
16234 * @warning The value must to be between min and max values. This values
16235 * are set by elm_slider_min_max_set().
16237 * @see elm_slider_value_get()
16238 * @see elm_slider_unit_format_set()
16239 * @see elm_slider_indicator_format_set()
16240 * @see elm_slider_min_max_set()
16244 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16247 * Get the value displayed by the spinner.
16249 * @param obj The spinner object.
16250 * @return The value displayed.
16252 * @see elm_spinner_value_set() for details.
16256 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16259 * Invert a given slider widget's displaying values order
16261 * @param obj The slider object.
16262 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16263 * @c EINA_FALSE to bring it back to default, non-inverted values.
16265 * A slider may be @b inverted, in which state it gets its
16266 * values inverted, with high vales being on the left or top and
16267 * low values on the right or bottom, as opposed to normally have
16268 * the low values on the former and high values on the latter,
16269 * respectively, for horizontal and vertical modes.
16271 * @see elm_slider_inverted_get()
16275 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16278 * Get whether a given slider widget's displaying values are
16281 * @param obj The slider object.
16282 * @return @c EINA_TRUE, if @p obj has inverted values,
16283 * @c EINA_FALSE otherwise (and on errors).
16285 * @see elm_slider_inverted_set() for more details.
16289 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16292 * Set whether to enlarge slider indicator (augmented knob) or not.
16294 * @param obj The slider object.
16295 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16296 * let the knob always at default size.
16298 * By default, indicator will be bigger while dragged by the user.
16300 * @warning It won't display values set with
16301 * elm_slider_indicator_format_set() if you disable indicator.
16305 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16308 * Get whether a given slider widget's enlarging indicator or not.
16310 * @param obj The slider object.
16311 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16312 * @c EINA_FALSE otherwise (and on errors).
16314 * @see elm_slider_indicator_show_set() for details.
16318 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16325 * @addtogroup Actionslider Actionslider
16327 * @image html img/widget/actionslider/preview-00.png
16328 * @image latex img/widget/actionslider/preview-00.eps
16330 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16331 * properties. The indicator is the element the user drags to choose a label.
16332 * When the position is set with magnet, when released the indicator will be
16333 * moved to it if it's nearest the magnetized position.
16335 * @note By default all positions are set as enabled.
16337 * Signals that you can add callbacks for are:
16339 * "selected" - when user selects an enabled position (the label is passed
16342 * "pos_changed" - when the indicator reaches any of the positions("left",
16343 * "right" or "center").
16345 * See an example of actionslider usage @ref actionslider_example_page "here"
16348 typedef enum _Elm_Actionslider_Pos
16350 ELM_ACTIONSLIDER_NONE = 0,
16351 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16352 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16353 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16354 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16355 } Elm_Actionslider_Pos;
16358 * Add a new actionslider to the parent.
16360 * @param parent The parent object
16361 * @return The new actionslider object or NULL if it cannot be created
16363 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16365 * Set actionslider labels.
16367 * @param obj The actionslider object
16368 * @param left_label The label to be set on the left.
16369 * @param center_label The label to be set on the center.
16370 * @param right_label The label to be set on the right.
16371 * @deprecated use elm_object_text_set() instead.
16373 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);
16375 * Get actionslider labels.
16377 * @param obj The actionslider object
16378 * @param left_label A char** to place the left_label of @p obj into.
16379 * @param center_label A char** to place the center_label of @p obj into.
16380 * @param right_label A char** to place the right_label of @p obj into.
16381 * @deprecated use elm_object_text_set() instead.
16383 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);
16385 * Get actionslider selected label.
16387 * @param obj The actionslider object
16388 * @return The selected label
16390 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16392 * Set actionslider indicator position.
16394 * @param obj The actionslider object.
16395 * @param pos The position of the indicator.
16397 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16399 * Get actionslider indicator position.
16401 * @param obj The actionslider object.
16402 * @return The position of the indicator.
16404 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16406 * Set actionslider magnet position. To make multiple positions magnets @c or
16407 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16409 * @param obj The actionslider object.
16410 * @param pos Bit mask indicating the magnet positions.
16412 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16414 * Get actionslider magnet position.
16416 * @param obj The actionslider object.
16417 * @return The positions with magnet property.
16419 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16421 * Set actionslider enabled position. To set multiple positions as enabled @c or
16422 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16424 * @note All the positions are enabled by default.
16426 * @param obj The actionslider object.
16427 * @param pos Bit mask indicating the enabled positions.
16429 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16431 * Get actionslider enabled position.
16433 * @param obj The actionslider object.
16434 * @return The enabled positions.
16436 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16438 * Set the label used on the indicator.
16440 * @param obj The actionslider object
16441 * @param label The label to be set on the indicator.
16442 * @deprecated use elm_object_text_set() instead.
16444 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16446 * Get the label used on the indicator object.
16448 * @param obj The actionslider object
16449 * @return The indicator label
16450 * @deprecated use elm_object_text_get() instead.
16452 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16458 * @defgroup Genlist Genlist
16460 * @image html img/widget/genlist/preview-00.png
16461 * @image latex img/widget/genlist/preview-00.eps
16462 * @image html img/genlist.png
16463 * @image latex img/genlist.eps
16465 * This widget aims to have more expansive list than the simple list in
16466 * Elementary that could have more flexible items and allow many more entries
16467 * while still being fast and low on memory usage. At the same time it was
16468 * also made to be able to do tree structures. But the price to pay is more
16469 * complexity when it comes to usage. If all you want is a simple list with
16470 * icons and a single label, use the normal @ref List object.
16472 * Genlist has a fairly large API, mostly because it's relatively complex,
16473 * trying to be both expansive, powerful and efficient. First we will begin
16474 * an overview on the theory behind genlist.
16476 * @section Genlist_Item_Class Genlist item classes - creating items
16478 * In order to have the ability to add and delete items on the fly, genlist
16479 * implements a class (callback) system where the application provides a
16480 * structure with information about that type of item (genlist may contain
16481 * multiple different items with different classes, states and styles).
16482 * Genlist will call the functions in this struct (methods) when an item is
16483 * "realized" (i.e., created dynamically, while the user is scrolling the
16484 * grid). All objects will simply be deleted when no longer needed with
16485 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16486 * following members:
16487 * - @c item_style - This is a constant string and simply defines the name
16488 * of the item style. It @b must be specified and the default should be @c
16490 * - @c mode_item_style - This is a constant string and simply defines the
16491 * name of the style that will be used for mode animations. It can be left
16492 * as @c NULL if you don't plan to use Genlist mode. See
16493 * elm_genlist_item_mode_set() for more info.
16495 * - @c func - A struct with pointers to functions that will be called when
16496 * an item is going to be actually created. All of them receive a @c data
16497 * parameter that will point to the same data passed to
16498 * elm_genlist_item_append() and related item creation functions, and a @c
16499 * obj parameter that points to the genlist object itself.
16501 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16502 * state_get and @c del. The 3 first functions also receive a @c part
16503 * parameter described below. A brief description of these functions follows:
16505 * - @c label_get - The @c part parameter is the name string of one of the
16506 * existing text parts in the Edje group implementing the item's theme.
16507 * This function @b must return a strdup'()ed string, as the caller will
16508 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16509 * - @c icon_get - The @c part parameter is the name string of one of the
16510 * existing (icon) swallow parts in the Edje group implementing the item's
16511 * theme. It must return @c NULL, when no icon is desired, or a valid
16512 * object handle, otherwise. The object will be deleted by the genlist on
16513 * its deletion or when the item is "unrealized". See
16514 * #Elm_Genlist_Item_Icon_Get_Cb.
16515 * - @c func.state_get - The @c part parameter is the name string of one of
16516 * the state parts in the Edje group implementing the item's theme. Return
16517 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16518 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16519 * and @c "elm" as "emission" and "source" arguments, respectively, when
16520 * the state is true (the default is false), where @c XXX is the name of
16521 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16522 * - @c func.del - This is intended for use when genlist items are deleted,
16523 * so any data attached to the item (e.g. its data parameter on creation)
16524 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16526 * available item styles:
16528 * - default_style - The text part is a textblock
16530 * @image html img/widget/genlist/preview-04.png
16531 * @image latex img/widget/genlist/preview-04.eps
16535 * @image html img/widget/genlist/preview-01.png
16536 * @image latex img/widget/genlist/preview-01.eps
16538 * - icon_top_text_bottom
16540 * @image html img/widget/genlist/preview-02.png
16541 * @image latex img/widget/genlist/preview-02.eps
16545 * @image html img/widget/genlist/preview-03.png
16546 * @image latex img/widget/genlist/preview-03.eps
16548 * @section Genlist_Items Structure of items
16550 * An item in a genlist can have 0 or more text labels (they can be regular
16551 * text or textblock Evas objects - that's up to the style to determine), 0
16552 * or more icons (which are simply objects swallowed into the genlist item's
16553 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16554 * behavior left to the user to define. The Edje part names for each of
16555 * these properties will be looked up, in the theme file for the genlist,
16556 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16557 * "states", respectively. For each of those properties, if more than one
16558 * part is provided, they must have names listed separated by spaces in the
16559 * data fields. For the default genlist item theme, we have @b one label
16560 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16561 * "elm.swallow.end") and @b no state parts.
16563 * A genlist item may be at one of several styles. Elementary provides one
16564 * by default - "default", but this can be extended by system or application
16565 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16568 * @section Genlist_Manipulation Editing and Navigating
16570 * Items can be added by several calls. All of them return a @ref
16571 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16572 * They all take a data parameter that is meant to be used for a handle to
16573 * the applications internal data (eg the struct with the original item
16574 * data). The parent parameter is the parent genlist item this belongs to if
16575 * it is a tree or an indexed group, and NULL if there is no parent. The
16576 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16577 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16578 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16579 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16580 * is set then this item is group index item that is displayed at the top
16581 * until the next group comes. The func parameter is a convenience callback
16582 * that is called when the item is selected and the data parameter will be
16583 * the func_data parameter, obj be the genlist object and event_info will be
16584 * the genlist item.
16586 * elm_genlist_item_append() adds an item to the end of the list, or if
16587 * there is a parent, to the end of all the child items of the parent.
16588 * elm_genlist_item_prepend() is the same but adds to the beginning of
16589 * the list or children list. elm_genlist_item_insert_before() inserts at
16590 * item before another item and elm_genlist_item_insert_after() inserts after
16591 * the indicated item.
16593 * The application can clear the list with elm_genlist_clear() which deletes
16594 * all the items in the list and elm_genlist_item_del() will delete a specific
16595 * item. elm_genlist_item_subitems_clear() will clear all items that are
16596 * children of the indicated parent item.
16598 * To help inspect list items you can jump to the item at the top of the list
16599 * with elm_genlist_first_item_get() which will return the item pointer, and
16600 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16601 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16602 * and previous items respectively relative to the indicated item. Using
16603 * these calls you can walk the entire item list/tree. Note that as a tree
16604 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16605 * let you know which item is the parent (and thus know how to skip them if
16608 * @section Genlist_Muti_Selection Multi-selection
16610 * If the application wants multiple items to be able to be selected,
16611 * elm_genlist_multi_select_set() can enable this. If the list is
16612 * single-selection only (the default), then elm_genlist_selected_item_get()
16613 * will return the selected item, if any, or NULL I none is selected. If the
16614 * list is multi-select then elm_genlist_selected_items_get() will return a
16615 * list (that is only valid as long as no items are modified (added, deleted,
16616 * selected or unselected)).
16618 * @section Genlist_Usage_Hints Usage hints
16620 * There are also convenience functions. elm_genlist_item_genlist_get() will
16621 * return the genlist object the item belongs to. elm_genlist_item_show()
16622 * will make the scroller scroll to show that specific item so its visible.
16623 * elm_genlist_item_data_get() returns the data pointer set by the item
16624 * creation functions.
16626 * If an item changes (state of boolean changes, label or icons change),
16627 * then use elm_genlist_item_update() to have genlist update the item with
16628 * the new state. Genlist will re-realize the item thus call the functions
16629 * in the _Elm_Genlist_Item_Class for that item.
16631 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16632 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16633 * to expand/contract an item and get its expanded state, use
16634 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16635 * again to make an item disabled (unable to be selected and appear
16636 * differently) use elm_genlist_item_disabled_set() to set this and
16637 * elm_genlist_item_disabled_get() to get the disabled state.
16639 * In general to indicate how the genlist should expand items horizontally to
16640 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16641 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16642 * mode means that if items are too wide to fit, the scroller will scroll
16643 * horizontally. Otherwise items are expanded to fill the width of the
16644 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16645 * to the viewport width and limited to that size. This can be combined with
16646 * a different style that uses edjes' ellipsis feature (cutting text off like
16649 * Items will only call their selection func and callback when first becoming
16650 * selected. Any further clicks will do nothing, unless you enable always
16651 * select with elm_genlist_always_select_mode_set(). This means even if
16652 * selected, every click will make the selected callbacks be called.
16653 * elm_genlist_no_select_mode_set() will turn off the ability to select
16654 * items entirely and they will neither appear selected nor call selected
16655 * callback functions.
16657 * Remember that you can create new styles and add your own theme augmentation
16658 * per application with elm_theme_extension_add(). If you absolutely must
16659 * have a specific style that overrides any theme the user or system sets up
16660 * you can use elm_theme_overlay_add() to add such a file.
16662 * @section Genlist_Implementation Implementation
16664 * Evas tracks every object you create. Every time it processes an event
16665 * (mouse move, down, up etc.) it needs to walk through objects and find out
16666 * what event that affects. Even worse every time it renders display updates,
16667 * in order to just calculate what to re-draw, it needs to walk through many
16668 * many many objects. Thus, the more objects you keep active, the more
16669 * overhead Evas has in just doing its work. It is advisable to keep your
16670 * active objects to the minimum working set you need. Also remember that
16671 * object creation and deletion carries an overhead, so there is a
16672 * middle-ground, which is not easily determined. But don't keep massive lists
16673 * of objects you can't see or use. Genlist does this with list objects. It
16674 * creates and destroys them dynamically as you scroll around. It groups them
16675 * into blocks so it can determine the visibility etc. of a whole block at
16676 * once as opposed to having to walk the whole list. This 2-level list allows
16677 * for very large numbers of items to be in the list (tests have used up to
16678 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16679 * may be different sizes, every item added needs to be calculated as to its
16680 * size and thus this presents a lot of overhead on populating the list, this
16681 * genlist employs a queue. Any item added is queued and spooled off over
16682 * time, actually appearing some time later, so if your list has many members
16683 * you may find it takes a while for them to all appear, with your process
16684 * consuming a lot of CPU while it is busy spooling.
16686 * Genlist also implements a tree structure, but it does so with callbacks to
16687 * the application, with the application filling in tree structures when
16688 * requested (allowing for efficient building of a very deep tree that could
16689 * even be used for file-management). See the above smart signal callbacks for
16692 * @section Genlist_Smart_Events Genlist smart events
16694 * Signals that you can add callbacks for are:
16695 * - @c "activated" - The user has double-clicked or pressed
16696 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16697 * item that was activated.
16698 * - @c "clicked,double" - The user has double-clicked an item. The @c
16699 * event_info parameter is the item that was double-clicked.
16700 * - @c "selected" - This is called when a user has made an item selected.
16701 * The event_info parameter is the genlist item that was selected.
16702 * - @c "unselected" - This is called when a user has made an item
16703 * unselected. The event_info parameter is the genlist item that was
16705 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16706 * called and the item is now meant to be expanded. The event_info
16707 * parameter is the genlist item that was indicated to expand. It is the
16708 * job of this callback to then fill in the child items.
16709 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16710 * called and the item is now meant to be contracted. The event_info
16711 * parameter is the genlist item that was indicated to contract. It is the
16712 * job of this callback to then delete the child items.
16713 * - @c "expand,request" - This is called when a user has indicated they want
16714 * to expand a tree branch item. The callback should decide if the item can
16715 * expand (has any children) and then call elm_genlist_item_expanded_set()
16716 * appropriately to set the state. The event_info parameter is the genlist
16717 * item that was indicated to expand.
16718 * - @c "contract,request" - This is called when a user has indicated they
16719 * want to contract a tree branch item. The callback should decide if the
16720 * item can contract (has any children) and then call
16721 * elm_genlist_item_expanded_set() appropriately to set the state. The
16722 * event_info parameter is the genlist item that was indicated to contract.
16723 * - @c "realized" - This is called when the item in the list is created as a
16724 * real evas object. event_info parameter is the genlist item that was
16725 * created. The object may be deleted at any time, so it is up to the
16726 * caller to not use the object pointer from elm_genlist_item_object_get()
16727 * in a way where it may point to freed objects.
16728 * - @c "unrealized" - This is called just before an item is unrealized.
16729 * After this call icon objects provided will be deleted and the item
16730 * object itself delete or be put into a floating cache.
16731 * - @c "drag,start,up" - This is called when the item in the list has been
16732 * dragged (not scrolled) up.
16733 * - @c "drag,start,down" - This is called when the item in the list has been
16734 * dragged (not scrolled) down.
16735 * - @c "drag,start,left" - This is called when the item in the list has been
16736 * dragged (not scrolled) left.
16737 * - @c "drag,start,right" - This is called when the item in the list has
16738 * been dragged (not scrolled) right.
16739 * - @c "drag,stop" - This is called when the item in the list has stopped
16741 * - @c "drag" - This is called when the item in the list is being dragged.
16742 * - @c "longpressed" - This is called when the item is pressed for a certain
16743 * amount of time. By default it's 1 second.
16744 * - @c "scroll,anim,start" - This is called when scrolling animation has
16746 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16748 * - @c "scroll,drag,start" - This is called when dragging the content has
16750 * - @c "scroll,drag,stop" - This is called when dragging the content has
16752 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16754 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16755 * until the bottom edge.
16756 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16757 * until the left edge.
16758 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16759 * until the right edge.
16760 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16762 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16764 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16766 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16768 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16769 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16770 * multi-touch pinched in.
16771 * - @c "swipe" - This is called when the genlist is swiped.
16773 * @section Genlist_Examples Examples
16775 * Here is a list of examples that use the genlist, trying to show some of
16776 * its capabilities:
16777 * - @ref genlist_example_01
16778 * - @ref genlist_example_02
16779 * - @ref genlist_example_03
16780 * - @ref genlist_example_04
16781 * - @ref genlist_example_05
16785 * @addtogroup Genlist
16790 * @enum _Elm_Genlist_Item_Flags
16791 * @typedef Elm_Genlist_Item_Flags
16793 * Defines if the item is of any special type (has subitems or it's the
16794 * index of a group), or is just a simple item.
16798 typedef enum _Elm_Genlist_Item_Flags
16800 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16801 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16802 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16803 } Elm_Genlist_Item_Flags;
16804 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16805 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16806 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16807 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16808 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. */
16809 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. */
16810 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16811 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16813 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16814 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16815 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16816 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16819 * @struct _Elm_Genlist_Item_Class
16821 * Genlist item class definition structs.
16823 * This struct contains the style and fetching functions that will define the
16824 * contents of each item.
16826 * @see @ref Genlist_Item_Class
16828 struct _Elm_Genlist_Item_Class
16830 const char *item_style; /**< style of this class. */
16833 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16834 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16835 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16836 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16837 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16839 const char *mode_item_style;
16843 * Add a new genlist widget to the given parent Elementary
16844 * (container) object
16846 * @param parent The parent object
16847 * @return a new genlist widget handle or @c NULL, on errors
16849 * This function inserts a new genlist widget on the canvas.
16851 * @see elm_genlist_item_append()
16852 * @see elm_genlist_item_del()
16853 * @see elm_genlist_clear()
16857 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16859 * Remove all items from a given genlist widget.
16861 * @param obj The genlist object
16863 * This removes (and deletes) all items in @p obj, leaving it empty.
16865 * @see elm_genlist_item_del(), to remove just one item.
16869 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16871 * Enable or disable multi-selection in the genlist
16873 * @param obj The genlist object
16874 * @param multi Multi-select enable/disable. Default is disabled.
16876 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16877 * the list. This allows more than 1 item to be selected. To retrieve the list
16878 * of selected items, use elm_genlist_selected_items_get().
16880 * @see elm_genlist_selected_items_get()
16881 * @see elm_genlist_multi_select_get()
16885 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16887 * Gets if multi-selection in genlist is enabled or disabled.
16889 * @param obj The genlist object
16890 * @return Multi-select enabled/disabled
16891 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16893 * @see elm_genlist_multi_select_set()
16897 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16899 * This sets the horizontal stretching mode.
16901 * @param obj The genlist object
16902 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16904 * This sets the mode used for sizing items horizontally. Valid modes
16905 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16906 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16907 * the scroller will scroll horizontally. Otherwise items are expanded
16908 * to fill the width of the viewport of the scroller. If it is
16909 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16910 * limited to that size.
16912 * @see elm_genlist_horizontal_get()
16916 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16917 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16919 * Gets the horizontal stretching mode.
16921 * @param obj The genlist object
16922 * @return The mode to use
16923 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16925 * @see elm_genlist_horizontal_set()
16929 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16930 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16932 * Set the always select mode.
16934 * @param obj The genlist object
16935 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16936 * EINA_FALSE = off). Default is @c EINA_FALSE.
16938 * Items will only call their selection func and callback when first
16939 * becoming selected. Any further clicks will do nothing, unless you
16940 * enable always select with elm_genlist_always_select_mode_set().
16941 * This means that, even if selected, every click will make the selected
16942 * callbacks be called.
16944 * @see elm_genlist_always_select_mode_get()
16948 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16950 * Get the always select mode.
16952 * @param obj The genlist object
16953 * @return The always select mode
16954 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16956 * @see elm_genlist_always_select_mode_set()
16960 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16962 * Enable/disable the no select mode.
16964 * @param obj The genlist object
16965 * @param no_select The no select mode
16966 * (EINA_TRUE = on, EINA_FALSE = off)
16968 * This will turn off the ability to select items entirely and they
16969 * will neither appear selected nor call selected callback functions.
16971 * @see elm_genlist_no_select_mode_get()
16975 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16977 * Gets whether the no select mode is enabled.
16979 * @param obj The genlist object
16980 * @return The no select mode
16981 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16983 * @see elm_genlist_no_select_mode_set()
16987 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16989 * Enable/disable compress mode.
16991 * @param obj The genlist object
16992 * @param compress The compress mode
16993 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16995 * This will enable the compress mode where items are "compressed"
16996 * horizontally to fit the genlist scrollable viewport width. This is
16997 * special for genlist. Do not rely on
16998 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16999 * work as genlist needs to handle it specially.
17001 * @see elm_genlist_compress_mode_get()
17005 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17007 * Get whether the compress mode is enabled.
17009 * @param obj The genlist object
17010 * @return The compress mode
17011 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17013 * @see elm_genlist_compress_mode_set()
17017 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17019 * Enable/disable height-for-width mode.
17021 * @param obj The genlist object
17022 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17023 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17025 * With height-for-width mode the item width will be fixed (restricted
17026 * to a minimum of) to the list width when calculating its size in
17027 * order to allow the height to be calculated based on it. This allows,
17028 * for instance, text block to wrap lines if the Edje part is
17029 * configured with "text.min: 0 1".
17031 * @note This mode will make list resize slower as it will have to
17032 * recalculate every item height again whenever the list width
17035 * @note When height-for-width mode is enabled, it also enables
17036 * compress mode (see elm_genlist_compress_mode_set()) and
17037 * disables homogeneous (see elm_genlist_homogeneous_set()).
17041 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17043 * Get whether the height-for-width mode is enabled.
17045 * @param obj The genlist object
17046 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17051 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17053 * Enable/disable horizontal and vertical bouncing effect.
17055 * @param obj The genlist object
17056 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17057 * EINA_FALSE = off). Default is @c EINA_FALSE.
17058 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17059 * EINA_FALSE = off). Default is @c EINA_TRUE.
17061 * This will enable or disable the scroller bouncing effect for the
17062 * genlist. See elm_scroller_bounce_set() for details.
17064 * @see elm_scroller_bounce_set()
17065 * @see elm_genlist_bounce_get()
17069 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17071 * Get whether the horizontal and vertical bouncing effect is enabled.
17073 * @param obj The genlist object
17074 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17076 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17079 * @see elm_genlist_bounce_set()
17083 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17085 * Enable/disable homogenous mode.
17087 * @param obj The genlist object
17088 * @param homogeneous Assume the items within the genlist are of the
17089 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17092 * This will enable the homogeneous mode where items are of the same
17093 * height and width so that genlist may do the lazy-loading at its
17094 * maximum (which increases the performance for scrolling the list). This
17095 * implies 'compressed' mode.
17097 * @see elm_genlist_compress_mode_set()
17098 * @see elm_genlist_homogeneous_get()
17102 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17104 * Get whether the homogenous mode is enabled.
17106 * @param obj The genlist object
17107 * @return Assume the items within the genlist are of the same height
17108 * and width (EINA_TRUE = on, EINA_FALSE = off)
17110 * @see elm_genlist_homogeneous_set()
17114 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17116 * Set the maximum number of items within an item block
17118 * @param obj The genlist object
17119 * @param n Maximum number of items within an item block. Default is 32.
17121 * This will configure the block count to tune to the target with
17122 * particular performance matrix.
17124 * A block of objects will be used to reduce the number of operations due to
17125 * many objects in the screen. It can determine the visibility, or if the
17126 * object has changed, it theme needs to be updated, etc. doing this kind of
17127 * calculation to the entire block, instead of per object.
17129 * The default value for the block count is enough for most lists, so unless
17130 * you know you will have a lot of objects visible in the screen at the same
17131 * time, don't try to change this.
17133 * @see elm_genlist_block_count_get()
17134 * @see @ref Genlist_Implementation
17138 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17140 * Get the maximum number of items within an item block
17142 * @param obj The genlist object
17143 * @return Maximum number of items within an item block
17145 * @see elm_genlist_block_count_set()
17149 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17151 * Set the timeout in seconds for the longpress event.
17153 * @param obj The genlist object
17154 * @param timeout timeout in seconds. Default is 1.
17156 * This option will change how long it takes to send an event "longpressed"
17157 * after the mouse down signal is sent to the list. If this event occurs, no
17158 * "clicked" event will be sent.
17160 * @see elm_genlist_longpress_timeout_set()
17164 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17166 * Get the timeout in seconds for the longpress event.
17168 * @param obj The genlist object
17169 * @return timeout in seconds
17171 * @see elm_genlist_longpress_timeout_get()
17175 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17177 * Append a new item in a given genlist widget.
17179 * @param obj The genlist object
17180 * @param itc The item class for the item
17181 * @param data The item data
17182 * @param parent The parent item, or NULL if none
17183 * @param flags Item flags
17184 * @param func Convenience function called when the item is selected
17185 * @param func_data Data passed to @p func above.
17186 * @return A handle to the item added or @c NULL if not possible
17188 * This adds the given item to the end of the list or the end of
17189 * the children list if the @p parent is given.
17191 * @see elm_genlist_item_prepend()
17192 * @see elm_genlist_item_insert_before()
17193 * @see elm_genlist_item_insert_after()
17194 * @see elm_genlist_item_del()
17198 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);
17200 * Prepend a new item in a given genlist widget.
17202 * @param obj The genlist object
17203 * @param itc The item class for the item
17204 * @param data The item data
17205 * @param parent The parent item, or NULL if none
17206 * @param flags Item flags
17207 * @param func Convenience function called when the item is selected
17208 * @param func_data Data passed to @p func above.
17209 * @return A handle to the item added or NULL if not possible
17211 * This adds an item to the beginning of the list or beginning of the
17212 * children of the parent if given.
17214 * @see elm_genlist_item_append()
17215 * @see elm_genlist_item_insert_before()
17216 * @see elm_genlist_item_insert_after()
17217 * @see elm_genlist_item_del()
17221 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);
17223 * Insert an item before another in a genlist widget
17225 * @param obj The genlist object
17226 * @param itc The item class for the item
17227 * @param data The item data
17228 * @param before The item to place this new one before.
17229 * @param flags Item flags
17230 * @param func Convenience function called when the item is selected
17231 * @param func_data Data passed to @p func above.
17232 * @return A handle to the item added or @c NULL if not possible
17234 * This inserts an item before another in the list. It will be in the
17235 * same tree level or group as the item it is inserted before.
17237 * @see elm_genlist_item_append()
17238 * @see elm_genlist_item_prepend()
17239 * @see elm_genlist_item_insert_after()
17240 * @see elm_genlist_item_del()
17244 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);
17246 * Insert an item after another in a genlist widget
17248 * @param obj The genlist object
17249 * @param itc The item class for the item
17250 * @param data The item data
17251 * @param after The item to place this new one after.
17252 * @param flags Item flags
17253 * @param func Convenience function called when the item is selected
17254 * @param func_data Data passed to @p func above.
17255 * @return A handle to the item added or @c NULL if not possible
17257 * This inserts an item after another in the list. It will be in the
17258 * same tree level or group as the item it is inserted after.
17260 * @see elm_genlist_item_append()
17261 * @see elm_genlist_item_prepend()
17262 * @see elm_genlist_item_insert_before()
17263 * @see elm_genlist_item_del()
17267 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);
17269 * Insert a new item into the sorted genlist object
17271 * @param obj The genlist object
17272 * @param itc The item class for the item
17273 * @param data The item data
17274 * @param parent The parent item, or NULL if none
17275 * @param flags Item flags
17276 * @param comp The function called for the sort
17277 * @param func Convenience function called when item selected
17278 * @param func_data Data passed to @p func above.
17279 * @return A handle to the item added or NULL if not possible
17283 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);
17284 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);
17285 /* operations to retrieve existing items */
17287 * Get the selectd item in the genlist.
17289 * @param obj The genlist object
17290 * @return The selected item, or NULL if none is selected.
17292 * This gets the selected item in the list (if multi-selection is enabled, only
17293 * the item that was first selected in the list is returned - which is not very
17294 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17297 * If no item is selected, NULL is returned.
17299 * @see elm_genlist_selected_items_get()
17303 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17305 * Get a list of selected items in the genlist.
17307 * @param obj The genlist object
17308 * @return The list of selected items, or NULL if none are selected.
17310 * It returns a list of the selected items. This list pointer is only valid so
17311 * long as the selection doesn't change (no items are selected or unselected, or
17312 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17313 * pointers. The order of the items in this list is the order which they were
17314 * selected, i.e. the first item in this list is the first item that was
17315 * selected, and so on.
17317 * @note If not in multi-select mode, consider using function
17318 * elm_genlist_selected_item_get() instead.
17320 * @see elm_genlist_multi_select_set()
17321 * @see elm_genlist_selected_item_get()
17325 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17327 * Get a list of realized items in genlist
17329 * @param obj The genlist object
17330 * @return The list of realized items, nor NULL if none are realized.
17332 * This returns a list of the realized items in the genlist. The list
17333 * contains Elm_Genlist_Item pointers. The list must be freed by the
17334 * caller when done with eina_list_free(). The item pointers in the
17335 * list are only valid so long as those items are not deleted or the
17336 * genlist is not deleted.
17338 * @see elm_genlist_realized_items_update()
17342 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17344 * Get the item that is at the x, y canvas coords.
17346 * @param obj The gelinst object.
17347 * @param x The input x coordinate
17348 * @param y The input y coordinate
17349 * @param posret The position relative to the item returned here
17350 * @return The item at the coordinates or NULL if none
17352 * This returns the item at the given coordinates (which are canvas
17353 * relative, not object-relative). If an item is at that coordinate,
17354 * that item handle is returned, and if @p posret is not NULL, the
17355 * integer pointed to is set to a value of -1, 0 or 1, depending if
17356 * the coordinate is on the upper portion of that item (-1), on the
17357 * middle section (0) or on the lower part (1). If NULL is returned as
17358 * an item (no item found there), then posret may indicate -1 or 1
17359 * based if the coordinate is above or below all items respectively in
17364 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);
17366 * Get the first item in the genlist
17368 * This returns the first item in the list.
17370 * @param obj The genlist object
17371 * @return The first item, or NULL if none
17375 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17377 * Get the last item in the genlist
17379 * This returns the last item in the list.
17381 * @return The last item, or NULL if none
17385 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17387 * Set the scrollbar policy
17389 * @param obj The genlist object
17390 * @param policy_h Horizontal scrollbar policy.
17391 * @param policy_v Vertical scrollbar policy.
17393 * This sets the scrollbar visibility policy for the given genlist
17394 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17395 * made visible if it is needed, and otherwise kept hidden.
17396 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17397 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17398 * respectively for the horizontal and vertical scrollbars. Default is
17399 * #ELM_SMART_SCROLLER_POLICY_AUTO
17401 * @see elm_genlist_scroller_policy_get()
17405 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17407 * Get the scrollbar policy
17409 * @param obj The genlist object
17410 * @param policy_h Pointer to store the horizontal scrollbar policy.
17411 * @param policy_v Pointer to store the vertical scrollbar policy.
17413 * @see elm_genlist_scroller_policy_set()
17417 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);
17419 * Get the @b next item in a genlist widget's internal list of items,
17420 * given a handle to one of those items.
17422 * @param item The genlist item to fetch next from
17423 * @return The item after @p item, or @c NULL if there's none (and
17426 * This returns the item placed after the @p item, on the container
17429 * @see elm_genlist_item_prev_get()
17433 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17435 * Get the @b previous item in a genlist widget's internal list of items,
17436 * given a handle to one of those items.
17438 * @param item The genlist item to fetch previous from
17439 * @return The item before @p item, or @c NULL if there's none (and
17442 * This returns the item placed before the @p item, on the container
17445 * @see elm_genlist_item_next_get()
17449 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17451 * Get the genlist object's handle which contains a given genlist
17454 * @param item The item to fetch the container from
17455 * @return The genlist (parent) object
17457 * This returns the genlist object itself that an item belongs to.
17461 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17463 * Get the parent item of the given item
17465 * @param it The item
17466 * @return The parent of the item or @c NULL if it has no parent.
17468 * This returns the item that was specified as parent of the item @p it on
17469 * elm_genlist_item_append() and insertion related functions.
17473 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17475 * Remove all sub-items (children) of the given item
17477 * @param it The item
17479 * This removes all items that are children (and their descendants) of the
17480 * given item @p it.
17482 * @see elm_genlist_clear()
17483 * @see elm_genlist_item_del()
17487 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17489 * Set whether a given genlist item is selected or not
17491 * @param it The item
17492 * @param selected Use @c EINA_TRUE, to make it selected, @c
17493 * EINA_FALSE to make it unselected
17495 * This sets the selected state of an item. If multi selection is
17496 * not enabled on the containing genlist and @p selected is @c
17497 * EINA_TRUE, any other previously selected items will get
17498 * unselected in favor of this new one.
17500 * @see elm_genlist_item_selected_get()
17504 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17506 * Get whether a given genlist item is selected or not
17508 * @param it The item
17509 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17511 * @see elm_genlist_item_selected_set() for more details
17515 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17517 * Sets the expanded state of an item.
17519 * @param it The item
17520 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17522 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17525 * The theme will respond to this change visually, and a signal "expanded" or
17526 * "contracted" will be sent from the genlist with a pointer to the item that
17527 * has been expanded/contracted.
17529 * Calling this function won't show or hide any child of this item (if it is
17530 * a parent). You must manually delete and create them on the callbacks fo
17531 * the "expanded" or "contracted" signals.
17533 * @see elm_genlist_item_expanded_get()
17537 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17539 * Get the expanded state of an item
17541 * @param it The item
17542 * @return The expanded state
17544 * This gets the expanded state of an item.
17546 * @see elm_genlist_item_expanded_set()
17550 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17552 * Get the depth of expanded item
17554 * @param it The genlist item object
17555 * @return The depth of expanded item
17559 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17561 * Set whether a given genlist item is disabled or not.
17563 * @param it The item
17564 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17565 * to enable it back.
17567 * A disabled item cannot be selected or unselected. It will also
17568 * change its appearance, to signal the user it's disabled.
17570 * @see elm_genlist_item_disabled_get()
17574 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17576 * Get whether a given genlist item is disabled or not.
17578 * @param it The item
17579 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17582 * @see elm_genlist_item_disabled_set() for more details
17586 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17588 * Sets the display only state of an item.
17590 * @param it The item
17591 * @param display_only @c EINA_TRUE if the item is display only, @c
17592 * EINA_FALSE otherwise.
17594 * A display only item cannot be selected or unselected. It is for
17595 * display only and not selecting or otherwise clicking, dragging
17596 * etc. by the user, thus finger size rules will not be applied to
17599 * It's good to set group index items to display only state.
17601 * @see elm_genlist_item_display_only_get()
17605 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17607 * Get the display only state of an item
17609 * @param it The item
17610 * @return @c EINA_TRUE if the item is display only, @c
17611 * EINA_FALSE otherwise.
17613 * @see elm_genlist_item_display_only_set()
17617 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17619 * Show the portion of a genlist's internal list containing a given
17620 * item, immediately.
17622 * @param it The item to display
17624 * This causes genlist to jump to the given item @p it and show it (by
17625 * immediately scrolling to that position), if it is not fully visible.
17627 * @see elm_genlist_item_bring_in()
17628 * @see elm_genlist_item_top_show()
17629 * @see elm_genlist_item_middle_show()
17633 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17635 * Animatedly bring in, to the visible are of a genlist, a given
17638 * @param it The item to display
17640 * This causes genlist to jump to the given item @p it and show it (by
17641 * animatedly scrolling), if it is not fully visible. This may use animation
17642 * to do so and take a period of time
17644 * @see elm_genlist_item_show()
17645 * @see elm_genlist_item_top_bring_in()
17646 * @see elm_genlist_item_middle_bring_in()
17650 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17652 * Show the portion of a genlist's internal list containing a given
17653 * item, immediately.
17655 * @param it The item to display
17657 * This causes genlist to jump to the given item @p it and show it (by
17658 * immediately scrolling to that position), if it is not fully visible.
17660 * The item will be positioned at the top of the genlist viewport.
17662 * @see elm_genlist_item_show()
17663 * @see elm_genlist_item_top_bring_in()
17667 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17669 * Animatedly bring in, to the visible are of a genlist, a given
17672 * @param it The item
17674 * This causes genlist to jump to the given item @p it and show it (by
17675 * animatedly scrolling), if it is not fully visible. This may use animation
17676 * to do so and take a period of time
17678 * The item will be positioned at the top of the genlist viewport.
17680 * @see elm_genlist_item_bring_in()
17681 * @see elm_genlist_item_top_show()
17685 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17687 * Show the portion of a genlist's internal list containing a given
17688 * item, immediately.
17690 * @param it The item to display
17692 * This causes genlist to jump to the given item @p it and show it (by
17693 * immediately scrolling to that position), if it is not fully visible.
17695 * The item will be positioned at the middle of the genlist viewport.
17697 * @see elm_genlist_item_show()
17698 * @see elm_genlist_item_middle_bring_in()
17702 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17704 * Animatedly bring in, to the visible are of a genlist, a given
17707 * @param it The item
17709 * This causes genlist to jump to the given item @p it and show it (by
17710 * animatedly scrolling), if it is not fully visible. This may use animation
17711 * to do so and take a period of time
17713 * The item will be positioned at the middle of the genlist viewport.
17715 * @see elm_genlist_item_bring_in()
17716 * @see elm_genlist_item_middle_show()
17720 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17722 * Remove a genlist item from the its parent, deleting it.
17724 * @param item The item to be removed.
17725 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17727 * @see elm_genlist_clear(), to remove all items in a genlist at
17732 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17734 * Return the data associated to a given genlist item
17736 * @param item The genlist item.
17737 * @return the data associated to this item.
17739 * This returns the @c data value passed on the
17740 * elm_genlist_item_append() and related item addition calls.
17742 * @see elm_genlist_item_append()
17743 * @see elm_genlist_item_data_set()
17747 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17749 * Set the data associated to a given genlist item
17751 * @param item The genlist item
17752 * @param data The new data pointer to set on it
17754 * This @b overrides the @c data value passed on the
17755 * elm_genlist_item_append() and related item addition calls. This
17756 * function @b won't call elm_genlist_item_update() automatically,
17757 * so you'd issue it afterwards if you want to hove the item
17758 * updated to reflect the that new data.
17760 * @see elm_genlist_item_data_get()
17764 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17766 * Tells genlist to "orphan" icons fetchs by the item class
17768 * @param it The item
17770 * This instructs genlist to release references to icons in the item,
17771 * meaning that they will no longer be managed by genlist and are
17772 * floating "orphans" that can be re-used elsewhere if the user wants
17777 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17779 * Get the real Evas object created to implement the view of a
17780 * given genlist item
17782 * @param item The genlist item.
17783 * @return the Evas object implementing this item's view.
17785 * This returns the actual Evas object used to implement the
17786 * specified genlist item's view. This may be @c NULL, as it may
17787 * not have been created or may have been deleted, at any time, by
17788 * the genlist. <b>Do not modify this object</b> (move, resize,
17789 * show, hide, etc.), as the genlist is controlling it. This
17790 * function is for querying, emitting custom signals or hooking
17791 * lower level callbacks for events on that object. Do not delete
17792 * this object under any circumstances.
17794 * @see elm_genlist_item_data_get()
17798 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17800 * Update the contents of an item
17802 * @param it The item
17804 * This updates an item by calling all the item class functions again
17805 * to get the icons, labels and states. Use this when the original
17806 * item data has changed and the changes are desired to be reflected.
17808 * Use elm_genlist_realized_items_update() to update all already realized
17811 * @see elm_genlist_realized_items_update()
17815 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17817 * Update the item class of an item
17819 * @param it The item
17820 * @param itc The item class for the item
17822 * This sets another class fo the item, changing the way that it is
17823 * displayed. After changing the item class, elm_genlist_item_update() is
17824 * called on the item @p it.
17828 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17829 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17831 * Set the text to be shown in a given genlist item's tooltips.
17833 * @param item The genlist item
17834 * @param text The text to set in the content
17836 * This call will setup the text to be used as tooltip to that item
17837 * (analogous to elm_object_tooltip_text_set(), but being item
17838 * tooltips with higher precedence than object tooltips). It can
17839 * have only one tooltip at a time, so any previous tooltip data
17840 * will get removed.
17842 * In order to set an icon or something else as a tooltip, look at
17843 * elm_genlist_item_tooltip_content_cb_set().
17847 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17849 * Set the content to be shown in a given genlist item's tooltips
17851 * @param item The genlist item.
17852 * @param func The function returning the tooltip contents.
17853 * @param data What to provide to @a func as callback data/context.
17854 * @param del_cb Called when data is not needed anymore, either when
17855 * another callback replaces @p func, the tooltip is unset with
17856 * elm_genlist_item_tooltip_unset() or the owner @p item
17857 * dies. This callback receives as its first parameter the
17858 * given @p data, being @c event_info the item handle.
17860 * This call will setup the tooltip's contents to @p item
17861 * (analogous to elm_object_tooltip_content_cb_set(), but being
17862 * item tooltips with higher precedence than object tooltips). It
17863 * can have only one tooltip at a time, so any previous tooltip
17864 * content will get removed. @p func (with @p data) will be called
17865 * every time Elementary needs to show the tooltip and it should
17866 * return a valid Evas object, which will be fully managed by the
17867 * tooltip system, getting deleted when the tooltip is gone.
17869 * In order to set just a text as a tooltip, look at
17870 * elm_genlist_item_tooltip_text_set().
17874 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);
17876 * Unset a tooltip from a given genlist item
17878 * @param item genlist item to remove a previously set tooltip from.
17880 * This call removes any tooltip set on @p item. The callback
17881 * provided as @c del_cb to
17882 * elm_genlist_item_tooltip_content_cb_set() will be called to
17883 * notify it is not used anymore (and have resources cleaned, if
17886 * @see elm_genlist_item_tooltip_content_cb_set()
17890 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17892 * Set a different @b style for a given genlist item's tooltip.
17894 * @param item genlist item with tooltip set
17895 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17896 * "default", @c "transparent", etc)
17898 * Tooltips can have <b>alternate styles</b> to be displayed on,
17899 * which are defined by the theme set on Elementary. This function
17900 * works analogously as elm_object_tooltip_style_set(), but here
17901 * applied only to genlist item objects. The default style for
17902 * tooltips is @c "default".
17904 * @note before you set a style you should define a tooltip with
17905 * elm_genlist_item_tooltip_content_cb_set() or
17906 * elm_genlist_item_tooltip_text_set()
17908 * @see elm_genlist_item_tooltip_style_get()
17912 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17914 * Get the style set a given genlist item's tooltip.
17916 * @param item genlist item with tooltip already set on.
17917 * @return style the theme style in use, which defaults to
17918 * "default". If the object does not have a tooltip set,
17919 * then @c NULL is returned.
17921 * @see elm_genlist_item_tooltip_style_set() for more details
17925 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17927 * @brief Disable size restrictions on an object's tooltip
17928 * @param item The tooltip's anchor object
17929 * @param disable If EINA_TRUE, size restrictions are disabled
17930 * @return EINA_FALSE on failure, EINA_TRUE on success
17932 * This function allows a tooltip to expand beyond its parant window's canvas.
17933 * It will instead be limited only by the size of the display.
17935 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17937 * @brief Retrieve size restriction state of an object's tooltip
17938 * @param item The tooltip's anchor object
17939 * @return If EINA_TRUE, size restrictions are disabled
17941 * This function returns whether a tooltip is allowed to expand beyond
17942 * its parant window's canvas.
17943 * It will instead be limited only by the size of the display.
17945 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17947 * Set the type of mouse pointer/cursor decoration to be shown,
17948 * when the mouse pointer is over the given genlist widget item
17950 * @param item genlist item to customize cursor on
17951 * @param cursor the cursor type's name
17953 * This function works analogously as elm_object_cursor_set(), but
17954 * here the cursor's changing area is restricted to the item's
17955 * area, and not the whole widget's. Note that that item cursors
17956 * have precedence over widget cursors, so that a mouse over @p
17957 * item will always show cursor @p type.
17959 * If this function is called twice for an object, a previously set
17960 * cursor will be unset on the second call.
17962 * @see elm_object_cursor_set()
17963 * @see elm_genlist_item_cursor_get()
17964 * @see elm_genlist_item_cursor_unset()
17968 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17970 * Get the type of mouse pointer/cursor decoration set to be shown,
17971 * when the mouse pointer is over the given genlist widget item
17973 * @param item genlist item with custom cursor set
17974 * @return the cursor type's name or @c NULL, if no custom cursors
17975 * were set to @p item (and on errors)
17977 * @see elm_object_cursor_get()
17978 * @see elm_genlist_item_cursor_set() for more details
17979 * @see elm_genlist_item_cursor_unset()
17983 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17985 * Unset any custom mouse pointer/cursor decoration set to be
17986 * shown, when the mouse pointer is over the given genlist widget
17987 * item, thus making it show the @b default cursor again.
17989 * @param item a genlist item
17991 * Use this call to undo any custom settings on this item's cursor
17992 * decoration, bringing it back to defaults (no custom style set).
17994 * @see elm_object_cursor_unset()
17995 * @see elm_genlist_item_cursor_set() for more details
17999 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18001 * Set a different @b style for a given custom cursor set for a
18004 * @param item genlist item with custom cursor set
18005 * @param style the <b>theme style</b> to use (e.g. @c "default",
18006 * @c "transparent", etc)
18008 * This function only makes sense when one is using custom mouse
18009 * cursor decorations <b>defined in a theme file</b> , which can
18010 * have, given a cursor name/type, <b>alternate styles</b> on
18011 * it. It works analogously as elm_object_cursor_style_set(), but
18012 * here applied only to genlist item objects.
18014 * @warning Before you set a cursor style you should have defined a
18015 * custom cursor previously on the item, with
18016 * elm_genlist_item_cursor_set()
18018 * @see elm_genlist_item_cursor_engine_only_set()
18019 * @see elm_genlist_item_cursor_style_get()
18023 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18025 * Get the current @b style set for a given genlist item's custom
18028 * @param item genlist item with custom cursor set.
18029 * @return style the cursor style in use. If the object does not
18030 * have a cursor set, then @c NULL is returned.
18032 * @see elm_genlist_item_cursor_style_set() for more details
18036 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18038 * Set if the (custom) cursor for a given genlist item should be
18039 * searched in its theme, also, or should only rely on the
18040 * rendering engine.
18042 * @param item item with custom (custom) cursor already set on
18043 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18044 * only on those provided by the rendering engine, @c EINA_FALSE to
18045 * have them searched on the widget's theme, as well.
18047 * @note This call is of use only if you've set a custom cursor
18048 * for genlist items, with elm_genlist_item_cursor_set().
18050 * @note By default, cursors will only be looked for between those
18051 * provided by the rendering engine.
18055 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18057 * Get if the (custom) cursor for a given genlist item is being
18058 * searched in its theme, also, or is only relying on the rendering
18061 * @param item a genlist item
18062 * @return @c EINA_TRUE, if cursors are being looked for only on
18063 * those provided by the rendering engine, @c EINA_FALSE if they
18064 * are being searched on the widget's theme, as well.
18066 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18070 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18072 * Update the contents of all realized items.
18074 * @param obj The genlist object.
18076 * This updates all realized items by calling all the item class functions again
18077 * to get the icons, labels and states. Use this when the original
18078 * item data has changed and the changes are desired to be reflected.
18080 * To update just one item, use elm_genlist_item_update().
18082 * @see elm_genlist_realized_items_get()
18083 * @see elm_genlist_item_update()
18087 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18089 * Activate a genlist mode on an item
18091 * @param item The genlist item
18092 * @param mode Mode name
18093 * @param mode_set Boolean to define set or unset mode.
18095 * A genlist mode is a different way of selecting an item. Once a mode is
18096 * activated on an item, any other selected item is immediately unselected.
18097 * This feature provides an easy way of implementing a new kind of animation
18098 * for selecting an item, without having to entirely rewrite the item style
18099 * theme. However, the elm_genlist_selected_* API can't be used to get what
18100 * item is activate for a mode.
18102 * The current item style will still be used, but applying a genlist mode to
18103 * an item will select it using a different kind of animation.
18105 * The current active item for a mode can be found by
18106 * elm_genlist_mode_item_get().
18108 * The characteristics of genlist mode are:
18109 * - Only one mode can be active at any time, and for only one item.
18110 * - Genlist handles deactivating other items when one item is activated.
18111 * - A mode is defined in the genlist theme (edc), and more modes can easily
18113 * - A mode style and the genlist item style are different things. They
18114 * can be combined to provide a default style to the item, with some kind
18115 * of animation for that item when the mode is activated.
18117 * When a mode is activated on an item, a new view for that item is created.
18118 * The theme of this mode defines the animation that will be used to transit
18119 * the item from the old view to the new view. This second (new) view will be
18120 * active for that item while the mode is active on the item, and will be
18121 * destroyed after the mode is totally deactivated from that item.
18123 * @see elm_genlist_mode_get()
18124 * @see elm_genlist_mode_item_get()
18128 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18130 * Get the last (or current) genlist mode used.
18132 * @param obj The genlist object
18134 * This function just returns the name of the last used genlist mode. It will
18135 * be the current mode if it's still active.
18137 * @see elm_genlist_item_mode_set()
18138 * @see elm_genlist_mode_item_get()
18142 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18144 * Get active genlist mode item
18146 * @param obj The genlist object
18147 * @return The active item for that current mode. Or @c NULL if no item is
18148 * activated with any mode.
18150 * This function returns the item that was activated with a mode, by the
18151 * function elm_genlist_item_mode_set().
18153 * @see elm_genlist_item_mode_set()
18154 * @see elm_genlist_mode_get()
18158 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18163 * @param obj The genlist object
18164 * @param reorder_mode The reorder mode
18165 * (EINA_TRUE = on, EINA_FALSE = off)
18169 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18172 * Get the reorder mode
18174 * @param obj The genlist object
18175 * @return The reorder mode
18176 * (EINA_TRUE = on, EINA_FALSE = off)
18180 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18187 * @defgroup Check Check
18189 * @image html img/widget/check/preview-00.png
18190 * @image latex img/widget/check/preview-00.eps
18191 * @image html img/widget/check/preview-01.png
18192 * @image latex img/widget/check/preview-01.eps
18193 * @image html img/widget/check/preview-02.png
18194 * @image latex img/widget/check/preview-02.eps
18196 * @brief The check widget allows for toggling a value between true and
18199 * Check objects are a lot like radio objects in layout and functionality
18200 * except they do not work as a group, but independently and only toggle the
18201 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18202 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18203 * returns the current state. For convenience, like the radio objects, you
18204 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18205 * for it to modify.
18207 * Signals that you can add callbacks for are:
18208 * "changed" - This is called whenever the user changes the state of one of
18209 * the check object(event_info is NULL).
18211 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18215 * @brief Add a new Check object
18217 * @param parent The parent object
18218 * @return The new object or NULL if it cannot be created
18220 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18222 * @brief Set the text label of the check object
18224 * @param obj The check object
18225 * @param label The text label string in UTF-8
18227 * @deprecated use elm_object_text_set() instead.
18229 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18231 * @brief Get the text label of the check object
18233 * @param obj The check object
18234 * @return The text label string in UTF-8
18236 * @deprecated use elm_object_text_get() instead.
18238 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18240 * @brief Set the icon object of the check object
18242 * @param obj The check object
18243 * @param icon The icon object
18245 * Once the icon object is set, a previously set one will be deleted.
18246 * If you want to keep that old content object, use the
18247 * elm_check_icon_unset() function.
18249 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18251 * @brief Get the icon object of the check object
18253 * @param obj The check object
18254 * @return The icon object
18256 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18258 * @brief Unset the icon used for the check object
18260 * @param obj The check object
18261 * @return The icon object that was being used
18263 * Unparent and return the icon object which was set for this widget.
18265 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18267 * @brief Set the on/off state of the check object
18269 * @param obj The check object
18270 * @param state The state to use (1 == on, 0 == off)
18272 * This sets the state of the check. If set
18273 * with elm_check_state_pointer_set() the state of that variable is also
18274 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18276 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18278 * @brief Get the state of the check object
18280 * @param obj The check object
18281 * @return The boolean state
18283 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18285 * @brief Set a convenience pointer to a boolean to change
18287 * @param obj The check object
18288 * @param statep Pointer to the boolean to modify
18290 * This sets a pointer to a boolean, that, in addition to the check objects
18291 * state will also be modified directly. To stop setting the object pointed
18292 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18293 * then when this is called, the check objects state will also be modified to
18294 * reflect the value of the boolean @p statep points to, just like calling
18295 * elm_check_state_set().
18297 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18303 * @defgroup Radio Radio
18305 * @image html img/widget/radio/preview-00.png
18306 * @image latex img/widget/radio/preview-00.eps
18308 * @brief Radio is a widget that allows for 1 or more options to be displayed
18309 * and have the user choose only 1 of them.
18311 * A radio object contains an indicator, an optional Label and an optional
18312 * icon object. While it's possible to have a group of only one radio they,
18313 * are normally used in groups of 2 or more. To add a radio to a group use
18314 * elm_radio_group_add(). The radio object(s) will select from one of a set
18315 * of integer values, so any value they are configuring needs to be mapped to
18316 * a set of integers. To configure what value that radio object represents,
18317 * use elm_radio_state_value_set() to set the integer it represents. To set
18318 * the value the whole group(which one is currently selected) is to indicate
18319 * use elm_radio_value_set() on any group member, and to get the groups value
18320 * use elm_radio_value_get(). For convenience the radio objects are also able
18321 * to directly set an integer(int) to the value that is selected. To specify
18322 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18323 * The radio objects will modify this directly. That implies the pointer must
18324 * point to valid memory for as long as the radio objects exist.
18326 * Signals that you can add callbacks for are:
18327 * @li changed - This is called whenever the user changes the state of one of
18328 * the radio objects within the group of radio objects that work together.
18330 * @ref tutorial_radio show most of this API in action.
18334 * @brief Add a new radio to the parent
18336 * @param parent The parent object
18337 * @return The new object or NULL if it cannot be created
18339 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18341 * @brief Set the text label of the radio object
18343 * @param obj The radio object
18344 * @param label The text label string in UTF-8
18346 * @deprecated use elm_object_text_set() instead.
18348 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18350 * @brief Get the text label of the radio object
18352 * @param obj The radio object
18353 * @return The text label string in UTF-8
18355 * @deprecated use elm_object_text_set() instead.
18357 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18359 * @brief Set the icon object of the radio object
18361 * @param obj The radio object
18362 * @param icon The icon object
18364 * Once the icon object is set, a previously set one will be deleted. If you
18365 * want to keep that old content object, use the elm_radio_icon_unset()
18368 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18370 * @brief Get the icon object of the radio object
18372 * @param obj The radio object
18373 * @return The icon object
18375 * @see elm_radio_icon_set()
18377 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18379 * @brief Unset the icon used for the radio object
18381 * @param obj The radio object
18382 * @return The icon object that was being used
18384 * Unparent and return the icon object which was set for this widget.
18386 * @see elm_radio_icon_set()
18388 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18390 * @brief Add this radio to a group of other radio objects
18392 * @param obj The radio object
18393 * @param group Any object whose group the @p obj is to join.
18395 * Radio objects work in groups. Each member should have a different integer
18396 * value assigned. In order to have them work as a group, they need to know
18397 * about each other. This adds the given radio object to the group of which
18398 * the group object indicated is a member.
18400 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18402 * @brief Set the integer value that this radio object represents
18404 * @param obj The radio object
18405 * @param value The value to use if this radio object is selected
18407 * This sets the value of the radio.
18409 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18411 * @brief Get the integer value that this radio object represents
18413 * @param obj The radio object
18414 * @return The value used if this radio object is selected
18416 * This gets the value of the radio.
18418 * @see elm_radio_value_set()
18420 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18422 * @brief Set the value of the radio.
18424 * @param obj The radio object
18425 * @param value The value to use for the group
18427 * This sets the value of the radio group and will also set the value if
18428 * pointed to, to the value supplied, but will not call any callbacks.
18430 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18432 * @brief Get the state of the radio object
18434 * @param obj The radio object
18435 * @return The integer state
18437 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18439 * @brief Set a convenience pointer to a integer to change
18441 * @param obj The radio object
18442 * @param valuep Pointer to the integer to modify
18444 * This sets a pointer to a integer, that, in addition to the radio objects
18445 * state will also be modified directly. To stop setting the object pointed
18446 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18447 * when this is called, the radio objects state will also be modified to
18448 * reflect the value of the integer valuep points to, just like calling
18449 * elm_radio_value_set().
18451 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18457 * @defgroup Pager Pager
18459 * @image html img/widget/pager/preview-00.png
18460 * @image latex img/widget/pager/preview-00.eps
18462 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18464 * The flipping between “pages” of objects is animated. All content in pager
18465 * is kept in a stack, the last content to be added will be on the top of the
18466 * stack(be visible).
18468 * Objects can be pushed or popped from the stack or deleted as normal.
18469 * Pushes and pops will animate (and a pop will delete the object once the
18470 * animation is finished). Any object already in the pager can be promoted to
18471 * the top(from its current stacking position) through the use of
18472 * elm_pager_content_promote(). Objects are pushed to the top with
18473 * elm_pager_content_push() and when the top item is no longer wanted, simply
18474 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18475 * object is no longer needed and is not the top item, just delete it as
18476 * normal. You can query which objects are the top and bottom with
18477 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18479 * Signals that you can add callbacks for are:
18480 * "hide,finished" - when the previous page is hided
18482 * This widget has the following styles available:
18485 * @li fade_translucide
18486 * @li fade_invisible
18487 * @note This styles affect only the flipping animations, the appearance when
18488 * not animating is unaffected by styles.
18490 * @ref tutorial_pager gives a good overview of the usage of the API.
18494 * Add a new pager to the parent
18496 * @param parent The parent object
18497 * @return The new object or NULL if it cannot be created
18501 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18503 * @brief Push an object to the top of the pager stack (and show it).
18505 * @param obj The pager object
18506 * @param content The object to push
18508 * The object pushed becomes a child of the pager, it will be controlled and
18509 * deleted when the pager is deleted.
18511 * @note If the content is already in the stack use
18512 * elm_pager_content_promote().
18513 * @warning Using this function on @p content already in the stack results in
18514 * undefined behavior.
18516 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18518 * @brief Pop the object that is on top of the stack
18520 * @param obj The pager object
18522 * This pops the object that is on the top(visible) of the pager, makes it
18523 * disappear, then deletes the object. The object that was underneath it on
18524 * the stack will become visible.
18526 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18528 * @brief Moves an object already in the pager stack to the top of the stack.
18530 * @param obj The pager object
18531 * @param content The object to promote
18533 * This will take the @p content and move it to the top of the stack as
18534 * if it had been pushed there.
18536 * @note If the content isn't already in the stack use
18537 * elm_pager_content_push().
18538 * @warning Using this function on @p content not already in the stack
18539 * results in undefined behavior.
18541 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18543 * @brief Return the object at the bottom of the pager stack
18545 * @param obj The pager object
18546 * @return The bottom object or NULL if none
18548 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18550 * @brief Return the object at the top of the pager stack
18552 * @param obj The pager object
18553 * @return The top object or NULL if none
18555 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18561 * @defgroup Slideshow Slideshow
18563 * @image html img/widget/slideshow/preview-00.png
18564 * @image latex img/widget/slideshow/preview-00.eps
18566 * This widget, as the name indicates, is a pre-made image
18567 * slideshow panel, with API functions acting on (child) image
18568 * items presentation. Between those actions, are:
18569 * - advance to next/previous image
18570 * - select the style of image transition animation
18571 * - set the exhibition time for each image
18572 * - start/stop the slideshow
18574 * The transition animations are defined in the widget's theme,
18575 * consequently new animations can be added without having to
18576 * update the widget's code.
18578 * @section Slideshow_Items Slideshow items
18580 * For slideshow items, just like for @ref Genlist "genlist" ones,
18581 * the user defines a @b classes, specifying functions that will be
18582 * called on the item's creation and deletion times.
18584 * The #Elm_Slideshow_Item_Class structure contains the following
18587 * - @c func.get - When an item is displayed, this function is
18588 * called, and it's where one should create the item object, de
18589 * facto. For example, the object can be a pure Evas image object
18590 * or an Elementary @ref Photocam "photocam" widget. See
18591 * #SlideshowItemGetFunc.
18592 * - @c func.del - When an item is no more displayed, this function
18593 * is called, where the user must delete any data associated to
18594 * the item. See #SlideshowItemDelFunc.
18596 * @section Slideshow_Caching Slideshow caching
18598 * The slideshow provides facilities to have items adjacent to the
18599 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18600 * you, so that the system does not have to decode image data
18601 * anymore at the time it has to actually switch images on its
18602 * viewport. The user is able to set the numbers of items to be
18603 * cached @b before and @b after the current item, in the widget's
18606 * Smart events one can add callbacks for are:
18608 * - @c "changed" - when the slideshow switches its view to a new
18611 * List of examples for the slideshow widget:
18612 * @li @ref slideshow_example
18616 * @addtogroup Slideshow
18620 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18621 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18622 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18623 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18624 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18627 * @struct _Elm_Slideshow_Item_Class
18629 * Slideshow item class definition. See @ref Slideshow_Items for
18632 struct _Elm_Slideshow_Item_Class
18634 struct _Elm_Slideshow_Item_Class_Func
18636 SlideshowItemGetFunc get;
18637 SlideshowItemDelFunc del;
18639 }; /**< #Elm_Slideshow_Item_Class member definitions */
18642 * Add a new slideshow widget to the given parent Elementary
18643 * (container) object
18645 * @param parent The parent object
18646 * @return A new slideshow widget handle or @c NULL, on errors
18648 * This function inserts a new slideshow widget on the canvas.
18650 * @ingroup Slideshow
18652 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18655 * Add (append) a new item in a given slideshow widget.
18657 * @param obj The slideshow object
18658 * @param itc The item class for the item
18659 * @param data The item's data
18660 * @return A handle to the item added or @c NULL, on errors
18662 * Add a new item to @p obj's internal list of items, appending it.
18663 * The item's class must contain the function really fetching the
18664 * image object to show for this item, which could be an Evas image
18665 * object or an Elementary photo, for example. The @p data
18666 * parameter is going to be passed to both class functions of the
18669 * @see #Elm_Slideshow_Item_Class
18670 * @see elm_slideshow_item_sorted_insert()
18672 * @ingroup Slideshow
18674 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18677 * Insert a new item into the given slideshow widget, using the @p func
18678 * function to sort items (by item handles).
18680 * @param obj The slideshow object
18681 * @param itc The item class for the item
18682 * @param data The item's data
18683 * @param func The comparing function to be used to sort slideshow
18684 * items <b>by #Elm_Slideshow_Item item handles</b>
18685 * @return Returns The slideshow item handle, on success, or
18686 * @c NULL, on errors
18688 * Add a new item to @p obj's internal list of items, in a position
18689 * determined by the @p func comparing function. The item's class
18690 * must contain the function really fetching the image object to
18691 * show for this item, which could be an Evas image object or an
18692 * Elementary photo, for example. The @p data parameter is going to
18693 * be passed to both class functions of the item.
18695 * @see #Elm_Slideshow_Item_Class
18696 * @see elm_slideshow_item_add()
18698 * @ingroup Slideshow
18700 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);
18703 * Display a given slideshow widget's item, programmatically.
18705 * @param obj The slideshow object
18706 * @param item The item to display on @p obj's viewport
18708 * The change between the current item and @p item will use the
18709 * transition @p obj is set to use (@see
18710 * elm_slideshow_transition_set()).
18712 * @ingroup Slideshow
18714 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18717 * Slide to the @b next item, in a given slideshow widget
18719 * @param obj The slideshow object
18721 * The sliding animation @p obj is set to use will be the
18722 * transition effect used, after this call is issued.
18724 * @note If the end of the slideshow's internal list of items is
18725 * reached, it'll wrap around to the list's beginning, again.
18727 * @ingroup Slideshow
18729 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18732 * Slide to the @b previous item, in a given slideshow widget
18734 * @param obj The slideshow object
18736 * The sliding animation @p obj is set to use will be the
18737 * transition effect used, after this call is issued.
18739 * @note If the beginning of the slideshow's internal list of items
18740 * is reached, it'll wrap around to the list's end, again.
18742 * @ingroup Slideshow
18744 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18747 * Returns the list of sliding transition/effect names available, for a
18748 * given slideshow widget.
18750 * @param obj The slideshow object
18751 * @return The list of transitions (list of @b stringshared strings
18754 * The transitions, which come from @p obj's theme, must be an EDC
18755 * data item named @c "transitions" on the theme file, with (prefix)
18756 * names of EDC programs actually implementing them.
18758 * The available transitions for slideshows on the default theme are:
18759 * - @c "fade" - the current item fades out, while the new one
18760 * fades in to the slideshow's viewport.
18761 * - @c "black_fade" - the current item fades to black, and just
18762 * then, the new item will fade in.
18763 * - @c "horizontal" - the current item slides horizontally, until
18764 * it gets out of the slideshow's viewport, while the new item
18765 * comes from the left to take its place.
18766 * - @c "vertical" - the current item slides vertically, until it
18767 * gets out of the slideshow's viewport, while the new item comes
18768 * from the bottom to take its place.
18769 * - @c "square" - the new item starts to appear from the middle of
18770 * the current one, but with a tiny size, growing until its
18771 * target (full) size and covering the old one.
18773 * @warning The stringshared strings get no new references
18774 * exclusive to the user grabbing the list, here, so if you'd like
18775 * to use them out of this call's context, you'd better @c
18776 * eina_stringshare_ref() them.
18778 * @see elm_slideshow_transition_set()
18780 * @ingroup Slideshow
18782 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18785 * Set the current slide transition/effect in use for a given
18788 * @param obj The slideshow object
18789 * @param transition The new transition's name string
18791 * If @p transition is implemented in @p obj's theme (i.e., is
18792 * contained in the list returned by
18793 * elm_slideshow_transitions_get()), this new sliding effect will
18794 * be used on the widget.
18796 * @see elm_slideshow_transitions_get() for more details
18798 * @ingroup Slideshow
18800 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18803 * Get the current slide transition/effect in use for a given
18806 * @param obj The slideshow object
18807 * @return The current transition's name
18809 * @see elm_slideshow_transition_set() for more details
18811 * @ingroup Slideshow
18813 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18816 * Set the interval between each image transition on a given
18817 * slideshow widget, <b>and start the slideshow, itself</b>
18819 * @param obj The slideshow object
18820 * @param timeout The new displaying timeout for images
18822 * After this call, the slideshow widget will start cycling its
18823 * view, sequentially and automatically, with the images of the
18824 * items it has. The time between each new image displayed is going
18825 * to be @p timeout, in @b seconds. If a different timeout was set
18826 * previously and an slideshow was in progress, it will continue
18827 * with the new time between transitions, after this call.
18829 * @note A value less than or equal to 0 on @p timeout will disable
18830 * the widget's internal timer, thus halting any slideshow which
18831 * could be happening on @p obj.
18833 * @see elm_slideshow_timeout_get()
18835 * @ingroup Slideshow
18837 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18840 * Get the interval set for image transitions on a given slideshow
18843 * @param obj The slideshow object
18844 * @return Returns the timeout set on it
18846 * @see elm_slideshow_timeout_set() for more details
18848 * @ingroup Slideshow
18850 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18853 * Set if, after a slideshow is started, for a given slideshow
18854 * widget, its items should be displayed cyclically or not.
18856 * @param obj The slideshow object
18857 * @param loop Use @c EINA_TRUE to make it cycle through items or
18858 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18861 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18862 * ignore what is set by this functions, i.e., they'll @b always
18863 * cycle through items. This affects only the "automatic"
18864 * slideshow, as set by elm_slideshow_timeout_set().
18866 * @see elm_slideshow_loop_get()
18868 * @ingroup Slideshow
18870 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18873 * Get if, after a slideshow is started, for a given slideshow
18874 * widget, its items are to be displayed cyclically or not.
18876 * @param obj The slideshow object
18877 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18878 * through or @c EINA_FALSE, otherwise
18880 * @see elm_slideshow_loop_set() for more details
18882 * @ingroup Slideshow
18884 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18887 * Remove all items from a given slideshow widget
18889 * @param obj The slideshow object
18891 * This removes (and deletes) all items in @p obj, leaving it
18894 * @see elm_slideshow_item_del(), to remove just one item.
18896 * @ingroup Slideshow
18898 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18901 * Get the internal list of items in a given slideshow widget.
18903 * @param obj The slideshow object
18904 * @return The list of items (#Elm_Slideshow_Item as data) or
18905 * @c NULL on errors.
18907 * This list is @b not to be modified in any way and must not be
18908 * freed. Use the list members with functions like
18909 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18911 * @warning This list is only valid until @p obj object's internal
18912 * items list is changed. It should be fetched again with another
18913 * call to this function when changes happen.
18915 * @ingroup Slideshow
18917 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18920 * Delete a given item from a slideshow widget.
18922 * @param item The slideshow item
18924 * @ingroup Slideshow
18926 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18929 * Return the data associated with a given slideshow item
18931 * @param item The slideshow item
18932 * @return Returns the data associated to this item
18934 * @ingroup Slideshow
18936 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18939 * Returns the currently displayed item, in a given slideshow widget
18941 * @param obj The slideshow object
18942 * @return A handle to the item being displayed in @p obj or
18943 * @c NULL, if none is (and on errors)
18945 * @ingroup Slideshow
18947 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18950 * Get the real Evas object created to implement the view of a
18951 * given slideshow item
18953 * @param item The slideshow item.
18954 * @return the Evas object implementing this item's view.
18956 * This returns the actual Evas object used to implement the
18957 * specified slideshow item's view. This may be @c NULL, as it may
18958 * not have been created or may have been deleted, at any time, by
18959 * the slideshow. <b>Do not modify this object</b> (move, resize,
18960 * show, hide, etc.), as the slideshow is controlling it. This
18961 * function is for querying, emitting custom signals or hooking
18962 * lower level callbacks for events on that object. Do not delete
18963 * this object under any circumstances.
18965 * @see elm_slideshow_item_data_get()
18967 * @ingroup Slideshow
18969 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18972 * Get the the item, in a given slideshow widget, placed at
18973 * position @p nth, in its internal items list
18975 * @param obj The slideshow object
18976 * @param nth The number of the item to grab a handle to (0 being
18978 * @return The item stored in @p obj at position @p nth or @c NULL,
18979 * if there's no item with that index (and on errors)
18981 * @ingroup Slideshow
18983 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18986 * Set the current slide layout in use for a given slideshow widget
18988 * @param obj The slideshow object
18989 * @param layout The new layout's name string
18991 * If @p layout is implemented in @p obj's theme (i.e., is contained
18992 * in the list returned by elm_slideshow_layouts_get()), this new
18993 * images layout will be used on the widget.
18995 * @see elm_slideshow_layouts_get() for more details
18997 * @ingroup Slideshow
18999 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19002 * Get the current slide layout in use for a given slideshow widget
19004 * @param obj The slideshow object
19005 * @return The current layout's name
19007 * @see elm_slideshow_layout_set() for more details
19009 * @ingroup Slideshow
19011 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19014 * Returns the list of @b layout names available, for a given
19015 * slideshow widget.
19017 * @param obj The slideshow object
19018 * @return The list of layouts (list of @b stringshared strings
19021 * Slideshow layouts will change how the widget is to dispose each
19022 * image item in its viewport, with regard to cropping, scaling,
19025 * The layouts, which come from @p obj's theme, must be an EDC
19026 * data item name @c "layouts" on the theme file, with (prefix)
19027 * names of EDC programs actually implementing them.
19029 * The available layouts for slideshows on the default theme are:
19030 * - @c "fullscreen" - item images with original aspect, scaled to
19031 * touch top and down slideshow borders or, if the image's heigh
19032 * is not enough, left and right slideshow borders.
19033 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19034 * one, but always leaving 10% of the slideshow's dimensions of
19035 * distance between the item image's borders and the slideshow
19036 * borders, for each axis.
19038 * @warning The stringshared strings get no new references
19039 * exclusive to the user grabbing the list, here, so if you'd like
19040 * to use them out of this call's context, you'd better @c
19041 * eina_stringshare_ref() them.
19043 * @see elm_slideshow_layout_set()
19045 * @ingroup Slideshow
19047 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19050 * Set the number of items to cache, on a given slideshow widget,
19051 * <b>before the current item</b>
19053 * @param obj The slideshow object
19054 * @param count Number of items to cache before the current one
19056 * The default value for this property is @c 2. See
19057 * @ref Slideshow_Caching "slideshow caching" for more details.
19059 * @see elm_slideshow_cache_before_get()
19061 * @ingroup Slideshow
19063 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19066 * Retrieve the number of items to cache, on a given slideshow widget,
19067 * <b>before the current item</b>
19069 * @param obj The slideshow object
19070 * @return The number of items set to be cached before the current one
19072 * @see elm_slideshow_cache_before_set() for more details
19074 * @ingroup Slideshow
19076 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19079 * Set the number of items to cache, on a given slideshow widget,
19080 * <b>after the current item</b>
19082 * @param obj The slideshow object
19083 * @param count Number of items to cache after the current one
19085 * The default value for this property is @c 2. See
19086 * @ref Slideshow_Caching "slideshow caching" for more details.
19088 * @see elm_slideshow_cache_after_get()
19090 * @ingroup Slideshow
19092 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19095 * Retrieve the number of items to cache, on a given slideshow widget,
19096 * <b>after the current item</b>
19098 * @param obj The slideshow object
19099 * @return The number of items set to be cached after the current one
19101 * @see elm_slideshow_cache_after_set() for more details
19103 * @ingroup Slideshow
19105 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19108 * Get the number of items stored in a given slideshow widget
19110 * @param obj The slideshow object
19111 * @return The number of items on @p obj, at the moment of this call
19113 * @ingroup Slideshow
19115 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19122 * @defgroup Fileselector File Selector
19124 * @image html img/widget/fileselector/preview-00.png
19125 * @image latex img/widget/fileselector/preview-00.eps
19127 * A file selector is a widget that allows a user to navigate
19128 * through a file system, reporting file selections back via its
19131 * It contains shortcut buttons for home directory (@c ~) and to
19132 * jump one directory upwards (..), as well as cancel/ok buttons to
19133 * confirm/cancel a given selection. After either one of those two
19134 * former actions, the file selector will issue its @c "done" smart
19137 * There's a text entry on it, too, showing the name of the current
19138 * selection. There's the possibility of making it editable, so it
19139 * is useful on file saving dialogs on applications, where one
19140 * gives a file name to save contents to, in a given directory in
19141 * the system. This custom file name will be reported on the @c
19142 * "done" smart callback (explained in sequence).
19144 * Finally, it has a view to display file system items into in two
19149 * If Elementary is built with support of the Ethumb thumbnailing
19150 * library, the second form of view will display preview thumbnails
19151 * of files which it supports.
19153 * Smart callbacks one can register to:
19155 * - @c "selected" - the user has clicked on a file (when not in
19156 * folders-only mode) or directory (when in folders-only mode)
19157 * - @c "directory,open" - the list has been populated with new
19158 * content (@c event_info is a pointer to the directory's
19159 * path, a @b stringshared string)
19160 * - @c "done" - the user has clicked on the "ok" or "cancel"
19161 * buttons (@c event_info is a pointer to the selection's
19162 * path, a @b stringshared string)
19164 * Here is an example on its usage:
19165 * @li @ref fileselector_example
19169 * @addtogroup Fileselector
19174 * Defines how a file selector widget is to layout its contents
19175 * (file system entries).
19177 typedef enum _Elm_Fileselector_Mode
19179 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19180 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19181 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19182 } Elm_Fileselector_Mode;
19185 * Add a new file selector widget to the given parent Elementary
19186 * (container) object
19188 * @param parent The parent object
19189 * @return a new file selector widget handle or @c NULL, on errors
19191 * This function inserts a new file selector widget on the canvas.
19193 * @ingroup Fileselector
19195 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19198 * Enable/disable the file name entry box where the user can type
19199 * in a name for a file, in a given file selector widget
19201 * @param obj The file selector object
19202 * @param is_save @c EINA_TRUE to make the file selector a "saving
19203 * dialog", @c EINA_FALSE otherwise
19205 * Having the entry editable is useful on file saving dialogs on
19206 * applications, where one gives a file name to save contents to,
19207 * in a given directory in the system. This custom file name will
19208 * be reported on the @c "done" smart callback.
19210 * @see elm_fileselector_is_save_get()
19212 * @ingroup Fileselector
19214 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19217 * Get whether the given file selector is in "saving dialog" mode
19219 * @param obj The file selector object
19220 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19221 * mode, @c EINA_FALSE otherwise (and on errors)
19223 * @see elm_fileselector_is_save_set() for more details
19225 * @ingroup Fileselector
19227 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19230 * Enable/disable folder-only view for a given file selector widget
19232 * @param obj The file selector object
19233 * @param only @c EINA_TRUE to make @p obj only display
19234 * directories, @c EINA_FALSE to make files to be displayed in it
19237 * If enabled, the widget's view will only display folder items,
19240 * @see elm_fileselector_folder_only_get()
19242 * @ingroup Fileselector
19244 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19247 * Get whether folder-only view is set for a given file selector
19250 * @param obj The file selector object
19251 * @return only @c EINA_TRUE if @p obj is only displaying
19252 * directories, @c EINA_FALSE if files are being displayed in it
19253 * too (and on errors)
19255 * @see elm_fileselector_folder_only_get()
19257 * @ingroup Fileselector
19259 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19262 * Enable/disable the "ok" and "cancel" buttons on a given file
19265 * @param obj The file selector object
19266 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19268 * @note A file selector without those buttons will never emit the
19269 * @c "done" smart event, and is only usable if one is just hooking
19270 * to the other two events.
19272 * @see elm_fileselector_buttons_ok_cancel_get()
19274 * @ingroup Fileselector
19276 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19279 * Get whether the "ok" and "cancel" buttons on a given file
19280 * selector widget are being shown.
19282 * @param obj The file selector object
19283 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19284 * otherwise (and on errors)
19286 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19288 * @ingroup Fileselector
19290 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19293 * Enable/disable a tree view in the given file selector widget,
19294 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19296 * @param obj The file selector object
19297 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19300 * In a tree view, arrows are created on the sides of directories,
19301 * allowing them to expand in place.
19303 * @note If it's in other mode, the changes made by this function
19304 * will only be visible when one switches back to "list" mode.
19306 * @see elm_fileselector_expandable_get()
19308 * @ingroup Fileselector
19310 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19313 * Get whether tree view is enabled for the given file selector
19316 * @param obj The file selector object
19317 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19318 * otherwise (and or errors)
19320 * @see elm_fileselector_expandable_set() for more details
19322 * @ingroup Fileselector
19324 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19327 * Set, programmatically, the @b directory that a given file
19328 * selector widget will display contents from
19330 * @param obj The file selector object
19331 * @param path The path to display in @p obj
19333 * This will change the @b directory that @p obj is displaying. It
19334 * will also clear the text entry area on the @p obj object, which
19335 * displays select files' names.
19337 * @see elm_fileselector_path_get()
19339 * @ingroup Fileselector
19341 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19344 * Get the parent directory's path that a given file selector
19345 * widget is displaying
19347 * @param obj The file selector object
19348 * @return The (full) path of the directory the file selector is
19349 * displaying, a @b stringshared string
19351 * @see elm_fileselector_path_set()
19353 * @ingroup Fileselector
19355 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19358 * Set, programmatically, the currently selected file/directory in
19359 * the given file selector widget
19361 * @param obj The file selector object
19362 * @param path The (full) path to a file or directory
19363 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19364 * latter case occurs if the directory or file pointed to do not
19367 * @see elm_fileselector_selected_get()
19369 * @ingroup Fileselector
19371 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19374 * Get the currently selected item's (full) path, in the given file
19377 * @param obj The file selector object
19378 * @return The absolute path of the selected item, a @b
19379 * stringshared string
19381 * @note Custom editions on @p obj object's text entry, if made,
19382 * will appear on the return string of this function, naturally.
19384 * @see elm_fileselector_selected_set() for more details
19386 * @ingroup Fileselector
19388 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19391 * Set the mode in which a given file selector widget will display
19392 * (layout) file system entries in its view
19394 * @param obj The file selector object
19395 * @param mode The mode of the fileselector, being it one of
19396 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19397 * first one, naturally, will display the files in a list. The
19398 * latter will make the widget to display its entries in a grid
19401 * @note By using elm_fileselector_expandable_set(), the user may
19402 * trigger a tree view for that list.
19404 * @note If Elementary is built with support of the Ethumb
19405 * thumbnailing library, the second form of view will display
19406 * preview thumbnails of files which it supports. You must have
19407 * elm_need_ethumb() called in your Elementary for thumbnailing to
19410 * @see elm_fileselector_expandable_set().
19411 * @see elm_fileselector_mode_get().
19413 * @ingroup Fileselector
19415 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19418 * Get the mode in which a given file selector widget is displaying
19419 * (layouting) file system entries in its view
19421 * @param obj The fileselector object
19422 * @return The mode in which the fileselector is at
19424 * @see elm_fileselector_mode_set() for more details
19426 * @ingroup Fileselector
19428 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19435 * @defgroup Progressbar Progress bar
19437 * The progress bar is a widget for visually representing the
19438 * progress status of a given job/task.
19440 * A progress bar may be horizontal or vertical. It may display an
19441 * icon besides it, as well as primary and @b units labels. The
19442 * former is meant to label the widget as a whole, while the
19443 * latter, which is formatted with floating point values (and thus
19444 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19445 * units"</c>), is meant to label the widget's <b>progress
19446 * value</b>. Label, icon and unit strings/objects are @b optional
19447 * for progress bars.
19449 * A progress bar may be @b inverted, in which state it gets its
19450 * values inverted, with high values being on the left or top and
19451 * low values on the right or bottom, as opposed to normally have
19452 * the low values on the former and high values on the latter,
19453 * respectively, for horizontal and vertical modes.
19455 * The @b span of the progress, as set by
19456 * elm_progressbar_span_size_set(), is its length (horizontally or
19457 * vertically), unless one puts size hints on the widget to expand
19458 * on desired directions, by any container. That length will be
19459 * scaled by the object or applications scaling factor. At any
19460 * point code can query the progress bar for its value with
19461 * elm_progressbar_value_get().
19463 * Available widget styles for progress bars:
19465 * - @c "wheel" (simple style, no text, no progression, only
19466 * "pulse" effect is available)
19468 * Here is an example on its usage:
19469 * @li @ref progressbar_example
19473 * Add a new progress bar widget to the given parent Elementary
19474 * (container) object
19476 * @param parent The parent object
19477 * @return a new progress bar widget handle or @c NULL, on errors
19479 * This function inserts a new progress bar widget on the canvas.
19481 * @ingroup Progressbar
19483 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19486 * Set whether a given progress bar widget is at "pulsing mode" or
19489 * @param obj The progress bar object
19490 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19491 * @c EINA_FALSE to put it back to its default one
19493 * By default, progress bars will display values from the low to
19494 * high value boundaries. There are, though, contexts in which the
19495 * state of progression of a given task is @b unknown. For those,
19496 * one can set a progress bar widget to a "pulsing state", to give
19497 * the user an idea that some computation is being held, but
19498 * without exact progress values. In the default theme it will
19499 * animate its bar with the contents filling in constantly and back
19500 * to non-filled, in a loop. To start and stop this pulsing
19501 * animation, one has to explicitly call elm_progressbar_pulse().
19503 * @see elm_progressbar_pulse_get()
19504 * @see elm_progressbar_pulse()
19506 * @ingroup Progressbar
19508 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19511 * Get whether a given progress bar widget is at "pulsing mode" or
19514 * @param obj The progress bar object
19515 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19516 * if it's in the default one (and on errors)
19518 * @ingroup Progressbar
19520 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19523 * Start/stop a given progress bar "pulsing" animation, if its
19526 * @param obj The progress bar object
19527 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19528 * @c EINA_FALSE to @b stop it
19530 * @note This call won't do anything if @p obj is not under "pulsing mode".
19532 * @see elm_progressbar_pulse_set() for more details.
19534 * @ingroup Progressbar
19536 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19539 * Set the progress value (in percentage) on a given progress bar
19542 * @param obj The progress bar object
19543 * @param val The progress value (@b must be between @c 0.0 and @c
19546 * Use this call to set progress bar levels.
19548 * @note If you passes a value out of the specified range for @p
19549 * val, it will be interpreted as the @b closest of the @b boundary
19550 * values in the range.
19552 * @ingroup Progressbar
19554 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19557 * Get the progress value (in percentage) on a given progress bar
19560 * @param obj The progress bar object
19561 * @return The value of the progressbar
19563 * @see elm_progressbar_value_set() for more details
19565 * @ingroup Progressbar
19567 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19570 * Set the label of a given progress bar widget
19572 * @param obj The progress bar object
19573 * @param label The text label string, in UTF-8
19575 * @ingroup Progressbar
19576 * @deprecated use elm_object_text_set() instead.
19578 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19581 * Get the label of a given progress bar widget
19583 * @param obj The progressbar object
19584 * @return The text label string, in UTF-8
19586 * @ingroup Progressbar
19587 * @deprecated use elm_object_text_set() instead.
19589 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19592 * Set the icon object of a given progress bar widget
19594 * @param obj The progress bar object
19595 * @param icon The icon object
19597 * Use this call to decorate @p obj with an icon next to it.
19599 * @note Once the icon object is set, a previously set one will be
19600 * deleted. If you want to keep that old content object, use the
19601 * elm_progressbar_icon_unset() function.
19603 * @see elm_progressbar_icon_get()
19605 * @ingroup Progressbar
19607 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19610 * Retrieve the icon object set for a given progress bar widget
19612 * @param obj The progress bar object
19613 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19614 * otherwise (and on errors)
19616 * @see elm_progressbar_icon_set() for more details
19618 * @ingroup Progressbar
19620 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19623 * Unset an icon set on a given progress bar widget
19625 * @param obj The progress bar object
19626 * @return The icon object that was being used, if any was set, or
19627 * @c NULL, otherwise (and on errors)
19629 * This call will unparent and return the icon object which was set
19630 * for this widget, previously, on success.
19632 * @see elm_progressbar_icon_set() for more details
19634 * @ingroup Progressbar
19636 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19639 * Set the (exact) length of the bar region of a given progress bar
19642 * @param obj The progress bar object
19643 * @param size The length of the progress bar's bar region
19645 * This sets the minimum width (when in horizontal mode) or height
19646 * (when in vertical mode) of the actual bar area of the progress
19647 * bar @p obj. This in turn affects the object's minimum size. Use
19648 * this when you're not setting other size hints expanding on the
19649 * given direction (like weight and alignment hints) and you would
19650 * like it to have a specific size.
19652 * @note Icon, label and unit text around @p obj will require their
19653 * own space, which will make @p obj to require more the @p size,
19656 * @see elm_progressbar_span_size_get()
19658 * @ingroup Progressbar
19660 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19663 * Get the length set for the bar region of a given progress bar
19666 * @param obj The progress bar object
19667 * @return The length of the progress bar's bar region
19669 * If that size was not set previously, with
19670 * elm_progressbar_span_size_set(), this call will return @c 0.
19672 * @ingroup Progressbar
19674 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19677 * Set the format string for a given progress bar widget's units
19680 * @param obj The progress bar object
19681 * @param format The format string for @p obj's units label
19683 * If @c NULL is passed on @p format, it will make @p obj's units
19684 * area to be hidden completely. If not, it'll set the <b>format
19685 * string</b> for the units label's @b text. The units label is
19686 * provided a floating point value, so the units text is up display
19687 * at most one floating point falue. Note that the units label is
19688 * optional. Use a format string such as "%1.2f meters" for
19691 * @note The default format string for a progress bar is an integer
19692 * percentage, as in @c "%.0f %%".
19694 * @see elm_progressbar_unit_format_get()
19696 * @ingroup Progressbar
19698 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19701 * Retrieve the format string set for a given progress bar widget's
19704 * @param obj The progress bar object
19705 * @return The format set string for @p obj's units label or
19706 * @c NULL, if none was set (and on errors)
19708 * @see elm_progressbar_unit_format_set() for more details
19710 * @ingroup Progressbar
19712 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19715 * Set the orientation of a given progress bar widget
19717 * @param obj The progress bar object
19718 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19719 * @b horizontal, @c EINA_FALSE to make it @b vertical
19721 * Use this function to change how your progress bar is to be
19722 * disposed: vertically or horizontally.
19724 * @see elm_progressbar_horizontal_get()
19726 * @ingroup Progressbar
19728 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19731 * Retrieve the orientation of a given progress bar widget
19733 * @param obj The progress bar object
19734 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19735 * @c EINA_FALSE if it's @b vertical (and on errors)
19737 * @see elm_progressbar_horizontal_set() for more details
19739 * @ingroup Progressbar
19741 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19744 * Invert a given progress bar widget's displaying values order
19746 * @param obj The progress bar object
19747 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19748 * @c EINA_FALSE to bring it back to default, non-inverted values.
19750 * A progress bar may be @b inverted, in which state it gets its
19751 * values inverted, with high values being on the left or top and
19752 * low values on the right or bottom, as opposed to normally have
19753 * the low values on the former and high values on the latter,
19754 * respectively, for horizontal and vertical modes.
19756 * @see elm_progressbar_inverted_get()
19758 * @ingroup Progressbar
19760 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19763 * Get whether a given progress bar widget's displaying values are
19766 * @param obj The progress bar object
19767 * @return @c EINA_TRUE, if @p obj has inverted values,
19768 * @c EINA_FALSE otherwise (and on errors)
19770 * @see elm_progressbar_inverted_set() for more details
19772 * @ingroup Progressbar
19774 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19777 * @defgroup Separator Separator
19779 * @brief Separator is a very thin object used to separate other objects.
19781 * A separator can be vertical or horizontal.
19783 * @ref tutorial_separator is a good example of how to use a separator.
19787 * @brief Add a separator object to @p parent
19789 * @param parent The parent object
19791 * @return The separator object, or NULL upon failure
19793 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19795 * @brief Set the horizontal mode of a separator object
19797 * @param obj The separator object
19798 * @param horizontal If true, the separator is horizontal
19800 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19802 * @brief Get the horizontal mode of a separator object
19804 * @param obj The separator object
19805 * @return If true, the separator is horizontal
19807 * @see elm_separator_horizontal_set()
19809 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19815 * @defgroup Spinner Spinner
19816 * @ingroup Elementary
19818 * @image html img/widget/spinner/preview-00.png
19819 * @image latex img/widget/spinner/preview-00.eps
19821 * A spinner is a widget which allows the user to increase or decrease
19822 * numeric values using arrow buttons, or edit values directly, clicking
19823 * over it and typing the new value.
19825 * By default the spinner will not wrap and has a label
19826 * of "%.0f" (just showing the integer value of the double).
19828 * A spinner has a label that is formatted with floating
19829 * point values and thus accepts a printf-style format string, like
19832 * It also allows specific values to be replaced by pre-defined labels.
19834 * Smart callbacks one can register to:
19836 * - "changed" - Whenever the spinner value is changed.
19837 * - "delay,changed" - A short time after the value is changed by the user.
19838 * This will be called only when the user stops dragging for a very short
19839 * period or when they release their finger/mouse, so it avoids possibly
19840 * expensive reactions to the value change.
19842 * Available styles for it:
19844 * - @c "vertical": up/down buttons at the right side and text left aligned.
19846 * Here is an example on its usage:
19847 * @ref spinner_example
19851 * @addtogroup Spinner
19856 * Add a new spinner widget to the given parent Elementary
19857 * (container) object.
19859 * @param parent The parent object.
19860 * @return a new spinner widget handle or @c NULL, on errors.
19862 * This function inserts a new spinner widget on the canvas.
19867 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19870 * Set the format string of the displayed label.
19872 * @param obj The spinner object.
19873 * @param fmt The format string for the label display.
19875 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19876 * string for the label text. The label text is provided a floating point
19877 * value, so the label text can display up to 1 floating point value.
19878 * Note that this is optional.
19880 * Use a format string such as "%1.2f meters" for example, and it will
19881 * display values like: "3.14 meters" for a value equal to 3.14159.
19883 * Default is "%0.f".
19885 * @see elm_spinner_label_format_get()
19889 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19892 * Get the label format of the spinner.
19894 * @param obj The spinner object.
19895 * @return The text label format string in UTF-8.
19897 * @see elm_spinner_label_format_set() for details.
19901 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19904 * Set the minimum and maximum values for the spinner.
19906 * @param obj The spinner object.
19907 * @param min The minimum value.
19908 * @param max The maximum value.
19910 * Define the allowed range of values to be selected by the user.
19912 * If actual value is less than @p min, it will be updated to @p min. If it
19913 * is bigger then @p max, will be updated to @p max. Actual value can be
19914 * get with elm_spinner_value_get().
19916 * By default, min is equal to 0, and max is equal to 100.
19918 * @warning Maximum must be greater than minimum.
19920 * @see elm_spinner_min_max_get()
19924 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19927 * Get the minimum and maximum values of the spinner.
19929 * @param obj The spinner object.
19930 * @param min Pointer where to store the minimum value.
19931 * @param max Pointer where to store the maximum value.
19933 * @note If only one value is needed, the other pointer can be passed
19936 * @see elm_spinner_min_max_set() for details.
19940 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19943 * Set the step used to increment or decrement the spinner value.
19945 * @param obj The spinner object.
19946 * @param step The step value.
19948 * This value will be incremented or decremented to the displayed value.
19949 * It will be incremented while the user keep right or top arrow pressed,
19950 * and will be decremented while the user keep left or bottom arrow pressed.
19952 * The interval to increment / decrement can be set with
19953 * elm_spinner_interval_set().
19955 * By default step value is equal to 1.
19957 * @see elm_spinner_step_get()
19961 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19964 * Get the step used to increment or decrement the spinner value.
19966 * @param obj The spinner object.
19967 * @return The step value.
19969 * @see elm_spinner_step_get() for more details.
19973 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19976 * Set the value the spinner displays.
19978 * @param obj The spinner object.
19979 * @param val The value to be displayed.
19981 * Value will be presented on the label following format specified with
19982 * elm_spinner_format_set().
19984 * @warning The value must to be between min and max values. This values
19985 * are set by elm_spinner_min_max_set().
19987 * @see elm_spinner_value_get().
19988 * @see elm_spinner_format_set().
19989 * @see elm_spinner_min_max_set().
19993 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19996 * Get the value displayed by the spinner.
19998 * @param obj The spinner object.
19999 * @return The value displayed.
20001 * @see elm_spinner_value_set() for details.
20005 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20008 * Set whether the spinner should wrap when it reaches its
20009 * minimum or maximum value.
20011 * @param obj The spinner object.
20012 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20015 * Disabled by default. If disabled, when the user tries to increment the
20017 * but displayed value plus step value is bigger than maximum value,
20019 * won't allow it. The same happens when the user tries to decrement it,
20020 * but the value less step is less than minimum value.
20022 * When wrap is enabled, in such situations it will allow these changes,
20023 * but will get the value that would be less than minimum and subtracts
20024 * from maximum. Or add the value that would be more than maximum to
20028 * @li min value = 10
20029 * @li max value = 50
20030 * @li step value = 20
20031 * @li displayed value = 20
20033 * When the user decrement value (using left or bottom arrow), it will
20034 * displays @c 40, because max - (min - (displayed - step)) is
20035 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20037 * @see elm_spinner_wrap_get().
20041 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20044 * Get whether the spinner should wrap when it reaches its
20045 * minimum or maximum value.
20047 * @param obj The spinner object
20048 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20049 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20051 * @see elm_spinner_wrap_set() for details.
20055 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20058 * Set whether the spinner can be directly edited by the user or not.
20060 * @param obj The spinner object.
20061 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20062 * don't allow users to edit it directly.
20064 * Spinner objects can have edition @b disabled, in which state they will
20065 * be changed only by arrows.
20066 * Useful for contexts
20067 * where you don't want your users to interact with it writting the value.
20069 * when using special values, the user can see real value instead
20070 * of special label on edition.
20072 * It's enabled by default.
20074 * @see elm_spinner_editable_get()
20078 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20081 * Get whether the spinner can be directly edited by the user or not.
20083 * @param obj The spinner object.
20084 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20085 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20087 * @see elm_spinner_editable_set() for details.
20091 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20094 * Set a special string to display in the place of the numerical value.
20096 * @param obj The spinner object.
20097 * @param value The value to be replaced.
20098 * @param label The label to be used.
20100 * It's useful for cases when a user should select an item that is
20101 * better indicated by a label than a value. For example, weekdays or months.
20105 * sp = elm_spinner_add(win);
20106 * elm_spinner_min_max_set(sp, 1, 3);
20107 * elm_spinner_special_value_add(sp, 1, "January");
20108 * elm_spinner_special_value_add(sp, 2, "February");
20109 * elm_spinner_special_value_add(sp, 3, "March");
20110 * evas_object_show(sp);
20115 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20118 * Set the interval on time updates for an user mouse button hold
20119 * on spinner widgets' arrows.
20121 * @param obj The spinner object.
20122 * @param interval The (first) interval value in seconds.
20124 * This interval value is @b decreased while the user holds the
20125 * mouse pointer either incrementing or decrementing spinner's value.
20127 * This helps the user to get to a given value distant from the
20128 * current one easier/faster, as it will start to change quicker and
20129 * quicker on mouse button holds.
20131 * The calculation for the next change interval value, starting from
20132 * the one set with this call, is the previous interval divided by
20133 * @c 1.05, so it decreases a little bit.
20135 * The default starting interval value for automatic changes is
20138 * @see elm_spinner_interval_get()
20142 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20145 * Get the interval on time updates for an user mouse button hold
20146 * on spinner widgets' arrows.
20148 * @param obj The spinner object.
20149 * @return The (first) interval value, in seconds, set on it.
20151 * @see elm_spinner_interval_set() for more details.
20155 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20162 * @defgroup Index Index
20164 * @image html img/widget/index/preview-00.png
20165 * @image latex img/widget/index/preview-00.eps
20167 * An index widget gives you an index for fast access to whichever
20168 * group of other UI items one might have. It's a list of text
20169 * items (usually letters, for alphabetically ordered access).
20171 * Index widgets are by default hidden and just appear when the
20172 * user clicks over it's reserved area in the canvas. In its
20173 * default theme, it's an area one @ref Fingers "finger" wide on
20174 * the right side of the index widget's container.
20176 * When items on the index are selected, smart callbacks get
20177 * called, so that its user can make other container objects to
20178 * show a given area or child object depending on the index item
20179 * selected. You'd probably be using an index together with @ref
20180 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20183 * Smart events one can add callbacks for are:
20184 * - @c "changed" - When the selected index item changes. @c
20185 * event_info is the selected item's data pointer.
20186 * - @c "delay,changed" - When the selected index item changes, but
20187 * after a small idling period. @c event_info is the selected
20188 * item's data pointer.
20189 * - @c "selected" - When the user releases a mouse button and
20190 * selects an item. @c event_info is the selected item's data
20192 * - @c "level,up" - when the user moves a finger from the first
20193 * level to the second level
20194 * - @c "level,down" - when the user moves a finger from the second
20195 * level to the first level
20197 * The @c "delay,changed" event is so that it'll wait a small time
20198 * before actually reporting those events and, moreover, just the
20199 * last event happening on those time frames will actually be
20202 * Here are some examples on its usage:
20203 * @li @ref index_example_01
20204 * @li @ref index_example_02
20208 * @addtogroup Index
20212 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20215 * Add a new index widget to the given parent Elementary
20216 * (container) object
20218 * @param parent The parent object
20219 * @return a new index widget handle or @c NULL, on errors
20221 * This function inserts a new index widget on the canvas.
20225 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20228 * Set whether a given index widget is or not visible,
20231 * @param obj The index object
20232 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20234 * Not to be confused with visible as in @c evas_object_show() --
20235 * visible with regard to the widget's auto hiding feature.
20237 * @see elm_index_active_get()
20241 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20244 * Get whether a given index widget is currently visible or not.
20246 * @param obj The index object
20247 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20249 * @see elm_index_active_set() for more details
20253 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20256 * Set the items level for a given index widget.
20258 * @param obj The index object.
20259 * @param level @c 0 or @c 1, the currently implemented levels.
20261 * @see elm_index_item_level_get()
20265 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20268 * Get the items level set for a given index widget.
20270 * @param obj The index object.
20271 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20273 * @see elm_index_item_level_set() for more information
20277 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20280 * Returns the last selected item's data, for a given index widget.
20282 * @param obj The index object.
20283 * @return The item @b data associated to the last selected item on
20284 * @p obj (or @c NULL, on errors).
20286 * @warning The returned value is @b not an #Elm_Index_Item item
20287 * handle, but the data associated to it (see the @c item parameter
20288 * in elm_index_item_append(), as an example).
20292 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20295 * Append a new item on a given index widget.
20297 * @param obj The index object.
20298 * @param letter Letter under which the item should be indexed
20299 * @param item The item data to set for the index's item
20301 * Despite the most common usage of the @p letter argument is for
20302 * single char strings, one could use arbitrary strings as index
20305 * @c item will be the pointer returned back on @c "changed", @c
20306 * "delay,changed" and @c "selected" smart events.
20310 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20313 * Prepend a new item on a given index widget.
20315 * @param obj The index object.
20316 * @param letter Letter under which the item should be indexed
20317 * @param item The item data to set for the index's item
20319 * Despite the most common usage of the @p letter argument is for
20320 * single char strings, one could use arbitrary strings as index
20323 * @c item will be the pointer returned back on @c "changed", @c
20324 * "delay,changed" and @c "selected" smart events.
20328 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20331 * Append a new item, on a given index widget, <b>after the item
20332 * having @p relative as data</b>.
20334 * @param obj The index object.
20335 * @param letter Letter under which the item should be indexed
20336 * @param item The item data to set for the index's item
20337 * @param relative The item data of the index item to be the
20338 * predecessor of this new one
20340 * Despite the most common usage of the @p letter argument is for
20341 * single char strings, one could use arbitrary strings as index
20344 * @c item will be the pointer returned back on @c "changed", @c
20345 * "delay,changed" and @c "selected" smart events.
20347 * @note If @p relative is @c NULL or if it's not found to be data
20348 * set on any previous item on @p obj, this function will behave as
20349 * elm_index_item_append().
20353 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20356 * Prepend a new item, on a given index widget, <b>after the item
20357 * having @p relative as data</b>.
20359 * @param obj The index object.
20360 * @param letter Letter under which the item should be indexed
20361 * @param item The item data to set for the index's item
20362 * @param relative The item data of the index item to be the
20363 * successor of this new one
20365 * Despite the most common usage of the @p letter argument is for
20366 * single char strings, one could use arbitrary strings as index
20369 * @c item will be the pointer returned back on @c "changed", @c
20370 * "delay,changed" and @c "selected" smart events.
20372 * @note If @p relative is @c NULL or if it's not found to be data
20373 * set on any previous item on @p obj, this function will behave as
20374 * elm_index_item_prepend().
20378 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20381 * Insert a new item into the given index widget, using @p cmp_func
20382 * function to sort items (by item handles).
20384 * @param obj The index object.
20385 * @param letter Letter under which the item should be indexed
20386 * @param item The item data to set for the index's item
20387 * @param cmp_func The comparing function to be used to sort index
20388 * items <b>by #Elm_Index_Item item handles</b>
20389 * @param cmp_data_func A @b fallback function to be called for the
20390 * sorting of index items <b>by item data</b>). It will be used
20391 * when @p cmp_func returns @c 0 (equality), which means an index
20392 * item with provided item data already exists. To decide which
20393 * data item should be pointed to by the index item in question, @p
20394 * cmp_data_func will be used. If @p cmp_data_func returns a
20395 * non-negative value, the previous index item data will be
20396 * replaced by the given @p item pointer. If the previous data need
20397 * to be freed, it should be done by the @p cmp_data_func function,
20398 * because all references to it will be lost. If this function is
20399 * not provided (@c NULL is given), index items will be @b
20400 * duplicated, if @p cmp_func returns @c 0.
20402 * Despite the most common usage of the @p letter argument is for
20403 * single char strings, one could use arbitrary strings as index
20406 * @c item will be the pointer returned back on @c "changed", @c
20407 * "delay,changed" and @c "selected" smart events.
20411 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);
20414 * Remove an item from a given index widget, <b>to be referenced by
20415 * it's data value</b>.
20417 * @param obj The index object
20418 * @param item The item's data pointer for the item to be removed
20421 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20422 * that callback function will be called by this one.
20424 * @warning The item to be removed from @p obj will be found via
20425 * its item data pointer, and not by an #Elm_Index_Item handle.
20429 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20432 * Find a given index widget's item, <b>using item data</b>.
20434 * @param obj The index object
20435 * @param item The item data pointed to by the desired index item
20436 * @return The index item handle, if found, or @c NULL otherwise
20440 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20443 * Removes @b all items from a given index widget.
20445 * @param obj The index object.
20447 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20448 * that callback function will be called for each item in @p obj.
20452 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20455 * Go to a given items level on a index widget
20457 * @param obj The index object
20458 * @param level The index level (one of @c 0 or @c 1)
20462 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20465 * Return the data associated with a given index widget item
20467 * @param it The index widget item handle
20468 * @return The data associated with @p it
20470 * @see elm_index_item_data_set()
20474 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20477 * Set the data associated with a given index widget item
20479 * @param it The index widget item handle
20480 * @param data The new data pointer to set to @p it
20482 * This sets new item data on @p it.
20484 * @warning The old data pointer won't be touched by this function, so
20485 * the user had better to free that old data himself/herself.
20489 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20492 * Set the function to be called when a given index widget item is freed.
20494 * @param it The item to set the callback on
20495 * @param func The function to call on the item's deletion
20497 * When called, @p func will have both @c data and @c event_info
20498 * arguments with the @p it item's data value and, naturally, the
20499 * @c obj argument with a handle to the parent index widget.
20503 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20506 * Get the letter (string) set on a given index widget item.
20508 * @param it The index item handle
20509 * @return The letter string set on @p it
20513 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20520 * @defgroup Photocam Photocam
20522 * @image html img/widget/photocam/preview-00.png
20523 * @image latex img/widget/photocam/preview-00.eps
20525 * This is a widget specifically for displaying high-resolution digital
20526 * camera photos giving speedy feedback (fast load), low memory footprint
20527 * and zooming and panning as well as fitting logic. It is entirely focused
20528 * on jpeg images, and takes advantage of properties of the jpeg format (via
20529 * evas loader features in the jpeg loader).
20531 * Signals that you can add callbacks for are:
20532 * @li "clicked" - This is called when a user has clicked the photo without
20534 * @li "press" - This is called when a user has pressed down on the photo.
20535 * @li "longpressed" - This is called when a user has pressed down on the
20536 * photo for a long time without dragging around.
20537 * @li "clicked,double" - This is called when a user has double-clicked the
20539 * @li "load" - Photo load begins.
20540 * @li "loaded" - This is called when the image file load is complete for the
20541 * first view (low resolution blurry version).
20542 * @li "load,detail" - Photo detailed data load begins.
20543 * @li "loaded,detail" - This is called when the image file load is complete
20544 * for the detailed image data (full resolution needed).
20545 * @li "zoom,start" - Zoom animation started.
20546 * @li "zoom,stop" - Zoom animation stopped.
20547 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20548 * @li "scroll" - the content has been scrolled (moved)
20549 * @li "scroll,anim,start" - scrolling animation has started
20550 * @li "scroll,anim,stop" - scrolling animation has stopped
20551 * @li "scroll,drag,start" - dragging the contents around has started
20552 * @li "scroll,drag,stop" - dragging the contents around has stopped
20554 * @ref tutorial_photocam shows the API in action.
20558 * @brief Types of zoom available.
20560 typedef enum _Elm_Photocam_Zoom_Mode
20562 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20563 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20564 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20565 ELM_PHOTOCAM_ZOOM_MODE_LAST
20566 } Elm_Photocam_Zoom_Mode;
20568 * @brief Add a new Photocam object
20570 * @param parent The parent object
20571 * @return The new object or NULL if it cannot be created
20573 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20575 * @brief Set the photo file to be shown
20577 * @param obj The photocam object
20578 * @param file The photo file
20579 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20581 * This sets (and shows) the specified file (with a relative or absolute
20582 * path) and will return a load error (same error that
20583 * evas_object_image_load_error_get() will return). The image will change and
20584 * adjust its size at this point and begin a background load process for this
20585 * photo that at some time in the future will be displayed at the full
20588 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20590 * @brief Returns the path of the current image file
20592 * @param obj The photocam object
20593 * @return Returns the path
20595 * @see elm_photocam_file_set()
20597 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20599 * @brief Set the zoom level of the photo
20601 * @param obj The photocam object
20602 * @param zoom The zoom level to set
20604 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20605 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20606 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20607 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20610 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20612 * @brief Get the zoom level of the photo
20614 * @param obj The photocam object
20615 * @return The current zoom level
20617 * This returns the current zoom level of the photocam object. Note that if
20618 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20619 * (which is the default), the zoom level may be changed at any time by the
20620 * photocam object itself to account for photo size and photocam viewpoer
20623 * @see elm_photocam_zoom_set()
20624 * @see elm_photocam_zoom_mode_set()
20626 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20628 * @brief Set the zoom mode
20630 * @param obj The photocam object
20631 * @param mode The desired mode
20633 * This sets the zoom mode to manual or one of several automatic levels.
20634 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20635 * elm_photocam_zoom_set() and will stay at that level until changed by code
20636 * or until zoom mode is changed. This is the default mode. The Automatic
20637 * modes will allow the photocam object to automatically adjust zoom mode
20638 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20639 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20640 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20641 * pixels within the frame are left unfilled.
20643 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20645 * @brief Get the zoom mode
20647 * @param obj The photocam object
20648 * @return The current zoom mode
20650 * This gets the current zoom mode of the photocam object.
20652 * @see elm_photocam_zoom_mode_set()
20654 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20656 * @brief Get the current image pixel width and height
20658 * @param obj The photocam object
20659 * @param w A pointer to the width return
20660 * @param h A pointer to the height return
20662 * This gets the current photo pixel width and height (for the original).
20663 * The size will be returned in the integers @p w and @p h that are pointed
20666 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20668 * @brief Get the area of the image that is currently shown
20671 * @param x A pointer to the X-coordinate of region
20672 * @param y A pointer to the Y-coordinate of region
20673 * @param w A pointer to the width
20674 * @param h A pointer to the height
20676 * @see elm_photocam_image_region_show()
20677 * @see elm_photocam_image_region_bring_in()
20679 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20681 * @brief Set the viewed portion of the image
20683 * @param obj The photocam object
20684 * @param x X-coordinate of region in image original pixels
20685 * @param y Y-coordinate of region in image original pixels
20686 * @param w Width of region in image original pixels
20687 * @param h Height of region in image original pixels
20689 * This shows the region of the image without using animation.
20691 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20693 * @brief Bring in the viewed portion of the image
20695 * @param obj The photocam object
20696 * @param x X-coordinate of region in image original pixels
20697 * @param y Y-coordinate of region in image original pixels
20698 * @param w Width of region in image original pixels
20699 * @param h Height of region in image original pixels
20701 * This shows the region of the image using animation.
20703 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20705 * @brief Set the paused state for photocam
20707 * @param obj The photocam object
20708 * @param paused The pause state to set
20710 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20711 * photocam. The default is off. This will stop zooming using animation on
20712 * zoom levels changes and change instantly. This will stop any existing
20713 * animations that are running.
20715 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20717 * @brief Get the paused state for photocam
20719 * @param obj The photocam object
20720 * @return The current paused state
20722 * This gets the current paused state for the photocam object.
20724 * @see elm_photocam_paused_set()
20726 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20728 * @brief Get the internal low-res image used for photocam
20730 * @param obj The photocam object
20731 * @return The internal image object handle, or NULL if none exists
20733 * This gets the internal image object inside photocam. Do not modify it. It
20734 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20735 * deleted at any time as well.
20737 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20739 * @brief Set the photocam scrolling bouncing.
20741 * @param obj The photocam object
20742 * @param h_bounce bouncing for horizontal
20743 * @param v_bounce bouncing for vertical
20745 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20747 * @brief Get the photocam scrolling bouncing.
20749 * @param obj The photocam object
20750 * @param h_bounce bouncing for horizontal
20751 * @param v_bounce bouncing for vertical
20753 * @see elm_photocam_bounce_set()
20755 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20761 * @defgroup Map Map
20762 * @ingroup Elementary
20764 * @image html img/widget/map/preview-00.png
20765 * @image latex img/widget/map/preview-00.eps
20767 * This is a widget specifically for displaying a map. It uses basically
20768 * OpenStreetMap provider http://www.openstreetmap.org/,
20769 * but custom providers can be added.
20771 * It supports some basic but yet nice features:
20772 * @li zoom and scroll
20773 * @li markers with content to be displayed when user clicks over it
20774 * @li group of markers
20777 * Smart callbacks one can listen to:
20779 * - "clicked" - This is called when a user has clicked the map without
20781 * - "press" - This is called when a user has pressed down on the map.
20782 * - "longpressed" - This is called when a user has pressed down on the map
20783 * for a long time without dragging around.
20784 * - "clicked,double" - This is called when a user has double-clicked
20786 * - "load,detail" - Map detailed data load begins.
20787 * - "loaded,detail" - This is called when all currently visible parts of
20788 * the map are loaded.
20789 * - "zoom,start" - Zoom animation started.
20790 * - "zoom,stop" - Zoom animation stopped.
20791 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20792 * - "scroll" - the content has been scrolled (moved).
20793 * - "scroll,anim,start" - scrolling animation has started.
20794 * - "scroll,anim,stop" - scrolling animation has stopped.
20795 * - "scroll,drag,start" - dragging the contents around has started.
20796 * - "scroll,drag,stop" - dragging the contents around has stopped.
20797 * - "downloaded" - This is called when all currently required map images
20799 * - "route,load" - This is called when route request begins.
20800 * - "route,loaded" - This is called when route request ends.
20801 * - "name,load" - This is called when name request begins.
20802 * - "name,loaded- This is called when name request ends.
20804 * Available style for map widget:
20807 * Available style for markers:
20812 * Available style for marker bubble:
20815 * List of examples:
20816 * @li @ref map_example_01
20817 * @li @ref map_example_02
20818 * @li @ref map_example_03
20827 * @enum _Elm_Map_Zoom_Mode
20828 * @typedef Elm_Map_Zoom_Mode
20830 * Set map's zoom behavior. It can be set to manual or automatic.
20832 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20834 * Values <b> don't </b> work as bitmask, only one can be choosen.
20836 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20837 * than the scroller view.
20839 * @see elm_map_zoom_mode_set()
20840 * @see elm_map_zoom_mode_get()
20844 typedef enum _Elm_Map_Zoom_Mode
20846 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20847 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20848 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20849 ELM_MAP_ZOOM_MODE_LAST
20850 } Elm_Map_Zoom_Mode;
20853 * @enum _Elm_Map_Route_Sources
20854 * @typedef Elm_Map_Route_Sources
20856 * Set route service to be used. By default used source is
20857 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20859 * @see elm_map_route_source_set()
20860 * @see elm_map_route_source_get()
20864 typedef enum _Elm_Map_Route_Sources
20866 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20867 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. */
20868 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20869 ELM_MAP_ROUTE_SOURCE_LAST
20870 } Elm_Map_Route_Sources;
20872 typedef enum _Elm_Map_Name_Sources
20874 ELM_MAP_NAME_SOURCE_NOMINATIM,
20875 ELM_MAP_NAME_SOURCE_LAST
20876 } Elm_Map_Name_Sources;
20879 * @enum _Elm_Map_Route_Type
20880 * @typedef Elm_Map_Route_Type
20882 * Set type of transport used on route.
20884 * @see elm_map_route_add()
20888 typedef enum _Elm_Map_Route_Type
20890 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20891 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20892 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20893 ELM_MAP_ROUTE_TYPE_LAST
20894 } Elm_Map_Route_Type;
20897 * @enum _Elm_Map_Route_Method
20898 * @typedef Elm_Map_Route_Method
20900 * Set the routing method, what should be priorized, time or distance.
20902 * @see elm_map_route_add()
20906 typedef enum _Elm_Map_Route_Method
20908 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20909 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20910 ELM_MAP_ROUTE_METHOD_LAST
20911 } Elm_Map_Route_Method;
20913 typedef enum _Elm_Map_Name_Method
20915 ELM_MAP_NAME_METHOD_SEARCH,
20916 ELM_MAP_NAME_METHOD_REVERSE,
20917 ELM_MAP_NAME_METHOD_LAST
20918 } Elm_Map_Name_Method;
20920 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(). */
20921 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(). */
20922 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(). */
20923 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(). */
20924 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20925 typedef struct _Elm_Map_Track Elm_Map_Track;
20927 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. */
20928 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20929 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20930 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20932 typedef char *(*ElmMapModuleSourceFunc) (void);
20933 typedef int (*ElmMapModuleZoomMinFunc) (void);
20934 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20935 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20936 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20937 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20938 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20939 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20940 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20943 * Add a new map widget to the given parent Elementary (container) object.
20945 * @param parent The parent object.
20946 * @return a new map widget handle or @c NULL, on errors.
20948 * This function inserts a new map widget on the canvas.
20952 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20955 * Set the zoom level of the map.
20957 * @param obj The map object.
20958 * @param zoom The zoom level to set.
20960 * This sets the zoom level.
20962 * It will respect limits defined by elm_map_source_zoom_min_set() and
20963 * elm_map_source_zoom_max_set().
20965 * By default these values are 0 (world map) and 18 (maximum zoom).
20967 * This function should be used when zoom mode is set to
20968 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20969 * with elm_map_zoom_mode_set().
20971 * @see elm_map_zoom_mode_set().
20972 * @see elm_map_zoom_get().
20976 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20979 * Get the zoom level of the map.
20981 * @param obj The map object.
20982 * @return The current zoom level.
20984 * This returns the current zoom level of the map object.
20986 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20987 * (which is the default), the zoom level may be changed at any time by the
20988 * map object itself to account for map size and map viewport size.
20990 * @see elm_map_zoom_set() for details.
20994 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20997 * Set the zoom mode used by the map object.
20999 * @param obj The map object.
21000 * @param mode The zoom mode of the map, being it one of
21001 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21002 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21004 * This sets the zoom mode to manual or one of the automatic levels.
21005 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21006 * elm_map_zoom_set() and will stay at that level until changed by code
21007 * or until zoom mode is changed. This is the default mode.
21009 * The Automatic modes will allow the map object to automatically
21010 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21011 * adjust zoom so the map fits inside the scroll frame with no pixels
21012 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21013 * ensure no pixels within the frame are left unfilled. Do not forget that
21014 * the valid sizes are 2^zoom, consequently the map may be smaller than
21015 * the scroller view.
21017 * @see elm_map_zoom_set()
21021 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21024 * Get the zoom mode used by the map object.
21026 * @param obj The map object.
21027 * @return The zoom mode of the map, being it one of
21028 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21029 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21031 * This function returns the current zoom mode used by the map object.
21033 * @see elm_map_zoom_mode_set() for more details.
21037 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21040 * Get the current coordinates of the map.
21042 * @param obj The map object.
21043 * @param lon Pointer where to store longitude.
21044 * @param lat Pointer where to store latitude.
21046 * This gets the current center coordinates of the map object. It can be
21047 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21049 * @see elm_map_geo_region_bring_in()
21050 * @see elm_map_geo_region_show()
21054 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21057 * Animatedly bring in given coordinates to the center of the map.
21059 * @param obj The map object.
21060 * @param lon Longitude to center at.
21061 * @param lat Latitude to center at.
21063 * This causes map to jump to the given @p lat and @p lon coordinates
21064 * and show it (by scrolling) in the center of the viewport, if it is not
21065 * already centered. This will use animation to do so and take a period
21066 * of time to complete.
21068 * @see elm_map_geo_region_show() for a function to avoid animation.
21069 * @see elm_map_geo_region_get()
21073 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21076 * Show the given coordinates at the center of the map, @b immediately.
21078 * @param obj The map object.
21079 * @param lon Longitude to center at.
21080 * @param lat Latitude to center at.
21082 * This causes map to @b redraw its viewport's contents to the
21083 * region contining the given @p lat and @p lon, that will be moved to the
21084 * center of the map.
21086 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21087 * @see elm_map_geo_region_get()
21091 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21094 * Pause or unpause the map.
21096 * @param obj The map object.
21097 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21100 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21103 * The default is off.
21105 * This will stop zooming using animation, changing zoom levels will
21106 * change instantly. This will stop any existing animations that are running.
21108 * @see elm_map_paused_get()
21112 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21115 * Get a value whether map is paused or not.
21117 * @param obj The map object.
21118 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21119 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21121 * This gets the current paused state for the map object.
21123 * @see elm_map_paused_set() for details.
21127 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21130 * Set to show markers during zoom level changes or not.
21132 * @param obj The map object.
21133 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21136 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21139 * The default is off.
21141 * This will stop zooming using animation, changing zoom levels will
21142 * change instantly. This will stop any existing animations that are running.
21144 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21147 * The default is off.
21149 * Enabling it will force the map to stop displaying the markers during
21150 * zoom level changes. Set to on if you have a large number of markers.
21152 * @see elm_map_paused_markers_get()
21156 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21159 * Get a value whether markers will be displayed on zoom level changes or not
21161 * @param obj The map object.
21162 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21163 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21165 * This gets the current markers paused state for the map object.
21167 * @see elm_map_paused_markers_set() for details.
21171 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21174 * Get the information of downloading status.
21176 * @param obj The map object.
21177 * @param try_num Pointer where to store number of tiles being downloaded.
21178 * @param finish_num Pointer where to store number of tiles successfully
21181 * This gets the current downloading status for the map object, the number
21182 * of tiles being downloaded and the number of tiles already downloaded.
21186 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21189 * Convert a pixel coordinate (x,y) into a geographic coordinate
21190 * (longitude, latitude).
21192 * @param obj The map object.
21193 * @param x the coordinate.
21194 * @param y the coordinate.
21195 * @param size the size in pixels of the map.
21196 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21197 * @param lon Pointer where to store the longitude that correspond to x.
21198 * @param lat Pointer where to store the latitude that correspond to y.
21200 * @note Origin pixel point is the top left corner of the viewport.
21201 * Map zoom and size are taken on account.
21203 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21207 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);
21210 * Convert a geographic coordinate (longitude, latitude) into a pixel
21211 * coordinate (x, y).
21213 * @param obj The map object.
21214 * @param lon the longitude.
21215 * @param lat the latitude.
21216 * @param size the size in pixels of the map. The map is a square
21217 * and generally his size is : pow(2.0, zoom)*256.
21218 * @param x Pointer where to store the horizontal pixel coordinate that
21219 * correspond to the longitude.
21220 * @param y Pointer where to store the vertical pixel coordinate that
21221 * correspond to the latitude.
21223 * @note Origin pixel point is the top left corner of the viewport.
21224 * Map zoom and size are taken on account.
21226 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21230 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);
21233 * Convert a geographic coordinate (longitude, latitude) into a name
21236 * @param obj The map object.
21237 * @param lon the longitude.
21238 * @param lat the latitude.
21239 * @return name A #Elm_Map_Name handle for this coordinate.
21241 * To get the string for this address, elm_map_name_address_get()
21244 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21248 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21251 * Convert a name (address) into a geographic coordinate
21252 * (longitude, latitude).
21254 * @param obj The map object.
21255 * @param name The address.
21256 * @return name A #Elm_Map_Name handle for this address.
21258 * To get the longitude and latitude, elm_map_name_region_get()
21261 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21265 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21268 * Convert a pixel coordinate into a rotated pixel coordinate.
21270 * @param obj The map object.
21271 * @param x horizontal coordinate of the point to rotate.
21272 * @param y vertical coordinate of the point to rotate.
21273 * @param cx rotation's center horizontal position.
21274 * @param cy rotation's center vertical position.
21275 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21276 * @param xx Pointer where to store rotated x.
21277 * @param yy Pointer where to store rotated y.
21281 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);
21284 * Add a new marker to the map object.
21286 * @param obj The map object.
21287 * @param lon The longitude of the marker.
21288 * @param lat The latitude of the marker.
21289 * @param clas The class, to use when marker @b isn't grouped to others.
21290 * @param clas_group The class group, to use when marker is grouped to others
21291 * @param data The data passed to the callbacks.
21293 * @return The created marker or @c NULL upon failure.
21295 * A marker will be created and shown in a specific point of the map, defined
21296 * by @p lon and @p lat.
21298 * It will be displayed using style defined by @p class when this marker
21299 * is displayed alone (not grouped). A new class can be created with
21300 * elm_map_marker_class_new().
21302 * If the marker is grouped to other markers, it will be displayed with
21303 * style defined by @p class_group. Markers with the same group are grouped
21304 * if they are close. A new group class can be created with
21305 * elm_map_marker_group_class_new().
21307 * Markers created with this method can be deleted with
21308 * elm_map_marker_remove().
21310 * A marker can have associated content to be displayed by a bubble,
21311 * when a user click over it, as well as an icon. These objects will
21312 * be fetch using class' callback functions.
21314 * @see elm_map_marker_class_new()
21315 * @see elm_map_marker_group_class_new()
21316 * @see elm_map_marker_remove()
21320 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);
21323 * Set the maximum numbers of markers' content to be displayed in a group.
21325 * @param obj The map object.
21326 * @param max The maximum numbers of items displayed in a bubble.
21328 * A bubble will be displayed when the user clicks over the group,
21329 * and will place the content of markers that belong to this group
21332 * A group can have a long list of markers, consequently the creation
21333 * of the content of the bubble can be very slow.
21335 * In order to avoid this, a maximum number of items is displayed
21338 * By default this number is 30.
21340 * Marker with the same group class are grouped if they are close.
21342 * @see elm_map_marker_add()
21346 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21349 * Remove a marker from the map.
21351 * @param marker The marker to remove.
21353 * @see elm_map_marker_add()
21357 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21360 * Get the current coordinates of the marker.
21362 * @param marker marker.
21363 * @param lat Pointer where to store the marker's latitude.
21364 * @param lon Pointer where to store the marker's longitude.
21366 * These values are set when adding markers, with function
21367 * elm_map_marker_add().
21369 * @see elm_map_marker_add()
21373 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21376 * Animatedly bring in given marker to the center of the map.
21378 * @param marker The marker to center at.
21380 * This causes map to jump to the given @p marker's coordinates
21381 * and show it (by scrolling) in the center of the viewport, if it is not
21382 * already centered. This will use animation to do so and take a period
21383 * of time to complete.
21385 * @see elm_map_marker_show() for a function to avoid animation.
21386 * @see elm_map_marker_region_get()
21390 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21393 * Show the given marker at the center of the map, @b immediately.
21395 * @param marker The marker to center at.
21397 * This causes map to @b redraw its viewport's contents to the
21398 * region contining the given @p marker's coordinates, that will be
21399 * moved to the center of the map.
21401 * @see elm_map_marker_bring_in() for a function to move with animation.
21402 * @see elm_map_markers_list_show() if more than one marker need to be
21404 * @see elm_map_marker_region_get()
21408 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21411 * Move and zoom the map to display a list of markers.
21413 * @param markers A list of #Elm_Map_Marker handles.
21415 * The map will be centered on the center point of the markers in the list.
21416 * Then the map will be zoomed in order to fit the markers using the maximum
21417 * zoom which allows display of all the markers.
21419 * @warning All the markers should belong to the same map object.
21421 * @see elm_map_marker_show() to show a single marker.
21422 * @see elm_map_marker_bring_in()
21426 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21429 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21431 * @param marker The marker wich content should be returned.
21432 * @return Return the evas object if it exists, else @c NULL.
21434 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21435 * elm_map_marker_class_get_cb_set() should be used.
21437 * This content is what will be inside the bubble that will be displayed
21438 * when an user clicks over the marker.
21440 * This returns the actual Evas object used to be placed inside
21441 * the bubble. This may be @c NULL, as it may
21442 * not have been created or may have been deleted, at any time, by
21443 * the map. <b>Do not modify this object</b> (move, resize,
21444 * show, hide, etc.), as the map is controlling it. This
21445 * function is for querying, emitting custom signals or hooking
21446 * lower level callbacks for events on that object. Do not delete
21447 * this object under any circumstances.
21451 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21454 * Update the marker
21456 * @param marker The marker to be updated.
21458 * If a content is set to this marker, it will call function to delete it,
21459 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21460 * #ElmMapMarkerGetFunc.
21462 * These functions are set for the marker class with
21463 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21467 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21470 * Close all the bubbles opened by the user.
21472 * @param obj The map object.
21474 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21475 * when the user clicks on a marker.
21477 * This functions is set for the marker class with
21478 * elm_map_marker_class_get_cb_set().
21482 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21485 * Create a new group class.
21487 * @param obj The map object.
21488 * @return Returns the new group class.
21490 * Each marker must be associated to a group class. Markers in the same
21491 * group are grouped if they are close.
21493 * The group class defines the style of the marker when a marker is grouped
21494 * to others markers. When it is alone, another class will be used.
21496 * A group class will need to be provided when creating a marker with
21497 * elm_map_marker_add().
21499 * Some properties and functions can be set by class, as:
21500 * - style, with elm_map_group_class_style_set()
21501 * - data - to be associated to the group class. It can be set using
21502 * elm_map_group_class_data_set().
21503 * - min zoom to display markers, set with
21504 * elm_map_group_class_zoom_displayed_set().
21505 * - max zoom to group markers, set using
21506 * elm_map_group_class_zoom_grouped_set().
21507 * - visibility - set if markers will be visible or not, set with
21508 * elm_map_group_class_hide_set().
21509 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21510 * It can be set using elm_map_group_class_icon_cb_set().
21512 * @see elm_map_marker_add()
21513 * @see elm_map_group_class_style_set()
21514 * @see elm_map_group_class_data_set()
21515 * @see elm_map_group_class_zoom_displayed_set()
21516 * @see elm_map_group_class_zoom_grouped_set()
21517 * @see elm_map_group_class_hide_set()
21518 * @see elm_map_group_class_icon_cb_set()
21522 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21525 * Set the marker's style of a group class.
21527 * @param clas The group class.
21528 * @param style The style to be used by markers.
21530 * Each marker must be associated to a group class, and will use the style
21531 * defined by such class when grouped to other markers.
21533 * The following styles are provided by default theme:
21534 * @li @c radio - blue circle
21535 * @li @c radio2 - green circle
21538 * @see elm_map_group_class_new() for more details.
21539 * @see elm_map_marker_add()
21543 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21546 * Set the icon callback function of a group class.
21548 * @param clas The group class.
21549 * @param icon_get The callback function that will return the icon.
21551 * Each marker must be associated to a group class, and it can display a
21552 * custom icon. The function @p icon_get must return this icon.
21554 * @see elm_map_group_class_new() for more details.
21555 * @see elm_map_marker_add()
21559 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21562 * Set the data associated to the group class.
21564 * @param clas The group class.
21565 * @param data The new user data.
21567 * This data will be passed for callback functions, like icon get callback,
21568 * that can be set with elm_map_group_class_icon_cb_set().
21570 * If a data was previously set, the object will lose the pointer for it,
21571 * so if needs to be freed, you must do it yourself.
21573 * @see elm_map_group_class_new() for more details.
21574 * @see elm_map_group_class_icon_cb_set()
21575 * @see elm_map_marker_add()
21579 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21582 * Set the minimum zoom from where the markers are displayed.
21584 * @param clas The group class.
21585 * @param zoom The minimum zoom.
21587 * Markers only will be displayed when the map is displayed at @p zoom
21590 * @see elm_map_group_class_new() for more details.
21591 * @see elm_map_marker_add()
21595 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21598 * Set the zoom from where the markers are no more grouped.
21600 * @param clas The group class.
21601 * @param zoom The maximum zoom.
21603 * Markers only will be grouped when the map is displayed at
21604 * less than @p zoom.
21606 * @see elm_map_group_class_new() for more details.
21607 * @see elm_map_marker_add()
21611 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21614 * Set if the markers associated to the group class @clas are hidden or not.
21616 * @param clas The group class.
21617 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21620 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21625 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21628 * Create a new marker class.
21630 * @param obj The map object.
21631 * @return Returns the new group class.
21633 * Each marker must be associated to a class.
21635 * The marker class defines the style of the marker when a marker is
21636 * displayed alone, i.e., not grouped to to others markers. When grouped
21637 * it will use group class style.
21639 * A marker class will need to be provided when creating a marker with
21640 * elm_map_marker_add().
21642 * Some properties and functions can be set by class, as:
21643 * - style, with elm_map_marker_class_style_set()
21644 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21645 * It can be set using elm_map_marker_class_icon_cb_set().
21646 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21647 * Set using elm_map_marker_class_get_cb_set().
21648 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21649 * Set using elm_map_marker_class_del_cb_set().
21651 * @see elm_map_marker_add()
21652 * @see elm_map_marker_class_style_set()
21653 * @see elm_map_marker_class_icon_cb_set()
21654 * @see elm_map_marker_class_get_cb_set()
21655 * @see elm_map_marker_class_del_cb_set()
21659 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21662 * Set the marker's style of a marker class.
21664 * @param clas The marker class.
21665 * @param style The style to be used by markers.
21667 * Each marker must be associated to a marker class, and will use the style
21668 * defined by such class when alone, i.e., @b not grouped to other markers.
21670 * The following styles are provided by default theme:
21675 * @see elm_map_marker_class_new() for more details.
21676 * @see elm_map_marker_add()
21680 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21683 * Set the icon callback function of a marker class.
21685 * @param clas The marker class.
21686 * @param icon_get The callback function that will return the icon.
21688 * Each marker must be associated to a marker class, and it can display a
21689 * custom icon. The function @p icon_get must return this icon.
21691 * @see elm_map_marker_class_new() for more details.
21692 * @see elm_map_marker_add()
21696 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21699 * Set the bubble content callback function of a marker class.
21701 * @param clas The marker class.
21702 * @param get The callback function that will return the content.
21704 * Each marker must be associated to a marker class, and it can display a
21705 * a content on a bubble that opens when the user click over the marker.
21706 * The function @p get must return this content object.
21708 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21711 * @see elm_map_marker_class_new() for more details.
21712 * @see elm_map_marker_class_del_cb_set()
21713 * @see elm_map_marker_add()
21717 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21720 * Set the callback function used to delete bubble content of a marker class.
21722 * @param clas The marker class.
21723 * @param del The callback function that will delete the content.
21725 * Each marker must be associated to a marker class, and it can display a
21726 * a content on a bubble that opens when the user click over the marker.
21727 * The function to return such content can be set with
21728 * elm_map_marker_class_get_cb_set().
21730 * If this content must be freed, a callback function need to be
21731 * set for that task with this function.
21733 * If this callback is defined it will have to delete (or not) the
21734 * object inside, but if the callback is not defined the object will be
21735 * destroyed with evas_object_del().
21737 * @see elm_map_marker_class_new() for more details.
21738 * @see elm_map_marker_class_get_cb_set()
21739 * @see elm_map_marker_add()
21743 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21746 * Get the list of available sources.
21748 * @param obj The map object.
21749 * @return The source names list.
21751 * It will provide a list with all available sources, that can be set as
21752 * current source with elm_map_source_name_set(), or get with
21753 * elm_map_source_name_get().
21755 * Available sources:
21761 * @see elm_map_source_name_set() for more details.
21762 * @see elm_map_source_name_get()
21766 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21769 * Set the source of the map.
21771 * @param obj The map object.
21772 * @param source The source to be used.
21774 * Map widget retrieves images that composes the map from a web service.
21775 * This web service can be set with this method.
21777 * A different service can return a different maps with different
21778 * information and it can use different zoom values.
21780 * The @p source_name need to match one of the names provided by
21781 * elm_map_source_names_get().
21783 * The current source can be get using elm_map_source_name_get().
21785 * @see elm_map_source_names_get()
21786 * @see elm_map_source_name_get()
21791 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21794 * Get the name of currently used source.
21796 * @param obj The map object.
21797 * @return Returns the name of the source in use.
21799 * @see elm_map_source_name_set() for more details.
21803 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21806 * Set the source of the route service to be used by the map.
21808 * @param obj The map object.
21809 * @param source The route service to be used, being it one of
21810 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21811 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21813 * Each one has its own algorithm, so the route retrieved may
21814 * differ depending on the source route. Now, only the default is working.
21816 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21817 * http://www.yournavigation.org/.
21819 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21820 * assumptions. Its routing core is based on Contraction Hierarchies.
21822 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21824 * @see elm_map_route_source_get().
21828 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21831 * Get the current route source.
21833 * @param obj The map object.
21834 * @return The source of the route service used by the map.
21836 * @see elm_map_route_source_set() for details.
21840 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21843 * Set the minimum zoom of the source.
21845 * @param obj The map object.
21846 * @param zoom New minimum zoom value to be used.
21848 * By default, it's 0.
21852 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21855 * Get the minimum zoom of the source.
21857 * @param obj The map object.
21858 * @return Returns the minimum zoom of the source.
21860 * @see elm_map_source_zoom_min_set() for details.
21864 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21867 * Set the maximum zoom of the source.
21869 * @param obj The map object.
21870 * @param zoom New maximum zoom value to be used.
21872 * By default, it's 18.
21876 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21879 * Get the maximum zoom of the source.
21881 * @param obj The map object.
21882 * @return Returns the maximum zoom of the source.
21884 * @see elm_map_source_zoom_min_set() for details.
21888 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21891 * Set the user agent used by the map object to access routing services.
21893 * @param obj The map object.
21894 * @param user_agent The user agent to be used by the map.
21896 * User agent is a client application implementing a network protocol used
21897 * in communications within a client–server distributed computing system
21899 * The @p user_agent identification string will transmitted in a header
21900 * field @c User-Agent.
21902 * @see elm_map_user_agent_get()
21906 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21909 * Get the user agent used by the map object.
21911 * @param obj The map object.
21912 * @return The user agent identification string used by the map.
21914 * @see elm_map_user_agent_set() for details.
21918 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21921 * Add a new route to the map object.
21923 * @param obj The map object.
21924 * @param type The type of transport to be considered when tracing a route.
21925 * @param method The routing method, what should be priorized.
21926 * @param flon The start longitude.
21927 * @param flat The start latitude.
21928 * @param tlon The destination longitude.
21929 * @param tlat The destination latitude.
21931 * @return The created route or @c NULL upon failure.
21933 * A route will be traced by point on coordinates (@p flat, @p flon)
21934 * to point on coordinates (@p tlat, @p tlon), using the route service
21935 * set with elm_map_route_source_set().
21937 * It will take @p type on consideration to define the route,
21938 * depending if the user will be walking or driving, the route may vary.
21939 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21940 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21942 * Another parameter is what the route should priorize, the minor distance
21943 * or the less time to be spend on the route. So @p method should be one
21944 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21946 * Routes created with this method can be deleted with
21947 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21948 * and distance can be get with elm_map_route_distance_get().
21950 * @see elm_map_route_remove()
21951 * @see elm_map_route_color_set()
21952 * @see elm_map_route_distance_get()
21953 * @see elm_map_route_source_set()
21957 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);
21960 * Remove a route from the map.
21962 * @param route The route to remove.
21964 * @see elm_map_route_add()
21968 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21971 * Set the route color.
21973 * @param route The route object.
21974 * @param r Red channel value, from 0 to 255.
21975 * @param g Green channel value, from 0 to 255.
21976 * @param b Blue channel value, from 0 to 255.
21977 * @param a Alpha channel value, from 0 to 255.
21979 * It uses an additive color model, so each color channel represents
21980 * how much of each primary colors must to be used. 0 represents
21981 * ausence of this color, so if all of the three are set to 0,
21982 * the color will be black.
21984 * These component values should be integers in the range 0 to 255,
21985 * (single 8-bit byte).
21987 * This sets the color used for the route. By default, it is set to
21988 * solid red (r = 255, g = 0, b = 0, a = 255).
21990 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21992 * @see elm_map_route_color_get()
21996 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21999 * Get the route color.
22001 * @param route The route object.
22002 * @param r Pointer where to store the red channel value.
22003 * @param g Pointer where to store the green channel value.
22004 * @param b Pointer where to store the blue channel value.
22005 * @param a Pointer where to store the alpha channel value.
22007 * @see elm_map_route_color_set() for details.
22011 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22014 * Get the route distance in kilometers.
22016 * @param route The route object.
22017 * @return The distance of route (unit : km).
22021 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22024 * Get the information of route nodes.
22026 * @param route The route object.
22027 * @return Returns a string with the nodes of route.
22031 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22034 * Get the information of route waypoint.
22036 * @param route the route object.
22037 * @return Returns a string with information about waypoint of route.
22041 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22044 * Get the address of the name.
22046 * @param name The name handle.
22047 * @return Returns the address string of @p name.
22049 * This gets the coordinates of the @p name, created with one of the
22050 * conversion functions.
22052 * @see elm_map_utils_convert_name_into_coord()
22053 * @see elm_map_utils_convert_coord_into_name()
22057 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22060 * Get the current coordinates of the name.
22062 * @param name The name handle.
22063 * @param lat Pointer where to store the latitude.
22064 * @param lon Pointer where to store The longitude.
22066 * This gets the coordinates of the @p name, created with one of the
22067 * conversion functions.
22069 * @see elm_map_utils_convert_name_into_coord()
22070 * @see elm_map_utils_convert_coord_into_name()
22074 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22077 * Remove a name from the map.
22079 * @param name The name to remove.
22081 * Basically the struct handled by @p name will be freed, so convertions
22082 * between address and coordinates will be lost.
22084 * @see elm_map_utils_convert_name_into_coord()
22085 * @see elm_map_utils_convert_coord_into_name()
22089 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22094 * @param obj The map object.
22095 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22096 * @param cx Rotation's center horizontal position.
22097 * @param cy Rotation's center vertical position.
22099 * @see elm_map_rotate_get()
22103 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22106 * Get the rotate degree of the map
22108 * @param obj The map object
22109 * @param degree Pointer where to store degrees from 0.0 to 360.0
22110 * to rotate arount Z axis.
22111 * @param cx Pointer where to store rotation's center horizontal position.
22112 * @param cy Pointer where to store rotation's center vertical position.
22114 * @see elm_map_rotate_set() to set map rotation.
22118 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);
22121 * Enable or disable mouse wheel to be used to zoom in / out the map.
22123 * @param obj The map object.
22124 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22127 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22129 * It's disabled by default.
22131 * @see elm_map_wheel_disabled_get()
22135 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22138 * Get a value whether mouse wheel is enabled or not.
22140 * @param obj The map object.
22141 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22142 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22144 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22146 * @see elm_map_wheel_disabled_set() for details.
22150 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22154 * Add a track on the map
22156 * @param obj The map object.
22157 * @param emap The emap route object.
22158 * @return The route object. This is an elm object of type Route.
22160 * @see elm_route_add() for details.
22164 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22168 * Remove a track from the map
22170 * @param obj The map object.
22171 * @param route The track to remove.
22175 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22182 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22184 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22186 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22187 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22188 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22189 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22193 * @defgroup Panel Panel
22195 * @image html img/widget/panel/preview-00.png
22196 * @image latex img/widget/panel/preview-00.eps
22198 * @brief A panel is a type of animated container that contains subobjects.
22199 * It can be expanded or contracted by clicking the button on it's edge.
22201 * Orientations are as follows:
22202 * @li ELM_PANEL_ORIENT_TOP
22203 * @li ELM_PANEL_ORIENT_LEFT
22204 * @li ELM_PANEL_ORIENT_RIGHT
22206 * @ref tutorial_panel shows one way to use this widget.
22209 typedef enum _Elm_Panel_Orient
22211 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22212 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22213 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22214 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22215 } Elm_Panel_Orient;
22217 * @brief Adds a panel object
22219 * @param parent The parent object
22221 * @return The panel object, or NULL on failure
22223 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22225 * @brief Sets the orientation of the panel
22227 * @param parent The parent object
22228 * @param orient The panel orientation. Can be one of the following:
22229 * @li ELM_PANEL_ORIENT_TOP
22230 * @li ELM_PANEL_ORIENT_LEFT
22231 * @li ELM_PANEL_ORIENT_RIGHT
22233 * Sets from where the panel will (dis)appear.
22235 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22237 * @brief Get the orientation of the panel.
22239 * @param obj The panel object
22240 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22242 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22244 * @brief Set the content of the panel.
22246 * @param obj The panel object
22247 * @param content The panel content
22249 * Once the content object is set, a previously set one will be deleted.
22250 * If you want to keep that old content object, use the
22251 * elm_panel_content_unset() function.
22253 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22255 * @brief Get the content of the panel.
22257 * @param obj The panel object
22258 * @return The content that is being used
22260 * Return the content object which is set for this widget.
22262 * @see elm_panel_content_set()
22264 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22266 * @brief Unset the content of the panel.
22268 * @param obj The panel object
22269 * @return The content that was being used
22271 * Unparent and return the content object which was set for this widget.
22273 * @see elm_panel_content_set()
22275 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22277 * @brief Set the state of the panel.
22279 * @param obj The panel object
22280 * @param hidden If true, the panel will run the animation to contract
22282 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22284 * @brief Get the state of the panel.
22286 * @param obj The panel object
22287 * @param hidden If true, the panel is in the "hide" state
22289 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22291 * @brief Toggle the hidden state of the panel from code
22293 * @param obj The panel object
22295 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22301 * @defgroup Panes Panes
22302 * @ingroup Elementary
22304 * @image html img/widget/panes/preview-00.png
22305 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22307 * @image html img/panes.png
22308 * @image latex img/panes.eps width=\textwidth
22310 * The panes adds a dragable bar between two contents. When dragged
22311 * this bar will resize contents size.
22313 * Panes can be displayed vertically or horizontally, and contents
22314 * size proportion can be customized (homogeneous by default).
22316 * Smart callbacks one can listen to:
22317 * - "press" - The panes has been pressed (button wasn't released yet).
22318 * - "unpressed" - The panes was released after being pressed.
22319 * - "clicked" - The panes has been clicked>
22320 * - "clicked,double" - The panes has been double clicked
22322 * Available styles for it:
22325 * Here is an example on its usage:
22326 * @li @ref panes_example
22330 * @addtogroup Panes
22335 * Add a new panes widget to the given parent Elementary
22336 * (container) object.
22338 * @param parent The parent object.
22339 * @return a new panes widget handle or @c NULL, on errors.
22341 * This function inserts a new panes widget on the canvas.
22345 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22348 * Set the left content of the panes widget.
22350 * @param obj The panes object.
22351 * @param content The new left content object.
22353 * Once the content object is set, a previously set one will be deleted.
22354 * If you want to keep that old content object, use the
22355 * elm_panes_content_left_unset() function.
22357 * If panes is displayed vertically, left content will be displayed at
22360 * @see elm_panes_content_left_get()
22361 * @see elm_panes_content_right_set() to set content on the other side.
22365 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22368 * Set the right content of the panes widget.
22370 * @param obj The panes object.
22371 * @param content The new right content object.
22373 * Once the content object is set, a previously set one will be deleted.
22374 * If you want to keep that old content object, use the
22375 * elm_panes_content_right_unset() function.
22377 * If panes is displayed vertically, left content will be displayed at
22380 * @see elm_panes_content_right_get()
22381 * @see elm_panes_content_left_set() to set content on the other side.
22385 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22388 * Get the left content of the panes.
22390 * @param obj The panes object.
22391 * @return The left content object that is being used.
22393 * Return the left content object which is set for this widget.
22395 * @see elm_panes_content_left_set() for details.
22399 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22402 * Get the right content of the panes.
22404 * @param obj The panes object
22405 * @return The right content object that is being used
22407 * Return the right content object which is set for this widget.
22409 * @see elm_panes_content_right_set() for details.
22413 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22416 * Unset the left content used for the panes.
22418 * @param obj The panes object.
22419 * @return The left content object that was being used.
22421 * Unparent and return the left content object which was set for this widget.
22423 * @see elm_panes_content_left_set() for details.
22424 * @see elm_panes_content_left_get().
22428 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22431 * Unset the right content used for the panes.
22433 * @param obj The panes object.
22434 * @return The right content object that was being used.
22436 * Unparent and return the right content object which was set for this
22439 * @see elm_panes_content_right_set() for details.
22440 * @see elm_panes_content_right_get().
22444 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22447 * Get the size proportion of panes widget's left side.
22449 * @param obj The panes object.
22450 * @return float value between 0.0 and 1.0 representing size proportion
22453 * @see elm_panes_content_left_size_set() for more details.
22457 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22460 * Set the size proportion of panes widget's left side.
22462 * @param obj The panes object.
22463 * @param size Value between 0.0 and 1.0 representing size proportion
22466 * By default it's homogeneous, i.e., both sides have the same size.
22468 * If something different is required, it can be set with this function.
22469 * For example, if the left content should be displayed over
22470 * 75% of the panes size, @p size should be passed as @c 0.75.
22471 * This way, right content will be resized to 25% of panes size.
22473 * If displayed vertically, left content is displayed at top, and
22474 * right content at bottom.
22476 * @note This proportion will change when user drags the panes bar.
22478 * @see elm_panes_content_left_size_get()
22482 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22485 * Set the orientation of a given panes widget.
22487 * @param obj The panes object.
22488 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22489 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22491 * Use this function to change how your panes is to be
22492 * disposed: vertically or horizontally.
22494 * By default it's displayed horizontally.
22496 * @see elm_panes_horizontal_get()
22500 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22503 * Retrieve the orientation of a given panes widget.
22505 * @param obj The panes object.
22506 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22507 * @c EINA_FALSE if it's @b vertical (and on errors).
22509 * @see elm_panes_horizontal_set() for more details.
22513 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22520 * @defgroup Flip Flip
22522 * @image html img/widget/flip/preview-00.png
22523 * @image latex img/widget/flip/preview-00.eps
22525 * This widget holds 2 content objects(Evas_Object): one on the front and one
22526 * on the back. It allows you to flip from front to back and vice-versa using
22527 * various animations.
22529 * If either the front or back contents are not set the flip will treat that
22530 * as transparent. So if you wore to set the front content but not the back,
22531 * and then call elm_flip_go() you would see whatever is below the flip.
22533 * For a list of supported animations see elm_flip_go().
22535 * Signals that you can add callbacks for are:
22536 * "animate,begin" - when a flip animation was started
22537 * "animate,done" - when a flip animation is finished
22539 * @ref tutorial_flip show how to use most of the API.
22543 typedef enum _Elm_Flip_Mode
22545 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22546 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22547 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22548 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22549 ELM_FLIP_CUBE_LEFT,
22550 ELM_FLIP_CUBE_RIGHT,
22552 ELM_FLIP_CUBE_DOWN,
22553 ELM_FLIP_PAGE_LEFT,
22554 ELM_FLIP_PAGE_RIGHT,
22558 typedef enum _Elm_Flip_Interaction
22560 ELM_FLIP_INTERACTION_NONE,
22561 ELM_FLIP_INTERACTION_ROTATE,
22562 ELM_FLIP_INTERACTION_CUBE,
22563 ELM_FLIP_INTERACTION_PAGE
22564 } Elm_Flip_Interaction;
22565 typedef enum _Elm_Flip_Direction
22567 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22568 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22569 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22570 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22571 } Elm_Flip_Direction;
22573 * @brief Add a new flip to the parent
22575 * @param parent The parent object
22576 * @return The new object or NULL if it cannot be created
22578 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22580 * @brief Set the front content of the flip widget.
22582 * @param obj The flip object
22583 * @param content The new front content object
22585 * Once the content object is set, a previously set one will be deleted.
22586 * If you want to keep that old content object, use the
22587 * elm_flip_content_front_unset() function.
22589 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22591 * @brief Set the back content of the flip widget.
22593 * @param obj The flip object
22594 * @param content The new back content object
22596 * Once the content object is set, a previously set one will be deleted.
22597 * If you want to keep that old content object, use the
22598 * elm_flip_content_back_unset() function.
22600 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22602 * @brief Get the front content used for the flip
22604 * @param obj The flip object
22605 * @return The front content object that is being used
22607 * Return the front content object which is set for this widget.
22609 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22611 * @brief Get the back content used for the flip
22613 * @param obj The flip object
22614 * @return The back content object that is being used
22616 * Return the back content object which is set for this widget.
22618 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22620 * @brief Unset the front content used for the flip
22622 * @param obj The flip object
22623 * @return The front content object that was being used
22625 * Unparent and return the front content object which was set for this widget.
22627 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22629 * @brief Unset the back content used for the flip
22631 * @param obj The flip object
22632 * @return The back content object that was being used
22634 * Unparent and return the back content object which was set for this widget.
22636 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22638 * @brief Get flip front visibility state
22640 * @param obj The flip objct
22641 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22644 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22646 * @brief Set flip perspective
22648 * @param obj The flip object
22649 * @param foc The coordinate to set the focus on
22650 * @param x The X coordinate
22651 * @param y The Y coordinate
22653 * @warning This function currently does nothing.
22655 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22657 * @brief Runs the flip animation
22659 * @param obj The flip object
22660 * @param mode The mode type
22662 * Flips the front and back contents using the @p mode animation. This
22663 * efectively hides the currently visible content and shows the hidden one.
22665 * There a number of possible animations to use for the flipping:
22666 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22667 * around a horizontal axis in the middle of its height, the other content
22668 * is shown as the other side of the flip.
22669 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22670 * around a vertical axis in the middle of its width, the other content is
22671 * shown as the other side of the flip.
22672 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22673 * around a diagonal axis in the middle of its width, the other content is
22674 * shown as the other side of the flip.
22675 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22676 * around a diagonal axis in the middle of its height, the other content is
22677 * shown as the other side of the flip.
22678 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22679 * as if the flip was a cube, the other content is show as the right face of
22681 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22682 * right as if the flip was a cube, the other content is show as the left
22683 * face of the cube.
22684 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22685 * flip was a cube, the other content is show as the bottom face of the cube.
22686 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22687 * the flip was a cube, the other content is show as the upper face of the
22689 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22690 * if the flip was a book, the other content is shown as the page below that.
22691 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22692 * as if the flip was a book, the other content is shown as the page below
22694 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22695 * flip was a book, the other content is shown as the page below that.
22696 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22697 * flip was a book, the other content is shown as the page below that.
22699 * @image html elm_flip.png
22700 * @image latex elm_flip.eps width=\textwidth
22702 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22704 * @brief Set the interactive flip mode
22706 * @param obj The flip object
22707 * @param mode The interactive flip mode to use
22709 * This sets if the flip should be interactive (allow user to click and
22710 * drag a side of the flip to reveal the back page and cause it to flip).
22711 * By default a flip is not interactive. You may also need to set which
22712 * sides of the flip are "active" for flipping and how much space they use
22713 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22714 * and elm_flip_interacton_direction_hitsize_set()
22716 * The four avilable mode of interaction are:
22717 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22718 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22719 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22720 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22722 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22723 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22724 * happen, those can only be acheived with elm_flip_go();
22726 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22728 * @brief Get the interactive flip mode
22730 * @param obj The flip object
22731 * @return The interactive flip mode
22733 * Returns the interactive flip mode set by elm_flip_interaction_set()
22735 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22737 * @brief Set which directions of the flip respond to interactive flip
22739 * @param obj The flip object
22740 * @param dir The direction to change
22741 * @param enabled If that direction is enabled or not
22743 * By default all directions are disabled, so you may want to enable the
22744 * desired directions for flipping if you need interactive flipping. You must
22745 * call this function once for each direction that should be enabled.
22747 * @see elm_flip_interaction_set()
22749 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22751 * @brief Get the enabled state of that flip direction
22753 * @param obj The flip object
22754 * @param dir The direction to check
22755 * @return If that direction is enabled or not
22757 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22759 * @see elm_flip_interaction_set()
22761 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22763 * @brief Set the amount of the flip that is sensitive to interactive flip
22765 * @param obj The flip object
22766 * @param dir The direction to modify
22767 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22769 * Set the amount of the flip that is sensitive to interactive flip, with 0
22770 * representing no area in the flip and 1 representing the entire flip. There
22771 * is however a consideration to be made in that the area will never be
22772 * smaller than the finger size set(as set in your Elementary configuration).
22774 * @see elm_flip_interaction_set()
22776 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22778 * @brief Get the amount of the flip that is sensitive to interactive flip
22780 * @param obj The flip object
22781 * @param dir The direction to check
22782 * @return The size set for that direction
22784 * Returns the amount os sensitive area set by
22785 * elm_flip_interacton_direction_hitsize_set().
22787 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22792 /* scrolledentry */
22793 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22794 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22795 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22796 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22797 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22798 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22799 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22800 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22801 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22802 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22803 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22804 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22805 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22806 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22807 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22808 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22809 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22810 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22811 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22812 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22813 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22814 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22815 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22816 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22817 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22818 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22819 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22820 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22821 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22822 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22823 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22824 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22825 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22826 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22827 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22828 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);
22829 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22830 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22831 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);
22832 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22833 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);
22834 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22835 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22836 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22837 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22838 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22839 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22840 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22841 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22842 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);
22843 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);
22844 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);
22845 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);
22846 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);
22847 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);
22848 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22849 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22850 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22851 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22852 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22853 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22854 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22857 * @defgroup Conformant Conformant
22858 * @ingroup Elementary
22860 * @image html img/widget/conformant/preview-00.png
22861 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22863 * @image html img/conformant.png
22864 * @image latex img/conformant.eps width=\textwidth
22866 * The aim is to provide a widget that can be used in elementary apps to
22867 * account for space taken up by the indicator, virtual keypad & softkey
22868 * windows when running the illume2 module of E17.
22870 * So conformant content will be sized and positioned considering the
22871 * space required for such stuff, and when they popup, as a keyboard
22872 * shows when an entry is selected, conformant content won't change.
22874 * Available styles for it:
22877 * See how to use this widget in this example:
22878 * @ref conformant_example
22882 * @addtogroup Conformant
22887 * Add a new conformant widget to the given parent Elementary
22888 * (container) object.
22890 * @param parent The parent object.
22891 * @return A new conformant widget handle or @c NULL, on errors.
22893 * This function inserts a new conformant widget on the canvas.
22895 * @ingroup Conformant
22897 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22900 * Set the content of the conformant widget.
22902 * @param obj The conformant object.
22903 * @param content The content to be displayed by the conformant.
22905 * Content will be sized and positioned considering the space required
22906 * to display a virtual keyboard. So it won't fill all the conformant
22907 * size. This way is possible to be sure that content won't resize
22908 * or be re-positioned after the keyboard is displayed.
22910 * Once the content object is set, a previously set one will be deleted.
22911 * If you want to keep that old content object, use the
22912 * elm_conformat_content_unset() function.
22914 * @see elm_conformant_content_unset()
22915 * @see elm_conformant_content_get()
22917 * @ingroup Conformant
22919 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22922 * Get the content of the conformant widget.
22924 * @param obj The conformant object.
22925 * @return The content that is being used.
22927 * Return the content object which is set for this widget.
22928 * It won't be unparent from conformant. For that, use
22929 * elm_conformant_content_unset().
22931 * @see elm_conformant_content_set() for more details.
22932 * @see elm_conformant_content_unset()
22934 * @ingroup Conformant
22936 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22939 * Unset the content of the conformant widget.
22941 * @param obj The conformant object.
22942 * @return The content that was being used.
22944 * Unparent and return the content object which was set for this widget.
22946 * @see elm_conformant_content_set() for more details.
22948 * @ingroup Conformant
22950 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22953 * Returns the Evas_Object that represents the content area.
22955 * @param obj The conformant object.
22956 * @return The content area of the widget.
22958 * @ingroup Conformant
22960 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22967 * @defgroup Mapbuf Mapbuf
22968 * @ingroup Elementary
22970 * @image html img/widget/mapbuf/preview-00.png
22971 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22973 * This holds one content object and uses an Evas Map of transformation
22974 * points to be later used with this content. So the content will be
22975 * moved, resized, etc as a single image. So it will improve performance
22976 * when you have a complex interafce, with a lot of elements, and will
22977 * need to resize or move it frequently (the content object and its
22980 * See how to use this widget in this example:
22981 * @ref mapbuf_example
22985 * @addtogroup Mapbuf
22990 * Add a new mapbuf widget to the given parent Elementary
22991 * (container) object.
22993 * @param parent The parent object.
22994 * @return A new mapbuf widget handle or @c NULL, on errors.
22996 * This function inserts a new mapbuf widget on the canvas.
23000 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23003 * Set the content of the mapbuf.
23005 * @param obj The mapbuf object.
23006 * @param content The content that will be filled in this mapbuf object.
23008 * Once the content object is set, a previously set one will be deleted.
23009 * If you want to keep that old content object, use the
23010 * elm_mapbuf_content_unset() function.
23012 * To enable map, elm_mapbuf_enabled_set() should be used.
23016 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23019 * Get the content of the mapbuf.
23021 * @param obj The mapbuf object.
23022 * @return The content that is being used.
23024 * Return the content object which is set for this widget.
23026 * @see elm_mapbuf_content_set() for details.
23030 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23033 * Unset the content of the mapbuf.
23035 * @param obj The mapbuf object.
23036 * @return The content that was being used.
23038 * Unparent and return the content object which was set for this widget.
23040 * @see elm_mapbuf_content_set() for details.
23044 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23047 * Enable or disable the map.
23049 * @param obj The mapbuf object.
23050 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23052 * This enables the map that is set or disables it. On enable, the object
23053 * geometry will be saved, and the new geometry will change (position and
23054 * size) to reflect the map geometry set.
23056 * Also, when enabled, alpha and smooth states will be used, so if the
23057 * content isn't solid, alpha should be enabled, for example, otherwise
23058 * a black retangle will fill the content.
23060 * When disabled, the stored map will be freed and geometry prior to
23061 * enabling the map will be restored.
23063 * It's disabled by default.
23065 * @see elm_mapbuf_alpha_set()
23066 * @see elm_mapbuf_smooth_set()
23070 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23073 * Get a value whether map is enabled or not.
23075 * @param obj The mapbuf object.
23076 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23077 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23079 * @see elm_mapbuf_enabled_set() for details.
23083 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23086 * Enable or disable smooth map rendering.
23088 * @param obj The mapbuf object.
23089 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23092 * This sets smoothing for map rendering. If the object is a type that has
23093 * its own smoothing settings, then both the smooth settings for this object
23094 * and the map must be turned off.
23096 * By default smooth maps are enabled.
23100 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23103 * Get a value whether smooth map rendering is enabled or not.
23105 * @param obj The mapbuf object.
23106 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23107 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23109 * @see elm_mapbuf_smooth_set() for details.
23113 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23116 * Set or unset alpha flag for map rendering.
23118 * @param obj The mapbuf object.
23119 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23122 * This sets alpha flag for map rendering. If the object is a type that has
23123 * its own alpha settings, then this will take precedence. Only image objects
23124 * have this currently. It stops alpha blending of the map area, and is
23125 * useful if you know the object and/or all sub-objects is 100% solid.
23127 * Alpha is enabled by default.
23131 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23134 * Get a value whether alpha blending is enabled or not.
23136 * @param obj The mapbuf object.
23137 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23138 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23140 * @see elm_mapbuf_alpha_set() for details.
23144 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23151 * @defgroup Flipselector Flip Selector
23153 * @image html img/widget/flipselector/preview-00.png
23154 * @image latex img/widget/flipselector/preview-00.eps
23156 * A flip selector is a widget to show a set of @b text items, one
23157 * at a time, with the same sheet switching style as the @ref Clock
23158 * "clock" widget, when one changes the current displaying sheet
23159 * (thus, the "flip" in the name).
23161 * User clicks to flip sheets which are @b held for some time will
23162 * make the flip selector to flip continuosly and automatically for
23163 * the user. The interval between flips will keep growing in time,
23164 * so that it helps the user to reach an item which is distant from
23165 * the current selection.
23167 * Smart callbacks one can register to:
23168 * - @c "selected" - when the widget's selected text item is changed
23169 * - @c "overflowed" - when the widget's current selection is changed
23170 * from the first item in its list to the last
23171 * - @c "underflowed" - when the widget's current selection is changed
23172 * from the last item in its list to the first
23174 * Available styles for it:
23177 * Here is an example on its usage:
23178 * @li @ref flipselector_example
23182 * @addtogroup Flipselector
23186 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23189 * Add a new flip selector widget to the given parent Elementary
23190 * (container) widget
23192 * @param parent The parent object
23193 * @return a new flip selector widget handle or @c NULL, on errors
23195 * This function inserts a new flip selector widget on the canvas.
23197 * @ingroup Flipselector
23199 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23202 * Programmatically select the next item of a flip selector widget
23204 * @param obj The flipselector object
23206 * @note The selection will be animated. Also, if it reaches the
23207 * end of its list of member items, it will continue with the first
23210 * @ingroup Flipselector
23212 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23215 * Programmatically select the previous item of a flip selector
23218 * @param obj The flipselector object
23220 * @note The selection will be animated. Also, if it reaches the
23221 * beginning of its list of member items, it will continue with the
23222 * last one backwards.
23224 * @ingroup Flipselector
23226 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23229 * Append a (text) item to a flip selector widget
23231 * @param obj The flipselector object
23232 * @param label The (text) label of the new item
23233 * @param func Convenience callback function to take place when
23235 * @param data Data passed to @p func, above
23236 * @return A handle to the item added or @c NULL, on errors
23238 * The widget's list of labels to show will be appended with the
23239 * given value. If the user wishes so, a callback function pointer
23240 * can be passed, which will get called when this same item is
23243 * @note The current selection @b won't be modified by appending an
23244 * element to the list.
23246 * @note The maximum length of the text label is going to be
23247 * determined <b>by the widget's theme</b>. Strings larger than
23248 * that value are going to be @b truncated.
23250 * @ingroup Flipselector
23252 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23255 * Prepend a (text) item to a flip selector widget
23257 * @param obj The flipselector object
23258 * @param label The (text) label of the new item
23259 * @param func Convenience callback function to take place when
23261 * @param data Data passed to @p func, above
23262 * @return A handle to the item added or @c NULL, on errors
23264 * The widget's list of labels to show will be prepended with the
23265 * given value. If the user wishes so, a callback function pointer
23266 * can be passed, which will get called when this same item is
23269 * @note The current selection @b won't be modified by prepending
23270 * an element to the list.
23272 * @note The maximum length of the text label is going to be
23273 * determined <b>by the widget's theme</b>. Strings larger than
23274 * that value are going to be @b truncated.
23276 * @ingroup Flipselector
23278 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23281 * Get the internal list of items in a given flip selector widget.
23283 * @param obj The flipselector object
23284 * @return The list of items (#Elm_Flipselector_Item as data) or
23285 * @c NULL on errors.
23287 * This list is @b not to be modified in any way and must not be
23288 * freed. Use the list members with functions like
23289 * elm_flipselector_item_label_set(),
23290 * elm_flipselector_item_label_get(),
23291 * elm_flipselector_item_del(),
23292 * elm_flipselector_item_selected_get(),
23293 * elm_flipselector_item_selected_set().
23295 * @warning This list is only valid until @p obj object's internal
23296 * items list is changed. It should be fetched again with another
23297 * call to this function when changes happen.
23299 * @ingroup Flipselector
23301 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23304 * Get the first item in the given flip selector widget's list of
23307 * @param obj The flipselector object
23308 * @return The first item or @c NULL, if it has no items (and on
23311 * @see elm_flipselector_item_append()
23312 * @see elm_flipselector_last_item_get()
23314 * @ingroup Flipselector
23316 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23319 * Get the last item in the given flip selector widget's list of
23322 * @param obj The flipselector object
23323 * @return The last item or @c NULL, if it has no items (and on
23326 * @see elm_flipselector_item_prepend()
23327 * @see elm_flipselector_first_item_get()
23329 * @ingroup Flipselector
23331 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23334 * Get the currently selected item in a flip selector widget.
23336 * @param obj The flipselector object
23337 * @return The selected item or @c NULL, if the widget has no items
23340 * @ingroup Flipselector
23342 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23345 * Set whether a given flip selector widget's item should be the
23346 * currently selected one.
23348 * @param item The flip selector item
23349 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23351 * This sets whether @p item is or not the selected (thus, under
23352 * display) one. If @p item is different than one under display,
23353 * the latter will be unselected. If the @p item is set to be
23354 * unselected, on the other hand, the @b first item in the widget's
23355 * internal members list will be the new selected one.
23357 * @see elm_flipselector_item_selected_get()
23359 * @ingroup Flipselector
23361 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23364 * Get whether a given flip selector widget's item is the currently
23367 * @param item The flip selector item
23368 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23371 * @see elm_flipselector_item_selected_set()
23373 * @ingroup Flipselector
23375 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23378 * Delete a given item from a flip selector widget.
23380 * @param item The item to delete
23382 * @ingroup Flipselector
23384 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23387 * Get the label of a given flip selector widget's item.
23389 * @param item The item to get label from
23390 * @return The text label of @p item or @c NULL, on errors
23392 * @see elm_flipselector_item_label_set()
23394 * @ingroup Flipselector
23396 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23399 * Set the label of a given flip selector widget's item.
23401 * @param item The item to set label on
23402 * @param label The text label string, in UTF-8 encoding
23404 * @see elm_flipselector_item_label_get()
23406 * @ingroup Flipselector
23408 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23411 * Gets the item before @p item in a flip selector widget's
23412 * internal list of items.
23414 * @param item The item to fetch previous from
23415 * @return The item before the @p item, in its parent's list. If
23416 * there is no previous item for @p item or there's an
23417 * error, @c NULL is returned.
23419 * @see elm_flipselector_item_next_get()
23421 * @ingroup Flipselector
23423 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23426 * Gets the item after @p item in a flip selector widget's
23427 * internal list of items.
23429 * @param item The item to fetch next from
23430 * @return The item after the @p item, in its parent's list. If
23431 * there is no next item for @p item or there's an
23432 * error, @c NULL is returned.
23434 * @see elm_flipselector_item_next_get()
23436 * @ingroup Flipselector
23438 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23441 * Set the interval on time updates for an user mouse button hold
23442 * on a flip selector widget.
23444 * @param obj The flip selector object
23445 * @param interval The (first) interval value in seconds
23447 * This interval value is @b decreased while the user holds the
23448 * mouse pointer either flipping up or flipping doww a given flip
23451 * This helps the user to get to a given item distant from the
23452 * current one easier/faster, as it will start to flip quicker and
23453 * quicker on mouse button holds.
23455 * The calculation for the next flip interval value, starting from
23456 * the one set with this call, is the previous interval divided by
23457 * 1.05, so it decreases a little bit.
23459 * The default starting interval value for automatic flips is
23462 * @see elm_flipselector_interval_get()
23464 * @ingroup Flipselector
23466 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23469 * Get the interval on time updates for an user mouse button hold
23470 * on a flip selector widget.
23472 * @param obj The flip selector object
23473 * @return The (first) interval value, in seconds, set on it
23475 * @see elm_flipselector_interval_set() for more details
23477 * @ingroup Flipselector
23479 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23485 * @addtogroup Calendar
23490 * @enum _Elm_Calendar_Mark_Repeat
23491 * @typedef Elm_Calendar_Mark_Repeat
23493 * Event periodicity, used to define if a mark should be repeated
23494 * @b beyond event's day. It's set when a mark is added.
23496 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23497 * there will be marks every week after this date. Marks will be displayed
23498 * at 13th, 20th, 27th, 3rd June ...
23500 * Values don't work as bitmask, only one can be choosen.
23502 * @see elm_calendar_mark_add()
23504 * @ingroup Calendar
23506 typedef enum _Elm_Calendar_Mark_Repeat
23508 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23509 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23510 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23511 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*/
23512 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. */
23513 } Elm_Calendar_Mark_Repeat;
23515 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(). */
23518 * Add a new calendar widget to the given parent Elementary
23519 * (container) object.
23521 * @param parent The parent object.
23522 * @return a new calendar widget handle or @c NULL, on errors.
23524 * This function inserts a new calendar widget on the canvas.
23526 * @ref calendar_example_01
23528 * @ingroup Calendar
23530 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23533 * Get weekdays names displayed by the calendar.
23535 * @param obj The calendar object.
23536 * @return Array of seven strings to be used as weekday names.
23538 * By default, weekdays abbreviations get from system are displayed:
23539 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23540 * The first string is related to Sunday, the second to Monday...
23542 * @see elm_calendar_weekdays_name_set()
23544 * @ref calendar_example_05
23546 * @ingroup Calendar
23548 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23551 * Set weekdays names to be displayed by the calendar.
23553 * @param obj The calendar object.
23554 * @param weekdays Array of seven strings to be used as weekday names.
23555 * @warning It must have 7 elements, or it will access invalid memory.
23556 * @warning The strings must be NULL terminated ('@\0').
23558 * By default, weekdays abbreviations get from system are displayed:
23559 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23561 * The first string should be related to Sunday, the second to Monday...
23563 * The usage should be like this:
23565 * const char *weekdays[] =
23567 * "Sunday", "Monday", "Tuesday", "Wednesday",
23568 * "Thursday", "Friday", "Saturday"
23570 * elm_calendar_weekdays_names_set(calendar, weekdays);
23573 * @see elm_calendar_weekdays_name_get()
23575 * @ref calendar_example_02
23577 * @ingroup Calendar
23579 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23582 * Set the minimum and maximum values for the year
23584 * @param obj The calendar object
23585 * @param min The minimum year, greater than 1901;
23586 * @param max The maximum year;
23588 * Maximum must be greater than minimum, except if you don't wan't to set
23590 * Default values are 1902 and -1.
23592 * If the maximum year is a negative value, it will be limited depending
23593 * on the platform architecture (year 2037 for 32 bits);
23595 * @see elm_calendar_min_max_year_get()
23597 * @ref calendar_example_03
23599 * @ingroup Calendar
23601 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23604 * Get the minimum and maximum values for the year
23606 * @param obj The calendar object.
23607 * @param min The minimum year.
23608 * @param max The maximum year.
23610 * Default values are 1902 and -1.
23612 * @see elm_calendar_min_max_year_get() for more details.
23614 * @ref calendar_example_05
23616 * @ingroup Calendar
23618 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23621 * Enable or disable day selection
23623 * @param obj The calendar object.
23624 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23627 * Enabled by default. If disabled, the user still can select months,
23628 * but not days. Selected days are highlighted on calendar.
23629 * It should be used if you won't need such selection for the widget usage.
23631 * When a day is selected, or month is changed, smart callbacks for
23632 * signal "changed" will be called.
23634 * @see elm_calendar_day_selection_enable_get()
23636 * @ref calendar_example_04
23638 * @ingroup Calendar
23640 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23643 * Get a value whether day selection is enabled or not.
23645 * @see elm_calendar_day_selection_enable_set() for details.
23647 * @param obj The calendar object.
23648 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23649 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23651 * @ref calendar_example_05
23653 * @ingroup Calendar
23655 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23659 * Set selected date to be highlighted on calendar.
23661 * @param obj The calendar object.
23662 * @param selected_time A @b tm struct to represent the selected date.
23664 * Set the selected date, changing the displayed month if needed.
23665 * Selected date changes when the user goes to next/previous month or
23666 * select a day pressing over it on calendar.
23668 * @see elm_calendar_selected_time_get()
23670 * @ref calendar_example_04
23672 * @ingroup Calendar
23674 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23677 * Get selected date.
23679 * @param obj The calendar object
23680 * @param selected_time A @b tm struct to point to selected date
23681 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23684 * Get date selected by the user or set by function
23685 * elm_calendar_selected_time_set().
23686 * Selected date changes when the user goes to next/previous month or
23687 * select a day pressing over it on calendar.
23689 * @see elm_calendar_selected_time_get()
23691 * @ref calendar_example_05
23693 * @ingroup Calendar
23695 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23698 * Set a function to format the string that will be used to display
23701 * @param obj The calendar object
23702 * @param format_function Function to set the month-year string given
23703 * the selected date
23705 * By default it uses strftime with "%B %Y" format string.
23706 * It should allocate the memory that will be used by the string,
23707 * that will be freed by the widget after usage.
23708 * A pointer to the string and a pointer to the time struct will be provided.
23713 * _format_month_year(struct tm *selected_time)
23716 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23717 * return strdup(buf);
23720 * elm_calendar_format_function_set(calendar, _format_month_year);
23723 * @ref calendar_example_02
23725 * @ingroup Calendar
23727 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23730 * Add a new mark to the calendar
23732 * @param obj The calendar object
23733 * @param mark_type A string used to define the type of mark. It will be
23734 * emitted to the theme, that should display a related modification on these
23735 * days representation.
23736 * @param mark_time A time struct to represent the date of inclusion of the
23737 * mark. For marks that repeats it will just be displayed after the inclusion
23738 * date in the calendar.
23739 * @param repeat Repeat the event following this periodicity. Can be a unique
23740 * mark (that don't repeat), daily, weekly, monthly or annually.
23741 * @return The created mark or @p NULL upon failure.
23743 * Add a mark that will be drawn in the calendar respecting the insertion
23744 * time and periodicity. It will emit the type as signal to the widget theme.
23745 * Default theme supports "holiday" and "checked", but it can be extended.
23747 * It won't immediately update the calendar, drawing the marks.
23748 * For this, call elm_calendar_marks_draw(). However, when user selects
23749 * next or previous month calendar forces marks drawn.
23751 * Marks created with this method can be deleted with
23752 * elm_calendar_mark_del().
23756 * struct tm selected_time;
23757 * time_t current_time;
23759 * current_time = time(NULL) + 5 * 84600;
23760 * localtime_r(¤t_time, &selected_time);
23761 * elm_calendar_mark_add(cal, "holiday", selected_time,
23762 * ELM_CALENDAR_ANNUALLY);
23764 * current_time = time(NULL) + 1 * 84600;
23765 * localtime_r(¤t_time, &selected_time);
23766 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23768 * elm_calendar_marks_draw(cal);
23771 * @see elm_calendar_marks_draw()
23772 * @see elm_calendar_mark_del()
23774 * @ref calendar_example_06
23776 * @ingroup Calendar
23778 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);
23781 * Delete mark from the calendar.
23783 * @param mark The mark to be deleted.
23785 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23786 * should be used instead of getting marks list and deleting each one.
23788 * @see elm_calendar_mark_add()
23790 * @ref calendar_example_06
23792 * @ingroup Calendar
23794 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23797 * Remove all calendar's marks
23799 * @param obj The calendar object.
23801 * @see elm_calendar_mark_add()
23802 * @see elm_calendar_mark_del()
23804 * @ingroup Calendar
23806 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23810 * Get a list of all the calendar marks.
23812 * @param obj The calendar object.
23813 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23815 * @see elm_calendar_mark_add()
23816 * @see elm_calendar_mark_del()
23817 * @see elm_calendar_marks_clear()
23819 * @ingroup Calendar
23821 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23824 * Draw calendar marks.
23826 * @param obj The calendar object.
23828 * Should be used after adding, removing or clearing marks.
23829 * It will go through the entire marks list updating the calendar.
23830 * If lots of marks will be added, add all the marks and then call
23833 * When the month is changed, i.e. user selects next or previous month,
23834 * marks will be drawed.
23836 * @see elm_calendar_mark_add()
23837 * @see elm_calendar_mark_del()
23838 * @see elm_calendar_marks_clear()
23840 * @ref calendar_example_06
23842 * @ingroup Calendar
23844 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23847 * Set a day text color to the same that represents Saturdays.
23849 * @param obj The calendar object.
23850 * @param pos The text position. Position is the cell counter, from left
23851 * to right, up to down. It starts on 0 and ends on 41.
23853 * @deprecated use elm_calendar_mark_add() instead like:
23856 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23857 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23860 * @see elm_calendar_mark_add()
23862 * @ingroup Calendar
23864 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23867 * Set a day text color to the same that represents Sundays.
23869 * @param obj The calendar object.
23870 * @param pos The text position. Position is the cell counter, from left
23871 * to right, up to down. It starts on 0 and ends on 41.
23873 * @deprecated use elm_calendar_mark_add() instead like:
23876 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23877 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23880 * @see elm_calendar_mark_add()
23882 * @ingroup Calendar
23884 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23887 * Set a day text color to the same that represents Weekdays.
23889 * @param obj The calendar object
23890 * @param pos The text position. Position is the cell counter, from left
23891 * to right, up to down. It starts on 0 and ends on 41.
23893 * @deprecated use elm_calendar_mark_add() instead like:
23896 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23898 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23899 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23900 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23901 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23902 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23903 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23904 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23905 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23906 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23909 * @see elm_calendar_mark_add()
23911 * @ingroup Calendar
23913 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23916 * Set the interval on time updates for an user mouse button hold
23917 * on calendar widgets' month selection.
23919 * @param obj The calendar object
23920 * @param interval The (first) interval value in seconds
23922 * This interval value is @b decreased while the user holds the
23923 * mouse pointer either selecting next or previous month.
23925 * This helps the user to get to a given month distant from the
23926 * current one easier/faster, as it will start to change quicker and
23927 * quicker on mouse button holds.
23929 * The calculation for the next change interval value, starting from
23930 * the one set with this call, is the previous interval divided by
23931 * 1.05, so it decreases a little bit.
23933 * The default starting interval value for automatic changes is
23936 * @see elm_calendar_interval_get()
23938 * @ingroup Calendar
23940 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23943 * Get the interval on time updates for an user mouse button hold
23944 * on calendar widgets' month selection.
23946 * @param obj The calendar object
23947 * @return The (first) interval value, in seconds, set on it
23949 * @see elm_calendar_interval_set() for more details
23951 * @ingroup Calendar
23953 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23960 * @defgroup Diskselector Diskselector
23961 * @ingroup Elementary
23963 * @image html img/widget/diskselector/preview-00.png
23964 * @image latex img/widget/diskselector/preview-00.eps
23966 * A diskselector is a kind of list widget. It scrolls horizontally,
23967 * and can contain label and icon objects. Three items are displayed
23968 * with the selected one in the middle.
23970 * It can act like a circular list with round mode and labels can be
23971 * reduced for a defined length for side items.
23973 * Smart callbacks one can listen to:
23974 * - "selected" - when item is selected, i.e. scroller stops.
23976 * Available styles for it:
23979 * List of examples:
23980 * @li @ref diskselector_example_01
23981 * @li @ref diskselector_example_02
23985 * @addtogroup Diskselector
23989 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(). */
23992 * Add a new diskselector widget to the given parent Elementary
23993 * (container) object.
23995 * @param parent The parent object.
23996 * @return a new diskselector widget handle or @c NULL, on errors.
23998 * This function inserts a new diskselector widget on the canvas.
24000 * @ingroup Diskselector
24002 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24005 * Enable or disable round mode.
24007 * @param obj The diskselector object.
24008 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24011 * Disabled by default. If round mode is enabled the items list will
24012 * work like a circle list, so when the user reaches the last item,
24013 * the first one will popup.
24015 * @see elm_diskselector_round_get()
24017 * @ingroup Diskselector
24019 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24022 * Get a value whether round mode is enabled or not.
24024 * @see elm_diskselector_round_set() for details.
24026 * @param obj The diskselector object.
24027 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24028 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24030 * @ingroup Diskselector
24032 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24035 * Get the side labels max length.
24037 * @deprecated use elm_diskselector_side_label_length_get() instead:
24039 * @param obj The diskselector object.
24040 * @return The max length defined for side labels, or 0 if not a valid
24043 * @ingroup Diskselector
24045 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24048 * Set the side labels max length.
24050 * @deprecated use elm_diskselector_side_label_length_set() instead:
24052 * @param obj The diskselector object.
24053 * @param len The max length defined for side labels.
24055 * @ingroup Diskselector
24057 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24060 * Get the side labels max length.
24062 * @see elm_diskselector_side_label_length_set() for details.
24064 * @param obj The diskselector object.
24065 * @return The max length defined for side labels, or 0 if not a valid
24068 * @ingroup Diskselector
24070 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24073 * Set the side labels max length.
24075 * @param obj The diskselector object.
24076 * @param len The max length defined for side labels.
24078 * Length is the number of characters of items' label that will be
24079 * visible when it's set on side positions. It will just crop
24080 * the string after defined size. E.g.:
24082 * An item with label "January" would be displayed on side position as
24083 * "Jan" if max length is set to 3, or "Janu", if this property
24086 * When it's selected, the entire label will be displayed, except for
24087 * width restrictions. In this case label will be cropped and "..."
24088 * will be concatenated.
24090 * Default side label max length is 3.
24092 * This property will be applyed over all items, included before or
24093 * later this function call.
24095 * @ingroup Diskselector
24097 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24100 * Set the number of items to be displayed.
24102 * @param obj The diskselector object.
24103 * @param num The number of items the diskselector will display.
24105 * Default value is 3, and also it's the minimun. If @p num is less
24106 * than 3, it will be set to 3.
24108 * Also, it can be set on theme, using data item @c display_item_num
24109 * on group "elm/diskselector/item/X", where X is style set.
24112 * group { name: "elm/diskselector/item/X";
24114 * item: "display_item_num" "5";
24117 * @ingroup Diskselector
24119 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24122 * Set bouncing behaviour when the scrolled content reaches an edge.
24124 * Tell the internal scroller object whether it should bounce or not
24125 * when it reaches the respective edges for each axis.
24127 * @param obj The diskselector object.
24128 * @param h_bounce Whether to bounce or not in the horizontal axis.
24129 * @param v_bounce Whether to bounce or not in the vertical axis.
24131 * @see elm_scroller_bounce_set()
24133 * @ingroup Diskselector
24135 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24138 * Get the bouncing behaviour of the internal scroller.
24140 * Get whether the internal scroller should bounce when the edge of each
24141 * axis is reached scrolling.
24143 * @param obj The diskselector object.
24144 * @param h_bounce Pointer where to store the bounce state of the horizontal
24146 * @param v_bounce Pointer where to store the bounce state of the vertical
24149 * @see elm_scroller_bounce_get()
24150 * @see elm_diskselector_bounce_set()
24152 * @ingroup Diskselector
24154 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24157 * Get the scrollbar policy.
24159 * @see elm_diskselector_scroller_policy_get() for details.
24161 * @param obj The diskselector object.
24162 * @param policy_h Pointer where to store horizontal scrollbar policy.
24163 * @param policy_v Pointer where to store vertical scrollbar policy.
24165 * @ingroup Diskselector
24167 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);
24170 * Set the scrollbar policy.
24172 * @param obj The diskselector object.
24173 * @param policy_h Horizontal scrollbar policy.
24174 * @param policy_v Vertical scrollbar policy.
24176 * This sets the scrollbar visibility policy for the given scroller.
24177 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24178 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24179 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24180 * This applies respectively for the horizontal and vertical scrollbars.
24182 * The both are disabled by default, i.e., are set to
24183 * #ELM_SCROLLER_POLICY_OFF.
24185 * @ingroup Diskselector
24187 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24190 * Remove all diskselector's items.
24192 * @param obj The diskselector object.
24194 * @see elm_diskselector_item_del()
24195 * @see elm_diskselector_item_append()
24197 * @ingroup Diskselector
24199 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24202 * Get a list of all the diskselector items.
24204 * @param obj The diskselector object.
24205 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24206 * or @c NULL on failure.
24208 * @see elm_diskselector_item_append()
24209 * @see elm_diskselector_item_del()
24210 * @see elm_diskselector_clear()
24212 * @ingroup Diskselector
24214 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24217 * Appends a new item to the diskselector object.
24219 * @param obj The diskselector object.
24220 * @param label The label of the diskselector item.
24221 * @param icon The icon object to use at left side of the item. An
24222 * icon can be any Evas object, but usually it is an icon created
24223 * with elm_icon_add().
24224 * @param func The function to call when the item is selected.
24225 * @param data The data to associate with the item for related callbacks.
24227 * @return The created item or @c NULL upon failure.
24229 * A new item will be created and appended to the diskselector, i.e., will
24230 * be set as last item. Also, if there is no selected item, it will
24231 * be selected. This will always happens for the first appended item.
24233 * If no icon is set, label will be centered on item position, otherwise
24234 * the icon will be placed at left of the label, that will be shifted
24237 * Items created with this method can be deleted with
24238 * elm_diskselector_item_del().
24240 * Associated @p data can be properly freed when item is deleted if a
24241 * callback function is set with elm_diskselector_item_del_cb_set().
24243 * If a function is passed as argument, it will be called everytime this item
24244 * is selected, i.e., the user stops the diskselector with this
24245 * item on center position. If such function isn't needed, just passing
24246 * @c NULL as @p func is enough. The same should be done for @p data.
24248 * Simple example (with no function callback or data associated):
24250 * disk = elm_diskselector_add(win);
24251 * ic = elm_icon_add(win);
24252 * elm_icon_file_set(ic, "path/to/image", NULL);
24253 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24254 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24257 * @see elm_diskselector_item_del()
24258 * @see elm_diskselector_item_del_cb_set()
24259 * @see elm_diskselector_clear()
24260 * @see elm_icon_add()
24262 * @ingroup Diskselector
24264 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);
24268 * Delete them item from the diskselector.
24270 * @param it The item of diskselector to be deleted.
24272 * If deleting all diskselector items is required, elm_diskselector_clear()
24273 * should be used instead of getting items list and deleting each one.
24275 * @see elm_diskselector_clear()
24276 * @see elm_diskselector_item_append()
24277 * @see elm_diskselector_item_del_cb_set()
24279 * @ingroup Diskselector
24281 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24284 * Set the function called when a diskselector item is freed.
24286 * @param it The item to set the callback on
24287 * @param func The function called
24289 * If there is a @p func, then it will be called prior item's memory release.
24290 * That will be called with the following arguments:
24292 * @li item's Evas object;
24295 * This way, a data associated to a diskselector item could be properly
24298 * @ingroup Diskselector
24300 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24303 * Get the data associated to the item.
24305 * @param it The diskselector item
24306 * @return The data associated to @p it
24308 * The return value is a pointer to data associated to @p item when it was
24309 * created, with function elm_diskselector_item_append(). If no data
24310 * was passed as argument, it will return @c NULL.
24312 * @see elm_diskselector_item_append()
24314 * @ingroup Diskselector
24316 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24319 * Set the icon associated to the item.
24321 * @param it The diskselector item
24322 * @param icon The icon object to associate with @p it
24324 * The icon object to use at left side of the item. An
24325 * icon can be any Evas object, but usually it is an icon created
24326 * with elm_icon_add().
24328 * Once the icon object is set, a previously set one will be deleted.
24329 * @warning Setting the same icon for two items will cause the icon to
24330 * dissapear from the first item.
24332 * If an icon was passed as argument on item creation, with function
24333 * elm_diskselector_item_append(), it will be already
24334 * associated to the item.
24336 * @see elm_diskselector_item_append()
24337 * @see elm_diskselector_item_icon_get()
24339 * @ingroup Diskselector
24341 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24344 * Get the icon associated to the item.
24346 * @param it The diskselector item
24347 * @return The icon associated to @p it
24349 * The return value is a pointer to the icon associated to @p item when it was
24350 * created, with function elm_diskselector_item_append(), or later
24351 * with function elm_diskselector_item_icon_set. If no icon
24352 * was passed as argument, it will return @c NULL.
24354 * @see elm_diskselector_item_append()
24355 * @see elm_diskselector_item_icon_set()
24357 * @ingroup Diskselector
24359 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24362 * Set the label of item.
24364 * @param it The item of diskselector.
24365 * @param label The label of item.
24367 * The label to be displayed by the item.
24369 * If no icon is set, label will be centered on item position, otherwise
24370 * the icon will be placed at left of the label, that will be shifted
24373 * An item with label "January" would be displayed on side position as
24374 * "Jan" if max length is set to 3 with function
24375 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24378 * When this @p item is selected, the entire label will be displayed,
24379 * except for width restrictions.
24380 * In this case label will be cropped and "..." will be concatenated,
24381 * but only for display purposes. It will keep the entire string, so
24382 * if diskselector is resized the remaining characters will be displayed.
24384 * If a label was passed as argument on item creation, with function
24385 * elm_diskselector_item_append(), it will be already
24386 * displayed by the item.
24388 * @see elm_diskselector_side_label_lenght_set()
24389 * @see elm_diskselector_item_label_get()
24390 * @see elm_diskselector_item_append()
24392 * @ingroup Diskselector
24394 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24397 * Get the label of item.
24399 * @param it The item of diskselector.
24400 * @return The label of item.
24402 * The return value is a pointer to the label associated to @p item when it was
24403 * created, with function elm_diskselector_item_append(), or later
24404 * with function elm_diskselector_item_label_set. If no label
24405 * was passed as argument, it will return @c NULL.
24407 * @see elm_diskselector_item_label_set() for more details.
24408 * @see elm_diskselector_item_append()
24410 * @ingroup Diskselector
24412 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24415 * Get the selected item.
24417 * @param obj The diskselector object.
24418 * @return The selected diskselector item.
24420 * The selected item can be unselected with function
24421 * elm_diskselector_item_selected_set(), and the first item of
24422 * diskselector will be selected.
24424 * The selected item always will be centered on diskselector, with
24425 * full label displayed, i.e., max lenght set to side labels won't
24426 * apply on the selected item. More details on
24427 * elm_diskselector_side_label_length_set().
24429 * @ingroup Diskselector
24431 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24434 * Set the selected state of an item.
24436 * @param it The diskselector item
24437 * @param selected The selected state
24439 * This sets the selected state of the given item @p it.
24440 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24442 * If a new item is selected the previosly selected will be unselected.
24443 * Previoulsy selected item can be get with function
24444 * elm_diskselector_selected_item_get().
24446 * If the item @p it is unselected, the first item of diskselector will
24449 * Selected items will be visible on center position of diskselector.
24450 * So if it was on another position before selected, or was invisible,
24451 * diskselector will animate items until the selected item reaches center
24454 * @see elm_diskselector_item_selected_get()
24455 * @see elm_diskselector_selected_item_get()
24457 * @ingroup Diskselector
24459 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24462 * Get whether the @p item is selected or not.
24464 * @param it The diskselector item.
24465 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24466 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24468 * @see elm_diskselector_selected_item_set() for details.
24469 * @see elm_diskselector_item_selected_get()
24471 * @ingroup Diskselector
24473 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24476 * Get the first item of the diskselector.
24478 * @param obj The diskselector object.
24479 * @return The first item, or @c NULL if none.
24481 * The list of items follows append order. So it will return the first
24482 * item appended to the widget that wasn't deleted.
24484 * @see elm_diskselector_item_append()
24485 * @see elm_diskselector_items_get()
24487 * @ingroup Diskselector
24489 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24492 * Get the last item of the diskselector.
24494 * @param obj The diskselector object.
24495 * @return The last item, or @c NULL if none.
24497 * The list of items follows append order. So it will return last first
24498 * item appended to the widget that wasn't deleted.
24500 * @see elm_diskselector_item_append()
24501 * @see elm_diskselector_items_get()
24503 * @ingroup Diskselector
24505 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24508 * Get the item before @p item in diskselector.
24510 * @param it The diskselector item.
24511 * @return The item before @p item, or @c NULL if none or on failure.
24513 * The list of items follows append order. So it will return item appended
24514 * just before @p item and that wasn't deleted.
24516 * If it is the first item, @c NULL will be returned.
24517 * First item can be get by elm_diskselector_first_item_get().
24519 * @see elm_diskselector_item_append()
24520 * @see elm_diskselector_items_get()
24522 * @ingroup Diskselector
24524 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24527 * Get the item after @p item in diskselector.
24529 * @param it The diskselector item.
24530 * @return The item after @p item, or @c NULL if none or on failure.
24532 * The list of items follows append order. So it will return item appended
24533 * just after @p item and that wasn't deleted.
24535 * If it is the last item, @c NULL will be returned.
24536 * Last item can be get by elm_diskselector_last_item_get().
24538 * @see elm_diskselector_item_append()
24539 * @see elm_diskselector_items_get()
24541 * @ingroup Diskselector
24543 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24546 * Set the text to be shown in the diskselector item.
24548 * @param item Target item
24549 * @param text The text to set in the content
24551 * Setup the text as tooltip to object. The item can have only one tooltip,
24552 * so any previous tooltip data is removed.
24554 * @see elm_object_tooltip_text_set() for more details.
24556 * @ingroup Diskselector
24558 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24561 * Set the content to be shown in the tooltip item.
24563 * Setup the tooltip to item. The item can have only one tooltip,
24564 * so any previous tooltip data is removed. @p func(with @p data) will
24565 * be called every time that need show the tooltip and it should
24566 * return a valid Evas_Object. This object is then managed fully by
24567 * tooltip system and is deleted when the tooltip is gone.
24569 * @param item the diskselector item being attached a tooltip.
24570 * @param func the function used to create the tooltip contents.
24571 * @param data what to provide to @a func as callback data/context.
24572 * @param del_cb called when data is not needed anymore, either when
24573 * another callback replaces @p func, the tooltip is unset with
24574 * elm_diskselector_item_tooltip_unset() or the owner @a item
24575 * dies. This callback receives as the first parameter the
24576 * given @a data, and @c event_info is the item.
24578 * @see elm_object_tooltip_content_cb_set() for more details.
24580 * @ingroup Diskselector
24582 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);
24585 * Unset tooltip from item.
24587 * @param item diskselector item to remove previously set tooltip.
24589 * Remove tooltip from item. The callback provided as del_cb to
24590 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24591 * it is not used anymore.
24593 * @see elm_object_tooltip_unset() for more details.
24594 * @see elm_diskselector_item_tooltip_content_cb_set()
24596 * @ingroup Diskselector
24598 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24602 * Sets a different style for this item tooltip.
24604 * @note before you set a style you should define a tooltip with
24605 * elm_diskselector_item_tooltip_content_cb_set() or
24606 * elm_diskselector_item_tooltip_text_set()
24608 * @param item diskselector item with tooltip already set.
24609 * @param style the theme style to use (default, transparent, ...)
24611 * @see elm_object_tooltip_style_set() for more details.
24613 * @ingroup Diskselector
24615 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24618 * Get the style for this item tooltip.
24620 * @param item diskselector item with tooltip already set.
24621 * @return style the theme style in use, defaults to "default". If the
24622 * object does not have a tooltip set, then NULL is returned.
24624 * @see elm_object_tooltip_style_get() for more details.
24625 * @see elm_diskselector_item_tooltip_style_set()
24627 * @ingroup Diskselector
24629 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24632 * Set the cursor to be shown when mouse is over the diskselector item
24634 * @param item Target item
24635 * @param cursor the cursor name to be used.
24637 * @see elm_object_cursor_set() for more details.
24639 * @ingroup Diskselector
24641 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24644 * Get the cursor to be shown when mouse is over the diskselector item
24646 * @param item diskselector item with cursor already set.
24647 * @return the cursor name.
24649 * @see elm_object_cursor_get() for more details.
24650 * @see elm_diskselector_cursor_set()
24652 * @ingroup Diskselector
24654 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24658 * Unset the cursor to be shown when mouse is over the diskselector item
24660 * @param item Target item
24662 * @see elm_object_cursor_unset() for more details.
24663 * @see elm_diskselector_cursor_set()
24665 * @ingroup Diskselector
24667 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24670 * Sets a different style for this item cursor.
24672 * @note before you set a style you should define a cursor with
24673 * elm_diskselector_item_cursor_set()
24675 * @param item diskselector item with cursor already set.
24676 * @param style the theme style to use (default, transparent, ...)
24678 * @see elm_object_cursor_style_set() for more details.
24680 * @ingroup Diskselector
24682 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24686 * Get the style for this item cursor.
24688 * @param item diskselector item with cursor already set.
24689 * @return style the theme style in use, defaults to "default". If the
24690 * object does not have a cursor set, then @c NULL is returned.
24692 * @see elm_object_cursor_style_get() for more details.
24693 * @see elm_diskselector_item_cursor_style_set()
24695 * @ingroup Diskselector
24697 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24701 * Set if the cursor set should be searched on the theme or should use
24702 * the provided by the engine, only.
24704 * @note before you set if should look on theme you should define a cursor
24705 * with elm_diskselector_item_cursor_set().
24706 * By default it will only look for cursors provided by the engine.
24708 * @param item widget item with cursor already set.
24709 * @param engine_only boolean to define if cursors set with
24710 * elm_diskselector_item_cursor_set() should be searched only
24711 * between cursors provided by the engine or searched on widget's
24714 * @see elm_object_cursor_engine_only_set() for more details.
24716 * @ingroup Diskselector
24718 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24721 * Get the cursor engine only usage for this item cursor.
24723 * @param item widget item with cursor already set.
24724 * @return engine_only boolean to define it cursors should be looked only
24725 * between the provided by the engine or searched on widget's theme as well.
24726 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24728 * @see elm_object_cursor_engine_only_get() for more details.
24729 * @see elm_diskselector_item_cursor_engine_only_set()
24731 * @ingroup Diskselector
24733 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24740 * @defgroup Colorselector Colorselector
24744 * @image html img/widget/colorselector/preview-00.png
24745 * @image latex img/widget/colorselector/preview-00.eps
24747 * @brief Widget for user to select a color.
24749 * Signals that you can add callbacks for are:
24750 * "changed" - When the color value changes(event_info is NULL).
24752 * See @ref tutorial_colorselector.
24755 * @brief Add a new colorselector to the parent
24757 * @param parent The parent object
24758 * @return The new object or NULL if it cannot be created
24760 * @ingroup Colorselector
24762 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24764 * Set a color for the colorselector
24766 * @param obj Colorselector object
24767 * @param r r-value of color
24768 * @param g g-value of color
24769 * @param b b-value of color
24770 * @param a a-value of color
24772 * @ingroup Colorselector
24774 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24776 * Get a color from the colorselector
24778 * @param obj Colorselector object
24779 * @param r integer pointer for r-value of color
24780 * @param g integer pointer for g-value of color
24781 * @param b integer pointer for b-value of color
24782 * @param a integer pointer for a-value of color
24784 * @ingroup Colorselector
24786 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24792 * @defgroup Ctxpopup Ctxpopup
24794 * @image html img/widget/ctxpopup/preview-00.png
24795 * @image latex img/widget/ctxpopup/preview-00.eps
24797 * @brief Context popup widet.
24799 * A ctxpopup is a widget that, when shown, pops up a list of items.
24800 * It automatically chooses an area inside its parent object's view
24801 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24802 * optimally fit into it. In the default theme, it will also point an
24803 * arrow to it's top left position at the time one shows it. Ctxpopup
24804 * items have a label and/or an icon. It is intended for a small
24805 * number of items (hence the use of list, not genlist).
24807 * @note Ctxpopup is a especialization of @ref Hover.
24809 * Signals that you can add callbacks for are:
24810 * "dismissed" - the ctxpopup was dismissed
24812 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24815 typedef enum _Elm_Ctxpopup_Direction
24817 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24819 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24820 the clicked area */
24821 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24822 the clicked area */
24823 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24825 } Elm_Ctxpopup_Direction;
24828 * @brief Add a new Ctxpopup object to the parent.
24830 * @param parent Parent object
24831 * @return New object or @c NULL, if it cannot be created
24833 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24835 * @brief Set the Ctxpopup's parent
24837 * @param obj The ctxpopup object
24838 * @param area The parent to use
24840 * Set the parent object.
24842 * @note elm_ctxpopup_add() will automatically call this function
24843 * with its @c parent argument.
24845 * @see elm_ctxpopup_add()
24846 * @see elm_hover_parent_set()
24848 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24850 * @brief Get the Ctxpopup's parent
24852 * @param obj The ctxpopup object
24854 * @see elm_ctxpopup_hover_parent_set() for more information
24856 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24858 * @brief Clear all items in the given ctxpopup object.
24860 * @param obj Ctxpopup object
24862 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24864 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24866 * @param obj Ctxpopup object
24867 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24869 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24871 * @brief Get the value of current ctxpopup object's orientation.
24873 * @param obj Ctxpopup object
24874 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24876 * @see elm_ctxpopup_horizontal_set()
24878 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24880 * @brief Add a new item to a ctxpopup object.
24882 * @param obj Ctxpopup object
24883 * @param icon Icon to be set on new item
24884 * @param label The Label of the new item
24885 * @param func Convenience function called when item selected
24886 * @param data Data passed to @p func
24887 * @return A handle to the item added or @c NULL, on errors
24889 * @warning Ctxpopup can't hold both an item list and a content at the same
24890 * time. When an item is added, any previous content will be removed.
24892 * @see elm_ctxpopup_content_set()
24894 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);
24896 * @brief Delete the given item in a ctxpopup object.
24898 * @param it Ctxpopup item to be deleted
24900 * @see elm_ctxpopup_item_append()
24902 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24904 * @brief Set the ctxpopup item's state as disabled or enabled.
24906 * @param it Ctxpopup item to be enabled/disabled
24907 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24909 * When disabled the item is greyed out to indicate it's state.
24911 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24913 * @brief Get the ctxpopup item's disabled/enabled state.
24915 * @param it Ctxpopup item to be enabled/disabled
24916 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24918 * @see elm_ctxpopup_item_disabled_set()
24920 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24922 * @brief Get the icon object for the given ctxpopup item.
24924 * @param it Ctxpopup item
24925 * @return icon object or @c NULL, if the item does not have icon or an error
24928 * @see elm_ctxpopup_item_append()
24929 * @see elm_ctxpopup_item_icon_set()
24931 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24933 * @brief Sets the side icon associated with the ctxpopup item
24935 * @param it Ctxpopup item
24936 * @param icon Icon object to be set
24938 * Once the icon object is set, a previously set one will be deleted.
24939 * @warning Setting the same icon for two items will cause the icon to
24940 * dissapear from the first item.
24942 * @see elm_ctxpopup_item_append()
24944 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24946 * @brief Get the label for the given ctxpopup item.
24948 * @param it Ctxpopup item
24949 * @return label string or @c NULL, if the item does not have label or an
24952 * @see elm_ctxpopup_item_append()
24953 * @see elm_ctxpopup_item_label_set()
24955 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24957 * @brief (Re)set the label on the given ctxpopup item.
24959 * @param it Ctxpopup item
24960 * @param label String to set as label
24962 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24964 * @brief Set an elm widget as the content of the ctxpopup.
24966 * @param obj Ctxpopup object
24967 * @param content Content to be swallowed
24969 * If the content object is already set, a previous one will bedeleted. If
24970 * you want to keep that old content object, use the
24971 * elm_ctxpopup_content_unset() function.
24973 * @deprecated use elm_object_content_set()
24975 * @warning Ctxpopup can't hold both a item list and a content at the same
24976 * time. When a content is set, any previous items will be removed.
24978 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24980 * @brief Unset the ctxpopup content
24982 * @param obj Ctxpopup object
24983 * @return The content that was being used
24985 * Unparent and return the content object which was set for this widget.
24987 * @deprecated use elm_object_content_unset()
24989 * @see elm_ctxpopup_content_set()
24991 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24993 * @brief Set the direction priority of a ctxpopup.
24995 * @param obj Ctxpopup object
24996 * @param first 1st priority of direction
24997 * @param second 2nd priority of direction
24998 * @param third 3th priority of direction
24999 * @param fourth 4th priority of direction
25001 * This functions gives a chance to user to set the priority of ctxpopup
25002 * showing direction. This doesn't guarantee the ctxpopup will appear in the
25003 * requested direction.
25005 * @see Elm_Ctxpopup_Direction
25007 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);
25009 * @brief Get the direction priority of a ctxpopup.
25011 * @param obj Ctxpopup object
25012 * @param first 1st priority of direction to be returned
25013 * @param second 2nd priority of direction to be returned
25014 * @param third 3th priority of direction to be returned
25015 * @param fourth 4th priority of direction to be returned
25017 * @see elm_ctxpopup_direction_priority_set() for more information.
25019 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);
25027 * @defgroup Transit Transit
25028 * @ingroup Elementary
25030 * Transit is designed to apply various animated transition effects to @c
25031 * Evas_Object, such like translation, rotation, etc. For using these
25032 * effects, create an @ref Elm_Transit and add the desired transition effects.
25034 * Once the effects are added into transit, they will be automatically
25035 * managed (their callback will be called until the duration is ended, and
25036 * they will be deleted on completion).
25040 * Elm_Transit *trans = elm_transit_add();
25041 * elm_transit_object_add(trans, obj);
25042 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25043 * elm_transit_duration_set(transit, 1);
25044 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25045 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25046 * elm_transit_repeat_times_set(transit, 3);
25049 * Some transition effects are used to change the properties of objects. They
25051 * @li @ref elm_transit_effect_translation_add
25052 * @li @ref elm_transit_effect_color_add
25053 * @li @ref elm_transit_effect_rotation_add
25054 * @li @ref elm_transit_effect_wipe_add
25055 * @li @ref elm_transit_effect_zoom_add
25056 * @li @ref elm_transit_effect_resizing_add
25058 * Other transition effects are used to make one object disappear and another
25059 * object appear on its old place. These effects are:
25061 * @li @ref elm_transit_effect_flip_add
25062 * @li @ref elm_transit_effect_resizable_flip_add
25063 * @li @ref elm_transit_effect_fade_add
25064 * @li @ref elm_transit_effect_blend_add
25066 * It's also possible to make a transition chain with @ref
25067 * elm_transit_chain_transit_add.
25069 * @warning We strongly recommend to use elm_transit just when edje can not do
25070 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25071 * animations can be manipulated inside the theme.
25073 * List of examples:
25074 * @li @ref transit_example_01_explained
25075 * @li @ref transit_example_02_explained
25076 * @li @ref transit_example_03_c
25077 * @li @ref transit_example_04_c
25083 * @enum Elm_Transit_Tween_Mode
25085 * The type of acceleration used in the transition.
25089 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25090 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25091 over time, then decrease again
25093 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25095 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25097 } Elm_Transit_Tween_Mode;
25100 * @enum Elm_Transit_Effect_Flip_Axis
25102 * The axis where flip effect should be applied.
25106 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25107 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25108 } Elm_Transit_Effect_Flip_Axis;
25110 * @enum Elm_Transit_Effect_Wipe_Dir
25112 * The direction where the wipe effect should occur.
25116 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25117 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25118 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25119 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25120 } Elm_Transit_Effect_Wipe_Dir;
25121 /** @enum Elm_Transit_Effect_Wipe_Type
25123 * Whether the wipe effect should show or hide the object.
25127 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25129 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25131 } Elm_Transit_Effect_Wipe_Type;
25134 * @typedef Elm_Transit
25136 * The Transit created with elm_transit_add(). This type has the information
25137 * about the objects which the transition will be applied, and the
25138 * transition effects that will be used. It also contains info about
25139 * duration, number of repetitions, auto-reverse, etc.
25141 typedef struct _Elm_Transit Elm_Transit;
25142 typedef void Elm_Transit_Effect;
25144 * @typedef Elm_Transit_Effect_Transition_Cb
25146 * Transition callback called for this effect on each transition iteration.
25148 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25150 * Elm_Transit_Effect_End_Cb
25152 * Transition callback called for this effect when the transition is over.
25154 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25157 * Elm_Transit_Del_Cb
25159 * A callback called when the transit is deleted.
25161 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25166 * @note Is not necessary to delete the transit object, it will be deleted at
25167 * the end of its operation.
25168 * @note The transit will start playing when the program enter in the main loop, is not
25169 * necessary to give a start to the transit.
25171 * @return The transit object.
25175 EAPI Elm_Transit *elm_transit_add(void);
25178 * Stops the animation and delete the @p transit object.
25180 * Call this function if you wants to stop the animation before the duration
25181 * time. Make sure the @p transit object is still alive with
25182 * elm_transit_del_cb_set() function.
25183 * All added effects will be deleted, calling its repective data_free_cb
25184 * functions. The function setted by elm_transit_del_cb_set() will be called.
25186 * @see elm_transit_del_cb_set()
25188 * @param transit The transit object to be deleted.
25191 * @warning Just call this function if you are sure the transit is alive.
25193 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25196 * Add a new effect to the transit.
25198 * @note The cb function and the data are the key to the effect. If you try to
25199 * add an already added effect, nothing is done.
25200 * @note After the first addition of an effect in @p transit, if its
25201 * effect list become empty again, the @p transit will be killed by
25202 * elm_transit_del(transit) function.
25206 * Elm_Transit *transit = elm_transit_add();
25207 * elm_transit_effect_add(transit,
25208 * elm_transit_effect_blend_op,
25209 * elm_transit_effect_blend_context_new(),
25210 * elm_transit_effect_blend_context_free);
25213 * @param transit The transit object.
25214 * @param transition_cb The operation function. It is called when the
25215 * animation begins, it is the function that actually performs the animation.
25216 * It is called with the @p data, @p transit and the time progression of the
25217 * animation (a double value between 0.0 and 1.0).
25218 * @param effect The context data of the effect.
25219 * @param end_cb The function to free the context data, it will be called
25220 * at the end of the effect, it must finalize the animation and free the
25224 * @warning The transit free the context data at the and of the transition with
25225 * the data_free_cb function, do not use the context data in another transit.
25227 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);
25230 * Delete an added effect.
25232 * This function will remove the effect from the @p transit, calling the
25233 * data_free_cb to free the @p data.
25235 * @see elm_transit_effect_add()
25237 * @note If the effect is not found, nothing is done.
25238 * @note If the effect list become empty, this function will call
25239 * elm_transit_del(transit), that is, it will kill the @p transit.
25241 * @param transit The transit object.
25242 * @param transition_cb The operation function.
25243 * @param effect The context data of the effect.
25247 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);
25250 * Add new object to apply the effects.
25252 * @note After the first addition of an object in @p transit, if its
25253 * object list become empty again, the @p transit will be killed by
25254 * elm_transit_del(transit) function.
25255 * @note If the @p obj belongs to another transit, the @p obj will be
25256 * removed from it and it will only belong to the @p transit. If the old
25257 * transit stays without objects, it will die.
25258 * @note When you add an object into the @p transit, its state from
25259 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25260 * transit ends, if you change this state whith evas_object_pass_events_set()
25261 * after add the object, this state will change again when @p transit stops to
25264 * @param transit The transit object.
25265 * @param obj Object to be animated.
25268 * @warning It is not allowed to add a new object after transit begins to go.
25270 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25273 * Removes an added object from the transit.
25275 * @note If the @p obj is not in the @p transit, nothing is done.
25276 * @note If the list become empty, this function will call
25277 * elm_transit_del(transit), that is, it will kill the @p transit.
25279 * @param transit The transit object.
25280 * @param obj Object to be removed from @p transit.
25283 * @warning It is not allowed to remove objects after transit begins to go.
25285 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25288 * Get the objects of the transit.
25290 * @param transit The transit object.
25291 * @return a Eina_List with the objects from the transit.
25295 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25298 * Enable/disable keeping up the objects states.
25299 * If it is not kept, the objects states will be reset when transition ends.
25301 * @note @p transit can not be NULL.
25302 * @note One state includes geometry, color, map data.
25304 * @param transit The transit object.
25305 * @param state_keep Keeping or Non Keeping.
25309 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25312 * Get a value whether the objects states will be reset or not.
25314 * @note @p transit can not be NULL
25316 * @see elm_transit_objects_final_state_keep_set()
25318 * @param transit The transit object.
25319 * @return EINA_TRUE means the states of the objects will be reset.
25320 * If @p transit is NULL, EINA_FALSE is returned
25324 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25327 * Set the event enabled when transit is operating.
25329 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25330 * events from mouse and keyboard during the animation.
25331 * @note When you add an object with elm_transit_object_add(), its state from
25332 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25333 * transit ends, if you change this state with evas_object_pass_events_set()
25334 * after adding the object, this state will change again when @p transit stops
25337 * @param transit The transit object.
25338 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25339 * ignored otherwise.
25343 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25346 * Get the value of event enabled status.
25348 * @see elm_transit_event_enabled_set()
25350 * @param transit The Transit object
25351 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25352 * EINA_FALSE is returned
25356 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25359 * Set the user-callback function when the transit is deleted.
25361 * @note Using this function twice will overwrite the first function setted.
25362 * @note the @p transit object will be deleted after call @p cb function.
25364 * @param transit The transit object.
25365 * @param cb Callback function pointer. This function will be called before
25366 * the deletion of the transit.
25367 * @param data Callback funtion user data. It is the @p op parameter.
25371 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25374 * Set reverse effect automatically.
25376 * If auto reverse is setted, after running the effects with the progress
25377 * parameter from 0 to 1, it will call the effecs again with the progress
25378 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25379 * where the duration was setted with the function elm_transit_add and
25380 * the repeat with the function elm_transit_repeat_times_set().
25382 * @param transit The transit object.
25383 * @param reverse EINA_TRUE means the auto_reverse is on.
25387 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25390 * Get if the auto reverse is on.
25392 * @see elm_transit_auto_reverse_set()
25394 * @param transit The transit object.
25395 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25396 * EINA_FALSE is returned
25400 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25403 * Set the transit repeat count. Effect will be repeated by repeat count.
25405 * This function sets the number of repetition the transit will run after
25406 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25407 * If the @p repeat is a negative number, it will repeat infinite times.
25409 * @note If this function is called during the transit execution, the transit
25410 * will run @p repeat times, ignoring the times it already performed.
25412 * @param transit The transit object
25413 * @param repeat Repeat count
25417 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25420 * Get the transit repeat count.
25422 * @see elm_transit_repeat_times_set()
25424 * @param transit The Transit object.
25425 * @return The repeat count. If @p transit is NULL
25430 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25433 * Set the transit animation acceleration type.
25435 * This function sets the tween mode of the transit that can be:
25436 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25437 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25438 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25439 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25441 * @param transit The transit object.
25442 * @param tween_mode The tween type.
25446 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25449 * Get the transit animation acceleration type.
25451 * @note @p transit can not be NULL
25453 * @param transit The transit object.
25454 * @return The tween type. If @p transit is NULL
25455 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25459 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25462 * Set the transit animation time
25464 * @note @p transit can not be NULL
25466 * @param transit The transit object.
25467 * @param duration The animation time.
25471 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25474 * Get the transit animation time
25476 * @note @p transit can not be NULL
25478 * @param transit The transit object.
25480 * @return The transit animation time.
25484 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25487 * Starts the transition.
25488 * Once this API is called, the transit begins to measure the time.
25490 * @note @p transit can not be NULL
25492 * @param transit The transit object.
25496 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25499 * Pause/Resume the transition.
25501 * If you call elm_transit_go again, the transit will be started from the
25502 * beginning, and will be unpaused.
25504 * @note @p transit can not be NULL
25506 * @param transit The transit object.
25507 * @param paused Whether the transition should be paused or not.
25511 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25514 * Get the value of paused status.
25516 * @see elm_transit_paused_set()
25518 * @note @p transit can not be NULL
25520 * @param transit The transit object.
25521 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25522 * EINA_FALSE is returned
25526 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25529 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25531 * The value returned is a fraction (current time / total time). It
25532 * represents the progression position relative to the total.
25534 * @note @p transit can not be NULL
25536 * @param transit The transit object.
25538 * @return The time progression value. If @p transit is NULL
25543 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25546 * Makes the chain relationship between two transits.
25548 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25549 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25551 * @param transit The transit object.
25552 * @param chain_transit The chain transit object. This transit will be operated
25553 * after transit is done.
25555 * This function adds @p chain_transit transition to a chain after the @p
25556 * transit, and will be started as soon as @p transit ends. See @ref
25557 * transit_example_02_explained for a full example.
25561 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25564 * Cut off the chain relationship between two transits.
25566 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25567 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25569 * @param transit The transit object.
25570 * @param chain_transit The chain transit object.
25572 * This function remove the @p chain_transit transition from the @p transit.
25576 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25579 * Get the current chain transit list.
25581 * @note @p transit can not be NULL.
25583 * @param transit The transit object.
25584 * @return chain transit list.
25588 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25591 * Add the Resizing Effect to Elm_Transit.
25593 * @note This API is one of the facades. It creates resizing effect context
25594 * and add it's required APIs to elm_transit_effect_add.
25596 * @see elm_transit_effect_add()
25598 * @param transit Transit object.
25599 * @param from_w Object width size when effect begins.
25600 * @param from_h Object height size when effect begins.
25601 * @param to_w Object width size when effect ends.
25602 * @param to_h Object height size when effect ends.
25603 * @return Resizing effect context data.
25607 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);
25610 * Add the Translation Effect to Elm_Transit.
25612 * @note This API is one of the facades. It creates translation effect context
25613 * and add it's required APIs to elm_transit_effect_add.
25615 * @see elm_transit_effect_add()
25617 * @param transit Transit object.
25618 * @param from_dx X Position variation when effect begins.
25619 * @param from_dy Y Position variation when effect begins.
25620 * @param to_dx X Position variation when effect ends.
25621 * @param to_dy Y Position variation when effect ends.
25622 * @return Translation effect context data.
25625 * @warning It is highly recommended just create a transit with this effect when
25626 * the window that the objects of the transit belongs has already been created.
25627 * This is because this effect needs the geometry information about the objects,
25628 * and if the window was not created yet, it can get a wrong information.
25630 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);
25633 * Add the Zoom Effect to Elm_Transit.
25635 * @note This API is one of the facades. It creates zoom effect context
25636 * and add it's required APIs to elm_transit_effect_add.
25638 * @see elm_transit_effect_add()
25640 * @param transit Transit object.
25641 * @param from_rate Scale rate when effect begins (1 is current rate).
25642 * @param to_rate Scale rate when effect ends.
25643 * @return Zoom effect context data.
25646 * @warning It is highly recommended just create a transit with this effect when
25647 * the window that the objects of the transit belongs has already been created.
25648 * This is because this effect needs the geometry information about the objects,
25649 * and if the window was not created yet, it can get a wrong information.
25651 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25654 * Add the Flip Effect to Elm_Transit.
25656 * @note This API is one of the facades. It creates flip effect context
25657 * and add it's required APIs to elm_transit_effect_add.
25658 * @note This effect is applied to each pair of objects in the order they are listed
25659 * in the transit list of objects. The first object in the pair will be the
25660 * "front" object and the second will be the "back" object.
25662 * @see elm_transit_effect_add()
25664 * @param transit Transit object.
25665 * @param axis Flipping Axis(X or Y).
25666 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25667 * @return Flip effect context data.
25670 * @warning It is highly recommended just create a transit with this effect when
25671 * the window that the objects of the transit belongs has already been created.
25672 * This is because this effect needs the geometry information about the objects,
25673 * and if the window was not created yet, it can get a wrong information.
25675 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25678 * Add the Resizable Flip Effect to Elm_Transit.
25680 * @note This API is one of the facades. It creates resizable flip effect context
25681 * and add it's required APIs to elm_transit_effect_add.
25682 * @note This effect is applied to each pair of objects in the order they are listed
25683 * in the transit list of objects. The first object in the pair will be the
25684 * "front" object and the second will be the "back" object.
25686 * @see elm_transit_effect_add()
25688 * @param transit Transit object.
25689 * @param axis Flipping Axis(X or Y).
25690 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25691 * @return Resizable flip effect context data.
25694 * @warning It is highly recommended just create a transit with this effect when
25695 * the window that the objects of the transit belongs has already been created.
25696 * This is because this effect needs the geometry information about the objects,
25697 * and if the window was not created yet, it can get a wrong information.
25699 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25702 * Add the Wipe Effect to Elm_Transit.
25704 * @note This API is one of the facades. It creates wipe effect context
25705 * and add it's required APIs to elm_transit_effect_add.
25707 * @see elm_transit_effect_add()
25709 * @param transit Transit object.
25710 * @param type Wipe type. Hide or show.
25711 * @param dir Wipe Direction.
25712 * @return Wipe effect context data.
25715 * @warning It is highly recommended just create a transit with this effect when
25716 * the window that the objects of the transit belongs has already been created.
25717 * This is because this effect needs the geometry information about the objects,
25718 * and if the window was not created yet, it can get a wrong information.
25720 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25723 * Add the Color Effect to Elm_Transit.
25725 * @note This API is one of the facades. It creates color effect context
25726 * and add it's required APIs to elm_transit_effect_add.
25728 * @see elm_transit_effect_add()
25730 * @param transit Transit object.
25731 * @param from_r RGB R when effect begins.
25732 * @param from_g RGB G when effect begins.
25733 * @param from_b RGB B when effect begins.
25734 * @param from_a RGB A when effect begins.
25735 * @param to_r RGB R when effect ends.
25736 * @param to_g RGB G when effect ends.
25737 * @param to_b RGB B when effect ends.
25738 * @param to_a RGB A when effect ends.
25739 * @return Color effect context data.
25743 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);
25746 * Add the Fade Effect to Elm_Transit.
25748 * @note This API is one of the facades. It creates fade effect context
25749 * and add it's required APIs to elm_transit_effect_add.
25750 * @note This effect is applied to each pair of objects in the order they are listed
25751 * in the transit list of objects. The first object in the pair will be the
25752 * "before" object and the second will be the "after" object.
25754 * @see elm_transit_effect_add()
25756 * @param transit Transit object.
25757 * @return Fade effect context data.
25760 * @warning It is highly recommended just create a transit with this effect when
25761 * the window that the objects of the transit belongs has already been created.
25762 * This is because this effect needs the color information about the objects,
25763 * and if the window was not created yet, it can get a wrong information.
25765 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25768 * Add the Blend Effect to Elm_Transit.
25770 * @note This API is one of the facades. It creates blend effect context
25771 * and add it's required APIs to elm_transit_effect_add.
25772 * @note This effect is applied to each pair of objects in the order they are listed
25773 * in the transit list of objects. The first object in the pair will be the
25774 * "before" object and the second will be the "after" object.
25776 * @see elm_transit_effect_add()
25778 * @param transit Transit object.
25779 * @return Blend effect context data.
25782 * @warning It is highly recommended just create a transit with this effect when
25783 * the window that the objects of the transit belongs has already been created.
25784 * This is because this effect needs the color information about the objects,
25785 * and if the window was not created yet, it can get a wrong information.
25787 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25790 * Add the Rotation Effect to Elm_Transit.
25792 * @note This API is one of the facades. It creates rotation effect context
25793 * and add it's required APIs to elm_transit_effect_add.
25795 * @see elm_transit_effect_add()
25797 * @param transit Transit object.
25798 * @param from_degree Degree when effect begins.
25799 * @param to_degree Degree when effect is ends.
25800 * @return Rotation effect context data.
25803 * @warning It is highly recommended just create a transit with this effect when
25804 * the window that the objects of the transit belongs has already been created.
25805 * This is because this effect needs the geometry information about the objects,
25806 * and if the window was not created yet, it can get a wrong information.
25808 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25811 * Add the ImageAnimation Effect to Elm_Transit.
25813 * @note This API is one of the facades. It creates image animation effect context
25814 * and add it's required APIs to elm_transit_effect_add.
25815 * The @p images parameter is a list images paths. This list and
25816 * its contents will be deleted at the end of the effect by
25817 * elm_transit_effect_image_animation_context_free() function.
25821 * char buf[PATH_MAX];
25822 * Eina_List *images = NULL;
25823 * Elm_Transit *transi = elm_transit_add();
25825 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25826 * images = eina_list_append(images, eina_stringshare_add(buf));
25828 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25829 * images = eina_list_append(images, eina_stringshare_add(buf));
25830 * elm_transit_effect_image_animation_add(transi, images);
25834 * @see elm_transit_effect_add()
25836 * @param transit Transit object.
25837 * @param images Eina_List of images file paths. This list and
25838 * its contents will be deleted at the end of the effect by
25839 * elm_transit_effect_image_animation_context_free() function.
25840 * @return Image Animation effect context data.
25844 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25849 typedef struct _Elm_Store Elm_Store;
25850 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25851 typedef struct _Elm_Store_Item Elm_Store_Item;
25852 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25853 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25854 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25855 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25856 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25857 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25858 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25859 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25861 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25862 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25863 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25864 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25868 ELM_STORE_ITEM_MAPPING_NONE = 0,
25869 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25870 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25871 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25872 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25873 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25874 // can add more here as needed by common apps
25875 ELM_STORE_ITEM_MAPPING_LAST
25876 } Elm_Store_Item_Mapping_Type;
25878 struct _Elm_Store_Item_Mapping_Icon
25880 // FIXME: allow edje file icons
25882 Elm_Icon_Lookup_Order lookup_order;
25883 Eina_Bool standard_name : 1;
25884 Eina_Bool no_scale : 1;
25885 Eina_Bool smooth : 1;
25886 Eina_Bool scale_up : 1;
25887 Eina_Bool scale_down : 1;
25890 struct _Elm_Store_Item_Mapping_Empty
25895 struct _Elm_Store_Item_Mapping_Photo
25900 struct _Elm_Store_Item_Mapping_Custom
25902 Elm_Store_Item_Mapping_Cb func;
25905 struct _Elm_Store_Item_Mapping
25907 Elm_Store_Item_Mapping_Type type;
25912 Elm_Store_Item_Mapping_Empty empty;
25913 Elm_Store_Item_Mapping_Icon icon;
25914 Elm_Store_Item_Mapping_Photo photo;
25915 Elm_Store_Item_Mapping_Custom custom;
25916 // add more types here
25920 struct _Elm_Store_Item_Info
25922 Elm_Genlist_Item_Class *item_class;
25923 const Elm_Store_Item_Mapping *mapping;
25928 struct _Elm_Store_Item_Info_Filesystem
25930 Elm_Store_Item_Info base;
25934 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25935 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25937 EAPI void elm_store_free(Elm_Store *st);
25939 EAPI Elm_Store *elm_store_filesystem_new(void);
25940 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25941 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25942 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25944 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25946 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25947 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25948 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25949 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25950 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25951 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25953 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25954 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25955 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25956 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25957 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25958 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25959 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25962 * @defgroup SegmentControl SegmentControl
25963 * @ingroup Elementary
25965 * @image html img/widget/segment_control/preview-00.png
25966 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25968 * @image html img/segment_control.png
25969 * @image latex img/segment_control.eps width=\textwidth
25971 * Segment control widget is a horizontal control made of multiple segment
25972 * items, each segment item functioning similar to discrete two state button.
25973 * A segment control groups the items together and provides compact
25974 * single button with multiple equal size segments.
25976 * Segment item size is determined by base widget
25977 * size and the number of items added.
25978 * Only one segment item can be at selected state. A segment item can display
25979 * combination of Text and any Evas_Object like Images or other widget.
25981 * Smart callbacks one can listen to:
25982 * - "changed" - When the user clicks on a segment item which is not
25983 * previously selected and get selected. The event_info parameter is the
25984 * segment item index.
25986 * Available styles for it:
25989 * Here is an example on its usage:
25990 * @li @ref segment_control_example
25994 * @addtogroup SegmentControl
25998 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26001 * Add a new segment control widget to the given parent Elementary
26002 * (container) object.
26004 * @param parent The parent object.
26005 * @return a new segment control widget handle or @c NULL, on errors.
26007 * This function inserts a new segment control widget on the canvas.
26009 * @ingroup SegmentControl
26011 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26014 * Append a new item to the segment control object.
26016 * @param obj The segment control object.
26017 * @param icon The icon object to use for the left side of the item. An
26018 * icon can be any Evas object, but usually it is an icon created
26019 * with elm_icon_add().
26020 * @param label The label of the item.
26021 * Note that, NULL is different from empty string "".
26022 * @return The created item or @c NULL upon failure.
26024 * A new item will be created and appended to the segment control, i.e., will
26025 * be set as @b last item.
26027 * If it should be inserted at another position,
26028 * elm_segment_control_item_insert_at() should be used instead.
26030 * Items created with this function can be deleted with function
26031 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26033 * @note @p label set to @c NULL is different from empty string "".
26035 * only has icon, it will be displayed bigger and centered. If it has
26036 * icon and label, even that an empty string, icon will be smaller and
26037 * positioned at left.
26041 * sc = elm_segment_control_add(win);
26042 * ic = elm_icon_add(win);
26043 * elm_icon_file_set(ic, "path/to/image", NULL);
26044 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26045 * elm_segment_control_item_add(sc, ic, "label");
26046 * evas_object_show(sc);
26049 * @see elm_segment_control_item_insert_at()
26050 * @see elm_segment_control_item_del()
26052 * @ingroup SegmentControl
26054 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26057 * Insert a new item to the segment control object at specified position.
26059 * @param obj The segment control object.
26060 * @param icon The icon object to use for the left side of the item. An
26061 * icon can be any Evas object, but usually it is an icon created
26062 * with elm_icon_add().
26063 * @param label The label of the item.
26064 * @param index Item position. Value should be between 0 and items count.
26065 * @return The created item or @c NULL upon failure.
26067 * Index values must be between @c 0, when item will be prepended to
26068 * segment control, and items count, that can be get with
26069 * elm_segment_control_item_count_get(), case when item will be appended
26070 * to segment control, just like elm_segment_control_item_add().
26072 * Items created with this function can be deleted with function
26073 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26075 * @note @p label set to @c NULL is different from empty string "".
26077 * only has icon, it will be displayed bigger and centered. If it has
26078 * icon and label, even that an empty string, icon will be smaller and
26079 * positioned at left.
26081 * @see elm_segment_control_item_add()
26082 * @see elm_segment_control_count_get()
26083 * @see elm_segment_control_item_del()
26085 * @ingroup SegmentControl
26087 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);
26090 * Remove a segment control item from its parent, deleting it.
26092 * @param it The item to be removed.
26094 * Items can be added with elm_segment_control_item_add() or
26095 * elm_segment_control_item_insert_at().
26097 * @ingroup SegmentControl
26099 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26102 * Remove a segment control item at given index from its parent,
26105 * @param obj The segment control object.
26106 * @param index The position of the segment control item to be deleted.
26108 * Items can be added with elm_segment_control_item_add() or
26109 * elm_segment_control_item_insert_at().
26111 * @ingroup SegmentControl
26113 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26116 * Get the Segment items count from segment control.
26118 * @param obj The segment control object.
26119 * @return Segment items count.
26121 * It will just return the number of items added to segment control @p obj.
26123 * @ingroup SegmentControl
26125 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26128 * Get the item placed at specified index.
26130 * @param obj The segment control object.
26131 * @param index The index of the segment item.
26132 * @return The segment control item or @c NULL on failure.
26134 * Index is the position of an item in segment control widget. Its
26135 * range is from @c 0 to <tt> count - 1 </tt>.
26136 * Count is the number of items, that can be get with
26137 * elm_segment_control_item_count_get().
26139 * @ingroup SegmentControl
26141 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26144 * Get the label of item.
26146 * @param obj The segment control object.
26147 * @param index The index of the segment item.
26148 * @return The label of the item at @p index.
26150 * The return value is a pointer to the label associated to the item when
26151 * it was created, with function elm_segment_control_item_add(), or later
26152 * with function elm_segment_control_item_label_set. If no label
26153 * was passed as argument, it will return @c NULL.
26155 * @see elm_segment_control_item_label_set() for more details.
26156 * @see elm_segment_control_item_add()
26158 * @ingroup SegmentControl
26160 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26163 * Set the label of item.
26165 * @param it The item of segment control.
26166 * @param text The label of item.
26168 * The label to be displayed by the item.
26169 * Label will be at right of the icon (if set).
26171 * If a label was passed as argument on item creation, with function
26172 * elm_control_segment_item_add(), it will be already
26173 * displayed by the item.
26175 * @see elm_segment_control_item_label_get()
26176 * @see elm_segment_control_item_add()
26178 * @ingroup SegmentControl
26180 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26183 * Get the icon associated to the item.
26185 * @param obj The segment control object.
26186 * @param index The index of the segment item.
26187 * @return The left side icon associated to the item at @p index.
26189 * The return value is a pointer to the icon associated to the item when
26190 * it was created, with function elm_segment_control_item_add(), or later
26191 * with function elm_segment_control_item_icon_set(). If no icon
26192 * was passed as argument, it will return @c NULL.
26194 * @see elm_segment_control_item_add()
26195 * @see elm_segment_control_item_icon_set()
26197 * @ingroup SegmentControl
26199 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26202 * Set the icon associated to the item.
26204 * @param it The segment control item.
26205 * @param icon The icon object to associate with @p it.
26207 * The icon object to use at left side of the item. An
26208 * icon can be any Evas object, but usually it is an icon created
26209 * with elm_icon_add().
26211 * Once the icon object is set, a previously set one will be deleted.
26212 * @warning Setting the same icon for two items will cause the icon to
26213 * dissapear from the first item.
26215 * If an icon was passed as argument on item creation, with function
26216 * elm_segment_control_item_add(), it will be already
26217 * associated to the item.
26219 * @see elm_segment_control_item_add()
26220 * @see elm_segment_control_item_icon_get()
26222 * @ingroup SegmentControl
26224 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26227 * Get the index of an item.
26229 * @param it The segment control item.
26230 * @return The position of item in segment control widget.
26232 * Index is the position of an item in segment control widget. Its
26233 * range is from @c 0 to <tt> count - 1 </tt>.
26234 * Count is the number of items, that can be get with
26235 * elm_segment_control_item_count_get().
26237 * @ingroup SegmentControl
26239 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26242 * Get the base object of the item.
26244 * @param it The segment control item.
26245 * @return The base object associated with @p it.
26247 * Base object is the @c Evas_Object that represents that item.
26249 * @ingroup SegmentControl
26251 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26254 * Get the selected item.
26256 * @param obj The segment control object.
26257 * @return The selected item or @c NULL if none of segment items is
26260 * The selected item can be unselected with function
26261 * elm_segment_control_item_selected_set().
26263 * The selected item always will be highlighted on segment control.
26265 * @ingroup SegmentControl
26267 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26270 * Set the selected state of an item.
26272 * @param it The segment control item
26273 * @param select The selected state
26275 * This sets the selected state of the given item @p it.
26276 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26278 * If a new item is selected the previosly selected will be unselected.
26279 * Previoulsy selected item can be get with function
26280 * elm_segment_control_item_selected_get().
26282 * The selected item always will be highlighted on segment control.
26284 * @see elm_segment_control_item_selected_get()
26286 * @ingroup SegmentControl
26288 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26295 * @defgroup Grid Grid
26297 * The grid is a grid layout widget that lays out a series of children as a
26298 * fixed "grid" of widgets using a given percentage of the grid width and
26299 * height each using the child object.
26301 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26302 * widgets size itself. The default is 100 x 100, so that means the
26303 * position and sizes of children will effectively be percentages (0 to 100)
26304 * of the width or height of the grid widget
26310 * Add a new grid to the parent
26312 * @param parent The parent object
26313 * @return The new object or NULL if it cannot be created
26317 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26320 * Set the virtual size of the grid
26322 * @param obj The grid object
26323 * @param w The virtual width of the grid
26324 * @param h The virtual height of the grid
26328 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26331 * Get the virtual size of the grid
26333 * @param obj The grid object
26334 * @param w Pointer to integer to store the virtual width of the grid
26335 * @param h Pointer to integer to store the virtual height of the grid
26339 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26342 * Pack child at given position and size
26344 * @param obj The grid object
26345 * @param subobj The child to pack
26346 * @param x The virtual x coord at which to pack it
26347 * @param y The virtual y coord at which to pack it
26348 * @param w The virtual width at which to pack it
26349 * @param h The virtual height at which to pack it
26353 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26356 * Unpack a child from a grid object
26358 * @param obj The grid object
26359 * @param subobj The child to unpack
26363 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26366 * Faster way to remove all child objects from a grid object.
26368 * @param obj The grid object
26369 * @param clear If true, it will delete just removed children
26373 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26376 * Set packing of an existing child at to position and size
26378 * @param subobj The child to set packing of
26379 * @param x The virtual x coord at which to pack it
26380 * @param y The virtual y coord at which to pack it
26381 * @param w The virtual width at which to pack it
26382 * @param h The virtual height at which to pack it
26386 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26389 * get packing of a child
26391 * @param subobj The child to query
26392 * @param x Pointer to integer to store the virtual x coord
26393 * @param y Pointer to integer to store the virtual y coord
26394 * @param w Pointer to integer to store the virtual width
26395 * @param h Pointer to integer to store the virtual height
26399 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26405 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26406 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26407 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26410 * @defgroup Video Video
26412 * This object display an player that let you control an Elm_Video
26413 * object. It take care of updating it's content according to what is
26414 * going on inside the Emotion object. It does activate the remember
26415 * function on the linked Elm_Video object.
26417 * Signals that you cann add callback for are :
26419 * "forward,clicked" - the user clicked the forward button.
26420 * "info,clicked" - the user clicked the info button.
26421 * "next,clicked" - the user clicked the next button.
26422 * "pause,clicked" - the user clicked the pause button.
26423 * "play,clicked" - the user clicked the play button.
26424 * "prev,clicked" - the user clicked the prev button.
26425 * "rewind,clicked" - the user clicked the rewind button.
26426 * "stop,clicked" - the user clicked the stop button.
26428 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26429 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26430 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26431 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26432 EAPI void elm_video_play(Evas_Object *video);
26433 EAPI void elm_video_pause(Evas_Object *video);
26434 EAPI void elm_video_stop(Evas_Object *video);
26435 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26436 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26437 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26438 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26439 EAPI double elm_video_audio_level_get(Evas_Object *video);
26440 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26441 EAPI double elm_video_play_position_get(Evas_Object *video);
26442 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26443 EAPI double elm_video_play_length_get(Evas_Object *video);
26444 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26445 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26446 EAPI const char *elm_video_title_get(Evas_Object *video);
26448 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26449 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26452 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26453 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);
26454 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26455 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26456 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26457 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26458 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26459 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26460 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26461 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26462 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26463 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26464 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26465 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26466 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);