3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to build it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
310 * @brief Elementary's API
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
326 /* Standard headers for standard system calls etc. */
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
347 # ifdef ELM_LIBINTL_H
348 # include <libintl.h>
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
362 # define alloca _alloca
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
390 # include <Ethumb_Client.h>
402 # ifdef ELEMENTARY_BUILD
404 # define EAPI __declspec(dllexport)
407 # endif /* ! DLL_EXPORT */
409 # define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
414 # define EAPI __attribute__ ((visibility("default")))
421 #endif /* ! _WIN32 */
426 # define EAPI_MAIN EAPI
429 /* allow usage from c++ */
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
437 typedef struct _Elm_Version
445 EAPI extern Elm_Version *elm_version;
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
452 * @defgroup General General
454 * @brief General Elementary API. Functions that don't relate to
455 * Elementary objects specifically.
457 * Here are documented functions which init/shutdown the library,
458 * that apply to generic Elementary objects, that deal with
459 * configuration, et cetera.
461 * @ref general_functions_example_page "This" example contemplates
462 * some of these functions.
466 * @addtogroup General
471 * Defines couple of standard Evas_Object layers to be used
472 * with evas_object_layer_set().
474 * @note whenever extending with new values, try to keep some padding
475 * to siblings so there is room for further extensions.
477 typedef enum _Elm_Object_Layer
479 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
487 /**************************************************************************/
488 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
491 * Emitted when any Elementary's policy value is changed.
493 EAPI extern int ELM_EVENT_POLICY_CHANGED;
496 * @typedef Elm_Event_Policy_Changed
498 * Data on the event when an Elementary policy has changed
500 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
503 * @struct _Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 struct _Elm_Event_Policy_Changed
509 unsigned int policy; /**< the policy identifier */
510 int new_value; /**< value the policy had before the change */
511 int old_value; /**< new value the policy got */
515 * Policy identifiers.
517 typedef enum _Elm_Policy
519 ELM_POLICY_QUIT, /**< under which circumstances the application
520 * should quit automatically. @see
524 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
527 typedef enum _Elm_Policy_Quit
529 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533 * window is closed */
534 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536 typedef enum _Elm_Focus_Direction
540 } Elm_Focus_Direction;
542 typedef enum _Elm_Text_Format
544 ELM_TEXT_FORMAT_PLAIN_UTF8,
545 ELM_TEXT_FORMAT_MARKUP_UTF8
549 * Line wrapping types.
551 typedef enum _Elm_Wrap_Type
553 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
562 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
563 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
564 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
565 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
566 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
567 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
568 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
569 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
570 ELM_INPUT_PANEL_LAYOUT_INVALID
571 } Elm_Input_Panel_Layout;
574 * @typedef Elm_Object_Item
575 * An Elementary Object item handle.
578 typedef struct _Elm_Object_Item Elm_Object_Item;
582 * Called back when a widget's tooltip is activated and needs content.
583 * @param data user-data given to elm_object_tooltip_content_cb_set()
584 * @param obj owner widget.
585 * @param tooltip The tooltip object (affix content to this!)
587 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
590 * Called back when a widget's item tooltip is activated and needs content.
591 * @param data user-data given to elm_object_tooltip_content_cb_set()
592 * @param obj owner widget.
593 * @param tooltip The tooltip object (affix content to this!)
594 * @param item context dependent item. As an example, if tooltip was
595 * set on Elm_List_Item, then it is of this type.
597 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
599 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
601 #ifndef ELM_LIB_QUICKLAUNCH
602 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
604 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
607 /**************************************************************************/
611 * Initialize Elementary
613 * @param[in] argc System's argument count value
614 * @param[in] argv System's pointer to array of argument strings
615 * @return The init counter value.
617 * This function initializes Elementary and increments a counter of
618 * the number of calls to it. It returns the new counter's value.
620 * @warning This call is exported only for use by the @c ELM_MAIN()
621 * macro. There is no need to use this if you use this macro (which
622 * is highly advisable). An elm_main() should contain the entry
623 * point code for your application, having the same prototype as
624 * elm_init(), and @b not being static (putting the @c EAPI symbol
625 * in front of its type declaration is advisable). The @c
626 * ELM_MAIN() call should be placed just after it.
629 * @dontinclude bg_example_01.c
633 * See the full @ref bg_example_01_c "example".
635 * @see elm_shutdown().
638 EAPI int elm_init(int argc, char **argv);
641 * Shut down Elementary
643 * @return The init counter value.
645 * This should be called at the end of your application, just
646 * before it ceases to do any more processing. This will clean up
647 * any permanent resources your application may have allocated via
648 * Elementary that would otherwise persist.
650 * @see elm_init() for an example
654 EAPI int elm_shutdown(void);
657 * Run Elementary's main loop
659 * This call should be issued just after all initialization is
660 * completed. This function will not return until elm_exit() is
661 * called. It will keep looping, running the main
662 * (event/processing) loop for Elementary.
664 * @see elm_init() for an example
668 EAPI void elm_run(void);
671 * Exit Elementary's main loop
673 * If this call is issued, it will flag the main loop to cease
674 * processing and return back to its parent function (usually your
675 * elm_main() function).
677 * @see elm_init() for an example. There, just after a request to
678 * close the window comes, the main loop will be left.
680 * @note By using the #ELM_POLICY_QUIT on your Elementary
681 * applications, you'll this function called automatically for you.
685 EAPI void elm_exit(void);
688 * Provide information in order to make Elementary determine the @b
689 * run time location of the software in question, so other data files
690 * such as images, sound files, executable utilities, libraries,
691 * modules and locale files can be found.
693 * @param mainfunc This is your application's main function name,
694 * whose binary's location is to be found. Providing @c NULL
695 * will make Elementary not to use it
696 * @param dom This will be used as the application's "domain", in the
697 * form of a prefix to any environment variables that may
698 * override prefix detection and the directory name, inside the
699 * standard share or data directories, where the software's
700 * data files will be looked for.
701 * @param checkfile This is an (optional) magic file's path to check
702 * for existence (and it must be located in the data directory,
703 * under the share directory provided above). Its presence will
704 * help determine the prefix found was correct. Pass @c NULL if
705 * the check is not to be done.
707 * This function allows one to re-locate the application somewhere
708 * else after compilation, if the developer wishes for easier
709 * distribution of pre-compiled binaries.
711 * The prefix system is designed to locate where the given software is
712 * installed (under a common path prefix) at run time and then report
713 * specific locations of this prefix and common directories inside
714 * this prefix like the binary, library, data and locale directories,
715 * through the @c elm_app_*_get() family of functions.
717 * Call elm_app_info_set() early on before you change working
718 * directory or anything about @c argv[0], so it gets accurate
721 * It will then try and trace back which file @p mainfunc comes from,
722 * if provided, to determine the application's prefix directory.
724 * The @p dom parameter provides a string prefix to prepend before
725 * environment variables, allowing a fallback to @b specific
726 * environment variables to locate the software. You would most
727 * probably provide a lowercase string there, because it will also
728 * serve as directory domain, explained next. For environment
729 * variables purposes, this string is made uppercase. For example if
730 * @c "myapp" is provided as the prefix, then the program would expect
731 * @c "MYAPP_PREFIX" as a master environment variable to specify the
732 * exact install prefix for the software, or more specific environment
733 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
734 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
735 * the user or scripts before launching. If not provided (@c NULL),
736 * environment variables will not be used to override compiled-in
737 * defaults or auto detections.
739 * The @p dom string also provides a subdirectory inside the system
740 * shared data directory for data files. For example, if the system
741 * directory is @c /usr/local/share, then this directory name is
742 * appended, creating @c /usr/local/share/myapp, if it @p was @c
743 * "myapp". It is expected the application installs data files in
746 * The @p checkfile is a file name or path of something inside the
747 * share or data directory to be used to test that the prefix
748 * detection worked. For example, your app will install a wallpaper
749 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
750 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
753 * @see elm_app_compile_bin_dir_set()
754 * @see elm_app_compile_lib_dir_set()
755 * @see elm_app_compile_data_dir_set()
756 * @see elm_app_compile_locale_set()
757 * @see elm_app_prefix_dir_get()
758 * @see elm_app_bin_dir_get()
759 * @see elm_app_lib_dir_get()
760 * @see elm_app_data_dir_get()
761 * @see elm_app_locale_dir_get()
763 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
766 * Provide information on the @b fallback application's binaries
767 * directory, on scenarios where they get overriden by
768 * elm_app_info_set().
770 * @param dir The path to the default binaries directory (compile time
773 * @note Elementary will as well use this path to determine actual
774 * names of binaries' directory paths, maybe changing it to be @c
775 * something/local/bin instead of @c something/bin, only, for
778 * @warning You should call this function @b before
779 * elm_app_info_set().
781 EAPI void elm_app_compile_bin_dir_set(const char *dir);
784 * Provide information on the @b fallback application's libraries
785 * directory, on scenarios where they get overriden by
786 * elm_app_info_set().
788 * @param dir The path to the default libraries directory (compile
791 * @note Elementary will as well use this path to determine actual
792 * names of libraries' directory paths, maybe changing it to be @c
793 * something/lib32 or @c something/lib64 instead of @c something/lib,
796 * @warning You should call this function @b before
797 * elm_app_info_set().
799 EAPI void elm_app_compile_lib_dir_set(const char *dir);
802 * Provide information on the @b fallback application's data
803 * directory, on scenarios where they get overriden by
804 * elm_app_info_set().
806 * @param dir The path to the default data directory (compile time
809 * @note Elementary will as well use this path to determine actual
810 * names of data directory paths, maybe changing it to be @c
811 * something/local/share instead of @c something/share, only, for
814 * @warning You should call this function @b before
815 * elm_app_info_set().
817 EAPI void elm_app_compile_data_dir_set(const char *dir);
820 * Provide information on the @b fallback application's locale
821 * directory, on scenarios where they get overriden by
822 * elm_app_info_set().
824 * @param dir The path to the default locale directory (compile time
827 * @warning You should call this function @b before
828 * elm_app_info_set().
830 EAPI void elm_app_compile_locale_set(const char *dir);
833 * Retrieve the application's run time prefix directory, as set by
834 * elm_app_info_set() and the way (environment) the application was
837 * @return The directory prefix the application is actually using
839 EAPI const char *elm_app_prefix_dir_get(void);
842 * Retrieve the application's run time binaries prefix directory, as
843 * set by elm_app_info_set() and the way (environment) the application
846 * @return The binaries directory prefix the application is actually
849 EAPI const char *elm_app_bin_dir_get(void);
852 * Retrieve the application's run time libraries prefix directory, as
853 * set by elm_app_info_set() and the way (environment) the application
856 * @return The libraries directory prefix the application is actually
859 EAPI const char *elm_app_lib_dir_get(void);
862 * Retrieve the application's run time data prefix directory, as
863 * set by elm_app_info_set() and the way (environment) the application
866 * @return The data directory prefix the application is actually
869 EAPI const char *elm_app_data_dir_get(void);
872 * Retrieve the application's run time locale prefix directory, as
873 * set by elm_app_info_set() and the way (environment) the application
876 * @return The locale directory prefix the application is actually
879 EAPI const char *elm_app_locale_dir_get(void);
881 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
882 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
883 EAPI int elm_quicklaunch_init(int argc, char **argv);
884 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
885 EAPI int elm_quicklaunch_sub_shutdown(void);
886 EAPI int elm_quicklaunch_shutdown(void);
887 EAPI void elm_quicklaunch_seed(void);
888 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
889 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
890 EAPI void elm_quicklaunch_cleanup(void);
891 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
892 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
894 EAPI Eina_Bool elm_need_efreet(void);
895 EAPI Eina_Bool elm_need_e_dbus(void);
898 * This must be called before any other function that handle with
899 * elm_thumb objects or ethumb_client instances.
903 EAPI Eina_Bool elm_need_ethumb(void);
906 * Set a new policy's value (for a given policy group/identifier).
908 * @param policy policy identifier, as in @ref Elm_Policy.
909 * @param value policy value, which depends on the identifier
911 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
913 * Elementary policies define applications' behavior,
914 * somehow. These behaviors are divided in policy groups (see
915 * #Elm_Policy enumeration). This call will emit the Ecore event
916 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
917 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
920 * @note Currently, we have only one policy identifier/group
921 * (#ELM_POLICY_QUIT), which has two possible values.
925 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
928 * Gets the policy value set for given policy identifier.
930 * @param policy policy identifier, as in #Elm_Policy.
931 * @return The currently set policy value, for that
932 * identifier. Will be @c 0 if @p policy passed is invalid.
936 EAPI int elm_policy_get(unsigned int policy);
939 * Set a label of an object
941 * @param obj The Elementary object
942 * @param part The text part name to set (NULL for the default label)
943 * @param label The new text of the label
945 * @note Elementary objects may have many labels (e.g. Action Slider)
949 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
951 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
954 * Get a label of an object
956 * @param obj The Elementary object
957 * @param part The text part name to get (NULL for the default label)
958 * @return text of the label or NULL for any error
960 * @note Elementary objects may have many labels (e.g. Action Slider)
964 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
966 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
969 * Set a content of an object
971 * @param obj The Elementary object
972 * @param part The content part name to set (NULL for the default content)
973 * @param content The new content of the object
975 * @note Elementary objects may have many contents
979 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
981 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
984 * Get a content of an object
986 * @param obj The Elementary object
987 * @param item The content part name to get (NULL for the default content)
988 * @return content of the object or NULL for any error
990 * @note Elementary objects may have many contents
994 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
996 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
999 * Unset a content of an object
1001 * @param obj The Elementary object
1002 * @param item The content part name to unset (NULL for the default content)
1004 * @note Elementary objects may have many contents
1008 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1010 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1013 * Set a content of an object item
1015 * @param it The Elementary object item
1016 * @param part The content part name to set (NULL for the default content)
1017 * @param content The new content of the object item
1019 * @note Elementary object items may have many contents
1023 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1025 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1028 * Get a content of an object item
1030 * @param it The Elementary object item
1031 * @param part The content part name to unset (NULL for the default content)
1032 * @return content of the object item or NULL for any error
1034 * @note Elementary object items may have many contents
1038 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1040 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1043 * Unset a content of an object item
1045 * @param it The Elementary object item
1046 * @param part The content part name to unset (NULL for the default content)
1048 * @note Elementary object items may have many contents
1052 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1054 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1057 * Set a label of an objec itemt
1059 * @param it The Elementary object item
1060 * @param part The text part name to set (NULL for the default label)
1061 * @param label The new text of the label
1063 * @note Elementary object items may have many labels
1067 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1069 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1072 * Get a label of an object
1074 * @param it The Elementary object item
1075 * @param part The text part name to get (NULL for the default label)
1076 * @return text of the label or NULL for any error
1078 * @note Elementary object items may have many labels
1082 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1085 * Set the text to read out when in accessibility mode
1087 * @param obj The object which is to be described
1088 * @param txt The text that describes the widget to people with poor or no vision
1092 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1095 * Set the text to read out when in accessibility mode
1097 * @param it The object item which is to be described
1098 * @param txt The text that describes the widget to people with poor or no vision
1102 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1105 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1108 * Get the data associated with an object item
1109 * @param it The object item
1110 * @return The data associated with @p it
1114 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1117 * Set the data associated with an object item
1118 * @param it The object item
1119 * @param data The data to be associated with @p it
1123 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1130 * @defgroup Caches Caches
1132 * These are functions which let one fine-tune some cache values for
1133 * Elementary applications, thus allowing for performance adjustments.
1139 * @brief Flush all caches.
1141 * Frees all data that was in cache and is not currently being used to reduce
1142 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1143 * to calling all of the following functions:
1144 * @li edje_file_cache_flush()
1145 * @li edje_collection_cache_flush()
1146 * @li eet_clearcache()
1147 * @li evas_image_cache_flush()
1148 * @li evas_font_cache_flush()
1149 * @li evas_render_dump()
1150 * @note Evas caches are flushed for every canvas associated with a window.
1154 EAPI void elm_all_flush(void);
1157 * Get the configured cache flush interval time
1159 * This gets the globally configured cache flush interval time, in
1162 * @return The cache flush interval time
1165 * @see elm_all_flush()
1167 EAPI int elm_cache_flush_interval_get(void);
1170 * Set the configured cache flush interval time
1172 * This sets the globally configured cache flush interval time, in ticks
1174 * @param size The cache flush interval time
1177 * @see elm_all_flush()
1179 EAPI void elm_cache_flush_interval_set(int size);
1182 * Set the configured cache flush interval time for all applications on the
1185 * This sets the globally configured cache flush interval time -- in ticks
1186 * -- for all applications on the display.
1188 * @param size The cache flush interval time
1191 EAPI void elm_cache_flush_interval_all_set(int size);
1194 * Get the configured cache flush enabled state
1196 * This gets the globally configured cache flush state - if it is enabled
1197 * or not. When cache flushing is enabled, elementary will regularly
1198 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1199 * memory and allow usage to re-seed caches and data in memory where it
1200 * can do so. An idle application will thus minimise its memory usage as
1201 * data will be freed from memory and not be re-loaded as it is idle and
1202 * not rendering or doing anything graphically right now.
1204 * @return The cache flush state
1207 * @see elm_all_flush()
1209 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1212 * Set the configured cache flush enabled state
1214 * This sets the globally configured cache flush enabled state
1216 * @param size The cache flush enabled state
1219 * @see elm_all_flush()
1221 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1224 * Set the configured cache flush enabled state for all applications on the
1227 * This sets the globally configured cache flush enabled state for all
1228 * applications on the display.
1230 * @param size The cache flush enabled state
1233 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1236 * Get the configured font cache size
1238 * This gets the globally configured font cache size, in bytes
1240 * @return The font cache size
1243 EAPI int elm_font_cache_get(void);
1246 * Set the configured font cache size
1248 * This sets the globally configured font cache size, in bytes
1250 * @param size The font cache size
1253 EAPI void elm_font_cache_set(int size);
1256 * Set the configured font cache size for all applications on the
1259 * This sets the globally configured font cache size -- in bytes
1260 * -- for all applications on the display.
1262 * @param size The font cache size
1265 EAPI void elm_font_cache_all_set(int size);
1268 * Get the configured image cache size
1270 * This gets the globally configured image cache size, in bytes
1272 * @return The image cache size
1275 EAPI int elm_image_cache_get(void);
1278 * Set the configured image cache size
1280 * This sets the globally configured image cache size, in bytes
1282 * @param size The image cache size
1285 EAPI void elm_image_cache_set(int size);
1288 * Set the configured image cache size for all applications on the
1291 * This sets the globally configured image cache size -- in bytes
1292 * -- for all applications on the display.
1294 * @param size The image cache size
1297 EAPI void elm_image_cache_all_set(int size);
1300 * Get the configured edje file cache size.
1302 * This gets the globally configured edje file cache size, in number
1305 * @return The edje file cache size
1308 EAPI int elm_edje_file_cache_get(void);
1311 * Set the configured edje file cache size
1313 * This sets the globally configured edje file cache size, in number
1316 * @param size The edje file cache size
1319 EAPI void elm_edje_file_cache_set(int size);
1322 * Set the configured edje file cache size for all applications on the
1325 * This sets the globally configured edje file cache size -- in number
1326 * of files -- for all applications on the display.
1328 * @param size The edje file cache size
1331 EAPI void elm_edje_file_cache_all_set(int size);
1334 * Get the configured edje collections (groups) cache size.
1336 * This gets the globally configured edje collections cache size, in
1337 * number of collections.
1339 * @return The edje collections cache size
1342 EAPI int elm_edje_collection_cache_get(void);
1345 * Set the configured edje collections (groups) cache size
1347 * This sets the globally configured edje collections cache size, in
1348 * number of collections.
1350 * @param size The edje collections cache size
1353 EAPI void elm_edje_collection_cache_set(int size);
1356 * Set the configured edje collections (groups) cache size for all
1357 * applications on the display
1359 * This sets the globally configured edje collections cache size -- in
1360 * number of collections -- for all applications on the display.
1362 * @param size The edje collections cache size
1365 EAPI void elm_edje_collection_cache_all_set(int size);
1372 * @defgroup Scaling Widget Scaling
1374 * Different widgets can be scaled independently. These functions
1375 * allow you to manipulate this scaling on a per-widget basis. The
1376 * object and all its children get their scaling factors multiplied
1377 * by the scale factor set. This is multiplicative, in that if a
1378 * child also has a scale size set it is in turn multiplied by its
1379 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1380 * double size, @c 0.5 is half, etc.
1382 * @ref general_functions_example_page "This" example contemplates
1383 * some of these functions.
1387 * Get the global scaling factor
1389 * This gets the globally configured scaling factor that is applied to all
1392 * @return The scaling factor
1395 EAPI double elm_scale_get(void);
1398 * Set the global scaling factor
1400 * This sets the globally configured scaling factor that is applied to all
1403 * @param scale The scaling factor to set
1406 EAPI void elm_scale_set(double scale);
1409 * Set the global scaling factor for all applications on the display
1411 * This sets the globally configured scaling factor that is applied to all
1412 * objects for all applications.
1413 * @param scale The scaling factor to set
1416 EAPI void elm_scale_all_set(double scale);
1419 * Set the scaling factor for a given Elementary object
1421 * @param obj The Elementary to operate on
1422 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1427 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1430 * Get the scaling factor for a given Elementary object
1432 * @param obj The object
1433 * @return The scaling factor set by elm_object_scale_set()
1437 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1440 * @defgroup Password_last_show Password last input show
1442 * Last show feature of password mode enables user to view
1443 * the last input entered for few seconds before masking it.
1444 * These functions allow to set this feature in password mode
1445 * of entry widget and also allow to manipulate the duration
1446 * for which the input has to be visible.
1452 * Get show last setting of password mode.
1454 * This gets the show last input setting of password mode which might be
1455 * enabled or disabled.
1457 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1459 * @ingroup Password_last_show
1461 EAPI Eina_Bool elm_password_show_last_get(void);
1464 * Set show last setting in password mode.
1466 * This enables or disables show last setting of password mode.
1468 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1469 * @see elm_password_show_last_timeout_set()
1470 * @ingroup Password_last_show
1472 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1475 * Get's the timeout value in last show password mode.
1477 * This gets the time out value for which the last input entered in password
1478 * mode will be visible.
1480 * @return The timeout value of last show password mode.
1481 * @ingroup Password_last_show
1483 EAPI double elm_password_show_last_timeout_get(void);
1486 * Set's the timeout value in last show password mode.
1488 * This sets the time out value for which the last input entered in password
1489 * mode will be visible.
1491 * @param password_show_last_timeout The timeout value.
1492 * @see elm_password_show_last_set()
1493 * @ingroup Password_last_show
1495 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1502 * @defgroup UI-Mirroring Selective Widget mirroring
1504 * These functions allow you to set ui-mirroring on specific
1505 * widgets or the whole interface. Widgets can be in one of two
1506 * modes, automatic and manual. Automatic means they'll be changed
1507 * according to the system mirroring mode and manual means only
1508 * explicit changes will matter. You are not supposed to change
1509 * mirroring state of a widget set to automatic, will mostly work,
1510 * but the behavior is not really defined.
1515 EAPI Eina_Bool elm_mirrored_get(void);
1516 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1519 * Get the system mirrored mode. This determines the default mirrored mode
1522 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1524 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1527 * Set the system mirrored mode. This determines the default mirrored mode
1530 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1532 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1535 * Returns the widget's mirrored mode setting.
1537 * @param obj The widget.
1538 * @return mirrored mode setting of the object.
1541 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1544 * Sets the widget's mirrored mode setting.
1545 * When widget in automatic mode, it follows the system mirrored mode set by
1546 * elm_mirrored_set().
1547 * @param obj The widget.
1548 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1550 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1557 * Set the style to use by a widget
1559 * Sets the style name that will define the appearance of a widget. Styles
1560 * vary from widget to widget and may also be defined by other themes
1561 * by means of extensions and overlays.
1563 * @param obj The Elementary widget to style
1564 * @param style The style name to use
1566 * @see elm_theme_extension_add()
1567 * @see elm_theme_extension_del()
1568 * @see elm_theme_overlay_add()
1569 * @see elm_theme_overlay_del()
1573 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1575 * Get the style used by the widget
1577 * This gets the style being used for that widget. Note that the string
1578 * pointer is only valid as longas the object is valid and the style doesn't
1581 * @param obj The Elementary widget to query for its style
1582 * @return The style name used
1584 * @see elm_object_style_set()
1588 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591 * @defgroup Styles Styles
1593 * Widgets can have different styles of look. These generic API's
1594 * set styles of widgets, if they support them (and if the theme(s)
1597 * @ref general_functions_example_page "This" example contemplates
1598 * some of these functions.
1602 * Set the disabled state of an Elementary object.
1604 * @param obj The Elementary object to operate on
1605 * @param disabled The state to put in in: @c EINA_TRUE for
1606 * disabled, @c EINA_FALSE for enabled
1608 * Elementary objects can be @b disabled, in which state they won't
1609 * receive input and, in general, will be themed differently from
1610 * their normal state, usually greyed out. Useful for contexts
1611 * where you don't want your users to interact with some of the
1612 * parts of you interface.
1614 * This sets the state for the widget, either disabling it or
1619 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1622 * Get the disabled state of an Elementary object.
1624 * @param obj The Elementary object to operate on
1625 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1626 * if it's enabled (or on errors)
1628 * This gets the state of the widget, which might be enabled or disabled.
1632 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635 * @defgroup WidgetNavigation Widget Tree Navigation.
1637 * How to check if an Evas Object is an Elementary widget? How to
1638 * get the first elementary widget that is parent of the given
1639 * object? These are all covered in widget tree navigation.
1641 * @ref general_functions_example_page "This" example contemplates
1642 * some of these functions.
1646 * Check if the given Evas Object is an Elementary widget.
1648 * @param obj the object to query.
1649 * @return @c EINA_TRUE if it is an elementary widget variant,
1650 * @c EINA_FALSE otherwise
1651 * @ingroup WidgetNavigation
1653 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1656 * Get the first parent of the given object that is an Elementary
1659 * @param obj the Elementary object to query parent from.
1660 * @return the parent object that is an Elementary widget, or @c
1661 * NULL, if it was not found.
1663 * Use this to query for an object's parent widget.
1665 * @note Most of Elementary users wouldn't be mixing non-Elementary
1666 * smart objects in the objects tree of an application, as this is
1667 * an advanced usage of Elementary with Evas. So, except for the
1668 * application's window, which is the root of that tree, all other
1669 * objects would have valid Elementary widget parents.
1671 * @ingroup WidgetNavigation
1673 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1676 * Get the top level parent of an Elementary widget.
1678 * @param obj The object to query.
1679 * @return The top level Elementary widget, or @c NULL if parent cannot be
1681 * @ingroup WidgetNavigation
1683 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1686 * Get the string that represents this Elementary widget.
1688 * @note Elementary is weird and exposes itself as a single
1689 * Evas_Object_Smart_Class of type "elm_widget", so
1690 * evas_object_type_get() always return that, making debug and
1691 * language bindings hard. This function tries to mitigate this
1692 * problem, but the solution is to change Elementary to use
1693 * proper inheritance.
1695 * @param obj the object to query.
1696 * @return Elementary widget name, or @c NULL if not a valid widget.
1697 * @ingroup WidgetNavigation
1699 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1702 * @defgroup Config Elementary Config
1704 * Elementary configuration is formed by a set options bounded to a
1705 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1706 * "finger size", etc. These are functions with which one syncronizes
1707 * changes made to those values to the configuration storing files, de
1708 * facto. You most probably don't want to use the functions in this
1709 * group unlees you're writing an elementary configuration manager.
1715 * Save back Elementary's configuration, so that it will persist on
1718 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1721 * This function will take effect -- thus, do I/O -- immediately. Use
1722 * it when you want to apply all configuration changes at once. The
1723 * current configuration set will get saved onto the current profile
1724 * configuration file.
1727 EAPI Eina_Bool elm_config_save(void);
1730 * Reload Elementary's configuration, bounded to current selected
1733 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1736 * Useful when you want to force reloading of configuration values for
1737 * a profile. If one removes user custom configuration directories,
1738 * for example, it will force a reload with system values insted.
1741 EAPI void elm_config_reload(void);
1748 * @defgroup Profile Elementary Profile
1750 * Profiles are pre-set options that affect the whole look-and-feel of
1751 * Elementary-based applications. There are, for example, profiles
1752 * aimed at desktop computer applications and others aimed at mobile,
1753 * touchscreen-based ones. You most probably don't want to use the
1754 * functions in this group unlees you're writing an elementary
1755 * configuration manager.
1761 * Get Elementary's profile in use.
1763 * This gets the global profile that is applied to all Elementary
1766 * @return The profile's name
1769 EAPI const char *elm_profile_current_get(void);
1772 * Get an Elementary's profile directory path in the filesystem. One
1773 * may want to fetch a system profile's dir or an user one (fetched
1776 * @param profile The profile's name
1777 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1778 * or a system one (@c EINA_FALSE)
1779 * @return The profile's directory path.
1782 * @note You must free it with elm_profile_dir_free().
1784 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1787 * Free an Elementary's profile directory path, as returned by
1788 * elm_profile_dir_get().
1790 * @param p_dir The profile's path
1794 EAPI void elm_profile_dir_free(const char *p_dir);
1797 * Get Elementary's list of available profiles.
1799 * @return The profiles list. List node data are the profile name
1803 * @note One must free this list, after usage, with the function
1804 * elm_profile_list_free().
1806 EAPI Eina_List *elm_profile_list_get(void);
1809 * Free Elementary's list of available profiles.
1811 * @param l The profiles list, as returned by elm_profile_list_get().
1815 EAPI void elm_profile_list_free(Eina_List *l);
1818 * Set Elementary's profile.
1820 * This sets the global profile that is applied to Elementary
1821 * applications. Just the process the call comes from will be
1824 * @param profile The profile's name
1828 EAPI void elm_profile_set(const char *profile);
1831 * Set Elementary's profile.
1833 * This sets the global profile that is applied to all Elementary
1834 * applications. All running Elementary windows will be affected.
1836 * @param profile The profile's name
1840 EAPI void elm_profile_all_set(const char *profile);
1847 * @defgroup Engine Elementary Engine
1849 * These are functions setting and querying which rendering engine
1850 * Elementary will use for drawing its windows' pixels.
1852 * The following are the available engines:
1853 * @li "software_x11"
1856 * @li "software_16_x11"
1857 * @li "software_8_x11"
1860 * @li "software_gdi"
1861 * @li "software_16_wince_gdi"
1863 * @li "software_16_sdl"
1871 * @brief Get Elementary's rendering engine in use.
1873 * @return The rendering engine's name
1874 * @note there's no need to free the returned string, here.
1876 * This gets the global rendering engine that is applied to all Elementary
1879 * @see elm_engine_set()
1881 EAPI const char *elm_engine_current_get(void);
1884 * @brief Set Elementary's rendering engine for use.
1886 * @param engine The rendering engine's name
1888 * This sets global rendering engine that is applied to all Elementary
1889 * applications. Note that it will take effect only to Elementary windows
1890 * created after this is called.
1892 * @see elm_win_add()
1894 EAPI void elm_engine_set(const char *engine);
1901 * @defgroup Fonts Elementary Fonts
1903 * These are functions dealing with font rendering, selection and the
1904 * like for Elementary applications. One might fetch which system
1905 * fonts are there to use and set custom fonts for individual classes
1906 * of UI items containing text (text classes).
1911 typedef struct _Elm_Text_Class
1917 typedef struct _Elm_Font_Overlay
1919 const char *text_class;
1921 Evas_Font_Size size;
1924 typedef struct _Elm_Font_Properties
1928 } Elm_Font_Properties;
1931 * Get Elementary's list of supported text classes.
1933 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1936 * Release the list with elm_text_classes_list_free().
1938 EAPI const Eina_List *elm_text_classes_list_get(void);
1941 * Free Elementary's list of supported text classes.
1945 * @see elm_text_classes_list_get().
1947 EAPI void elm_text_classes_list_free(const Eina_List *list);
1950 * Get Elementary's list of font overlays, set with
1951 * elm_font_overlay_set().
1953 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1958 * For each text class, one can set a <b>font overlay</b> for it,
1959 * overriding the default font properties for that class coming from
1960 * the theme in use. There is no need to free this list.
1962 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1964 EAPI const Eina_List *elm_font_overlay_list_get(void);
1967 * Set a font overlay for a given Elementary text class.
1969 * @param text_class Text class name
1970 * @param font Font name and style string
1971 * @param size Font size
1975 * @p font has to be in the format returned by
1976 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1977 * and elm_font_overlay_unset().
1979 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1982 * Unset a font overlay for a given Elementary text class.
1984 * @param text_class Text class name
1988 * This will bring back text elements belonging to text class
1989 * @p text_class back to their default font settings.
1991 EAPI void elm_font_overlay_unset(const char *text_class);
1994 * Apply the changes made with elm_font_overlay_set() and
1995 * elm_font_overlay_unset() on the current Elementary window.
1999 * This applies all font overlays set to all objects in the UI.
2001 EAPI void elm_font_overlay_apply(void);
2004 * Apply the changes made with elm_font_overlay_set() and
2005 * elm_font_overlay_unset() on all Elementary application windows.
2009 * This applies all font overlays set to all objects in the UI.
2011 EAPI void elm_font_overlay_all_apply(void);
2014 * Translate a font (family) name string in fontconfig's font names
2015 * syntax into an @c Elm_Font_Properties struct.
2017 * @param font The font name and styles string
2018 * @return the font properties struct
2022 * @note The reverse translation can be achived with
2023 * elm_font_fontconfig_name_get(), for one style only (single font
2024 * instance, not family).
2026 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2029 * Free font properties return by elm_font_properties_get().
2031 * @param efp the font properties struct
2035 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2038 * Translate a font name, bound to a style, into fontconfig's font names
2041 * @param name The font (family) name
2042 * @param style The given style (may be @c NULL)
2044 * @return the font name and style string
2048 * @note The reverse translation can be achived with
2049 * elm_font_properties_get(), for one style only (single font
2050 * instance, not family).
2052 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2055 * Free the font string return by elm_font_fontconfig_name_get().
2057 * @param efp the font properties struct
2061 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2064 * Create a font hash table of available system fonts.
2066 * One must call it with @p list being the return value of
2067 * evas_font_available_list(). The hash will be indexed by font
2068 * (family) names, being its values @c Elm_Font_Properties blobs.
2070 * @param list The list of available system fonts, as returned by
2071 * evas_font_available_list().
2072 * @return the font hash.
2076 * @note The user is supposed to get it populated at least with 3
2077 * default font families (Sans, Serif, Monospace), which should be
2078 * present on most systems.
2080 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2083 * Free the hash return by elm_font_available_hash_add().
2085 * @param hash the hash to be freed.
2089 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2096 * @defgroup Fingers Fingers
2098 * Elementary is designed to be finger-friendly for touchscreens,
2099 * and so in addition to scaling for display resolution, it can
2100 * also scale based on finger "resolution" (or size). You can then
2101 * customize the granularity of the areas meant to receive clicks
2104 * Different profiles may have pre-set values for finger sizes.
2106 * @ref general_functions_example_page "This" example contemplates
2107 * some of these functions.
2113 * Get the configured "finger size"
2115 * @return The finger size
2117 * This gets the globally configured finger size, <b>in pixels</b>
2121 EAPI Evas_Coord elm_finger_size_get(void);
2124 * Set the configured finger size
2126 * This sets the globally configured finger size in pixels
2128 * @param size The finger size
2131 EAPI void elm_finger_size_set(Evas_Coord size);
2134 * Set the configured finger size for all applications on the display
2136 * This sets the globally configured finger size in pixels for all
2137 * applications on the display
2139 * @param size The finger size
2142 EAPI void elm_finger_size_all_set(Evas_Coord size);
2149 * @defgroup Focus Focus
2151 * An Elementary application has, at all times, one (and only one)
2152 * @b focused object. This is what determines where the input
2153 * events go to within the application's window. Also, focused
2154 * objects can be decorated differently, in order to signal to the
2155 * user where the input is, at a given moment.
2157 * Elementary applications also have the concept of <b>focus
2158 * chain</b>: one can cycle through all the windows' focusable
2159 * objects by input (tab key) or programmatically. The default
2160 * focus chain for an application is the one define by the order in
2161 * which the widgets where added in code. One will cycle through
2162 * top level widgets, and, for each one containg sub-objects, cycle
2163 * through them all, before returning to the level
2164 * above. Elementary also allows one to set @b custom focus chains
2165 * for their applications.
2167 * Besides the focused decoration a widget may exhibit, when it
2168 * gets focus, Elementary has a @b global focus highlight object
2169 * that can be enabled for a window. If one chooses to do so, this
2170 * extra highlight effect will surround the current focused object,
2173 * @note Some Elementary widgets are @b unfocusable, after
2174 * creation, by their very nature: they are not meant to be
2175 * interacted with input events, but are there just for visual
2178 * @ref general_functions_example_page "This" example contemplates
2179 * some of these functions.
2183 * Get the enable status of the focus highlight
2185 * This gets whether the highlight on focused objects is enabled or not
2188 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2191 * Set the enable status of the focus highlight
2193 * Set whether to show or not the highlight on focused objects
2194 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2197 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2200 * Get the enable status of the highlight animation
2202 * Get whether the focus highlight, if enabled, will animate its switch from
2203 * one object to the next
2206 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2209 * Set the enable status of the highlight animation
2211 * Set whether the focus highlight, if enabled, will animate its switch from
2212 * one object to the next
2213 * @param animate Enable animation if EINA_TRUE, disable otherwise
2216 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2219 * Get the whether an Elementary object has the focus or not.
2221 * @param obj The Elementary object to get the information from
2222 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2223 * not (and on errors).
2225 * @see elm_object_focus_set()
2229 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2232 * Set/unset focus to a given Elementary object.
2234 * @param obj The Elementary object to operate on.
2235 * @param enable @c EINA_TRUE Set focus to a given object,
2236 * @c EINA_FALSE Unset focus to a given object.
2238 * @note When you set focus to this object, if it can handle focus, will
2239 * take the focus away from the one who had it previously and will, for
2240 * now on, be the one receiving input events. Unsetting focus will remove
2241 * the focus from @p obj, passing it back to the previous element in the
2244 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2248 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2251 * Make a given Elementary object the focused one.
2253 * @param obj The Elementary object to make focused.
2255 * @note This object, if it can handle focus, will take the focus
2256 * away from the one who had it previously and will, for now on, be
2257 * the one receiving input events.
2259 * @see elm_object_focus_get()
2260 * @deprecated use elm_object_focus_set() instead.
2264 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2267 * Remove the focus from an Elementary object
2269 * @param obj The Elementary to take focus from
2271 * This removes the focus from @p obj, passing it back to the
2272 * previous element in the focus chain list.
2274 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2275 * @deprecated use elm_object_focus_set() instead.
2279 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2282 * Set the ability for an Element object to be focused
2284 * @param obj The Elementary object to operate on
2285 * @param enable @c EINA_TRUE if the object can be focused, @c
2286 * EINA_FALSE if not (and on errors)
2288 * This sets whether the object @p obj is able to take focus or
2289 * not. Unfocusable objects do nothing when programmatically
2290 * focused, being the nearest focusable parent object the one
2291 * really getting focus. Also, when they receive mouse input, they
2292 * will get the event, but not take away the focus from where it
2297 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2300 * Get whether an Elementary object is focusable or not
2302 * @param obj The Elementary object to operate on
2303 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2304 * EINA_FALSE if not (and on errors)
2306 * @note Objects which are meant to be interacted with by input
2307 * events are created able to be focused, by default. All the
2312 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2315 * Set custom focus chain.
2317 * This function overwrites any previous custom focus chain within
2318 * the list of objects. The previous list will be deleted and this list
2319 * will be managed by elementary. After it is set, don't modify it.
2321 * @note On focus cycle, only will be evaluated children of this container.
2323 * @param obj The container object
2324 * @param objs Chain of objects to pass focus
2327 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2330 * Unset a custom focus chain on a given Elementary widget
2332 * @param obj The container object to remove focus chain from
2334 * Any focus chain previously set on @p obj (for its child objects)
2335 * is removed entirely after this call.
2339 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2342 * Get custom focus chain
2344 * @param obj The container object
2347 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2350 * Append object to custom focus chain.
2352 * @note If relative_child equal to NULL or not in custom chain, the object
2353 * will be added in end.
2355 * @note On focus cycle, only will be evaluated children of this container.
2357 * @param obj The container object
2358 * @param child The child to be added in custom chain
2359 * @param relative_child The relative object to position the child
2362 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2365 * Prepend object to custom focus chain.
2367 * @note If relative_child equal to NULL or not in custom chain, the object
2368 * will be added in begin.
2370 * @note On focus cycle, only will be evaluated children of this container.
2372 * @param obj The container object
2373 * @param child The child to be added in custom chain
2374 * @param relative_child The relative object to position the child
2377 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2380 * Give focus to next object in object tree.
2382 * Give focus to next object in focus chain of one object sub-tree.
2383 * If the last object of chain already have focus, the focus will go to the
2384 * first object of chain.
2386 * @param obj The object root of sub-tree
2387 * @param dir Direction to cycle the focus
2391 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2394 * Give focus to near object in one direction.
2396 * Give focus to near object in direction of one object.
2397 * If none focusable object in given direction, the focus will not change.
2399 * @param obj The reference object
2400 * @param x Horizontal component of direction to focus
2401 * @param y Vertical component of direction to focus
2405 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2408 * Make the elementary object and its children to be unfocusable
2411 * @param obj The Elementary object to operate on
2412 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2413 * @c EINA_FALSE for focusable.
2415 * This sets whether the object @p obj and its children objects
2416 * are able to take focus or not. If the tree is set as unfocusable,
2417 * newest focused object which is not in this tree will get focus.
2418 * This API can be helpful for an object to be deleted.
2419 * When an object will be deleted soon, it and its children may not
2420 * want to get focus (by focus reverting or by other focus controls).
2421 * Then, just use this API before deleting.
2423 * @see elm_object_tree_unfocusable_get()
2427 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2430 * Get whether an Elementary object and its children are unfocusable or not.
2432 * @param obj The Elementary object to get the information from
2433 * @return @c EINA_TRUE, if the tree is unfocussable,
2434 * @c EINA_FALSE if not (and on errors).
2436 * @see elm_object_tree_unfocusable_set()
2440 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2443 * @defgroup Scrolling Scrolling
2445 * These are functions setting how scrollable views in Elementary
2446 * widgets should behave on user interaction.
2452 * Get whether scrollers should bounce when they reach their
2453 * viewport's edge during a scroll.
2455 * @return the thumb scroll bouncing state
2457 * This is the default behavior for touch screens, in general.
2458 * @ingroup Scrolling
2460 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2463 * Set whether scrollers should bounce when they reach their
2464 * viewport's edge during a scroll.
2466 * @param enabled the thumb scroll bouncing state
2468 * @see elm_thumbscroll_bounce_enabled_get()
2469 * @ingroup Scrolling
2471 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2474 * Set whether scrollers should bounce when they reach their
2475 * viewport's edge during a scroll, for all Elementary application
2478 * @param enabled the thumb scroll bouncing state
2480 * @see elm_thumbscroll_bounce_enabled_get()
2481 * @ingroup Scrolling
2483 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2486 * Get the amount of inertia a scroller will impose at bounce
2489 * @return the thumb scroll bounce friction
2491 * @ingroup Scrolling
2493 EAPI double elm_scroll_bounce_friction_get(void);
2496 * Set the amount of inertia a scroller will impose at bounce
2499 * @param friction the thumb scroll bounce friction
2501 * @see elm_thumbscroll_bounce_friction_get()
2502 * @ingroup Scrolling
2504 EAPI void elm_scroll_bounce_friction_set(double friction);
2507 * Set the amount of inertia a scroller will impose at bounce
2508 * animations, for all Elementary application windows.
2510 * @param friction the thumb scroll bounce friction
2512 * @see elm_thumbscroll_bounce_friction_get()
2513 * @ingroup Scrolling
2515 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2518 * Get the amount of inertia a <b>paged</b> scroller will impose at
2519 * page fitting animations.
2521 * @return the page scroll friction
2523 * @ingroup Scrolling
2525 EAPI double elm_scroll_page_scroll_friction_get(void);
2528 * Set the amount of inertia a <b>paged</b> scroller will impose at
2529 * page fitting animations.
2531 * @param friction the page scroll friction
2533 * @see elm_thumbscroll_page_scroll_friction_get()
2534 * @ingroup Scrolling
2536 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2539 * Set the amount of inertia a <b>paged</b> scroller will impose at
2540 * page fitting animations, for all Elementary application windows.
2542 * @param friction the page scroll friction
2544 * @see elm_thumbscroll_page_scroll_friction_get()
2545 * @ingroup Scrolling
2547 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2550 * Get the amount of inertia a scroller will impose at region bring
2553 * @return the bring in scroll friction
2555 * @ingroup Scrolling
2557 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2560 * Set the amount of inertia a scroller will impose at region bring
2563 * @param friction the bring in scroll friction
2565 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2566 * @ingroup Scrolling
2568 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2571 * Set the amount of inertia a scroller will impose at region bring
2572 * animations, for all Elementary application windows.
2574 * @param friction the bring in scroll friction
2576 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2577 * @ingroup Scrolling
2579 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2582 * Get the amount of inertia scrollers will impose at animations
2583 * triggered by Elementary widgets' zooming API.
2585 * @return the zoom friction
2587 * @ingroup Scrolling
2589 EAPI double elm_scroll_zoom_friction_get(void);
2592 * Set the amount of inertia scrollers will impose at animations
2593 * triggered by Elementary widgets' zooming API.
2595 * @param friction the zoom friction
2597 * @see elm_thumbscroll_zoom_friction_get()
2598 * @ingroup Scrolling
2600 EAPI void elm_scroll_zoom_friction_set(double friction);
2603 * Set the amount of inertia scrollers will impose at animations
2604 * triggered by Elementary widgets' zooming API, for all Elementary
2605 * application windows.
2607 * @param friction the zoom friction
2609 * @see elm_thumbscroll_zoom_friction_get()
2610 * @ingroup Scrolling
2612 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2615 * Get whether scrollers should be draggable from any point in their
2618 * @return the thumb scroll state
2620 * @note This is the default behavior for touch screens, in general.
2621 * @note All other functions namespaced with "thumbscroll" will only
2622 * have effect if this mode is enabled.
2624 * @ingroup Scrolling
2626 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2629 * Set whether scrollers should be draggable from any point in their
2632 * @param enabled the thumb scroll state
2634 * @see elm_thumbscroll_enabled_get()
2635 * @ingroup Scrolling
2637 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2640 * Set whether scrollers should be draggable from any point in their
2641 * views, for all Elementary application windows.
2643 * @param enabled the thumb scroll state
2645 * @see elm_thumbscroll_enabled_get()
2646 * @ingroup Scrolling
2648 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2651 * Get the number of pixels one should travel while dragging a
2652 * scroller's view to actually trigger scrolling.
2654 * @return the thumb scroll threshould
2656 * One would use higher values for touch screens, in general, because
2657 * of their inherent imprecision.
2658 * @ingroup Scrolling
2660 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2663 * Set the number of pixels one should travel while dragging a
2664 * scroller's view to actually trigger scrolling.
2666 * @param threshold the thumb scroll threshould
2668 * @see elm_thumbscroll_threshould_get()
2669 * @ingroup Scrolling
2671 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2674 * Set the number of pixels one should travel while dragging a
2675 * scroller's view to actually trigger scrolling, for all Elementary
2676 * application windows.
2678 * @param threshold the thumb scroll threshould
2680 * @see elm_thumbscroll_threshould_get()
2681 * @ingroup Scrolling
2683 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2686 * Get the minimum speed of mouse cursor movement which will trigger
2687 * list self scrolling animation after a mouse up event
2690 * @return the thumb scroll momentum threshould
2692 * @ingroup Scrolling
2694 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2697 * Set the minimum speed of mouse cursor movement which will trigger
2698 * list self scrolling animation after a mouse up event
2701 * @param threshold the thumb scroll momentum threshould
2703 * @see elm_thumbscroll_momentum_threshould_get()
2704 * @ingroup Scrolling
2706 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2709 * Set the minimum speed of mouse cursor movement which will trigger
2710 * list self scrolling animation after a mouse up event
2711 * (pixels/second), for all Elementary application windows.
2713 * @param threshold the thumb scroll momentum threshould
2715 * @see elm_thumbscroll_momentum_threshould_get()
2716 * @ingroup Scrolling
2718 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2721 * Get the amount of inertia a scroller will impose at self scrolling
2724 * @return the thumb scroll friction
2726 * @ingroup Scrolling
2728 EAPI double elm_scroll_thumbscroll_friction_get(void);
2731 * Set the amount of inertia a scroller will impose at self scrolling
2734 * @param friction the thumb scroll friction
2736 * @see elm_thumbscroll_friction_get()
2737 * @ingroup Scrolling
2739 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2742 * Set the amount of inertia a scroller will impose at self scrolling
2743 * animations, for all Elementary application windows.
2745 * @param friction the thumb scroll friction
2747 * @see elm_thumbscroll_friction_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2753 * Get the amount of lag between your actual mouse cursor dragging
2754 * movement and a scroller's view movement itself, while pushing it
2755 * into bounce state manually.
2757 * @return the thumb scroll border friction
2759 * @ingroup Scrolling
2761 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2764 * Set the amount of lag between your actual mouse cursor dragging
2765 * movement and a scroller's view movement itself, while pushing it
2766 * into bounce state manually.
2768 * @param friction the thumb scroll border friction. @c 0.0 for
2769 * perfect synchrony between two movements, @c 1.0 for maximum
2772 * @see elm_thumbscroll_border_friction_get()
2773 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2775 * @ingroup Scrolling
2777 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2780 * Set the amount of lag between your actual mouse cursor dragging
2781 * movement and a scroller's view movement itself, while pushing it
2782 * into bounce state manually, for all Elementary application windows.
2784 * @param friction the thumb scroll border friction. @c 0.0 for
2785 * perfect synchrony between two movements, @c 1.0 for maximum
2788 * @see elm_thumbscroll_border_friction_get()
2789 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2791 * @ingroup Scrolling
2793 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2800 * @defgroup Scrollhints Scrollhints
2802 * Objects when inside a scroller can scroll, but this may not always be
2803 * desirable in certain situations. This allows an object to hint to itself
2804 * and parents to "not scroll" in one of 2 ways. If any child object of a
2805 * scroller has pushed a scroll freeze or hold then it affects all parent
2806 * scrollers until all children have released them.
2808 * 1. To hold on scrolling. This means just flicking and dragging may no
2809 * longer scroll, but pressing/dragging near an edge of the scroller will
2810 * still scroll. This is automatically used by the entry object when
2813 * 2. To totally freeze scrolling. This means it stops. until
2820 * Push the scroll hold by 1
2822 * This increments the scroll hold count by one. If it is more than 0 it will
2823 * take effect on the parents of the indicated object.
2825 * @param obj The object
2826 * @ingroup Scrollhints
2828 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2831 * Pop the scroll hold by 1
2833 * This decrements the scroll hold count by one. If it is more than 0 it will
2834 * take effect on the parents of the indicated object.
2836 * @param obj The object
2837 * @ingroup Scrollhints
2839 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2842 * Push the scroll freeze by 1
2844 * This increments the scroll freeze count by one. If it is more
2845 * than 0 it will take effect on the parents of the indicated
2848 * @param obj The object
2849 * @ingroup Scrollhints
2851 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2854 * Pop the scroll freeze by 1
2856 * This decrements the scroll freeze count by one. If it is more
2857 * than 0 it will take effect on the parents of the indicated
2860 * @param obj The object
2861 * @ingroup Scrollhints
2863 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2866 * Lock the scrolling of the given widget (and thus all parents)
2868 * This locks the given object from scrolling in the X axis (and implicitly
2869 * also locks all parent scrollers too from doing the same).
2871 * @param obj The object
2872 * @param lock The lock state (1 == locked, 0 == unlocked)
2873 * @ingroup Scrollhints
2875 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2878 * Lock the scrolling of the given widget (and thus all parents)
2880 * This locks the given object from scrolling in the Y axis (and implicitly
2881 * also locks all parent scrollers too from doing the same).
2883 * @param obj The object
2884 * @param lock The lock state (1 == locked, 0 == unlocked)
2885 * @ingroup Scrollhints
2887 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2890 * Get the scrolling lock of the given widget
2892 * This gets the lock for X axis scrolling.
2894 * @param obj The object
2895 * @ingroup Scrollhints
2897 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2900 * Get the scrolling lock of the given widget
2902 * This gets the lock for X axis scrolling.
2904 * @param obj The object
2905 * @ingroup Scrollhints
2907 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2914 * Send a signal to the widget edje object.
2916 * This function sends a signal to the edje object of the obj. An
2917 * edje program can respond to a signal by specifying matching
2918 * 'signal' and 'source' fields.
2920 * @param obj The object
2921 * @param emission The signal's name.
2922 * @param source The signal's source.
2925 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2928 * Add a callback for a signal emitted by widget edje object.
2930 * This function connects a callback function to a signal emitted by the
2931 * edje object of the obj.
2932 * Globs can occur in either the emission or source name.
2934 * @param obj The object
2935 * @param emission The signal's name.
2936 * @param source The signal's source.
2937 * @param func The callback function to be executed when the signal is
2939 * @param data A pointer to data to pass in to the callback function.
2942 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
2945 * Remove a signal-triggered callback from a widget edje object.
2947 * This function removes a callback, previoulsy attached to a
2948 * signal emitted by the edje object of the obj. The parameters
2949 * emission, source and func must match exactly those passed to a
2950 * previous call to elm_object_signal_callback_add(). The data
2951 * pointer that was passed to this call will be returned.
2953 * @param obj The object
2954 * @param emission The signal's name.
2955 * @param source The signal's source.
2956 * @param func The callback function to be executed when the signal is
2958 * @return The data pointer
2961 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
2964 * Add a callback for input events (key up, key down, mouse wheel)
2965 * on a given Elementary widget
2967 * @param obj The widget to add an event callback on
2968 * @param func The callback function to be executed when the event
2970 * @param data Data to pass in to @p func
2972 * Every widget in an Elementary interface set to receive focus,
2973 * with elm_object_focus_allow_set(), will propagate @b all of its
2974 * key up, key down and mouse wheel input events up to its parent
2975 * object, and so on. All of the focusable ones in this chain which
2976 * had an event callback set, with this call, will be able to treat
2977 * those events. There are two ways of making the propagation of
2978 * these event upwards in the tree of widgets to @b cease:
2979 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2980 * the event was @b not processed, so the propagation will go on.
2981 * - The @c event_info pointer passed to @p func will contain the
2982 * event's structure and, if you OR its @c event_flags inner
2983 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2984 * one has already handled it, thus killing the event's
2987 * @note Your event callback will be issued on those events taking
2988 * place only if no other child widget of @obj has consumed the
2991 * @note Not to be confused with @c
2992 * evas_object_event_callback_add(), which will add event callbacks
2993 * per type on general Evas objects (no event propagation
2994 * infrastructure taken in account).
2996 * @note Not to be confused with @c
2997 * elm_object_signal_callback_add(), which will add callbacks to @b
2998 * signals coming from a widget's theme, not input events.
3000 * @note Not to be confused with @c
3001 * edje_object_signal_callback_add(), which does the same as
3002 * elm_object_signal_callback_add(), but directly on an Edje
3005 * @note Not to be confused with @c
3006 * evas_object_smart_callback_add(), which adds callbacks to smart
3007 * objects' <b>smart events</b>, and not input events.
3009 * @see elm_object_event_callback_del()
3013 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3016 * Remove an event callback from a widget.
3018 * This function removes a callback, previoulsy attached to event emission
3020 * The parameters func and data must match exactly those passed to
3021 * a previous call to elm_object_event_callback_add(). The data pointer that
3022 * was passed to this call will be returned.
3024 * @param obj The object
3025 * @param func The callback function to be executed when the event is
3027 * @param data Data to pass in to the callback function.
3028 * @return The data pointer
3031 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3034 * Adjust size of an element for finger usage.
3036 * @param times_w How many fingers should fit horizontally
3037 * @param w Pointer to the width size to adjust
3038 * @param times_h How many fingers should fit vertically
3039 * @param h Pointer to the height size to adjust
3041 * This takes width and height sizes (in pixels) as input and a
3042 * size multiple (which is how many fingers you want to place
3043 * within the area, being "finger" the size set by
3044 * elm_finger_size_set()), and adjusts the size to be large enough
3045 * to accommodate the resulting size -- if it doesn't already
3046 * accommodate it. On return the @p w and @p h sizes pointed to by
3047 * these parameters will be modified, on those conditions.
3049 * @note This is kind of a low level Elementary call, most useful
3050 * on size evaluation times for widgets. An external user wouldn't
3051 * be calling, most of the time.
3055 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3058 * Get the duration for occuring long press event.
3060 * @return Timeout for long press event
3061 * @ingroup Longpress
3063 EAPI double elm_longpress_timeout_get(void);
3066 * Set the duration for occuring long press event.
3068 * @param lonpress_timeout Timeout for long press event
3069 * @ingroup Longpress
3071 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3074 * @defgroup Debug Debug
3075 * don't use it unless you are sure
3081 * Print Tree object hierarchy in stdout
3083 * @param obj The root object
3086 EAPI void elm_object_tree_dump(const Evas_Object *top);
3089 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3091 * @param obj The root object
3092 * @param file The path of output file
3095 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3102 * @defgroup Theme Theme
3104 * Elementary uses Edje to theme its widgets, naturally. But for the most
3105 * part this is hidden behind a simpler interface that lets the user set
3106 * extensions and choose the style of widgets in a much easier way.
3108 * Instead of thinking in terms of paths to Edje files and their groups
3109 * each time you want to change the appearance of a widget, Elementary
3110 * works so you can add any theme file with extensions or replace the
3111 * main theme at one point in the application, and then just set the style
3112 * of widgets with elm_object_style_set() and related functions. Elementary
3113 * will then look in its list of themes for a matching group and apply it,
3114 * and when the theme changes midway through the application, all widgets
3115 * will be updated accordingly.
3117 * There are three concepts you need to know to understand how Elementary
3118 * theming works: default theme, extensions and overlays.
3120 * Default theme, obviously enough, is the one that provides the default
3121 * look of all widgets. End users can change the theme used by Elementary
3122 * by setting the @c ELM_THEME environment variable before running an
3123 * application, or globally for all programs using the @c elementary_config
3124 * utility. Applications can change the default theme using elm_theme_set(),
3125 * but this can go against the user wishes, so it's not an adviced practice.
3127 * Ideally, applications should find everything they need in the already
3128 * provided theme, but there may be occasions when that's not enough and
3129 * custom styles are required to correctly express the idea. For this
3130 * cases, Elementary has extensions.
3132 * Extensions allow the application developer to write styles of its own
3133 * to apply to some widgets. This requires knowledge of how each widget
3134 * is themed, as extensions will always replace the entire group used by
3135 * the widget, so important signals and parts need to be there for the
3136 * object to behave properly (see documentation of Edje for details).
3137 * Once the theme for the extension is done, the application needs to add
3138 * it to the list of themes Elementary will look into, using
3139 * elm_theme_extension_add(), and set the style of the desired widgets as
3140 * he would normally with elm_object_style_set().
3142 * Overlays, on the other hand, can replace the look of all widgets by
3143 * overriding the default style. Like extensions, it's up to the application
3144 * developer to write the theme for the widgets it wants, the difference
3145 * being that when looking for the theme, Elementary will check first the
3146 * list of overlays, then the set theme and lastly the list of extensions,
3147 * so with overlays it's possible to replace the default view and every
3148 * widget will be affected. This is very much alike to setting the whole
3149 * theme for the application and will probably clash with the end user
3150 * options, not to mention the risk of ending up with not matching styles
3151 * across the program. Unless there's a very special reason to use them,
3152 * overlays should be avoided for the resons exposed before.
3154 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3155 * keeps one default internally and every function that receives one of
3156 * these can be called with NULL to refer to this default (except for
3157 * elm_theme_free()). It's possible to create a new instance of a
3158 * ::Elm_Theme to set other theme for a specific widget (and all of its
3159 * children), but this is as discouraged, if not even more so, than using
3160 * overlays. Don't use this unless you really know what you are doing.
3162 * But to be less negative about things, you can look at the following
3164 * @li @ref theme_example_01 "Using extensions"
3165 * @li @ref theme_example_02 "Using overlays"
3170 * @typedef Elm_Theme
3172 * Opaque handler for the list of themes Elementary looks for when
3173 * rendering widgets.
3175 * Stay out of this unless you really know what you are doing. For most
3176 * cases, sticking to the default is all a developer needs.
3178 typedef struct _Elm_Theme Elm_Theme;
3181 * Create a new specific theme
3183 * This creates an empty specific theme that only uses the default theme. A
3184 * specific theme has its own private set of extensions and overlays too
3185 * (which are empty by default). Specific themes do not fall back to themes
3186 * of parent objects. They are not intended for this use. Use styles, overlays
3187 * and extensions when needed, but avoid specific themes unless there is no
3188 * other way (example: you want to have a preview of a new theme you are
3189 * selecting in a "theme selector" window. The preview is inside a scroller
3190 * and should display what the theme you selected will look like, but not
3191 * actually apply it yet. The child of the scroller will have a specific
3192 * theme set to show this preview before the user decides to apply it to all
3195 EAPI Elm_Theme *elm_theme_new(void);
3197 * Free a specific theme
3199 * @param th The theme to free
3201 * This frees a theme created with elm_theme_new().
3203 EAPI void elm_theme_free(Elm_Theme *th);
3205 * Copy the theme fom the source to the destination theme
3207 * @param th The source theme to copy from
3208 * @param thdst The destination theme to copy data to
3210 * This makes a one-time static copy of all the theme config, extensions
3211 * and overlays from @p th to @p thdst. If @p th references a theme, then
3212 * @p thdst is also set to reference it, with all the theme settings,
3213 * overlays and extensions that @p th had.
3215 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3217 * Tell the source theme to reference the ref theme
3219 * @param th The theme that will do the referencing
3220 * @param thref The theme that is the reference source
3222 * This clears @p th to be empty and then sets it to refer to @p thref
3223 * so @p th acts as an override to @p thref, but where its overrides
3224 * don't apply, it will fall through to @p thref for configuration.
3226 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3228 * Return the theme referred to
3230 * @param th The theme to get the reference from
3231 * @return The referenced theme handle
3233 * This gets the theme set as the reference theme by elm_theme_ref_set().
3234 * If no theme is set as a reference, NULL is returned.
3236 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3238 * Return the default theme
3240 * @return The default theme handle
3242 * This returns the internal default theme setup handle that all widgets
3243 * use implicitly unless a specific theme is set. This is also often use
3244 * as a shorthand of NULL.
3246 EAPI Elm_Theme *elm_theme_default_get(void);
3248 * Prepends a theme overlay to the list of overlays
3250 * @param th The theme to add to, or if NULL, the default theme
3251 * @param item The Edje file path to be used
3253 * Use this if your application needs to provide some custom overlay theme
3254 * (An Edje file that replaces some default styles of widgets) where adding
3255 * new styles, or changing system theme configuration is not possible. Do
3256 * NOT use this instead of a proper system theme configuration. Use proper
3257 * configuration files, profiles, environment variables etc. to set a theme
3258 * so that the theme can be altered by simple confiugration by a user. Using
3259 * this call to achieve that effect is abusing the API and will create lots
3262 * @see elm_theme_extension_add()
3264 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3266 * Delete a theme overlay from the list of overlays
3268 * @param th The theme to delete from, or if NULL, the default theme
3269 * @param item The name of the theme overlay
3271 * @see elm_theme_overlay_add()
3273 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3275 * Appends a theme extension to the list of extensions.
3277 * @param th The theme to add to, or if NULL, the default theme
3278 * @param item The Edje file path to be used
3280 * This is intended when an application needs more styles of widgets or new
3281 * widget themes that the default does not provide (or may not provide). The
3282 * application has "extended" usage by coming up with new custom style names
3283 * for widgets for specific uses, but as these are not "standard", they are
3284 * not guaranteed to be provided by a default theme. This means the
3285 * application is required to provide these extra elements itself in specific
3286 * Edje files. This call adds one of those Edje files to the theme search
3287 * path to be search after the default theme. The use of this call is
3288 * encouraged when default styles do not meet the needs of the application.
3289 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3291 * @see elm_object_style_set()
3293 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3295 * Deletes a theme extension from the list of extensions.
3297 * @param th The theme to delete from, or if NULL, the default theme
3298 * @param item The name of the theme extension
3300 * @see elm_theme_extension_add()
3302 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3304 * Set the theme search order for the given theme
3306 * @param th The theme to set the search order, or if NULL, the default theme
3307 * @param theme Theme search string
3309 * This sets the search string for the theme in path-notation from first
3310 * theme to search, to last, delimited by the : character. Example:
3312 * "shiny:/path/to/file.edj:default"
3314 * See the ELM_THEME environment variable for more information.
3316 * @see elm_theme_get()
3317 * @see elm_theme_list_get()
3319 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3321 * Return the theme search order
3323 * @param th The theme to get the search order, or if NULL, the default theme
3324 * @return The internal search order path
3326 * This function returns a colon separated string of theme elements as
3327 * returned by elm_theme_list_get().
3329 * @see elm_theme_set()
3330 * @see elm_theme_list_get()
3332 EAPI const char *elm_theme_get(Elm_Theme *th);
3334 * Return a list of theme elements to be used in a theme.
3336 * @param th Theme to get the list of theme elements from.
3337 * @return The internal list of theme elements
3339 * This returns the internal list of theme elements (will only be valid as
3340 * long as the theme is not modified by elm_theme_set() or theme is not
3341 * freed by elm_theme_free(). This is a list of strings which must not be
3342 * altered as they are also internal. If @p th is NULL, then the default
3343 * theme element list is returned.
3345 * A theme element can consist of a full or relative path to a .edj file,
3346 * or a name, without extension, for a theme to be searched in the known
3347 * theme paths for Elemementary.
3349 * @see elm_theme_set()
3350 * @see elm_theme_get()
3352 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3354 * Return the full patrh for a theme element
3356 * @param f The theme element name
3357 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3358 * @return The full path to the file found.
3360 * This returns a string you should free with free() on success, NULL on
3361 * failure. This will search for the given theme element, and if it is a
3362 * full or relative path element or a simple searchable name. The returned
3363 * path is the full path to the file, if searched, and the file exists, or it
3364 * is simply the full path given in the element or a resolved path if
3365 * relative to home. The @p in_search_path boolean pointed to is set to
3366 * EINA_TRUE if the file was a searchable file andis in the search path,
3367 * and EINA_FALSE otherwise.
3369 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3371 * Flush the current theme.
3373 * @param th Theme to flush
3375 * This flushes caches that let elementary know where to find theme elements
3376 * in the given theme. If @p th is NULL, then the default theme is flushed.
3377 * Call this function if source theme data has changed in such a way as to
3378 * make any caches Elementary kept invalid.
3380 EAPI void elm_theme_flush(Elm_Theme *th);
3382 * This flushes all themes (default and specific ones).
3384 * This will flush all themes in the current application context, by calling
3385 * elm_theme_flush() on each of them.
3387 EAPI void elm_theme_full_flush(void);
3389 * Set the theme for all elementary using applications on the current display
3391 * @param theme The name of the theme to use. Format same as the ELM_THEME
3392 * environment variable.
3394 EAPI void elm_theme_all_set(const char *theme);
3396 * Return a list of theme elements in the theme search path
3398 * @return A list of strings that are the theme element names.
3400 * This lists all available theme files in the standard Elementary search path
3401 * for theme elements, and returns them in alphabetical order as theme
3402 * element names in a list of strings. Free this with
3403 * elm_theme_name_available_list_free() when you are done with the list.
3405 EAPI Eina_List *elm_theme_name_available_list_new(void);
3407 * Free the list returned by elm_theme_name_available_list_new()
3409 * This frees the list of themes returned by
3410 * elm_theme_name_available_list_new(). Once freed the list should no longer
3411 * be used. a new list mys be created.
3413 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3415 * Set a specific theme to be used for this object and its children
3417 * @param obj The object to set the theme on
3418 * @param th The theme to set
3420 * This sets a specific theme that will be used for the given object and any
3421 * child objects it has. If @p th is NULL then the theme to be used is
3422 * cleared and the object will inherit its theme from its parent (which
3423 * ultimately will use the default theme if no specific themes are set).
3425 * Use special themes with great care as this will annoy users and make
3426 * configuration difficult. Avoid any custom themes at all if it can be
3429 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3431 * Get the specific theme to be used
3433 * @param obj The object to get the specific theme from
3434 * @return The specifc theme set.
3436 * This will return a specific theme set, or NULL if no specific theme is
3437 * set on that object. It will not return inherited themes from parents, only
3438 * the specific theme set for that specific object. See elm_object_theme_set()
3439 * for more information.
3441 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3447 /** @defgroup Win Win
3449 * @image html img/widget/win/preview-00.png
3450 * @image latex img/widget/win/preview-00.eps
3452 * The window class of Elementary. Contains functions to manipulate
3453 * windows. The Evas engine used to render the window contents is specified
3454 * in the system or user elementary config files (whichever is found last),
3455 * and can be overridden with the ELM_ENGINE environment variable for
3456 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3457 * compilation setup and modules actually installed at runtime) are (listed
3458 * in order of best supported and most likely to be complete and work to
3461 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3462 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3464 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3466 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3468 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3470 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3471 * rendering using SDL as the buffer)
3472 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3473 * GDI with software)
3474 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3475 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3476 * grayscale using dedicated 8bit software engine in X11)
3477 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3478 * X11 using 16bit software engine)
3479 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3480 * (Windows CE rendering via GDI with 16bit software renderer)
3481 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3482 * buffer with 16bit software renderer)
3484 * All engines use a simple string to select the engine to render, EXCEPT
3485 * the "shot" engine. This actually encodes the output of the virtual
3486 * screenshot and how long to delay in the engine string. The engine string
3487 * is encoded in the following way:
3489 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3491 * Where options are separated by a ":" char if more than one option is
3492 * given, with delay, if provided being the first option and file the last
3493 * (order is important). The delay specifies how long to wait after the
3494 * window is shown before doing the virtual "in memory" rendering and then
3495 * save the output to the file specified by the file option (and then exit).
3496 * If no delay is given, the default is 0.5 seconds. If no file is given the
3497 * default output file is "out.png". Repeat option is for continous
3498 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3499 * fixed to "out001.png" Some examples of using the shot engine:
3501 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3502 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3503 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3504 * ELM_ENGINE="shot:delay=2.0" elementary_test
3505 * ELM_ENGINE="shot:" elementary_test
3507 * Signals that you can add callbacks for are:
3509 * @li "delete,request": the user requested to close the window. See
3510 * elm_win_autodel_set().
3511 * @li "focus,in": window got focus
3512 * @li "focus,out": window lost focus
3513 * @li "moved": window that holds the canvas was moved
3516 * @li @ref win_example_01
3521 * Defines the types of window that can be created
3523 * These are hints set on the window so that a running Window Manager knows
3524 * how the window should be handled and/or what kind of decorations it
3527 * Currently, only the X11 backed engines use them.
3529 typedef enum _Elm_Win_Type
3531 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3532 window. Almost every window will be created with this
3534 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3535 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3536 window holding desktop icons. */
3537 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3538 be kept on top of any other window by the Window
3540 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3542 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3543 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3545 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3546 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3547 entry in a menubar is clicked. Typically used
3548 with elm_win_override_set(). This hint exists
3549 for completion only, as the EFL way of
3550 implementing a menu would not normally use a
3551 separate window for its contents. */
3552 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3553 triggered by right-clicking an object. */
3554 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3555 explanatory text that typically appear after the
3556 mouse cursor hovers over an object for a while.
3557 Typically used with elm_win_override_set() and also
3558 not very commonly used in the EFL. */
3559 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3560 battery life or a new E-Mail received. */
3561 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3562 usually used in the EFL. */
3563 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3564 object being dragged across different windows, or even
3565 applications. Typically used with
3566 elm_win_override_set(). */
3567 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3568 buffer. No actual window is created for this
3569 type, instead the window and all of its
3570 contents will be rendered to an image buffer.
3571 This allows to have children window inside a
3572 parent one just like any other object would
3573 be, and do other things like applying @c
3574 Evas_Map effects to it. This is the only type
3575 of window that requires the @c parent
3576 parameter of elm_win_add() to be a valid @c
3581 * The differents layouts that can be requested for the virtual keyboard.
3583 * When the application window is being managed by Illume, it may request
3584 * any of the following layouts for the virtual keyboard.
3586 typedef enum _Elm_Win_Keyboard_Mode
3588 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3589 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3590 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3591 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3592 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3593 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3594 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3595 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3596 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3597 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3598 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3599 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3600 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3601 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3602 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3603 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3604 } Elm_Win_Keyboard_Mode;
3607 * Available commands that can be sent to the Illume manager.
3609 * When running under an Illume session, a window may send commands to the
3610 * Illume manager to perform different actions.
3612 typedef enum _Elm_Illume_Command
3614 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3616 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3618 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3620 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3621 } Elm_Illume_Command;
3624 * Adds a window object. If this is the first window created, pass NULL as
3627 * @param parent Parent object to add the window to, or NULL
3628 * @param name The name of the window
3629 * @param type The window type, one of #Elm_Win_Type.
3631 * The @p parent paramter can be @c NULL for every window @p type except
3632 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3633 * which the image object will be created.
3635 * @return The created object, or NULL on failure
3637 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3639 * Add @p subobj as a resize object of window @p obj.
3642 * Setting an object as a resize object of the window means that the
3643 * @p subobj child's size and position will be controlled by the window
3644 * directly. That is, the object will be resized to match the window size
3645 * and should never be moved or resized manually by the developer.
3647 * In addition, resize objects of the window control what the minimum size
3648 * of it will be, as well as whether it can or not be resized by the user.
3650 * For the end user to be able to resize a window by dragging the handles
3651 * or borders provided by the Window Manager, or using any other similar
3652 * mechanism, all of the resize objects in the window should have their
3653 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3655 * @param obj The window object
3656 * @param subobj The resize object to add
3658 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3660 * Delete @p subobj as a resize object of window @p obj.
3662 * This function removes the object @p subobj from the resize objects of
3663 * the window @p obj. It will not delete the object itself, which will be
3664 * left unmanaged and should be deleted by the developer, manually handled
3665 * or set as child of some other container.
3667 * @param obj The window object
3668 * @param subobj The resize object to add
3670 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3672 * Set the title of the window
3674 * @param obj The window object
3675 * @param title The title to set
3677 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3679 * Get the title of the window
3681 * The returned string is an internal one and should not be freed or
3682 * modified. It will also be rendered invalid if a new title is set or if
3683 * the window is destroyed.
3685 * @param obj The window object
3688 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3690 * Set the window's autodel state.
3692 * When closing the window in any way outside of the program control, like
3693 * pressing the X button in the titlebar or using a command from the
3694 * Window Manager, a "delete,request" signal is emitted to indicate that
3695 * this event occurred and the developer can take any action, which may
3696 * include, or not, destroying the window object.
3698 * When the @p autodel parameter is set, the window will be automatically
3699 * destroyed when this event occurs, after the signal is emitted.
3700 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3701 * and is up to the program to do so when it's required.
3703 * @param obj The window object
3704 * @param autodel If true, the window will automatically delete itself when
3707 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3709 * Get the window's autodel state.
3711 * @param obj The window object
3712 * @return If the window will automatically delete itself when closed
3714 * @see elm_win_autodel_set()
3716 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3718 * Activate a window object.
3720 * This function sends a request to the Window Manager to activate the
3721 * window pointed by @p obj. If honored by the WM, the window will receive
3722 * the keyboard focus.
3724 * @note This is just a request that a Window Manager may ignore, so calling
3725 * this function does not ensure in any way that the window will be the
3726 * active one after it.
3728 * @param obj The window object
3730 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3732 * Lower a window object.
3734 * Places the window pointed by @p obj at the bottom of the stack, so that
3735 * no other window is covered by it.
3737 * If elm_win_override_set() is not set, the Window Manager may ignore this
3740 * @param obj The window object
3742 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3744 * Raise a window object.
3746 * Places the window pointed by @p obj at the top of the stack, so that it's
3747 * not covered by any other window.
3749 * If elm_win_override_set() is not set, the Window Manager may ignore this
3752 * @param obj The window object
3754 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3756 * Set the borderless state of a window.
3758 * This function requests the Window Manager to not draw any decoration
3759 * around the window.
3761 * @param obj The window object
3762 * @param borderless If true, the window is borderless
3764 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3766 * Get the borderless state of a window.
3768 * @param obj The window object
3769 * @return If true, the window is borderless
3771 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3773 * Set the shaped state of a window.
3775 * Shaped windows, when supported, will render the parts of the window that
3776 * has no content, transparent.
3778 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3779 * background object or cover the entire window in any other way, or the
3780 * parts of the canvas that have no data will show framebuffer artifacts.
3782 * @param obj The window object
3783 * @param shaped If true, the window is shaped
3785 * @see elm_win_alpha_set()
3787 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3789 * Get the shaped state of a window.
3791 * @param obj The window object
3792 * @return If true, the window is shaped
3794 * @see elm_win_shaped_set()
3796 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3798 * Set the alpha channel state of a window.
3800 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3801 * possibly making parts of the window completely or partially transparent.
3802 * This is also subject to the underlying system supporting it, like for
3803 * example, running under a compositing manager. If no compositing is
3804 * available, enabling this option will instead fallback to using shaped
3805 * windows, with elm_win_shaped_set().
3807 * @param obj The window object
3808 * @param alpha If true, the window has an alpha channel
3810 * @see elm_win_alpha_set()
3812 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3814 * Get the transparency state of a window.
3816 * @param obj The window object
3817 * @return If true, the window is transparent
3819 * @see elm_win_transparent_set()
3821 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3823 * Set the transparency state of a window.
3825 * Use elm_win_alpha_set() instead.
3827 * @param obj The window object
3828 * @param transparent If true, the window is transparent
3830 * @see elm_win_alpha_set()
3832 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3834 * Get the alpha channel state of a window.
3836 * @param obj The window object
3837 * @return If true, the window has an alpha channel
3839 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3841 * Set the override state of a window.
3843 * A window with @p override set to EINA_TRUE will not be managed by the
3844 * Window Manager. This means that no decorations of any kind will be shown
3845 * for it, moving and resizing must be handled by the application, as well
3846 * as the window visibility.
3848 * This should not be used for normal windows, and even for not so normal
3849 * ones, it should only be used when there's a good reason and with a lot
3850 * of care. Mishandling override windows may result situations that
3851 * disrupt the normal workflow of the end user.
3853 * @param obj The window object
3854 * @param override If true, the window is overridden
3856 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3858 * Get the override state of a window.
3860 * @param obj The window object
3861 * @return If true, the window is overridden
3863 * @see elm_win_override_set()
3865 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3867 * Set the fullscreen state of a window.
3869 * @param obj The window object
3870 * @param fullscreen If true, the window is fullscreen
3872 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3874 * Get the fullscreen state of a window.
3876 * @param obj The window object
3877 * @return If true, the window is fullscreen
3879 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3881 * Set the maximized state of a window.
3883 * @param obj The window object
3884 * @param maximized If true, the window is maximized
3886 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3888 * Get the maximized state of a window.
3890 * @param obj The window object
3891 * @return If true, the window is maximized
3893 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895 * Set the iconified state of a window.
3897 * @param obj The window object
3898 * @param iconified If true, the window is iconified
3900 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3902 * Get the iconified state of a window.
3904 * @param obj The window object
3905 * @return If true, the window is iconified
3907 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909 * Set the layer of the window.
3911 * What this means exactly will depend on the underlying engine used.
3913 * In the case of X11 backed engines, the value in @p layer has the
3914 * following meanings:
3915 * @li < 3: The window will be placed below all others.
3916 * @li > 5: The window will be placed above all others.
3917 * @li other: The window will be placed in the default layer.
3919 * @param obj The window object
3920 * @param layer The layer of the window
3922 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3924 * Get the layer of the window.
3926 * @param obj The window object
3927 * @return The layer of the window
3929 * @see elm_win_layer_set()
3931 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3933 * Set the rotation of the window.
3935 * Most engines only work with multiples of 90.
3937 * This function is used to set the orientation of the window @p obj to
3938 * match that of the screen. The window itself will be resized to adjust
3939 * to the new geometry of its contents. If you want to keep the window size,
3940 * see elm_win_rotation_with_resize_set().
3942 * @param obj The window object
3943 * @param rotation The rotation of the window, in degrees (0-360),
3944 * counter-clockwise.
3946 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3948 * Rotates the window and resizes it.
3950 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3951 * that they fit inside the current window geometry.
3953 * @param obj The window object
3954 * @param layer The rotation of the window in degrees (0-360),
3955 * counter-clockwise.
3957 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3959 * Get the rotation of the window.
3961 * @param obj The window object
3962 * @return The rotation of the window in degrees (0-360)
3964 * @see elm_win_rotation_set()
3965 * @see elm_win_rotation_with_resize_set()
3967 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3969 * Set the sticky state of the window.
3971 * Hints the Window Manager that the window in @p obj should be left fixed
3972 * at its position even when the virtual desktop it's on moves or changes.
3974 * @param obj The window object
3975 * @param sticky If true, the window's sticky state is enabled
3977 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3979 * Get the sticky state of the window.
3981 * @param obj The window object
3982 * @return If true, the window's sticky state is enabled
3984 * @see elm_win_sticky_set()
3986 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3988 * Set if this window is an illume conformant window
3990 * @param obj The window object
3991 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3993 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3995 * Get if this window is an illume conformant window
3997 * @param obj The window object
3998 * @return A boolean if this window is illume conformant or not
4000 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4002 * Set a window to be an illume quickpanel window
4004 * By default window objects are not quickpanel windows.
4006 * @param obj The window object
4007 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4009 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4011 * Get if this window is a quickpanel or not
4013 * @param obj The window object
4014 * @return A boolean if this window is a quickpanel or not
4016 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 * Set the major priority of a quickpanel window
4020 * @param obj The window object
4021 * @param priority The major priority for this quickpanel
4023 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4025 * Get the major priority of a quickpanel window
4027 * @param obj The window object
4028 * @return The major priority of this quickpanel
4030 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4032 * Set the minor priority of a quickpanel window
4034 * @param obj The window object
4035 * @param priority The minor priority for this quickpanel
4037 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4039 * Get the minor priority of a quickpanel window
4041 * @param obj The window object
4042 * @return The minor priority of this quickpanel
4044 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046 * Set which zone this quickpanel should appear in
4048 * @param obj The window object
4049 * @param zone The requested zone for this quickpanel
4051 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4053 * Get which zone this quickpanel should appear in
4055 * @param obj The window object
4056 * @return The requested zone for this quickpanel
4058 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060 * Set the window to be skipped by keyboard focus
4062 * This sets the window to be skipped by normal keyboard input. This means
4063 * a window manager will be asked to not focus this window as well as omit
4064 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4066 * Call this and enable it on a window BEFORE you show it for the first time,
4067 * otherwise it may have no effect.
4069 * Use this for windows that have only output information or might only be
4070 * interacted with by the mouse or fingers, and never for typing input.
4071 * Be careful that this may have side-effects like making the window
4072 * non-accessible in some cases unless the window is specially handled. Use
4075 * @param obj The window object
4076 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4078 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4080 * Send a command to the windowing environment
4082 * This is intended to work in touchscreen or small screen device
4083 * environments where there is a more simplistic window management policy in
4084 * place. This uses the window object indicated to select which part of the
4085 * environment to control (the part that this window lives in), and provides
4086 * a command and an optional parameter structure (use NULL for this if not
4089 * @param obj The window object that lives in the environment to control
4090 * @param command The command to send
4091 * @param params Optional parameters for the command
4093 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4095 * Get the inlined image object handle
4097 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4098 * then the window is in fact an evas image object inlined in the parent
4099 * canvas. You can get this object (be careful to not manipulate it as it
4100 * is under control of elementary), and use it to do things like get pixel
4101 * data, save the image to a file, etc.
4103 * @param obj The window object to get the inlined image from
4104 * @return The inlined image object, or NULL if none exists
4106 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4108 * Set the enabled status for the focus highlight in a window
4110 * This function will enable or disable the focus highlight only for the
4111 * given window, regardless of the global setting for it
4113 * @param obj The window where to enable the highlight
4114 * @param enabled The enabled value for the highlight
4116 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4118 * Get the enabled value of the focus highlight for this window
4120 * @param obj The window in which to check if the focus highlight is enabled
4122 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4124 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4126 * Set the style for the focus highlight on this window
4128 * Sets the style to use for theming the highlight of focused objects on
4129 * the given window. If @p style is NULL, the default will be used.
4131 * @param obj The window where to set the style
4132 * @param style The style to set
4134 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4136 * Get the style set for the focus highlight object
4138 * Gets the style set for this windows highilght object, or NULL if none
4141 * @param obj The window to retrieve the highlights style from
4143 * @return The style set or NULL if none was. Default is used in that case.
4145 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4147 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4148 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4149 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4150 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4151 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4152 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4153 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4155 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4156 * (blank mouse, private mouse obj, defaultmouse)
4160 * Sets the keyboard mode of the window.
4162 * @param obj The window object
4163 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4165 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4167 * Gets the keyboard mode of the window.
4169 * @param obj The window object
4170 * @return The mode, one of #Elm_Win_Keyboard_Mode
4172 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4174 * Sets whether the window is a keyboard.
4176 * @param obj The window object
4177 * @param is_keyboard If true, the window is a virtual keyboard
4179 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4181 * Gets whether the window is a keyboard.
4183 * @param obj The window object
4184 * @return If the window is a virtual keyboard
4186 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4189 * Get the screen position of a window.
4191 * @param obj The window object
4192 * @param x The int to store the x coordinate to
4193 * @param y The int to store the y coordinate to
4195 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4201 * @defgroup Inwin Inwin
4203 * @image html img/widget/inwin/preview-00.png
4204 * @image latex img/widget/inwin/preview-00.eps
4205 * @image html img/widget/inwin/preview-01.png
4206 * @image latex img/widget/inwin/preview-01.eps
4207 * @image html img/widget/inwin/preview-02.png
4208 * @image latex img/widget/inwin/preview-02.eps
4210 * An inwin is a window inside a window that is useful for a quick popup.
4211 * It does not hover.
4213 * It works by creating an object that will occupy the entire window, so it
4214 * must be created using an @ref Win "elm_win" as parent only. The inwin
4215 * object can be hidden or restacked below every other object if it's
4216 * needed to show what's behind it without destroying it. If this is done,
4217 * the elm_win_inwin_activate() function can be used to bring it back to
4218 * full visibility again.
4220 * There are three styles available in the default theme. These are:
4221 * @li default: The inwin is sized to take over most of the window it's
4223 * @li minimal: The size of the inwin will be the minimum necessary to show
4225 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4226 * possible, but it's sized vertically the most it needs to fit its\
4229 * Some examples of Inwin can be found in the following:
4230 * @li @ref inwin_example_01
4235 * Adds an inwin to the current window
4237 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4238 * Never call this function with anything other than the top-most window
4239 * as its parameter, unless you are fond of undefined behavior.
4241 * After creating the object, the widget will set itself as resize object
4242 * for the window with elm_win_resize_object_add(), so when shown it will
4243 * appear to cover almost the entire window (how much of it depends on its
4244 * content and the style used). It must not be added into other container
4245 * objects and it needs not be moved or resized manually.
4247 * @param parent The parent object
4248 * @return The new object or NULL if it cannot be created
4250 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4252 * Activates an inwin object, ensuring its visibility
4254 * This function will make sure that the inwin @p obj is completely visible
4255 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4256 * to the front. It also sets the keyboard focus to it, which will be passed
4259 * The object's theme will also receive the signal "elm,action,show" with
4262 * @param obj The inwin to activate
4264 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4266 * Set the content of an inwin object.
4268 * Once the content object is set, a previously set one will be deleted.
4269 * If you want to keep that old content object, use the
4270 * elm_win_inwin_content_unset() function.
4272 * @param obj The inwin object
4273 * @param content The object to set as content
4275 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4277 * Get the content of an inwin object.
4279 * Return the content object which is set for this widget.
4281 * The returned object is valid as long as the inwin is still alive and no
4282 * other content is set on it. Deleting the object will notify the inwin
4283 * about it and this one will be left empty.
4285 * If you need to remove an inwin's content to be reused somewhere else,
4286 * see elm_win_inwin_content_unset().
4288 * @param obj The inwin object
4289 * @return The content that is being used
4291 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4293 * Unset the content of an inwin object.
4295 * Unparent and return the content object which was set for this widget.
4297 * @param obj The inwin object
4298 * @return The content that was being used
4300 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4304 /* X specific calls - won't work on non-x engines (return 0) */
4307 * Get the Ecore_X_Window of an Evas_Object
4309 * @param obj The object
4311 * @return The Ecore_X_Window of @p obj
4315 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4317 /* smart callbacks called:
4318 * "delete,request" - the user requested to delete the window
4319 * "focus,in" - window got focus
4320 * "focus,out" - window lost focus
4321 * "moved" - window that holds the canvas was moved
4327 * @image html img/widget/bg/preview-00.png
4328 * @image latex img/widget/bg/preview-00.eps
4330 * @brief Background object, used for setting a solid color, image or Edje
4331 * group as background to a window or any container object.
4333 * The bg object is used for setting a solid background to a window or
4334 * packing into any container object. It works just like an image, but has
4335 * some properties useful to a background, like setting it to tiled,
4336 * centered, scaled or stretched.
4338 * Here is some sample code using it:
4339 * @li @ref bg_01_example_page
4340 * @li @ref bg_02_example_page
4341 * @li @ref bg_03_example_page
4345 typedef enum _Elm_Bg_Option
4347 ELM_BG_OPTION_CENTER, /**< center the background */
4348 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4349 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4350 ELM_BG_OPTION_TILE /**< tile background at its original size */
4354 * Add a new background to the parent
4356 * @param parent The parent object
4357 * @return The new object or NULL if it cannot be created
4361 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4364 * Set the file (image or edje) used for the background
4366 * @param obj The bg object
4367 * @param file The file path
4368 * @param group Optional key (group in Edje) within the file
4370 * This sets the image file used in the background object. The image (or edje)
4371 * will be stretched (retaining aspect if its an image file) to completely fill
4372 * the bg object. This may mean some parts are not visible.
4374 * @note Once the image of @p obj is set, a previously set one will be deleted,
4375 * even if @p file is NULL.
4379 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4382 * Get the file (image or edje) used for the background
4384 * @param obj The bg object
4385 * @param file The file path
4386 * @param group Optional key (group in Edje) within the file
4390 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4393 * Set the option used for the background image
4395 * @param obj The bg object
4396 * @param option The desired background option (TILE, SCALE)
4398 * This sets the option used for manipulating the display of the background
4399 * image. The image can be tiled or scaled.
4403 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4406 * Get the option used for the background image
4408 * @param obj The bg object
4409 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4413 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4415 * Set the option used for the background color
4417 * @param obj The bg object
4422 * This sets the color used for the background rectangle. Its range goes
4427 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4429 * Get the option used for the background color
4431 * @param obj The bg object
4438 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4441 * Set the overlay object used for the background object.
4443 * @param obj The bg object
4444 * @param overlay The overlay object
4446 * This provides a way for elm_bg to have an 'overlay' that will be on top
4447 * of the bg. Once the over object is set, a previously set one will be
4448 * deleted, even if you set the new one to NULL. If you want to keep that
4449 * old content object, use the elm_bg_overlay_unset() function.
4454 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4457 * Get the overlay object used for the background object.
4459 * @param obj The bg object
4460 * @return The content that is being used
4462 * Return the content object which is set for this widget
4466 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4469 * Get the overlay object used for the background object.
4471 * @param obj The bg object
4472 * @return The content that was being used
4474 * Unparent and return the overlay object which was set for this widget
4478 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 * Set the size of the pixmap representation of the image.
4483 * This option just makes sense if an image is going to be set in the bg.
4485 * @param obj The bg object
4486 * @param w The new width of the image pixmap representation.
4487 * @param h The new height of the image pixmap representation.
4489 * This function sets a new size for pixmap representation of the given bg
4490 * image. It allows the image to be loaded already in the specified size,
4491 * reducing the memory usage and load time when loading a big image with load
4492 * size set to a smaller size.
4494 * NOTE: this is just a hint, the real size of the pixmap may differ
4495 * depending on the type of image being loaded, being bigger than requested.
4499 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4500 /* smart callbacks called:
4504 * @defgroup Icon Icon
4506 * @image html img/widget/icon/preview-00.png
4507 * @image latex img/widget/icon/preview-00.eps
4509 * An object that provides standard icon images (delete, edit, arrows, etc.)
4510 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4512 * The icon image requested can be in the elementary theme, or in the
4513 * freedesktop.org paths. It's possible to set the order of preference from
4514 * where the image will be used.
4516 * This API is very similar to @ref Image, but with ready to use images.
4518 * Default images provided by the theme are described below.
4520 * The first list contains icons that were first intended to be used in
4521 * toolbars, but can be used in many other places too:
4537 * Now some icons that were designed to be used in menus (but again, you can
4538 * use them anywhere else):
4543 * @li menu/arrow_down
4544 * @li menu/arrow_left
4545 * @li menu/arrow_right
4554 * And here we have some media player specific icons:
4555 * @li media_player/forward
4556 * @li media_player/info
4557 * @li media_player/next
4558 * @li media_player/pause
4559 * @li media_player/play
4560 * @li media_player/prev
4561 * @li media_player/rewind
4562 * @li media_player/stop
4564 * Signals that you can add callbacks for are:
4566 * "clicked" - This is called when a user has clicked the icon
4568 * An example of usage for this API follows:
4569 * @li @ref tutorial_icon
4577 typedef enum _Elm_Icon_Type
4584 * @enum _Elm_Icon_Lookup_Order
4585 * @typedef Elm_Icon_Lookup_Order
4587 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4588 * theme, FDO paths, or both?
4592 typedef enum _Elm_Icon_Lookup_Order
4594 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4595 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4596 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4597 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4598 } Elm_Icon_Lookup_Order;
4601 * Add a new icon object to the parent.
4603 * @param parent The parent object
4604 * @return The new object or NULL if it cannot be created
4606 * @see elm_icon_file_set()
4610 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4612 * Set the file that will be used as icon.
4614 * @param obj The icon object
4615 * @param file The path to file that will be used as icon image
4616 * @param group The group that the icon belongs to in edje file
4618 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4620 * @note The icon image set by this function can be changed by
4621 * elm_icon_standard_set().
4623 * @see elm_icon_file_get()
4627 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4629 * Set a location in memory to be used as an icon
4631 * @param obj The icon object
4632 * @param img The binary data that will be used as an image
4633 * @param size The size of binary data @p img
4634 * @param format Optional format of @p img to pass to the image loader
4635 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4637 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4639 * @note The icon image set by this function can be changed by
4640 * elm_icon_standard_set().
4644 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);
4646 * Get the file that will be used as icon.
4648 * @param obj The icon object
4649 * @param file The path to file that will be used as icon icon image
4650 * @param group The group that the icon belongs to in edje file
4652 * @see elm_icon_file_set()
4656 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4657 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4659 * Set the icon by icon standards names.
4661 * @param obj The icon object
4662 * @param name The icon name
4664 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4666 * For example, freedesktop.org defines standard icon names such as "home",
4667 * "network", etc. There can be different icon sets to match those icon
4668 * keys. The @p name given as parameter is one of these "keys", and will be
4669 * used to look in the freedesktop.org paths and elementary theme. One can
4670 * change the lookup order with elm_icon_order_lookup_set().
4672 * If name is not found in any of the expected locations and it is the
4673 * absolute path of an image file, this image will be used.
4675 * @note The icon image set by this function can be changed by
4676 * elm_icon_file_set().
4678 * @see elm_icon_standard_get()
4679 * @see elm_icon_file_set()
4683 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4685 * Get the icon name set by icon standard names.
4687 * @param obj The icon object
4688 * @return The icon name
4690 * If the icon image was set using elm_icon_file_set() instead of
4691 * elm_icon_standard_set(), then this function will return @c NULL.
4693 * @see elm_icon_standard_set()
4697 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4699 * Set the smooth effect for an icon object.
4701 * @param obj The icon object
4702 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4703 * otherwise. Default is @c EINA_TRUE.
4705 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4706 * scaling provides a better resulting image, but is slower.
4708 * The smooth scaling should be disabled when making animations that change
4709 * the icon size, since they will be faster. Animations that don't require
4710 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4711 * is already scaled, since the scaled icon image will be cached).
4713 * @see elm_icon_smooth_get()
4717 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4719 * Get the smooth effect for an icon object.
4721 * @param obj The icon object
4722 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4724 * @see elm_icon_smooth_set()
4728 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4730 * Disable scaling of this object.
4732 * @param obj The icon object.
4733 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4734 * otherwise. Default is @c EINA_FALSE.
4736 * This function disables scaling of the icon object through the function
4737 * elm_object_scale_set(). However, this does not affect the object
4738 * size/resize in any way. For that effect, take a look at
4739 * elm_icon_scale_set().
4741 * @see elm_icon_no_scale_get()
4742 * @see elm_icon_scale_set()
4743 * @see elm_object_scale_set()
4747 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4749 * Get whether scaling is disabled on the object.
4751 * @param obj The icon object
4752 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4754 * @see elm_icon_no_scale_set()
4758 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4760 * Set if the object is (up/down) resizable.
4762 * @param obj The icon object
4763 * @param scale_up A bool to set if the object is resizable up. Default is
4765 * @param scale_down A bool to set if the object is resizable down. Default
4768 * This function limits the icon object resize ability. If @p scale_up is set to
4769 * @c EINA_FALSE, the object can't have its height or width resized to a value
4770 * higher than the original icon size. Same is valid for @p scale_down.
4772 * @see elm_icon_scale_get()
4776 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4778 * Get if the object is (up/down) resizable.
4780 * @param obj The icon object
4781 * @param scale_up A bool to set if the object is resizable up
4782 * @param scale_down A bool to set if the object is resizable down
4784 * @see elm_icon_scale_set()
4788 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4790 * Get the object's image size
4792 * @param obj The icon object
4793 * @param w A pointer to store the width in
4794 * @param h A pointer to store the height in
4798 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4800 * Set if the icon fill the entire object area.
4802 * @param obj The icon object
4803 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4804 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4806 * When the icon object is resized to a different aspect ratio from the
4807 * original icon image, the icon image will still keep its aspect. This flag
4808 * tells how the image should fill the object's area. They are: keep the
4809 * entire icon inside the limits of height and width of the object (@p
4810 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4811 * of the object, and the icon will fill the entire object (@p fill_outside
4814 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4815 * retain property to false. Thus, the icon image will always keep its
4816 * original aspect ratio.
4818 * @see elm_icon_fill_outside_get()
4819 * @see elm_image_fill_outside_set()
4823 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4825 * Get if the object is filled outside.
4827 * @param obj The icon object
4828 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4830 * @see elm_icon_fill_outside_set()
4834 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4836 * Set the prescale size for the icon.
4838 * @param obj The icon object
4839 * @param size The prescale size. This value is used for both width and
4842 * This function sets a new size for pixmap representation of the given
4843 * icon. It allows the icon to be loaded already in the specified size,
4844 * reducing the memory usage and load time when loading a big icon with load
4845 * size set to a smaller size.
4847 * It's equivalent to the elm_bg_load_size_set() function for bg.
4849 * @note this is just a hint, the real size of the pixmap may differ
4850 * depending on the type of icon being loaded, being bigger than requested.
4852 * @see elm_icon_prescale_get()
4853 * @see elm_bg_load_size_set()
4857 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4859 * Get the prescale size for the icon.
4861 * @param obj The icon object
4862 * @return The prescale size
4864 * @see elm_icon_prescale_set()
4868 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4870 * Sets the icon lookup order used by elm_icon_standard_set().
4872 * @param obj The icon object
4873 * @param order The icon lookup order (can be one of
4874 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4875 * or ELM_ICON_LOOKUP_THEME)
4877 * @see elm_icon_order_lookup_get()
4878 * @see Elm_Icon_Lookup_Order
4882 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4884 * Gets the icon lookup order.
4886 * @param obj The icon object
4887 * @return The icon lookup order
4889 * @see elm_icon_order_lookup_set()
4890 * @see Elm_Icon_Lookup_Order
4894 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4896 * Get if the icon supports animation or not.
4898 * @param obj The icon object
4899 * @return @c EINA_TRUE if the icon supports animation,
4900 * @c EINA_FALSE otherwise.
4902 * Return if this elm icon's image can be animated. Currently Evas only
4903 * supports gif animation. If the return value is EINA_FALSE, other
4904 * elm_icon_animated_XXX APIs won't work.
4907 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4909 * Set animation mode of the icon.
4911 * @param obj The icon object
4912 * @param anim @c EINA_TRUE if the object do animation job,
4913 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4915 * Even though elm icon's file can be animated,
4916 * sometimes appication developer want to just first page of image.
4917 * In that time, don't call this function, because default value is EINA_FALSE
4918 * Only when you want icon support anition,
4919 * use this function and set animated to EINA_TURE
4922 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4924 * Get animation mode of the icon.
4926 * @param obj The icon object
4927 * @return The animation mode of the icon object
4928 * @see elm_icon_animated_set
4931 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4933 * Set animation play mode of the icon.
4935 * @param obj The icon object
4936 * @param play @c EINA_TRUE the object play animation images,
4937 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4939 * If you want to play elm icon's animation, you set play to EINA_TURE.
4940 * For example, you make gif player using this set/get API and click event.
4942 * 1. Click event occurs
4943 * 2. Check play flag using elm_icon_animaged_play_get
4944 * 3. If elm icon was playing, set play to EINA_FALSE.
4945 * Then animation will be stopped and vice versa
4948 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4950 * Get animation play mode of the icon.
4952 * @param obj The icon object
4953 * @return The play mode of the icon object
4955 * @see elm_icon_animated_lay_get
4958 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4965 * @defgroup Image Image
4967 * @image html img/widget/image/preview-00.png
4968 * @image latex img/widget/image/preview-00.eps
4971 * An object that allows one to load an image file to it. It can be used
4972 * anywhere like any other elementary widget.
4974 * This widget provides most of the functionality provided from @ref Bg or @ref
4975 * Icon, but with a slightly different API (use the one that fits better your
4978 * The features not provided by those two other image widgets are:
4979 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4980 * @li change the object orientation with elm_image_orient_set();
4981 * @li and turning the image editable with elm_image_editable_set().
4983 * Signals that you can add callbacks for are:
4985 * @li @c "clicked" - This is called when a user has clicked the image
4987 * An example of usage for this API follows:
4988 * @li @ref tutorial_image
4997 * @enum _Elm_Image_Orient
4998 * @typedef Elm_Image_Orient
5000 * Possible orientation options for elm_image_orient_set().
5002 * @image html elm_image_orient_set.png
5003 * @image latex elm_image_orient_set.eps width=\textwidth
5007 typedef enum _Elm_Image_Orient
5009 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5010 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5011 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5012 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5013 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5014 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5015 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5016 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5020 * Add a new image to the parent.
5022 * @param parent The parent object
5023 * @return The new object or NULL if it cannot be created
5025 * @see elm_image_file_set()
5029 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5031 * Set the file that will be used as image.
5033 * @param obj The image object
5034 * @param file The path to file that will be used as image
5035 * @param group The group that the image belongs in edje file (if it's an
5038 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5040 * @see elm_image_file_get()
5044 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5046 * Get the file that will be used as image.
5048 * @param obj The image object
5049 * @param file The path to file
5050 * @param group The group that the image belongs in edje file
5052 * @see elm_image_file_set()
5056 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5058 * Set the smooth effect for an image.
5060 * @param obj The image object
5061 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5062 * otherwise. Default is @c EINA_TRUE.
5064 * Set the scaling algorithm to be used when scaling the image. Smooth
5065 * scaling provides a better resulting image, but is slower.
5067 * The smooth scaling should be disabled when making animations that change
5068 * the image size, since it will be faster. Animations that don't require
5069 * resizing of the image can keep the smooth scaling enabled (even if the
5070 * image is already scaled, since the scaled image will be cached).
5072 * @see elm_image_smooth_get()
5076 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5078 * Get the smooth effect for an image.
5080 * @param obj The image object
5081 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5083 * @see elm_image_smooth_get()
5087 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5089 * Gets the current size of the image.
5091 * @param obj The image object.
5092 * @param w Pointer to store width, or NULL.
5093 * @param h Pointer to store height, or NULL.
5095 * This is the real size of the image, not the size of the object.
5097 * On error, neither w or h will be written.
5101 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5103 * Disable scaling of this object.
5105 * @param obj The image object.
5106 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5107 * otherwise. Default is @c EINA_FALSE.
5109 * This function disables scaling of the elm_image widget through the
5110 * function elm_object_scale_set(). However, this does not affect the widget
5111 * size/resize in any way. For that effect, take a look at
5112 * elm_image_scale_set().
5114 * @see elm_image_no_scale_get()
5115 * @see elm_image_scale_set()
5116 * @see elm_object_scale_set()
5120 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5122 * Get whether scaling is disabled on the object.
5124 * @param obj The image object
5125 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5127 * @see elm_image_no_scale_set()
5131 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5133 * Set if the object is (up/down) resizable.
5135 * @param obj The image object
5136 * @param scale_up A bool to set if the object is resizable up. Default is
5138 * @param scale_down A bool to set if the object is resizable down. Default
5141 * This function limits the image resize ability. If @p scale_up is set to
5142 * @c EINA_FALSE, the object can't have its height or width resized to a value
5143 * higher than the original image size. Same is valid for @p scale_down.
5145 * @see elm_image_scale_get()
5149 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5151 * Get if the object is (up/down) resizable.
5153 * @param obj The image object
5154 * @param scale_up A bool to set if the object is resizable up
5155 * @param scale_down A bool to set if the object is resizable down
5157 * @see elm_image_scale_set()
5161 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5163 * Set if the image fill the entire object area when keeping the aspect ratio.
5165 * @param obj The image object
5166 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5167 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5169 * When the image should keep its aspect ratio even if resized to another
5170 * aspect ratio, there are two possibilities to resize it: keep the entire
5171 * image inside the limits of height and width of the object (@p fill_outside
5172 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5173 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5175 * @note This option will have no effect if
5176 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5178 * @see elm_image_fill_outside_get()
5179 * @see elm_image_aspect_ratio_retained_set()
5183 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5185 * Get if the object is filled outside
5187 * @param obj The image object
5188 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5190 * @see elm_image_fill_outside_set()
5194 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5196 * Set the prescale size for the image
5198 * @param obj The image object
5199 * @param size The prescale size. This value is used for both width and
5202 * This function sets a new size for pixmap representation of the given
5203 * image. It allows the image to be loaded already in the specified size,
5204 * reducing the memory usage and load time when loading a big image with load
5205 * size set to a smaller size.
5207 * It's equivalent to the elm_bg_load_size_set() function for bg.
5209 * @note this is just a hint, the real size of the pixmap may differ
5210 * depending on the type of image being loaded, being bigger than requested.
5212 * @see elm_image_prescale_get()
5213 * @see elm_bg_load_size_set()
5217 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5219 * Get the prescale size for the image
5221 * @param obj The image object
5222 * @return The prescale size
5224 * @see elm_image_prescale_set()
5228 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5230 * Set the image orientation.
5232 * @param obj The image object
5233 * @param orient The image orientation
5234 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5235 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5236 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5237 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5238 * Default is #ELM_IMAGE_ORIENT_NONE.
5240 * This function allows to rotate or flip the given image.
5242 * @see elm_image_orient_get()
5243 * @see @ref Elm_Image_Orient
5247 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5249 * Get the image orientation.
5251 * @param obj The image object
5252 * @return The image orientation
5253 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5254 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5255 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5256 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5258 * @see elm_image_orient_set()
5259 * @see @ref Elm_Image_Orient
5263 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5265 * Make the image 'editable'.
5267 * @param obj Image object.
5268 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5270 * This means the image is a valid drag target for drag and drop, and can be
5271 * cut or pasted too.
5275 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5277 * Make the image 'editable'.
5279 * @param obj Image object.
5280 * @return Editability.
5282 * This means the image is a valid drag target for drag and drop, and can be
5283 * cut or pasted too.
5287 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5289 * Get the basic Evas_Image object from this object (widget).
5291 * @param obj The image object to get the inlined image from
5292 * @return The inlined image object, or NULL if none exists
5294 * This function allows one to get the underlying @c Evas_Object of type
5295 * Image from this elementary widget. It can be useful to do things like get
5296 * the pixel data, save the image to a file, etc.
5298 * @note Be careful to not manipulate it, as it is under control of
5303 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5305 * Set whether the original aspect ratio of the image should be kept on resize.
5307 * @param obj The image object.
5308 * @param retained @c EINA_TRUE if the image should retain the aspect,
5309 * @c EINA_FALSE otherwise.
5311 * The original aspect ratio (width / height) of the image is usually
5312 * distorted to match the object's size. Enabling this option will retain
5313 * this original aspect, and the way that the image is fit into the object's
5314 * area depends on the option set by elm_image_fill_outside_set().
5316 * @see elm_image_aspect_ratio_retained_get()
5317 * @see elm_image_fill_outside_set()
5321 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5323 * Get if the object retains the original aspect ratio.
5325 * @param obj The image object.
5326 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5331 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5338 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5340 typedef enum _Elm_GLView_Mode
5342 ELM_GLVIEW_ALPHA = 1,
5343 ELM_GLVIEW_DEPTH = 2,
5344 ELM_GLVIEW_STENCIL = 4
5348 * Defines a policy for the glview resizing.
5350 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5352 typedef enum _Elm_GLView_Resize_Policy
5354 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5355 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5356 } Elm_GLView_Resize_Policy;
5358 typedef enum _Elm_GLView_Render_Policy
5360 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5361 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5362 } Elm_GLView_Render_Policy;
5367 * A simple GLView widget that allows GL rendering.
5369 * Signals that you can add callbacks for are:
5375 * Add a new glview to the parent
5377 * @param parent The parent object
5378 * @return The new object or NULL if it cannot be created
5382 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5385 * Sets the size of the glview
5387 * @param obj The glview object
5388 * @param width width of the glview object
5389 * @param height height of the glview object
5393 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5396 * Gets the size of the glview.
5398 * @param obj The glview object
5399 * @param width width of the glview object
5400 * @param height height of the glview object
5402 * Note that this function returns the actual image size of the
5403 * glview. This means that when the scale policy is set to
5404 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5409 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5412 * Gets the gl api struct for gl rendering
5414 * @param obj The glview object
5415 * @return The api object or NULL if it cannot be created
5419 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422 * Set the mode of the GLView. Supports Three simple modes.
5424 * @param obj The glview object
5425 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5426 * @return True if set properly.
5430 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5433 * Set the resize policy for the glview object.
5435 * @param obj The glview object.
5436 * @param policy The scaling policy.
5438 * By default, the resize policy is set to
5439 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5440 * destroys the previous surface and recreates the newly specified
5441 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5442 * however, glview only scales the image object and not the underlying
5447 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5450 * Set the render policy for the glview object.
5452 * @param obj The glview object.
5453 * @param policy The render policy.
5455 * By default, the render policy is set to
5456 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5457 * that during the render loop, glview is only redrawn if it needs
5458 * to be redrawn. (i.e. When it is visible) If the policy is set to
5459 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5460 * whether it is visible/need redrawing or not.
5464 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5467 * Set the init function that runs once in the main loop.
5469 * @param obj The glview object.
5470 * @param func The init function to be registered.
5472 * The registered init function gets called once during the render loop.
5476 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5479 * Set the render function that runs in the main loop.
5481 * @param obj The glview object.
5482 * @param func The delete function to be registered.
5484 * The registered del function gets called when GLView object is deleted.
5488 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5491 * Set the resize function that gets called when resize happens.
5493 * @param obj The glview object.
5494 * @param func The resize function to be registered.
5498 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5501 * Set the render function that runs in the main loop.
5503 * @param obj The glview object.
5504 * @param func The render function to be registered.
5508 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5511 * Notifies that there has been changes in the GLView.
5513 * @param obj The glview object.
5517 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5527 * @image html img/widget/box/preview-00.png
5528 * @image latex img/widget/box/preview-00.eps width=\textwidth
5530 * @image html img/box.png
5531 * @image latex img/box.eps width=\textwidth
5533 * A box arranges objects in a linear fashion, governed by a layout function
5534 * that defines the details of this arrangement.
5536 * By default, the box will use an internal function to set the layout to
5537 * a single row, either vertical or horizontal. This layout is affected
5538 * by a number of parameters, such as the homogeneous flag set by
5539 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5540 * elm_box_align_set() and the hints set to each object in the box.
5542 * For this default layout, it's possible to change the orientation with
5543 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5544 * placing its elements ordered from top to bottom. When horizontal is set,
5545 * the order will go from left to right. If the box is set to be
5546 * homogeneous, every object in it will be assigned the same space, that
5547 * of the largest object. Padding can be used to set some spacing between
5548 * the cell given to each object. The alignment of the box, set with
5549 * elm_box_align_set(), determines how the bounding box of all the elements
5550 * will be placed within the space given to the box widget itself.
5552 * The size hints of each object also affect how they are placed and sized
5553 * within the box. evas_object_size_hint_min_set() will give the minimum
5554 * size the object can have, and the box will use it as the basis for all
5555 * latter calculations. Elementary widgets set their own minimum size as
5556 * needed, so there's rarely any need to use it manually.
5558 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5559 * used to tell whether the object will be allocated the minimum size it
5560 * needs or if the space given to it should be expanded. It's important
5561 * to realize that expanding the size given to the object is not the same
5562 * thing as resizing the object. It could very well end being a small
5563 * widget floating in a much larger empty space. If not set, the weight
5564 * for objects will normally be 0.0 for both axis, meaning the widget will
5565 * not be expanded. To take as much space possible, set the weight to
5566 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5568 * Besides how much space each object is allocated, it's possible to control
5569 * how the widget will be placed within that space using
5570 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5571 * for both axis, meaning the object will be centered, but any value from
5572 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5573 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5574 * is -1.0, means the object will be resized to fill the entire space it
5577 * In addition, customized functions to define the layout can be set, which
5578 * allow the application developer to organize the objects within the box
5579 * in any number of ways.
5581 * The special elm_box_layout_transition() function can be used
5582 * to switch from one layout to another, animating the motion of the
5583 * children of the box.
5585 * @note Objects should not be added to box objects using _add() calls.
5587 * Some examples on how to use boxes follow:
5588 * @li @ref box_example_01
5589 * @li @ref box_example_02
5594 * @typedef Elm_Box_Transition
5596 * Opaque handler containing the parameters to perform an animated
5597 * transition of the layout the box uses.
5599 * @see elm_box_transition_new()
5600 * @see elm_box_layout_set()
5601 * @see elm_box_layout_transition()
5603 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5606 * Add a new box to the parent
5608 * By default, the box will be in vertical mode and non-homogeneous.
5610 * @param parent The parent object
5611 * @return The new object or NULL if it cannot be created
5613 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5615 * Set the horizontal orientation
5617 * By default, box object arranges their contents vertically from top to
5619 * By calling this function with @p horizontal as EINA_TRUE, the box will
5620 * become horizontal, arranging contents from left to right.
5622 * @note This flag is ignored if a custom layout function is set.
5624 * @param obj The box object
5625 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5626 * EINA_FALSE = vertical)
5628 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5630 * Get the horizontal orientation
5632 * @param obj The box object
5633 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5635 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5637 * Set the box to arrange its children homogeneously
5639 * If enabled, homogeneous layout makes all items the same size, according
5640 * to the size of the largest of its children.
5642 * @note This flag is ignored if a custom layout function is set.
5644 * @param obj The box object
5645 * @param homogeneous The homogeneous flag
5647 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5649 * Get whether the box is using homogeneous mode or not
5651 * @param obj The box object
5652 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5654 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5655 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5656 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5658 * Add an object to the beginning of the pack list
5660 * Pack @p subobj into the box @p obj, placing it first in the list of
5661 * children objects. The actual position the object will get on screen
5662 * depends on the layout used. If no custom layout is set, it will be at
5663 * the top or left, depending if the box is vertical or horizontal,
5666 * @param obj The box object
5667 * @param subobj The object to add to the box
5669 * @see elm_box_pack_end()
5670 * @see elm_box_pack_before()
5671 * @see elm_box_pack_after()
5672 * @see elm_box_unpack()
5673 * @see elm_box_unpack_all()
5674 * @see elm_box_clear()
5676 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5678 * Add an object at the end of the pack list
5680 * Pack @p subobj into the box @p obj, placing it last in the list of
5681 * children objects. The actual position the object will get on screen
5682 * depends on the layout used. If no custom layout is set, it will be at
5683 * the bottom or right, depending if the box is vertical or horizontal,
5686 * @param obj The box object
5687 * @param subobj The object to add to the box
5689 * @see elm_box_pack_start()
5690 * @see elm_box_pack_before()
5691 * @see elm_box_pack_after()
5692 * @see elm_box_unpack()
5693 * @see elm_box_unpack_all()
5694 * @see elm_box_clear()
5696 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5698 * Adds an object to the box before the indicated object
5700 * This will add the @p subobj to the box indicated before the object
5701 * indicated with @p before. If @p before is not already in the box, results
5702 * are undefined. Before means either to the left of the indicated object or
5703 * above it depending on orientation.
5705 * @param obj The box object
5706 * @param subobj The object to add to the box
5707 * @param before The object before which to add it
5709 * @see elm_box_pack_start()
5710 * @see elm_box_pack_end()
5711 * @see elm_box_pack_after()
5712 * @see elm_box_unpack()
5713 * @see elm_box_unpack_all()
5714 * @see elm_box_clear()
5716 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5718 * Adds an object to the box after the indicated object
5720 * This will add the @p subobj to the box indicated after the object
5721 * indicated with @p after. If @p after is not already in the box, results
5722 * are undefined. After means either to the right of the indicated object or
5723 * below it depending on orientation.
5725 * @param obj The box object
5726 * @param subobj The object to add to the box
5727 * @param after The object after which to add it
5729 * @see elm_box_pack_start()
5730 * @see elm_box_pack_end()
5731 * @see elm_box_pack_before()
5732 * @see elm_box_unpack()
5733 * @see elm_box_unpack_all()
5734 * @see elm_box_clear()
5736 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5738 * Clear the box of all children
5740 * Remove all the elements contained by the box, deleting the respective
5743 * @param obj The box object
5745 * @see elm_box_unpack()
5746 * @see elm_box_unpack_all()
5748 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5752 * Remove the object given by @p subobj from the box @p obj without
5755 * @param obj The box object
5757 * @see elm_box_unpack_all()
5758 * @see elm_box_clear()
5760 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5762 * Remove all items from the box, without deleting them
5764 * Clear the box from all children, but don't delete the respective objects.
5765 * If no other references of the box children exist, the objects will never
5766 * be deleted, and thus the application will leak the memory. Make sure
5767 * when using this function that you hold a reference to all the objects
5768 * in the box @p obj.
5770 * @param obj The box object
5772 * @see elm_box_clear()
5773 * @see elm_box_unpack()
5775 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5777 * Retrieve a list of the objects packed into the box
5779 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5780 * The order of the list corresponds to the packing order the box uses.
5782 * You must free this list with eina_list_free() once you are done with it.
5784 * @param obj The box object
5786 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5788 * Set the space (padding) between the box's elements.
5790 * Extra space in pixels that will be added between a box child and its
5791 * neighbors after its containing cell has been calculated. This padding
5792 * is set for all elements in the box, besides any possible padding that
5793 * individual elements may have through their size hints.
5795 * @param obj The box object
5796 * @param horizontal The horizontal space between elements
5797 * @param vertical The vertical space between elements
5799 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5801 * Get the space (padding) between the box's elements.
5803 * @param obj The box object
5804 * @param horizontal The horizontal space between elements
5805 * @param vertical The vertical space between elements
5807 * @see elm_box_padding_set()
5809 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5811 * Set the alignment of the whole bouding box of contents.
5813 * Sets how the bounding box containing all the elements of the box, after
5814 * their sizes and position has been calculated, will be aligned within
5815 * the space given for the whole box widget.
5817 * @param obj The box object
5818 * @param horizontal The horizontal alignment of elements
5819 * @param vertical The vertical alignment of elements
5821 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5823 * Get the alignment of the whole bouding box of contents.
5825 * @param obj The box object
5826 * @param horizontal The horizontal alignment of elements
5827 * @param vertical The vertical alignment of elements
5829 * @see elm_box_align_set()
5831 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5834 * Set the layout defining function to be used by the box
5836 * Whenever anything changes that requires the box in @p obj to recalculate
5837 * the size and position of its elements, the function @p cb will be called
5838 * to determine what the layout of the children will be.
5840 * Once a custom function is set, everything about the children layout
5841 * is defined by it. The flags set by elm_box_horizontal_set() and
5842 * elm_box_homogeneous_set() no longer have any meaning, and the values
5843 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5844 * layout function to decide if they are used and how. These last two
5845 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5846 * passed to @p cb. The @c Evas_Object the function receives is not the
5847 * Elementary widget, but the internal Evas Box it uses, so none of the
5848 * functions described here can be used on it.
5850 * Any of the layout functions in @c Evas can be used here, as well as the
5851 * special elm_box_layout_transition().
5853 * The final @p data argument received by @p cb is the same @p data passed
5854 * here, and the @p free_data function will be called to free it
5855 * whenever the box is destroyed or another layout function is set.
5857 * Setting @p cb to NULL will revert back to the default layout function.
5859 * @param obj The box object
5860 * @param cb The callback function used for layout
5861 * @param data Data that will be passed to layout function
5862 * @param free_data Function called to free @p data
5864 * @see elm_box_layout_transition()
5866 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);
5868 * Special layout function that animates the transition from one layout to another
5870 * Normally, when switching the layout function for a box, this will be
5871 * reflected immediately on screen on the next render, but it's also
5872 * possible to do this through an animated transition.
5874 * This is done by creating an ::Elm_Box_Transition and setting the box
5875 * layout to this function.
5879 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5880 * evas_object_box_layout_vertical, // start
5881 * NULL, // data for initial layout
5882 * NULL, // free function for initial data
5883 * evas_object_box_layout_horizontal, // end
5884 * NULL, // data for final layout
5885 * NULL, // free function for final data
5886 * anim_end, // will be called when animation ends
5887 * NULL); // data for anim_end function\
5888 * elm_box_layout_set(box, elm_box_layout_transition, t,
5889 * elm_box_transition_free);
5892 * @note This function can only be used with elm_box_layout_set(). Calling
5893 * it directly will not have the expected results.
5895 * @see elm_box_transition_new
5896 * @see elm_box_transition_free
5897 * @see elm_box_layout_set
5899 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5901 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5903 * If you want to animate the change from one layout to another, you need
5904 * to set the layout function of the box to elm_box_layout_transition(),
5905 * passing as user data to it an instance of ::Elm_Box_Transition with the
5906 * necessary information to perform this animation. The free function to
5907 * set for the layout is elm_box_transition_free().
5909 * The parameters to create an ::Elm_Box_Transition sum up to how long
5910 * will it be, in seconds, a layout function to describe the initial point,
5911 * another for the final position of the children and one function to be
5912 * called when the whole animation ends. This last function is useful to
5913 * set the definitive layout for the box, usually the same as the end
5914 * layout for the animation, but could be used to start another transition.
5916 * @param start_layout The layout function that will be used to start the animation
5917 * @param start_layout_data The data to be passed the @p start_layout function
5918 * @param start_layout_free_data Function to free @p start_layout_data
5919 * @param end_layout The layout function that will be used to end the animation
5920 * @param end_layout_free_data The data to be passed the @p end_layout function
5921 * @param end_layout_free_data Function to free @p end_layout_data
5922 * @param transition_end_cb Callback function called when animation ends
5923 * @param transition_end_data Data to be passed to @p transition_end_cb
5924 * @return An instance of ::Elm_Box_Transition
5926 * @see elm_box_transition_new
5927 * @see elm_box_layout_transition
5929 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);
5931 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5933 * This function is mostly useful as the @c free_data parameter in
5934 * elm_box_layout_set() when elm_box_layout_transition().
5936 * @param data The Elm_Box_Transition instance to be freed.
5938 * @see elm_box_transition_new
5939 * @see elm_box_layout_transition
5941 EAPI void elm_box_transition_free(void *data);
5948 * @defgroup Button Button
5950 * @image html img/widget/button/preview-00.png
5951 * @image latex img/widget/button/preview-00.eps
5952 * @image html img/widget/button/preview-01.png
5953 * @image latex img/widget/button/preview-01.eps
5954 * @image html img/widget/button/preview-02.png
5955 * @image latex img/widget/button/preview-02.eps
5957 * This is a push-button. Press it and run some function. It can contain
5958 * a simple label and icon object and it also has an autorepeat feature.
5960 * This widgets emits the following signals:
5961 * @li "clicked": the user clicked the button (press/release).
5962 * @li "repeated": the user pressed the button without releasing it.
5963 * @li "pressed": button was pressed.
5964 * @li "unpressed": button was released after being pressed.
5965 * In all three cases, the @c event parameter of the callback will be
5968 * Also, defined in the default theme, the button has the following styles
5970 * @li default: a normal button.
5971 * @li anchor: Like default, but the button fades away when the mouse is not
5972 * over it, leaving only the text or icon.
5973 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5974 * continuous look across its options.
5975 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5977 * Follow through a complete example @ref button_example_01 "here".
5981 * Add a new button to the parent's canvas
5983 * @param parent The parent object
5984 * @return The new object or NULL if it cannot be created
5986 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5988 * Set the label used in the button
5990 * The passed @p label can be NULL to clean any existing text in it and
5991 * leave the button as an icon only object.
5993 * @param obj The button object
5994 * @param label The text will be written on the button
5995 * @deprecated use elm_object_text_set() instead.
5997 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5999 * Get the label set for the button
6001 * The string returned is an internal pointer and should not be freed or
6002 * altered. It will also become invalid when the button is destroyed.
6003 * The string returned, if not NULL, is a stringshare, so if you need to
6004 * keep it around even after the button is destroyed, you can use
6005 * eina_stringshare_ref().
6007 * @param obj The button object
6008 * @return The text set to the label, or NULL if nothing is set
6009 * @deprecated use elm_object_text_set() instead.
6011 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6013 * Set the icon used for the button
6015 * Setting a new icon will delete any other that was previously set, making
6016 * any reference to them invalid. If you need to maintain the previous
6017 * object alive, unset it first with elm_button_icon_unset().
6019 * @param obj The button object
6020 * @param icon The icon object for the button
6022 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6024 * Get the icon used for the button
6026 * Return the icon object which is set for this widget. If the button is
6027 * destroyed or another icon is set, the returned object will be deleted
6028 * and any reference to it will be invalid.
6030 * @param obj The button object
6031 * @return The icon object that is being used
6033 * @see elm_button_icon_unset()
6035 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6037 * Remove the icon set without deleting it and return the object
6039 * This function drops the reference the button holds of the icon object
6040 * and returns this last object. It is used in case you want to remove any
6041 * icon, or set another one, without deleting the actual object. The button
6042 * will be left without an icon set.
6044 * @param obj The button object
6045 * @return The icon object that was being used
6047 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 * Turn on/off the autorepeat event generated when the button is kept pressed
6051 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6052 * signal when they are clicked.
6054 * When on, keeping a button pressed will continuously emit a @c repeated
6055 * signal until the button is released. The time it takes until it starts
6056 * emitting the signal is given by
6057 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6058 * new emission by elm_button_autorepeat_gap_timeout_set().
6060 * @param obj The button object
6061 * @param on A bool to turn on/off the event
6063 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6065 * Get whether the autorepeat feature is enabled
6067 * @param obj The button object
6068 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6070 * @see elm_button_autorepeat_set()
6072 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6074 * Set the initial timeout before the autorepeat event is generated
6076 * Sets the timeout, in seconds, since the button is pressed until the
6077 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6078 * won't be any delay and the even will be fired the moment the button is
6081 * @param obj The button object
6082 * @param t Timeout in seconds
6084 * @see elm_button_autorepeat_set()
6085 * @see elm_button_autorepeat_gap_timeout_set()
6087 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6089 * Get the initial timeout before the autorepeat event is generated
6091 * @param obj The button object
6092 * @return Timeout in seconds
6094 * @see elm_button_autorepeat_initial_timeout_set()
6096 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6098 * Set the interval between each generated autorepeat event
6100 * After the first @c repeated event is fired, all subsequent ones will
6101 * follow after a delay of @p t seconds for each.
6103 * @param obj The button object
6104 * @param t Interval in seconds
6106 * @see elm_button_autorepeat_initial_timeout_set()
6108 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6110 * Get the interval between each generated autorepeat event
6112 * @param obj The button object
6113 * @return Interval in seconds
6115 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6121 * @defgroup File_Selector_Button File Selector Button
6123 * @image html img/widget/fileselector_button/preview-00.png
6124 * @image latex img/widget/fileselector_button/preview-00.eps
6125 * @image html img/widget/fileselector_button/preview-01.png
6126 * @image latex img/widget/fileselector_button/preview-01.eps
6127 * @image html img/widget/fileselector_button/preview-02.png
6128 * @image latex img/widget/fileselector_button/preview-02.eps
6130 * This is a button that, when clicked, creates an Elementary
6131 * window (or inner window) <b> with a @ref Fileselector "file
6132 * selector widget" within</b>. When a file is chosen, the (inner)
6133 * window is closed and the button emits a signal having the
6134 * selected file as it's @c event_info.
6136 * This widget encapsulates operations on its internal file
6137 * selector on its own API. There is less control over its file
6138 * selector than that one would have instatiating one directly.
6140 * The following styles are available for this button:
6143 * @li @c "hoversel_vertical"
6144 * @li @c "hoversel_vertical_entry"
6146 * Smart callbacks one can register to:
6147 * - @c "file,chosen" - the user has selected a path, whose string
6148 * pointer comes as the @c event_info data (a stringshared
6151 * Here is an example on its usage:
6152 * @li @ref fileselector_button_example
6154 * @see @ref File_Selector_Entry for a similar widget.
6159 * Add a new file selector button widget to the given parent
6160 * Elementary (container) object
6162 * @param parent The parent object
6163 * @return a new file selector button widget handle or @c NULL, on
6166 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6169 * Set the label for a given file selector button widget
6171 * @param obj The file selector button widget
6172 * @param label The text label to be displayed on @p obj
6174 * @deprecated use elm_object_text_set() instead.
6176 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6179 * Get the label set for a given file selector button widget
6181 * @param obj The file selector button widget
6182 * @return The button label
6184 * @deprecated use elm_object_text_set() instead.
6186 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6189 * Set the icon on a given file selector button widget
6191 * @param obj The file selector button widget
6192 * @param icon The icon object for the button
6194 * Once the icon object is set, a previously set one will be
6195 * deleted. If you want to keep the latter, use the
6196 * elm_fileselector_button_icon_unset() function.
6198 * @see elm_fileselector_button_icon_get()
6200 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6203 * Get the icon set for a given file selector button widget
6205 * @param obj The file selector button widget
6206 * @return The icon object currently set on @p obj or @c NULL, if
6209 * @see elm_fileselector_button_icon_set()
6211 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6214 * Unset the icon used in a given file selector button widget
6216 * @param obj The file selector button widget
6217 * @return The icon object that was being used on @p obj or @c
6220 * Unparent and return the icon object which was set for this
6223 * @see elm_fileselector_button_icon_set()
6225 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6228 * Set the title for a given file selector button widget's window
6230 * @param obj The file selector button widget
6231 * @param title The title string
6233 * This will change the window's title, when the file selector pops
6234 * out after a click on the button. Those windows have the default
6235 * (unlocalized) value of @c "Select a file" as titles.
6237 * @note It will only take any effect if the file selector
6238 * button widget is @b not under "inwin mode".
6240 * @see elm_fileselector_button_window_title_get()
6242 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6245 * Get the title set for a given file selector button widget's
6248 * @param obj The file selector button widget
6249 * @return Title of the file selector button's window
6251 * @see elm_fileselector_button_window_title_get() for more details
6253 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6256 * Set the size of a given file selector button widget's window,
6257 * holding the file selector itself.
6259 * @param obj The file selector button widget
6260 * @param width The window's width
6261 * @param height The window's height
6263 * @note it will only take any effect if the file selector button
6264 * widget is @b not under "inwin mode". The default size for the
6265 * window (when applicable) is 400x400 pixels.
6267 * @see elm_fileselector_button_window_size_get()
6269 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6272 * Get the size of a given file selector button widget's window,
6273 * holding the file selector itself.
6275 * @param obj The file selector button widget
6276 * @param width Pointer into which to store the width value
6277 * @param height Pointer into which to store the height value
6279 * @note Use @c NULL pointers on the size values you're not
6280 * interested in: they'll be ignored by the function.
6282 * @see elm_fileselector_button_window_size_set(), for more details
6284 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6287 * Set the initial file system path for a given file selector
6290 * @param obj The file selector button widget
6291 * @param path The path string
6293 * It must be a <b>directory</b> path, which will have the contents
6294 * displayed initially in the file selector's view, when invoked
6295 * from @p obj. The default initial path is the @c "HOME"
6296 * environment variable's value.
6298 * @see elm_fileselector_button_path_get()
6300 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6303 * Get the initial file system path set for a given file selector
6306 * @param obj The file selector button widget
6307 * @return path The path string
6309 * @see elm_fileselector_button_path_set() for more details
6311 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6314 * Enable/disable a tree view in the given file selector button
6315 * widget's internal file selector
6317 * @param obj The file selector button widget
6318 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6321 * This has the same effect as elm_fileselector_expandable_set(),
6322 * but now applied to a file selector button's internal file
6325 * @note There's no way to put a file selector button's internal
6326 * file selector in "grid mode", as one may do with "pure" file
6329 * @see elm_fileselector_expandable_get()
6331 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6334 * Get whether tree view is enabled for the given file selector
6335 * button widget's internal file selector
6337 * @param obj The file selector button widget
6338 * @return @c EINA_TRUE if @p obj widget's internal file selector
6339 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6341 * @see elm_fileselector_expandable_set() for more details
6343 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6346 * Set whether a given file selector button widget's internal file
6347 * selector is to display folders only or the directory contents,
6350 * @param obj The file selector button widget
6351 * @param only @c EINA_TRUE to make @p obj widget's internal file
6352 * selector only display directories, @c EINA_FALSE to make files
6353 * to be displayed in it too
6355 * This has the same effect as elm_fileselector_folder_only_set(),
6356 * but now applied to a file selector button's internal file
6359 * @see elm_fileselector_folder_only_get()
6361 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6364 * Get whether a given file selector button widget's internal file
6365 * selector is displaying folders only or the directory contents,
6368 * @param obj The file selector button widget
6369 * @return @c EINA_TRUE if @p obj widget's internal file
6370 * selector is only displaying directories, @c EINA_FALSE if files
6371 * are being displayed in it too (and on errors)
6373 * @see elm_fileselector_button_folder_only_set() for more details
6375 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6378 * Enable/disable the file name entry box where the user can type
6379 * in a name for a file, in a given file selector button widget's
6380 * internal file selector.
6382 * @param obj The file selector button widget
6383 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6384 * file selector a "saving dialog", @c EINA_FALSE otherwise
6386 * This has the same effect as elm_fileselector_is_save_set(),
6387 * but now applied to a file selector button's internal file
6390 * @see elm_fileselector_is_save_get()
6392 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6395 * Get whether the given file selector button widget's internal
6396 * file selector is in "saving dialog" mode
6398 * @param obj The file selector button widget
6399 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6400 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6403 * @see elm_fileselector_button_is_save_set() for more details
6405 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6408 * Set whether a given file selector button widget's internal file
6409 * selector will raise an Elementary "inner window", instead of a
6410 * dedicated Elementary window. By default, it won't.
6412 * @param obj The file selector button widget
6413 * @param value @c EINA_TRUE to make it use an inner window, @c
6414 * EINA_TRUE to make it use a dedicated window
6416 * @see elm_win_inwin_add() for more information on inner windows
6417 * @see elm_fileselector_button_inwin_mode_get()
6419 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6422 * Get whether a given file selector button widget's internal file
6423 * selector will raise an Elementary "inner window", instead of a
6424 * dedicated Elementary window.
6426 * @param obj The file selector button widget
6427 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6428 * if it will use a dedicated window
6430 * @see elm_fileselector_button_inwin_mode_set() for more details
6432 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6439 * @defgroup File_Selector_Entry File Selector Entry
6441 * @image html img/widget/fileselector_entry/preview-00.png
6442 * @image latex img/widget/fileselector_entry/preview-00.eps
6444 * This is an entry made to be filled with or display a <b>file
6445 * system path string</b>. Besides the entry itself, the widget has
6446 * a @ref File_Selector_Button "file selector button" on its side,
6447 * which will raise an internal @ref Fileselector "file selector widget",
6448 * when clicked, for path selection aided by file system
6451 * This file selector may appear in an Elementary window or in an
6452 * inner window. When a file is chosen from it, the (inner) window
6453 * is closed and the selected file's path string is exposed both as
6454 * an smart event and as the new text on the entry.
6456 * This widget encapsulates operations on its internal file
6457 * selector on its own API. There is less control over its file
6458 * selector than that one would have instatiating one directly.
6460 * Smart callbacks one can register to:
6461 * - @c "changed" - The text within the entry was changed
6462 * - @c "activated" - The entry has had editing finished and
6463 * changes are to be "committed"
6464 * - @c "press" - The entry has been clicked
6465 * - @c "longpressed" - The entry has been clicked (and held) for a
6467 * - @c "clicked" - The entry has been clicked
6468 * - @c "clicked,double" - The entry has been double clicked
6469 * - @c "focused" - The entry has received focus
6470 * - @c "unfocused" - The entry has lost focus
6471 * - @c "selection,paste" - A paste action has occurred on the
6473 * - @c "selection,copy" - A copy action has occurred on the entry
6474 * - @c "selection,cut" - A cut action has occurred on the entry
6475 * - @c "unpressed" - The file selector entry's button was released
6476 * after being pressed.
6477 * - @c "file,chosen" - The user has selected a path via the file
6478 * selector entry's internal file selector, whose string pointer
6479 * comes as the @c event_info data (a stringshared string)
6481 * Here is an example on its usage:
6482 * @li @ref fileselector_entry_example
6484 * @see @ref File_Selector_Button for a similar widget.
6489 * Add a new file selector entry widget to the given parent
6490 * Elementary (container) object
6492 * @param parent The parent object
6493 * @return a new file selector entry widget handle or @c NULL, on
6496 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6499 * Set the label for a given file selector entry widget's button
6501 * @param obj The file selector entry widget
6502 * @param label The text label to be displayed on @p obj widget's
6505 * @deprecated use elm_object_text_set() instead.
6507 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6510 * Get the label set for a given file selector entry widget's button
6512 * @param obj The file selector entry widget
6513 * @return The widget button's label
6515 * @deprecated use elm_object_text_set() instead.
6517 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6520 * Set the icon on a given file selector entry widget's button
6522 * @param obj The file selector entry widget
6523 * @param icon The icon object for the entry's button
6525 * Once the icon object is set, a previously set one will be
6526 * deleted. If you want to keep the latter, use the
6527 * elm_fileselector_entry_button_icon_unset() function.
6529 * @see elm_fileselector_entry_button_icon_get()
6531 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6534 * Get the icon set for a given file selector entry widget's button
6536 * @param obj The file selector entry widget
6537 * @return The icon object currently set on @p obj widget's button
6538 * or @c NULL, if none is
6540 * @see elm_fileselector_entry_button_icon_set()
6542 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6545 * Unset the icon used in a given file selector entry widget's
6548 * @param obj The file selector entry widget
6549 * @return The icon object that was being used on @p obj widget's
6550 * button or @c NULL, on errors
6552 * Unparent and return the icon object which was set for this
6555 * @see elm_fileselector_entry_button_icon_set()
6557 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6560 * Set the title for a given file selector entry widget's window
6562 * @param obj The file selector entry widget
6563 * @param title The title string
6565 * This will change the window's title, when the file selector pops
6566 * out after a click on the entry's button. Those windows have the
6567 * default (unlocalized) value of @c "Select a file" as titles.
6569 * @note It will only take any effect if the file selector
6570 * entry widget is @b not under "inwin mode".
6572 * @see elm_fileselector_entry_window_title_get()
6574 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6577 * Get the title set for a given file selector entry widget's
6580 * @param obj The file selector entry widget
6581 * @return Title of the file selector entry's window
6583 * @see elm_fileselector_entry_window_title_get() for more details
6585 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6588 * Set the size of a given file selector entry widget's window,
6589 * holding the file selector itself.
6591 * @param obj The file selector entry widget
6592 * @param width The window's width
6593 * @param height The window's height
6595 * @note it will only take any effect if the file selector entry
6596 * widget is @b not under "inwin mode". The default size for the
6597 * window (when applicable) is 400x400 pixels.
6599 * @see elm_fileselector_entry_window_size_get()
6601 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6604 * Get the size of a given file selector entry widget's window,
6605 * holding the file selector itself.
6607 * @param obj The file selector entry widget
6608 * @param width Pointer into which to store the width value
6609 * @param height Pointer into which to store the height value
6611 * @note Use @c NULL pointers on the size values you're not
6612 * interested in: they'll be ignored by the function.
6614 * @see elm_fileselector_entry_window_size_set(), for more details
6616 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6619 * Set the initial file system path and the entry's path string for
6620 * a given file selector entry widget
6622 * @param obj The file selector entry widget
6623 * @param path The path string
6625 * It must be a <b>directory</b> path, which will have the contents
6626 * displayed initially in the file selector's view, when invoked
6627 * from @p obj. The default initial path is the @c "HOME"
6628 * environment variable's value.
6630 * @see elm_fileselector_entry_path_get()
6632 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6635 * Get the entry's path string for a given file selector entry
6638 * @param obj The file selector entry widget
6639 * @return path The path string
6641 * @see elm_fileselector_entry_path_set() for more details
6643 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6646 * Enable/disable a tree view in the given file selector entry
6647 * widget's internal file selector
6649 * @param obj The file selector entry widget
6650 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6653 * This has the same effect as elm_fileselector_expandable_set(),
6654 * but now applied to a file selector entry's internal file
6657 * @note There's no way to put a file selector entry's internal
6658 * file selector in "grid mode", as one may do with "pure" file
6661 * @see elm_fileselector_expandable_get()
6663 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6666 * Get whether tree view is enabled for the given file selector
6667 * entry widget's internal file selector
6669 * @param obj The file selector entry widget
6670 * @return @c EINA_TRUE if @p obj widget's internal file selector
6671 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6673 * @see elm_fileselector_expandable_set() for more details
6675 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6678 * Set whether a given file selector entry widget's internal file
6679 * selector is to display folders only or the directory contents,
6682 * @param obj The file selector entry widget
6683 * @param only @c EINA_TRUE to make @p obj widget's internal file
6684 * selector only display directories, @c EINA_FALSE to make files
6685 * to be displayed in it too
6687 * This has the same effect as elm_fileselector_folder_only_set(),
6688 * but now applied to a file selector entry's internal file
6691 * @see elm_fileselector_folder_only_get()
6693 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6696 * Get whether a given file selector entry widget's internal file
6697 * selector is displaying folders only or the directory contents,
6700 * @param obj The file selector entry widget
6701 * @return @c EINA_TRUE if @p obj widget's internal file
6702 * selector is only displaying directories, @c EINA_FALSE if files
6703 * are being displayed in it too (and on errors)
6705 * @see elm_fileselector_entry_folder_only_set() for more details
6707 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6710 * Enable/disable the file name entry box where the user can type
6711 * in a name for a file, in a given file selector entry widget's
6712 * internal file selector.
6714 * @param obj The file selector entry widget
6715 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6716 * file selector a "saving dialog", @c EINA_FALSE otherwise
6718 * This has the same effect as elm_fileselector_is_save_set(),
6719 * but now applied to a file selector entry's internal file
6722 * @see elm_fileselector_is_save_get()
6724 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6727 * Get whether the given file selector entry widget's internal
6728 * file selector is in "saving dialog" mode
6730 * @param obj The file selector entry widget
6731 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6732 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6735 * @see elm_fileselector_entry_is_save_set() for more details
6737 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6740 * Set whether a given file selector entry widget's internal file
6741 * selector will raise an Elementary "inner window", instead of a
6742 * dedicated Elementary window. By default, it won't.
6744 * @param obj The file selector entry widget
6745 * @param value @c EINA_TRUE to make it use an inner window, @c
6746 * EINA_TRUE to make it use a dedicated window
6748 * @see elm_win_inwin_add() for more information on inner windows
6749 * @see elm_fileselector_entry_inwin_mode_get()
6751 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6754 * Get whether a given file selector entry widget's internal file
6755 * selector will raise an Elementary "inner window", instead of a
6756 * dedicated Elementary window.
6758 * @param obj The file selector entry widget
6759 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6760 * if it will use a dedicated window
6762 * @see elm_fileselector_entry_inwin_mode_set() for more details
6764 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6767 * Set the initial file system path for a given file selector entry
6770 * @param obj The file selector entry widget
6771 * @param path The path string
6773 * It must be a <b>directory</b> path, which will have the contents
6774 * displayed initially in the file selector's view, when invoked
6775 * from @p obj. The default initial path is the @c "HOME"
6776 * environment variable's value.
6778 * @see elm_fileselector_entry_path_get()
6780 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6783 * Get the parent directory's path to the latest file selection on
6784 * a given filer selector entry widget
6786 * @param obj The file selector object
6787 * @return The (full) path of the directory of the last selection
6788 * on @p obj widget, a @b stringshared string
6790 * @see elm_fileselector_entry_path_set()
6792 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6799 * @defgroup Scroller Scroller
6801 * A scroller holds a single object and "scrolls it around". This means that
6802 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6803 * region around, allowing to move through a much larger object that is
6804 * contained in the scroller. The scroiller will always have a small minimum
6805 * size by default as it won't be limited by the contents of the scroller.
6807 * Signals that you can add callbacks for are:
6808 * @li "edge,left" - the left edge of the content has been reached
6809 * @li "edge,right" - the right edge of the content has been reached
6810 * @li "edge,top" - the top edge of the content has been reached
6811 * @li "edge,bottom" - the bottom edge of the content has been reached
6812 * @li "scroll" - the content has been scrolled (moved)
6813 * @li "scroll,anim,start" - scrolling animation has started
6814 * @li "scroll,anim,stop" - scrolling animation has stopped
6815 * @li "scroll,drag,start" - dragging the contents around has started
6816 * @li "scroll,drag,stop" - dragging the contents around has stopped
6817 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6820 * @note When Elemementary is in embedded mode the scrollbars will not be
6821 * dragable, they appear merely as indicators of how much has been scrolled.
6822 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6823 * fingerscroll) won't work.
6825 * In @ref tutorial_scroller you'll find an example of how to use most of
6830 * @brief Type that controls when scrollbars should appear.
6832 * @see elm_scroller_policy_set()
6834 typedef enum _Elm_Scroller_Policy
6836 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6837 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6838 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6839 ELM_SCROLLER_POLICY_LAST
6840 } Elm_Scroller_Policy;
6842 * @brief Add a new scroller to the parent
6844 * @param parent The parent object
6845 * @return The new object or NULL if it cannot be created
6847 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6849 * @brief Set the content of the scroller widget (the object to be scrolled around).
6851 * @param obj The scroller object
6852 * @param content The new content object
6854 * Once the content object is set, a previously set one will be deleted.
6855 * If you want to keep that old content object, use the
6856 * elm_scroller_content_unset() function.
6858 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6860 * @brief Get the content of the scroller widget
6862 * @param obj The slider object
6863 * @return The content that is being used
6865 * Return the content object which is set for this widget
6867 * @see elm_scroller_content_set()
6869 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6871 * @brief Unset the content of the scroller widget
6873 * @param obj The slider object
6874 * @return The content that was being used
6876 * Unparent and return the content object which was set for this widget
6878 * @see elm_scroller_content_set()
6880 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6882 * @brief Set custom theme elements for the scroller
6884 * @param obj The scroller object
6885 * @param widget The widget name to use (default is "scroller")
6886 * @param base The base name to use (default is "base")
6888 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6890 * @brief Make the scroller minimum size limited to the minimum size of the content
6892 * @param obj The scroller object
6893 * @param w Enable limiting minimum size horizontally
6894 * @param h Enable limiting minimum size vertically
6896 * By default the scroller will be as small as its design allows,
6897 * irrespective of its content. This will make the scroller minimum size the
6898 * right size horizontally and/or vertically to perfectly fit its content in
6901 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6903 * @brief Show a specific virtual region within the scroller content object
6905 * @param obj The scroller object
6906 * @param x X coordinate of the region
6907 * @param y Y coordinate of the region
6908 * @param w Width of the region
6909 * @param h Height of the region
6911 * This will ensure all (or part if it does not fit) of the designated
6912 * region in the virtual content object (0, 0 starting at the top-left of the
6913 * virtual content object) is shown within the scroller.
6915 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);
6917 * @brief Set the scrollbar visibility policy
6919 * @param obj The scroller object
6920 * @param policy_h Horizontal scrollbar policy
6921 * @param policy_v Vertical scrollbar policy
6923 * This sets the scrollbar visibility policy for the given scroller.
6924 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6925 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6926 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6927 * respectively for the horizontal and vertical scrollbars.
6929 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6931 * @brief Gets scrollbar visibility policy
6933 * @param obj The scroller object
6934 * @param policy_h Horizontal scrollbar policy
6935 * @param policy_v Vertical scrollbar policy
6937 * @see elm_scroller_policy_set()
6939 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6941 * @brief Get the currently visible content region
6943 * @param obj The scroller object
6944 * @param x X coordinate of the region
6945 * @param y Y coordinate of the region
6946 * @param w Width of the region
6947 * @param h Height of the region
6949 * This gets the current region in the content object that is visible through
6950 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6951 * w, @p h values pointed to.
6953 * @note All coordinates are relative to the content.
6955 * @see elm_scroller_region_show()
6957 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);
6959 * @brief Get the size of the content object
6961 * @param obj The scroller object
6962 * @param w Width return
6963 * @param h Height return
6965 * This gets the size of the content object of the scroller.
6967 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6969 * @brief Set bouncing behavior
6971 * @param obj The scroller object
6972 * @param h_bounce Will the scroller bounce horizontally or not
6973 * @param v_bounce Will the scroller bounce vertically or not
6975 * When scrolling, the scroller may "bounce" when reaching an edge of the
6976 * content object. This is a visual way to indicate the end has been reached.
6977 * This is enabled by default for both axis. This will set if it is enabled
6978 * for that axis with the boolean parameters for each axis.
6980 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6982 * @brief Get the bounce mode
6984 * @param obj The Scroller object
6985 * @param h_bounce Allow bounce horizontally
6986 * @param v_bounce Allow bounce vertically
6988 * @see elm_scroller_bounce_set()
6990 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6992 * @brief Set scroll page size relative to viewport size.
6994 * @param obj The scroller object
6995 * @param h_pagerel The horizontal page relative size
6996 * @param v_pagerel The vertical page relative size
6998 * The scroller is capable of limiting scrolling by the user to "pages". That
6999 * is to jump by and only show a "whole page" at a time as if the continuous
7000 * area of the scroller content is split into page sized pieces. This sets
7001 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7002 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7003 * axis. This is mutually exclusive with page size
7004 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7005 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7006 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7009 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7011 * @brief Set scroll page size.
7013 * @param obj The scroller object
7014 * @param h_pagesize The horizontal page size
7015 * @param v_pagesize The vertical page size
7017 * This sets the page size to an absolute fixed value, with 0 turning it off
7020 * @see elm_scroller_page_relative_set()
7022 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7024 * @brief Get scroll current page number.
7026 * @param obj The scroller object
7027 * @param h_pagenumber The horizoptal page number
7028 * @param v_pagenumber The vertical page number
7030 * The page number starts from 0. 0 is the first page.
7031 * Current page means the page which meet the top-left of the viewport.
7032 * If there are two or more pages in the viewport, it returns the number of page
7033 * which meet the top-left of the viewport.
7035 * @see elm_scroller_last_page_get()
7036 * @see elm_scroller_page_show()
7037 * @see elm_scroller_page_brint_in()
7039 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7041 * @brief Get scroll last page number.
7043 * @param obj The scroller object
7044 * @param h_pagenumber The horizoptal page number
7045 * @param v_pagenumber The vertical page number
7047 * The page number starts from 0. 0 is the first page.
7048 * This returns the last page number among the pages.
7050 * @see elm_scroller_current_page_get()
7051 * @see elm_scroller_page_show()
7052 * @see elm_scroller_page_brint_in()
7054 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7056 * Show a specific virtual region within the scroller content object by page number.
7058 * @param obj The scroller object
7059 * @param h_pagenumber The horizoptal page number
7060 * @param v_pagenumber The vertical page number
7062 * 0, 0 of the indicated page is located at the top-left of the viewport.
7063 * This will jump to the page directly without animation.
7068 * sc = elm_scroller_add(win);
7069 * elm_scroller_content_set(sc, content);
7070 * elm_scroller_page_relative_set(sc, 1, 0);
7071 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7072 * elm_scroller_page_show(sc, h_page + 1, v_page);
7075 * @see elm_scroller_page_bring_in()
7077 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7079 * Show a specific virtual region within the scroller content object by page number.
7081 * @param obj The scroller object
7082 * @param h_pagenumber The horizoptal page number
7083 * @param v_pagenumber The vertical page number
7085 * 0, 0 of the indicated page is located at the top-left of the viewport.
7086 * This will slide to the page with animation.
7091 * sc = elm_scroller_add(win);
7092 * elm_scroller_content_set(sc, content);
7093 * elm_scroller_page_relative_set(sc, 1, 0);
7094 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7095 * elm_scroller_page_bring_in(sc, h_page, v_page);
7098 * @see elm_scroller_page_show()
7100 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7102 * @brief Show a specific virtual region within the scroller content object.
7104 * @param obj The scroller object
7105 * @param x X coordinate of the region
7106 * @param y Y coordinate of the region
7107 * @param w Width of the region
7108 * @param h Height of the region
7110 * This will ensure all (or part if it does not fit) of the designated
7111 * region in the virtual content object (0, 0 starting at the top-left of the
7112 * virtual content object) is shown within the scroller. Unlike
7113 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7114 * to this location (if configuration in general calls for transitions). It
7115 * may not jump immediately to the new location and make take a while and
7116 * show other content along the way.
7118 * @see elm_scroller_region_show()
7120 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);
7122 * @brief Set event propagation on a scroller
7124 * @param obj The scroller object
7125 * @param propagation If propagation is enabled or not
7127 * This enables or disabled event propagation from the scroller content to
7128 * the scroller and its parent. By default event propagation is disabled.
7130 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7132 * @brief Get event propagation for a scroller
7134 * @param obj The scroller object
7135 * @return The propagation state
7137 * This gets the event propagation for a scroller.
7139 * @see elm_scroller_propagate_events_set()
7141 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7147 * @defgroup Label Label
7149 * @image html img/widget/label/preview-00.png
7150 * @image latex img/widget/label/preview-00.eps
7152 * @brief Widget to display text, with simple html-like markup.
7154 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7155 * text doesn't fit the geometry of the label it will be ellipsized or be
7156 * cut. Elementary provides several themes for this widget:
7157 * @li default - No animation
7158 * @li marker - Centers the text in the label and make it bold by default
7159 * @li slide_long - The entire text appears from the right of the screen and
7160 * slides until it disappears in the left of the screen(reappering on the
7162 * @li slide_short - The text appears in the left of the label and slides to
7163 * the right to show the overflow. When all of the text has been shown the
7164 * position is reset.
7165 * @li slide_bounce - The text appears in the left of the label and slides to
7166 * the right to show the overflow. When all of the text has been shown the
7167 * animation reverses, moving the text to the left.
7169 * Custom themes can of course invent new markup tags and style them any way
7172 * See @ref tutorial_label for a demonstration of how to use a label widget.
7176 * @brief Add a new label to the parent
7178 * @param parent The parent object
7179 * @return The new object or NULL if it cannot be created
7181 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7183 * @brief Set the label on the label object
7185 * @param obj The label object
7186 * @param label The label will be used on the label object
7187 * @deprecated See elm_object_text_set()
7189 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 */
7191 * @brief Get the label used on the label object
7193 * @param obj The label object
7194 * @return The string inside the label
7195 * @deprecated See elm_object_text_get()
7197 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7199 * @brief Set the wrapping behavior of the label
7201 * @param obj The label object
7202 * @param wrap To wrap text or not
7204 * By default no wrapping is done. Possible values for @p wrap are:
7205 * @li ELM_WRAP_NONE - No wrapping
7206 * @li ELM_WRAP_CHAR - wrap between characters
7207 * @li ELM_WRAP_WORD - wrap between words
7208 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7210 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7212 * @brief Get the wrapping behavior of the label
7214 * @param obj The label object
7217 * @see elm_label_line_wrap_set()
7219 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7221 * @brief Set wrap width of the label
7223 * @param obj The label object
7224 * @param w The wrap width in pixels at a minimum where words need to wrap
7226 * This function sets the maximum width size hint of the label.
7228 * @warning This is only relevant if the label is inside a container.
7230 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7232 * @brief Get wrap width of the label
7234 * @param obj The label object
7235 * @return The wrap width in pixels at a minimum where words need to wrap
7237 * @see elm_label_wrap_width_set()
7239 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7241 * @brief Set wrap height of the label
7243 * @param obj The label object
7244 * @param h The wrap height in pixels at a minimum where words need to wrap
7246 * This function sets the maximum height size hint of the label.
7248 * @warning This is only relevant if the label is inside a container.
7250 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7252 * @brief get wrap width of the label
7254 * @param obj The label object
7255 * @return The wrap height in pixels at a minimum where words need to wrap
7257 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7259 * @brief Set the font size on the label object.
7261 * @param obj The label object
7262 * @param size font size
7264 * @warning NEVER use this. It is for hyper-special cases only. use styles
7265 * instead. e.g. "big", "medium", "small" - or better name them by use:
7266 * "title", "footnote", "quote" etc.
7268 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7270 * @brief Set the text color on the label object
7272 * @param obj The label object
7273 * @param r Red property background color of The label object
7274 * @param g Green property background color of The label object
7275 * @param b Blue property background color of The label object
7276 * @param a Alpha property background color of The label object
7278 * @warning NEVER use this. It is for hyper-special cases only. use styles
7279 * instead. e.g. "big", "medium", "small" - or better name them by use:
7280 * "title", "footnote", "quote" etc.
7282 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);
7284 * @brief Set the text align on the label object
7286 * @param obj The label object
7287 * @param align align mode ("left", "center", "right")
7289 * @warning NEVER use this. It is for hyper-special cases only. use styles
7290 * instead. e.g. "big", "medium", "small" - or better name them by use:
7291 * "title", "footnote", "quote" etc.
7293 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7295 * @brief Set background color of the label
7297 * @param obj The label object
7298 * @param r Red property background color of The label object
7299 * @param g Green property background color of The label object
7300 * @param b Blue property background color of The label object
7301 * @param a Alpha property background alpha of The label object
7303 * @warning NEVER use this. It is for hyper-special cases only. use styles
7304 * instead. e.g. "big", "medium", "small" - or better name them by use:
7305 * "title", "footnote", "quote" etc.
7307 EAPI void elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7309 * @brief Set the ellipsis behavior of the label
7311 * @param obj The label object
7312 * @param ellipsis To ellipsis text or not
7314 * If set to true and the text doesn't fit in the label an ellipsis("...")
7315 * will be shown at the end of the widget.
7317 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7318 * choosen wrap method was ELM_WRAP_WORD.
7320 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7322 * @brief Set the text slide of the label
7324 * @param obj The label object
7325 * @param slide To start slide or stop
7327 * If set to true the text of the label will slide throught the length of
7330 * @warning This only work with the themes "slide_short", "slide_long" and
7333 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7335 * @brief Get the text slide mode of the label
7337 * @param obj The label object
7338 * @return slide slide mode value
7340 * @see elm_label_slide_set()
7342 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7344 * @brief Set the slide duration(speed) of the label
7346 * @param obj The label object
7347 * @return The duration in seconds in moving text from slide begin position
7348 * to slide end position
7350 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7352 * @brief Get the slide duration(speed) of the label
7354 * @param obj The label object
7355 * @return The duration time in moving text from slide begin position to slide end position
7357 * @see elm_label_slide_duration_set()
7359 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7365 * @defgroup Toggle Toggle
7367 * @image html img/widget/toggle/preview-00.png
7368 * @image latex img/widget/toggle/preview-00.eps
7370 * @brief A toggle is a slider which can be used to toggle between
7371 * two values. It has two states: on and off.
7373 * Signals that you can add callbacks for are:
7374 * @li "changed" - Whenever the toggle value has been changed. Is not called
7375 * until the toggle is released by the cursor (assuming it
7376 * has been triggered by the cursor in the first place).
7378 * @ref tutorial_toggle show how to use a toggle.
7382 * @brief Add a toggle to @p parent.
7384 * @param parent The parent object
7386 * @return The toggle object
7388 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7390 * @brief Sets the label to be displayed with the toggle.
7392 * @param obj The toggle object
7393 * @param label The label to be displayed
7395 * @deprecated use elm_object_text_set() instead.
7397 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7399 * @brief Gets the label of the toggle
7401 * @param obj toggle object
7402 * @return The label of the toggle
7404 * @deprecated use elm_object_text_get() instead.
7406 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7408 * @brief Set the icon used for the toggle
7410 * @param obj The toggle object
7411 * @param icon The icon object for the button
7413 * Once the icon object is set, a previously set one will be deleted
7414 * If you want to keep that old content object, use the
7415 * elm_toggle_icon_unset() function.
7417 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7419 * @brief Get the icon used for the toggle
7421 * @param obj The toggle object
7422 * @return The icon object that is being used
7424 * Return the icon object which is set for this widget.
7426 * @see elm_toggle_icon_set()
7428 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7430 * @brief Unset the icon used for the toggle
7432 * @param obj The toggle object
7433 * @return The icon object that was being used
7435 * Unparent and return the icon object which was set for this widget.
7437 * @see elm_toggle_icon_set()
7439 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7441 * @brief Sets the labels to be associated with the on and off states of the toggle.
7443 * @param obj The toggle object
7444 * @param onlabel The label displayed when the toggle is in the "on" state
7445 * @param offlabel The label displayed when the toggle is in the "off" state
7447 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7449 * @brief Gets the labels associated with the on and off states of the toggle.
7451 * @param obj The toggle object
7452 * @param onlabel A char** to place the onlabel of @p obj into
7453 * @param offlabel A char** to place the offlabel of @p obj into
7455 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7457 * @brief Sets the state of the toggle to @p state.
7459 * @param obj The toggle object
7460 * @param state The state of @p obj
7462 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7464 * @brief Gets the state of the toggle to @p state.
7466 * @param obj The toggle object
7467 * @return The state of @p obj
7469 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7471 * @brief Sets the state pointer of the toggle to @p statep.
7473 * @param obj The toggle object
7474 * @param statep The state pointer of @p obj
7476 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7482 * @defgroup Frame Frame
7484 * @image html img/widget/frame/preview-00.png
7485 * @image latex img/widget/frame/preview-00.eps
7487 * @brief Frame is a widget that holds some content and has a title.
7489 * The default look is a frame with a title, but Frame supports multple
7497 * @li outdent_bottom
7499 * Of all this styles only default shows the title. Frame emits no signals.
7501 * For a detailed example see the @ref tutorial_frame.
7506 * @brief Add a new frame to the parent
7508 * @param parent The parent object
7509 * @return The new object or NULL if it cannot be created
7511 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7513 * @brief Set the frame label
7515 * @param obj The frame object
7516 * @param label The label of this frame object
7518 * @deprecated use elm_object_text_set() instead.
7520 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7522 * @brief Get the frame label
7524 * @param obj The frame object
7526 * @return The label of this frame objet or NULL if unable to get frame
7528 * @deprecated use elm_object_text_get() instead.
7530 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7532 * @brief Set the content of the frame widget
7534 * Once the content object is set, a previously set one will be deleted.
7535 * If you want to keep that old content object, use the
7536 * elm_frame_content_unset() function.
7538 * @param obj The frame object
7539 * @param content The content will be filled in this frame object
7541 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7543 * @brief Get the content of the frame widget
7545 * Return the content object which is set for this widget
7547 * @param obj The frame object
7548 * @return The content that is being used
7550 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7552 * @brief Unset the content of the frame widget
7554 * Unparent and return the content object which was set for this widget
7556 * @param obj The frame object
7557 * @return The content that was being used
7559 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7565 * @defgroup Table Table
7567 * A container widget to arrange other widgets in a table where items can
7568 * also span multiple columns or rows - even overlap (and then be raised or
7569 * lowered accordingly to adjust stacking if they do overlap).
7571 * The followin are examples of how to use a table:
7572 * @li @ref tutorial_table_01
7573 * @li @ref tutorial_table_02
7578 * @brief Add a new table to the parent
7580 * @param parent The parent object
7581 * @return The new object or NULL if it cannot be created
7583 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7585 * @brief Set the homogeneous layout in the table
7587 * @param obj The layout object
7588 * @param homogeneous A boolean to set if the layout is homogeneous in the
7589 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7591 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7593 * @brief Get the current table homogeneous mode.
7595 * @param obj The table object
7596 * @return A boolean to indicating if the layout is homogeneous in the table
7597 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7599 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7601 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7603 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7605 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7607 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7609 * @brief Set padding between cells.
7611 * @param obj The layout object.
7612 * @param horizontal set the horizontal padding.
7613 * @param vertical set the vertical padding.
7615 * Default value is 0.
7617 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7619 * @brief Get padding between cells.
7621 * @param obj The layout object.
7622 * @param horizontal set the horizontal padding.
7623 * @param vertical set the vertical padding.
7625 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7627 * @brief Add a subobject on the table with the coordinates passed
7629 * @param obj The table object
7630 * @param subobj The subobject to be added to the table
7631 * @param x Row number
7632 * @param y Column number
7636 * @note All positioning inside the table is relative to rows and columns, so
7637 * a value of 0 for x and y, means the top left cell of the table, and a
7638 * value of 1 for w and h means @p subobj only takes that 1 cell.
7640 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7642 * @brief Remove child from table.
7644 * @param obj The table object
7645 * @param subobj The subobject
7647 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7649 * @brief Faster way to remove all child objects from a table object.
7651 * @param obj The table object
7652 * @param clear If true, will delete children, else just remove from table.
7654 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7656 * @brief Set the packing location of an existing child of the table
7658 * @param subobj The subobject to be modified in the table
7659 * @param x Row number
7660 * @param y Column number
7664 * Modifies the position of an object already in the table.
7666 * @note All positioning inside the table is relative to rows and columns, so
7667 * a value of 0 for x and y, means the top left cell of the table, and a
7668 * value of 1 for w and h means @p subobj only takes that 1 cell.
7670 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7672 * @brief Get the packing location of an existing child of the table
7674 * @param subobj The subobject to be modified in the table
7675 * @param x Row number
7676 * @param y Column number
7680 * @see elm_table_pack_set()
7682 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7688 * @defgroup Gengrid Gengrid (Generic grid)
7690 * This widget aims to position objects in a grid layout while
7691 * actually creating and rendering only the visible ones, using the
7692 * same idea as the @ref Genlist "genlist": the user defines a @b
7693 * class for each item, specifying functions that will be called at
7694 * object creation, deletion, etc. When those items are selected by
7695 * the user, a callback function is issued. Users may interact with
7696 * a gengrid via the mouse (by clicking on items to select them and
7697 * clicking on the grid's viewport and swiping to pan the whole
7698 * view) or via the keyboard, navigating through item with the
7701 * @section Gengrid_Layouts Gengrid layouts
7703 * Gengrids may layout its items in one of two possible layouts:
7707 * When in "horizontal mode", items will be placed in @b columns,
7708 * from top to bottom and, when the space for a column is filled,
7709 * another one is started on the right, thus expanding the grid
7710 * horizontally, making for horizontal scrolling. When in "vertical
7711 * mode" , though, items will be placed in @b rows, from left to
7712 * right and, when the space for a row is filled, another one is
7713 * started below, thus expanding the grid vertically (and making
7714 * for vertical scrolling).
7716 * @section Gengrid_Items Gengrid items
7718 * An item in a gengrid can have 0 or more text labels (they can be
7719 * regular text or textblock Evas objects - that's up to the style
7720 * to determine), 0 or more icons (which are simply objects
7721 * swallowed into the gengrid item's theming Edje object) and 0 or
7722 * more <b>boolean states</b>, which have the behavior left to the
7723 * user to define. The Edje part names for each of these properties
7724 * will be looked up, in the theme file for the gengrid, under the
7725 * Edje (string) data items named @c "labels", @c "icons" and @c
7726 * "states", respectively. For each of those properties, if more
7727 * than one part is provided, they must have names listed separated
7728 * by spaces in the data fields. For the default gengrid item
7729 * theme, we have @b one label part (@c "elm.text"), @b two icon
7730 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7733 * A gengrid item may be at one of several styles. Elementary
7734 * provides one by default - "default", but this can be extended by
7735 * system or application custom themes/overlays/extensions (see
7736 * @ref Theme "themes" for more details).
7738 * @section Gengrid_Item_Class Gengrid item classes
7740 * In order to have the ability to add and delete items on the fly,
7741 * gengrid implements a class (callback) system where the
7742 * application provides a structure with information about that
7743 * type of item (gengrid may contain multiple different items with
7744 * different classes, states and styles). Gengrid will call the
7745 * functions in this struct (methods) when an item is "realized"
7746 * (i.e., created dynamically, while the user is scrolling the
7747 * grid). All objects will simply be deleted when no longer needed
7748 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7749 * contains the following members:
7750 * - @c item_style - This is a constant string and simply defines
7751 * the name of the item style. It @b must be specified and the
7752 * default should be @c "default".
7753 * - @c func.label_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 existing text parts in the Edje group implementing the
7759 * item's theme. This function @b must return a strdup'()ed string,
7760 * as the caller will free() it when done. See
7761 * #Elm_Gengrid_Item_Label_Get_Cb.
7762 * - @c func.icon_get - This function is called when an item object
7763 * is actually created. The @c data parameter will point to the
7764 * same data passed to elm_gengrid_item_append() and related item
7765 * creation functions. The @c obj parameter is the gengrid object
7766 * itself, while the @c part one is the name string of one of the
7767 * existing (icon) swallow parts in the Edje group implementing the
7768 * item's theme. It must return @c NULL, when no icon is desired,
7769 * or a valid object handle, otherwise. The object will be deleted
7770 * by the gengrid on its deletion or when the item is "unrealized".
7771 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7772 * - @c func.state_get - This function is called when an item
7773 * object is actually created. The @c data parameter will point to
7774 * the same data passed to elm_gengrid_item_append() and related
7775 * item creation functions. The @c obj parameter is the gengrid
7776 * object itself, while the @c part one is the name string of one
7777 * of the state parts in the Edje group implementing the item's
7778 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7779 * true/on. Gengrids will emit a signal to its theming Edje object
7780 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7781 * "source" arguments, respectively, when the state is true (the
7782 * default is false), where @c XXX is the name of the (state) part.
7783 * See #Elm_Gengrid_Item_State_Get_Cb.
7784 * - @c func.del - This is called when elm_gengrid_item_del() is
7785 * called on an item or elm_gengrid_clear() is called on the
7786 * gengrid. This is intended for use when gengrid items are
7787 * deleted, so any data attached to the item (e.g. its data
7788 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7790 * @section Gengrid_Usage_Hints Usage hints
7792 * If the user wants to have multiple items selected at the same
7793 * time, elm_gengrid_multi_select_set() will permit it. If the
7794 * gengrid is single-selection only (the default), then
7795 * elm_gengrid_select_item_get() will return the selected item or
7796 * @c NULL, if none is selected. If the gengrid is under
7797 * multi-selection, then elm_gengrid_selected_items_get() will
7798 * return a list (that is only valid as long as no items are
7799 * modified (added, deleted, selected or unselected) of child items
7802 * If an item changes (internal (boolean) state, label or icon
7803 * changes), then use elm_gengrid_item_update() to have gengrid
7804 * update the item with the new state. A gengrid will re-"realize"
7805 * the item, thus calling the functions in the
7806 * #Elm_Gengrid_Item_Class set for that item.
7808 * To programmatically (un)select an item, use
7809 * elm_gengrid_item_selected_set(). To get its selected state use
7810 * elm_gengrid_item_selected_get(). To make an item disabled
7811 * (unable to be selected and appear differently) use
7812 * elm_gengrid_item_disabled_set() to set this and
7813 * elm_gengrid_item_disabled_get() to get the disabled state.
7815 * Grid cells will only have their selection smart callbacks called
7816 * when firstly getting selected. Any further clicks will do
7817 * nothing, unless you enable the "always select mode", with
7818 * elm_gengrid_always_select_mode_set(), thus making every click to
7819 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7820 * turn off the ability to select items entirely in the widget and
7821 * they will neither appear selected nor call the selection smart
7824 * Remember that you can create new styles and add your own theme
7825 * augmentation per application with elm_theme_extension_add(). If
7826 * you absolutely must have a specific style that overrides any
7827 * theme the user or system sets up you can use
7828 * elm_theme_overlay_add() to add such a file.
7830 * @section Gengrid_Smart_Events Gengrid smart events
7832 * Smart events that you can add callbacks for are:
7833 * - @c "activated" - The user has double-clicked or pressed
7834 * (enter|return|spacebar) on an item. The @c event_info parameter
7835 * is the gengrid item that was activated.
7836 * - @c "clicked,double" - The user has double-clicked an item.
7837 * The @c event_info parameter is the gengrid item that was double-clicked.
7838 * - @c "selected" - The user has made an item selected. The
7839 * @c event_info parameter is the gengrid item that was selected.
7840 * - @c "unselected" - The user has made an item unselected. The
7841 * @c event_info parameter is the gengrid item that was unselected.
7842 * - @c "realized" - This is called when the item in the gengrid
7843 * has its implementing Evas object instantiated, de facto. @c
7844 * event_info is the gengrid item that was created. The object
7845 * may be deleted at any time, so it is highly advised to the
7846 * caller @b not to use the object pointer returned from
7847 * elm_gengrid_item_object_get(), because it may point to freed
7849 * - @c "unrealized" - This is called when the implementing Evas
7850 * object for this item is deleted. @c event_info is the gengrid
7851 * item that was deleted.
7852 * - @c "changed" - Called when an item is added, removed, resized
7853 * or moved and when the gengrid is resized or gets "horizontal"
7855 * - @c "scroll,anim,start" - This is called when scrolling animation has
7857 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7859 * - @c "drag,start,up" - Called when the item in the gengrid has
7860 * been dragged (not scrolled) up.
7861 * - @c "drag,start,down" - Called when the item in the gengrid has
7862 * been dragged (not scrolled) down.
7863 * - @c "drag,start,left" - Called when the item in the gengrid has
7864 * been dragged (not scrolled) left.
7865 * - @c "drag,start,right" - Called when the item in the gengrid has
7866 * been dragged (not scrolled) right.
7867 * - @c "drag,stop" - Called when the item in the gengrid has
7868 * stopped being dragged.
7869 * - @c "drag" - Called when the item in the gengrid is being
7871 * - @c "scroll" - called when the content has been scrolled
7873 * - @c "scroll,drag,start" - called when dragging the content has
7875 * - @c "scroll,drag,stop" - called when dragging the content has
7878 * List of gendrid examples:
7879 * @li @ref gengrid_example
7883 * @addtogroup Gengrid
7887 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7888 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7889 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7890 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7891 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. */
7892 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. */
7893 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7895 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7896 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7897 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7898 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7901 * @struct _Elm_Gengrid_Item_Class
7903 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7906 struct _Elm_Gengrid_Item_Class
7908 const char *item_style;
7909 struct _Elm_Gengrid_Item_Class_Func
7911 Elm_Gengrid_Item_Label_Get_Cb label_get;
7912 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7913 Elm_Gengrid_Item_State_Get_Cb state_get;
7914 Elm_Gengrid_Item_Del_Cb del;
7916 }; /**< #Elm_Gengrid_Item_Class member definitions */
7919 * Add a new gengrid widget to the given parent Elementary
7920 * (container) object
7922 * @param parent The parent object
7923 * @return a new gengrid widget handle or @c NULL, on errors
7925 * This function inserts a new gengrid widget on the canvas.
7927 * @see elm_gengrid_item_size_set()
7928 * @see elm_gengrid_group_item_size_set()
7929 * @see elm_gengrid_horizontal_set()
7930 * @see elm_gengrid_item_append()
7931 * @see elm_gengrid_item_del()
7932 * @see elm_gengrid_clear()
7936 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7939 * Set the size for the items of a given gengrid widget
7941 * @param obj The gengrid object.
7942 * @param w The items' width.
7943 * @param h The items' height;
7945 * A gengrid, after creation, has still no information on the size
7946 * to give to each of its cells. So, you most probably will end up
7947 * with squares one @ref Fingers "finger" wide, the default
7948 * size. Use this function to force a custom size for you items,
7949 * making them as big as you wish.
7951 * @see elm_gengrid_item_size_get()
7955 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7958 * Get the size set for the items of a given gengrid widget
7960 * @param obj The gengrid object.
7961 * @param w Pointer to a variable where to store the items' width.
7962 * @param h Pointer to a variable where to store the items' height.
7964 * @note Use @c NULL pointers on the size values you're not
7965 * interested in: they'll be ignored by the function.
7967 * @see elm_gengrid_item_size_get() for more details
7971 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7974 * Set the size for the group items of a given gengrid widget
7976 * @param obj The gengrid object.
7977 * @param w The group items' width.
7978 * @param h The group items' height;
7980 * A gengrid, after creation, has still no information on the size
7981 * to give to each of its cells. So, you most probably will end up
7982 * with squares one @ref Fingers "finger" wide, the default
7983 * size. Use this function to force a custom size for you group items,
7984 * making them as big as you wish.
7986 * @see elm_gengrid_group_item_size_get()
7990 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7993 * Get the size set for the group items of a given gengrid widget
7995 * @param obj The gengrid object.
7996 * @param w Pointer to a variable where to store the group items' width.
7997 * @param h Pointer to a variable where to store the group items' height.
7999 * @note Use @c NULL pointers on the size values you're not
8000 * interested in: they'll be ignored by the function.
8002 * @see elm_gengrid_group_item_size_get() for more details
8006 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8009 * Set the items grid's alignment within a given gengrid widget
8011 * @param obj The gengrid object.
8012 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8013 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8015 * This sets the alignment of the whole grid of items of a gengrid
8016 * within its given viewport. By default, those values are both
8017 * 0.5, meaning that the gengrid will have its items grid placed
8018 * exactly in the middle of its viewport.
8020 * @note If given alignment values are out of the cited ranges,
8021 * they'll be changed to the nearest boundary values on the valid
8024 * @see elm_gengrid_align_get()
8028 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8031 * Get the items grid's alignment values within a given gengrid
8034 * @param obj The gengrid object.
8035 * @param align_x Pointer to a variable where to store the
8036 * horizontal alignment.
8037 * @param align_y Pointer to a variable where to store the vertical
8040 * @note Use @c NULL pointers on the alignment values you're not
8041 * interested in: they'll be ignored by the function.
8043 * @see elm_gengrid_align_set() for more details
8047 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8050 * Set whether a given gengrid widget is or not able have items
8053 * @param obj The gengrid object
8054 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8055 * @c EINA_FALSE to turn it off
8057 * If a gengrid is set to allow reordering, a click held for more
8058 * than 0.5 over a given item will highlight it specially,
8059 * signalling the gengrid has entered the reordering state. From
8060 * that time on, the user will be able to, while still holding the
8061 * mouse button down, move the item freely in the gengrid's
8062 * viewport, replacing to said item to the locations it goes to.
8063 * The replacements will be animated and, whenever the user
8064 * releases the mouse button, the item being replaced gets a new
8065 * definitive place in the grid.
8067 * @see elm_gengrid_reorder_mode_get()
8071 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8074 * Get whether a given gengrid widget is or not able have items
8077 * @param obj The gengrid object
8078 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8081 * @see elm_gengrid_reorder_mode_set() for more details
8085 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8088 * Append a new item in a given gengrid widget.
8090 * @param obj The gengrid object.
8091 * @param gic The item class for the item.
8092 * @param data The item data.
8093 * @param func Convenience function called when the item is
8095 * @param func_data Data to be passed to @p func.
8096 * @return A handle to the item added or @c NULL, on errors.
8098 * This adds an item to the beginning of the gengrid.
8100 * @see elm_gengrid_item_prepend()
8101 * @see elm_gengrid_item_insert_before()
8102 * @see elm_gengrid_item_insert_after()
8103 * @see elm_gengrid_item_del()
8107 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);
8110 * Prepend a new item in a given gengrid widget.
8112 * @param obj The gengrid object.
8113 * @param gic The item class for the item.
8114 * @param data The item data.
8115 * @param func Convenience function called when the item is
8117 * @param func_data Data to be passed to @p func.
8118 * @return A handle to the item added or @c NULL, on errors.
8120 * This adds an item to the end of the gengrid.
8122 * @see elm_gengrid_item_append()
8123 * @see elm_gengrid_item_insert_before()
8124 * @see elm_gengrid_item_insert_after()
8125 * @see elm_gengrid_item_del()
8129 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);
8132 * Insert an item before another in a gengrid widget
8134 * @param obj The gengrid object.
8135 * @param gic The item class for the item.
8136 * @param data The item data.
8137 * @param relative The item to place this new one before.
8138 * @param func Convenience function called when the item is
8140 * @param func_data Data to be passed to @p func.
8141 * @return A handle to the item added or @c NULL, on errors.
8143 * This inserts an item before another in the gengrid.
8145 * @see elm_gengrid_item_append()
8146 * @see elm_gengrid_item_prepend()
8147 * @see elm_gengrid_item_insert_after()
8148 * @see elm_gengrid_item_del()
8152 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);
8155 * Insert an item after another in a gengrid widget
8157 * @param obj The gengrid object.
8158 * @param gic The item class for the item.
8159 * @param data The item data.
8160 * @param relative The item to place this new one after.
8161 * @param func Convenience function called when the item is
8163 * @param func_data Data to be passed to @p func.
8164 * @return A handle to the item added or @c NULL, on errors.
8166 * This inserts an item after another in the gengrid.
8168 * @see elm_gengrid_item_append()
8169 * @see elm_gengrid_item_prepend()
8170 * @see elm_gengrid_item_insert_after()
8171 * @see elm_gengrid_item_del()
8175 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);
8177 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);
8179 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);
8182 * Set whether items on a given gengrid widget are to get their
8183 * selection callbacks issued for @b every subsequent selection
8184 * click on them or just for the first click.
8186 * @param obj The gengrid object
8187 * @param always_select @c EINA_TRUE to make items "always
8188 * selected", @c EINA_FALSE, otherwise
8190 * By default, grid items will only call their selection callback
8191 * function when firstly getting selected, any subsequent further
8192 * clicks will do nothing. With this call, you make those
8193 * subsequent clicks also to issue the selection callbacks.
8195 * @note <b>Double clicks</b> will @b always be reported on items.
8197 * @see elm_gengrid_always_select_mode_get()
8201 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8204 * Get whether items on a given gengrid widget have their selection
8205 * callbacks issued for @b every subsequent selection click on them
8206 * or just for the first click.
8208 * @param obj The gengrid object.
8209 * @return @c EINA_TRUE if the gengrid items are "always selected",
8210 * @c EINA_FALSE, otherwise
8212 * @see elm_gengrid_always_select_mode_set() for more details
8216 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8219 * Set whether items on a given gengrid widget can be selected or not.
8221 * @param obj The gengrid object
8222 * @param no_select @c EINA_TRUE to make items selectable,
8223 * @c EINA_FALSE otherwise
8225 * This will make items in @p obj selectable or not. In the latter
8226 * case, any user interacion on the gendrid items will neither make
8227 * them appear selected nor them call their selection callback
8230 * @see elm_gengrid_no_select_mode_get()
8234 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8237 * Get whether items on a given gengrid widget can be selected or
8240 * @param obj The gengrid object
8241 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8244 * @see elm_gengrid_no_select_mode_set() for more details
8248 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8251 * Enable or disable multi-selection in a given gengrid widget
8253 * @param obj The gengrid object.
8254 * @param multi @c EINA_TRUE, to enable multi-selection,
8255 * @c EINA_FALSE to disable it.
8257 * Multi-selection is the ability for one to have @b more than one
8258 * item selected, on a given gengrid, simultaneously. When it is
8259 * enabled, a sequence of clicks on different items will make them
8260 * all selected, progressively. A click on an already selected item
8261 * will unselect it. If interecting via the keyboard,
8262 * multi-selection is enabled while holding the "Shift" key.
8264 * @note By default, multi-selection is @b disabled on gengrids
8266 * @see elm_gengrid_multi_select_get()
8270 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8273 * Get whether multi-selection is enabled or disabled for a given
8276 * @param obj The gengrid object.
8277 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8278 * EINA_FALSE otherwise
8280 * @see elm_gengrid_multi_select_set() for more details
8284 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8287 * Enable or disable bouncing effect for a given gengrid widget
8289 * @param obj The gengrid object
8290 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8291 * @c EINA_FALSE to disable it
8292 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8293 * @c EINA_FALSE to disable it
8295 * The bouncing effect occurs whenever one reaches the gengrid's
8296 * edge's while panning it -- it will scroll past its limits a
8297 * little bit and return to the edge again, in a animated for,
8300 * @note By default, gengrids have bouncing enabled on both axis
8302 * @see elm_gengrid_bounce_get()
8306 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8309 * Get whether bouncing effects are enabled or disabled, for a
8310 * given gengrid widget, on each axis
8312 * @param obj The gengrid object
8313 * @param h_bounce Pointer to a variable where to store the
8314 * horizontal bouncing flag.
8315 * @param v_bounce Pointer to a variable where to store the
8316 * vertical bouncing flag.
8318 * @see elm_gengrid_bounce_set() for more details
8322 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8325 * Set a given gengrid widget's scrolling page size, relative to
8326 * its viewport size.
8328 * @param obj The gengrid object
8329 * @param h_pagerel The horizontal page (relative) size
8330 * @param v_pagerel The vertical page (relative) size
8332 * The gengrid's scroller is capable of binding scrolling by the
8333 * user to "pages". It means that, while scrolling and, specially
8334 * after releasing the mouse button, the grid will @b snap to the
8335 * nearest displaying page's area. When page sizes are set, the
8336 * grid's continuous content area is split into (equal) page sized
8339 * This function sets the size of a page <b>relatively to the
8340 * viewport dimensions</b> of the gengrid, for each axis. A value
8341 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8342 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8343 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8344 * 1.0. Values beyond those will make it behave behave
8345 * inconsistently. If you only want one axis to snap to pages, use
8346 * the value @c 0.0 for the other one.
8348 * There is a function setting page size values in @b absolute
8349 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8350 * is mutually exclusive to this one.
8352 * @see elm_gengrid_page_relative_get()
8356 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8359 * Get a given gengrid widget's scrolling page size, relative to
8360 * its viewport size.
8362 * @param obj The gengrid object
8363 * @param h_pagerel Pointer to a variable where to store the
8364 * horizontal page (relative) size
8365 * @param v_pagerel Pointer to a variable where to store the
8366 * vertical page (relative) size
8368 * @see elm_gengrid_page_relative_set() for more details
8372 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8375 * Set a given gengrid widget's scrolling page size
8377 * @param obj The gengrid object
8378 * @param h_pagerel The horizontal page size, in pixels
8379 * @param v_pagerel The vertical page size, in pixels
8381 * The gengrid's scroller is capable of binding scrolling by the
8382 * user to "pages". It means that, while scrolling and, specially
8383 * after releasing the mouse button, the grid will @b snap to the
8384 * nearest displaying page's area. When page sizes are set, the
8385 * grid's continuous content area is split into (equal) page sized
8388 * This function sets the size of a page of the gengrid, in pixels,
8389 * for each axis. Sane usable values are, between @c 0 and the
8390 * dimensions of @p obj, for each axis. Values beyond those will
8391 * make it behave behave inconsistently. If you only want one axis
8392 * to snap to pages, use the value @c 0 for the other one.
8394 * There is a function setting page size values in @b relative
8395 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8396 * use is mutually exclusive to this one.
8400 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8403 * Set for what direction a given gengrid widget will expand while
8404 * placing its items.
8406 * @param obj The gengrid object.
8407 * @param setting @c EINA_TRUE to make the gengrid expand
8408 * horizontally, @c EINA_FALSE to expand vertically.
8410 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8411 * in @b columns, from top to bottom and, when the space for a
8412 * column is filled, another one is started on the right, thus
8413 * expanding the grid horizontally. When in "vertical mode"
8414 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8415 * to right and, when the space for a row is filled, another one is
8416 * started below, thus expanding the grid vertically.
8418 * @see elm_gengrid_horizontal_get()
8422 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8425 * Get for what direction a given gengrid widget will expand while
8426 * placing its items.
8428 * @param obj The gengrid object.
8429 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8430 * @c EINA_FALSE if it's set to expand vertically.
8432 * @see elm_gengrid_horizontal_set() for more detais
8436 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8439 * Get the first item in a given gengrid widget
8441 * @param obj The gengrid object
8442 * @return The first item's handle or @c NULL, if there are no
8443 * items in @p obj (and on errors)
8445 * This returns the first item in the @p obj's internal list of
8448 * @see elm_gengrid_last_item_get()
8452 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8455 * Get the last item in a given gengrid widget
8457 * @param obj The gengrid object
8458 * @return The last item's handle or @c NULL, if there are no
8459 * items in @p obj (and on errors)
8461 * This returns the last item in the @p obj's internal list of
8464 * @see elm_gengrid_first_item_get()
8468 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8471 * Get the @b next item in a gengrid widget's internal list of items,
8472 * given a handle to one of those items.
8474 * @param item The gengrid item to fetch next from
8475 * @return The item after @p item, or @c NULL if there's none (and
8478 * This returns the item placed after the @p item, on the container
8481 * @see elm_gengrid_item_prev_get()
8485 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8488 * Get the @b previous item in a gengrid widget's internal list of items,
8489 * given a handle to one of those items.
8491 * @param item The gengrid item to fetch previous from
8492 * @return The item before @p item, or @c NULL if there's none (and
8495 * This returns the item placed before the @p item, on the container
8498 * @see elm_gengrid_item_next_get()
8502 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8505 * Get the gengrid object's handle which contains a given gengrid
8508 * @param item The item to fetch the container from
8509 * @return The gengrid (parent) object
8511 * This returns the gengrid object itself that an item belongs to.
8515 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8518 * Remove a gengrid item from the its parent, deleting it.
8520 * @param item The item to be removed.
8521 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8523 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8528 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8531 * Update the contents of a given gengrid item
8533 * @param item The gengrid item
8535 * This updates an item by calling all the item class functions
8536 * again to get the icons, labels and states. Use this when the
8537 * original item data has changed and you want thta changes to be
8542 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8543 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8544 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8547 * Return the data associated to a given gengrid item
8549 * @param item The gengrid item.
8550 * @return the data associated to this item.
8552 * This returns the @c data value passed on the
8553 * elm_gengrid_item_append() and related item addition calls.
8555 * @see elm_gengrid_item_append()
8556 * @see elm_gengrid_item_data_set()
8560 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8563 * Set the data associated to a given gengrid item
8565 * @param item The gengrid item
8566 * @param data The new data pointer to set on it
8568 * This @b overrides the @c data value passed on the
8569 * elm_gengrid_item_append() and related item addition calls. This
8570 * function @b won't call elm_gengrid_item_update() automatically,
8571 * so you'd issue it afterwards if you want to hove the item
8572 * updated to reflect the that new data.
8574 * @see elm_gengrid_item_data_get()
8578 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8581 * Get a given gengrid item's position, relative to the whole
8582 * gengrid's grid area.
8584 * @param item The Gengrid item.
8585 * @param x Pointer to variable where to store the item's <b>row
8587 * @param y Pointer to variable where to store the item's <b>column
8590 * This returns the "logical" position of the item whithin the
8591 * gengrid. For example, @c (0, 1) would stand for first row,
8596 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8599 * Set whether a given gengrid item is selected or not
8601 * @param item The gengrid item
8602 * @param selected Use @c EINA_TRUE, to make it selected, @c
8603 * EINA_FALSE to make it unselected
8605 * This sets the selected state of an item. If multi selection is
8606 * not enabled on the containing gengrid and @p selected is @c
8607 * EINA_TRUE, any other previously selected items will get
8608 * unselected in favor of this new one.
8610 * @see elm_gengrid_item_selected_get()
8614 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8617 * Get whether a given gengrid item is selected or not
8619 * @param item The gengrid item
8620 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8622 * @see elm_gengrid_item_selected_set() for more details
8626 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8629 * Get the real Evas object created to implement the view of a
8630 * given gengrid item
8632 * @param item The gengrid item.
8633 * @return the Evas object implementing this item's view.
8635 * This returns the actual Evas object used to implement the
8636 * specified gengrid item's view. This may be @c NULL, as it may
8637 * not have been created or may have been deleted, at any time, by
8638 * the gengrid. <b>Do not modify this object</b> (move, resize,
8639 * show, hide, etc.), as the gengrid is controlling it. This
8640 * function is for querying, emitting custom signals or hooking
8641 * lower level callbacks for events on that object. Do not delete
8642 * this object under any circumstances.
8644 * @see elm_gengrid_item_data_get()
8648 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8651 * Show the portion of a gengrid's internal grid containing a given
8652 * item, @b immediately.
8654 * @param item The item to display
8656 * This causes gengrid to @b redraw its viewport's contents to the
8657 * region contining the given @p item item, if it is not fully
8660 * @see elm_gengrid_item_bring_in()
8664 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8667 * Animatedly bring in, to the visible are of a gengrid, a given
8670 * @param item The gengrid item to display
8672 * This causes gengrig to jump to the given @p item item and show
8673 * it (by scrolling), if it is not fully visible. This will use
8674 * animation to do so and take a period of time to complete.
8676 * @see elm_gengrid_item_show()
8680 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8683 * Set whether a given gengrid item is disabled or not.
8685 * @param item The gengrid item
8686 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8687 * to enable it back.
8689 * A disabled item cannot be selected or unselected. It will also
8690 * change its appearance, to signal the user it's disabled.
8692 * @see elm_gengrid_item_disabled_get()
8696 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8699 * Get whether a given gengrid item is disabled or not.
8701 * @param item The gengrid item
8702 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8705 * @see elm_gengrid_item_disabled_set() for more details
8709 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8712 * Set the text to be shown in a given gengrid item's tooltips.
8714 * @param item The gengrid item
8715 * @param text The text to set in the content
8717 * This call will setup the text to be used as tooltip to that item
8718 * (analogous to elm_object_tooltip_text_set(), but being item
8719 * tooltips with higher precedence than object tooltips). It can
8720 * have only one tooltip at a time, so any previous tooltip data
8725 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8728 * Set the content to be shown in a given gengrid item's tooltips
8730 * @param item The gengrid item.
8731 * @param func The function returning the tooltip contents.
8732 * @param data What to provide to @a func as callback data/context.
8733 * @param del_cb Called when data is not needed anymore, either when
8734 * another callback replaces @p func, the tooltip is unset with
8735 * elm_gengrid_item_tooltip_unset() or the owner @p item
8736 * dies. This callback receives as its first parameter the
8737 * given @p data, being @c event_info the item handle.
8739 * This call will setup the tooltip's contents to @p item
8740 * (analogous to elm_object_tooltip_content_cb_set(), but being
8741 * item tooltips with higher precedence than object tooltips). It
8742 * can have only one tooltip at a time, so any previous tooltip
8743 * content will get removed. @p func (with @p data) will be called
8744 * every time Elementary needs to show the tooltip and it should
8745 * return a valid Evas object, which will be fully managed by the
8746 * tooltip system, getting deleted when the tooltip is gone.
8750 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);
8753 * Unset a tooltip from a given gengrid item
8755 * @param item gengrid item to remove a previously set tooltip from.
8757 * This call removes any tooltip set on @p item. The callback
8758 * provided as @c del_cb to
8759 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8760 * notify it is not used anymore (and have resources cleaned, if
8763 * @see elm_gengrid_item_tooltip_content_cb_set()
8767 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8770 * Set a different @b style for a given gengrid item's tooltip.
8772 * @param item gengrid item with tooltip set
8773 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8774 * "default", @c "transparent", etc)
8776 * Tooltips can have <b>alternate styles</b> to be displayed on,
8777 * which are defined by the theme set on Elementary. This function
8778 * works analogously as elm_object_tooltip_style_set(), but here
8779 * applied only to gengrid item objects. The default style for
8780 * tooltips is @c "default".
8782 * @note before you set a style you should define a tooltip with
8783 * elm_gengrid_item_tooltip_content_cb_set() or
8784 * elm_gengrid_item_tooltip_text_set()
8786 * @see elm_gengrid_item_tooltip_style_get()
8790 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8793 * Get the style set a given gengrid item's tooltip.
8795 * @param item gengrid item with tooltip already set on.
8796 * @return style the theme style in use, which defaults to
8797 * "default". If the object does not have a tooltip set,
8798 * then @c NULL is returned.
8800 * @see elm_gengrid_item_tooltip_style_set() for more details
8804 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8806 * @brief Disable size restrictions on an object's tooltip
8807 * @param item The tooltip's anchor object
8808 * @param disable If EINA_TRUE, size restrictions are disabled
8809 * @return EINA_FALSE on failure, EINA_TRUE on success
8811 * This function allows a tooltip to expand beyond its parant window's canvas.
8812 * It will instead be limited only by the size of the display.
8814 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8816 * @brief Retrieve size restriction state of an object's tooltip
8817 * @param item The tooltip's anchor object
8818 * @return If EINA_TRUE, size restrictions are disabled
8820 * This function returns whether a tooltip is allowed to expand beyond
8821 * its parant window's canvas.
8822 * It will instead be limited only by the size of the display.
8824 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8826 * Set the type of mouse pointer/cursor decoration to be shown,
8827 * when the mouse pointer is over the given gengrid widget item
8829 * @param item gengrid item to customize cursor on
8830 * @param cursor the cursor type's name
8832 * This function works analogously as elm_object_cursor_set(), but
8833 * here the cursor's changing area is restricted to the item's
8834 * area, and not the whole widget's. Note that that item cursors
8835 * have precedence over widget cursors, so that a mouse over @p
8836 * item will always show cursor @p type.
8838 * If this function is called twice for an object, a previously set
8839 * cursor will be unset on the second call.
8841 * @see elm_object_cursor_set()
8842 * @see elm_gengrid_item_cursor_get()
8843 * @see elm_gengrid_item_cursor_unset()
8847 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8850 * Get the type of mouse pointer/cursor decoration set to be shown,
8851 * when the mouse pointer is over the given gengrid widget item
8853 * @param item gengrid item with custom cursor set
8854 * @return the cursor type's name or @c NULL, if no custom cursors
8855 * were set to @p item (and on errors)
8857 * @see elm_object_cursor_get()
8858 * @see elm_gengrid_item_cursor_set() for more details
8859 * @see elm_gengrid_item_cursor_unset()
8863 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8866 * Unset any custom mouse pointer/cursor decoration set to be
8867 * shown, when the mouse pointer is over the given gengrid widget
8868 * item, thus making it show the @b default cursor again.
8870 * @param item a gengrid item
8872 * Use this call to undo any custom settings on this item's cursor
8873 * decoration, bringing it back to defaults (no custom style set).
8875 * @see elm_object_cursor_unset()
8876 * @see elm_gengrid_item_cursor_set() for more details
8880 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8883 * Set a different @b style for a given custom cursor set for a
8886 * @param item gengrid item with custom cursor set
8887 * @param style the <b>theme style</b> to use (e.g. @c "default",
8888 * @c "transparent", etc)
8890 * This function only makes sense when one is using custom mouse
8891 * cursor decorations <b>defined in a theme file</b> , which can
8892 * have, given a cursor name/type, <b>alternate styles</b> on
8893 * it. It works analogously as elm_object_cursor_style_set(), but
8894 * here applied only to gengrid item objects.
8896 * @warning Before you set a cursor style you should have defined a
8897 * custom cursor previously on the item, with
8898 * elm_gengrid_item_cursor_set()
8900 * @see elm_gengrid_item_cursor_engine_only_set()
8901 * @see elm_gengrid_item_cursor_style_get()
8905 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8908 * Get the current @b style set for a given gengrid item's custom
8911 * @param item gengrid item with custom cursor set.
8912 * @return style the cursor style in use. If the object does not
8913 * have a cursor set, then @c NULL is returned.
8915 * @see elm_gengrid_item_cursor_style_set() for more details
8919 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8922 * Set if the (custom) cursor for a given gengrid item should be
8923 * searched in its theme, also, or should only rely on the
8926 * @param item item with custom (custom) cursor already set on
8927 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8928 * only on those provided by the rendering engine, @c EINA_FALSE to
8929 * have them searched on the widget's theme, as well.
8931 * @note This call is of use only if you've set a custom cursor
8932 * for gengrid items, with elm_gengrid_item_cursor_set().
8934 * @note By default, cursors will only be looked for between those
8935 * provided by the rendering engine.
8939 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8942 * Get if the (custom) cursor for a given gengrid item is being
8943 * searched in its theme, also, or is only relying on the rendering
8946 * @param item a gengrid item
8947 * @return @c EINA_TRUE, if cursors are being looked for only on
8948 * those provided by the rendering engine, @c EINA_FALSE if they
8949 * are being searched on the widget's theme, as well.
8951 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8955 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8958 * Remove all items from a given gengrid widget
8960 * @param obj The gengrid object.
8962 * This removes (and deletes) all items in @p obj, leaving it
8965 * @see elm_gengrid_item_del(), to remove just one item.
8969 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8972 * Get the selected item in a given gengrid widget
8974 * @param obj The gengrid object.
8975 * @return The selected item's handleor @c NULL, if none is
8976 * selected at the moment (and on errors)
8978 * This returns the selected item in @p obj. If multi selection is
8979 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8980 * the first item in the list is selected, which might not be very
8981 * useful. For that case, see elm_gengrid_selected_items_get().
8985 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8988 * Get <b>a list</b> of selected items in a given gengrid
8990 * @param obj The gengrid object.
8991 * @return The list of selected items or @c NULL, if none is
8992 * selected at the moment (and on errors)
8994 * This returns a list of the selected items, in the order that
8995 * they appear in the grid. This list is only valid as long as no
8996 * more items are selected or unselected (or unselected implictly
8997 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9000 * @see elm_gengrid_selected_item_get()
9004 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9011 * @defgroup Clock Clock
9013 * @image html img/widget/clock/preview-00.png
9014 * @image latex img/widget/clock/preview-00.eps
9016 * This is a @b digital clock widget. In its default theme, it has a
9017 * vintage "flipping numbers clock" appearance, which will animate
9018 * sheets of individual algarisms individually as time goes by.
9020 * A newly created clock will fetch system's time (already
9021 * considering local time adjustments) to start with, and will tick
9022 * accondingly. It may or may not show seconds.
9024 * Clocks have an @b edition mode. When in it, the sheets will
9025 * display extra arrow indications on the top and bottom and the
9026 * user may click on them to raise or lower the time values. After
9027 * it's told to exit edition mode, it will keep ticking with that
9028 * new time set (it keeps the difference from local time).
9030 * Also, when under edition mode, user clicks on the cited arrows
9031 * which are @b held for some time will make the clock to flip the
9032 * sheet, thus editing the time, continuosly and automatically for
9033 * the user. The interval between sheet flips will keep growing in
9034 * time, so that it helps the user to reach a time which is distant
9037 * The time display is, by default, in military mode (24h), but an
9038 * am/pm indicator may be optionally shown, too, when it will
9041 * Smart callbacks one can register to:
9042 * - "changed" - the clock's user changed the time
9044 * Here is an example on its usage:
9045 * @li @ref clock_example
9054 * Identifiers for which clock digits should be editable, when a
9055 * clock widget is in edition mode. Values may be ORed together to
9056 * make a mask, naturally.
9058 * @see elm_clock_edit_set()
9059 * @see elm_clock_digit_edit_set()
9061 typedef enum _Elm_Clock_Digedit
9063 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9064 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9065 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9066 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9067 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9068 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9069 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9070 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9071 } Elm_Clock_Digedit;
9074 * Add a new clock widget to the given parent Elementary
9075 * (container) object
9077 * @param parent The parent object
9078 * @return a new clock widget handle or @c NULL, on errors
9080 * This function inserts a new clock widget on the canvas.
9084 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9087 * Set a clock widget's time, programmatically
9089 * @param obj The clock widget object
9090 * @param hrs The hours to set
9091 * @param min The minutes to set
9092 * @param sec The secondes to set
9094 * This function updates the time that is showed by the clock
9097 * Values @b must be set within the following ranges:
9098 * - 0 - 23, for hours
9099 * - 0 - 59, for minutes
9100 * - 0 - 59, for seconds,
9102 * even if the clock is not in "military" mode.
9104 * @warning The behavior for values set out of those ranges is @b
9109 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9112 * Get a clock widget's time values
9114 * @param obj The clock object
9115 * @param[out] hrs Pointer to the variable to get the hours value
9116 * @param[out] min Pointer to the variable to get the minutes value
9117 * @param[out] sec Pointer to the variable to get the seconds value
9119 * This function gets the time set for @p obj, returning
9120 * it on the variables passed as the arguments to function
9122 * @note Use @c NULL pointers on the time values you're not
9123 * interested in: they'll be ignored by the function.
9127 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9130 * Set whether a given clock widget is under <b>edition mode</b> or
9131 * under (default) displaying-only mode.
9133 * @param obj The clock object
9134 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9135 * put it back to "displaying only" mode
9137 * This function makes a clock's time to be editable or not <b>by
9138 * user interaction</b>. When in edition mode, clocks @b stop
9139 * ticking, until one brings them back to canonical mode. The
9140 * elm_clock_digit_edit_set() function will influence which digits
9141 * of the clock will be editable. By default, all of them will be
9142 * (#ELM_CLOCK_NONE).
9144 * @note am/pm sheets, if being shown, will @b always be editable
9145 * under edition mode.
9147 * @see elm_clock_edit_get()
9151 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9154 * Retrieve whether a given clock widget is under <b>edition
9155 * mode</b> or under (default) displaying-only mode.
9157 * @param obj The clock object
9158 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9161 * This function retrieves whether the clock's time can be edited
9162 * or not by user interaction.
9164 * @see elm_clock_edit_set() for more details
9168 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9171 * Set what digits of the given clock widget should be editable
9172 * when in edition mode.
9174 * @param obj The clock object
9175 * @param digedit Bit mask indicating the digits to be editable
9176 * (values in #Elm_Clock_Digedit).
9178 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9179 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9182 * @see elm_clock_digit_edit_get()
9186 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9189 * Retrieve what digits of the given clock widget should be
9190 * editable when in edition mode.
9192 * @param obj The clock object
9193 * @return Bit mask indicating the digits to be editable
9194 * (values in #Elm_Clock_Digedit).
9196 * @see elm_clock_digit_edit_set() for more details
9200 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9203 * Set if the given clock widget must show hours in military or
9206 * @param obj The clock object
9207 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9210 * This function sets if the clock must show hours in military or
9211 * am/pm mode. In some countries like Brazil the military mode
9212 * (00-24h-format) is used, in opposition to the USA, where the
9213 * am/pm mode is more commonly used.
9215 * @see elm_clock_show_am_pm_get()
9219 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9222 * Get if the given clock widget shows hours in military or am/pm
9225 * @param obj The clock object
9226 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9229 * This function gets if the clock shows hours in military or am/pm
9232 * @see elm_clock_show_am_pm_set() for more details
9236 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9239 * Set if the given clock widget must show time with seconds or not
9241 * @param obj The clock object
9242 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9244 * This function sets if the given clock must show or not elapsed
9245 * seconds. By default, they are @b not shown.
9247 * @see elm_clock_show_seconds_get()
9251 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9254 * Get whether the given clock widget is showing time with seconds
9257 * @param obj The clock object
9258 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9260 * This function gets whether @p obj is showing or not the elapsed
9263 * @see elm_clock_show_seconds_set()
9267 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9270 * Set the interval on time updates for an user mouse button hold
9271 * on clock widgets' time edition.
9273 * @param obj The clock object
9274 * @param interval The (first) interval value in seconds
9276 * This interval value is @b decreased while the user holds the
9277 * mouse pointer either incrementing or decrementing a given the
9278 * clock digit's value.
9280 * This helps the user to get to a given time distant from the
9281 * current one easier/faster, as it will start to flip quicker and
9282 * quicker on mouse button holds.
9284 * The calculation for the next flip interval value, starting from
9285 * the one set with this call, is the previous interval divided by
9286 * 1.05, so it decreases a little bit.
9288 * The default starting interval value for automatic flips is
9291 * @see elm_clock_interval_get()
9295 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9298 * Get the interval on time updates for an user mouse button hold
9299 * on clock widgets' time edition.
9301 * @param obj The clock object
9302 * @return The (first) interval value, in seconds, set on it
9304 * @see elm_clock_interval_set() for more details
9308 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9315 * @defgroup Layout Layout
9317 * @image html img/widget/layout/preview-00.png
9318 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9320 * @image html img/layout-predefined.png
9321 * @image latex img/layout-predefined.eps width=\textwidth
9323 * This is a container widget that takes a standard Edje design file and
9324 * wraps it very thinly in a widget.
9326 * An Edje design (theme) file has a very wide range of possibilities to
9327 * describe the behavior of elements added to the Layout. Check out the Edje
9328 * documentation and the EDC reference to get more information about what can
9329 * be done with Edje.
9331 * Just like @ref List, @ref Box, and other container widgets, any
9332 * object added to the Layout will become its child, meaning that it will be
9333 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9335 * The Layout widget can contain as many Contents, Boxes or Tables as
9336 * described in its theme file. For instance, objects can be added to
9337 * different Tables by specifying the respective Table part names. The same
9338 * is valid for Content and Box.
9340 * The objects added as child of the Layout will behave as described in the
9341 * part description where they were added. There are 3 possible types of
9342 * parts where a child can be added:
9344 * @section secContent Content (SWALLOW part)
9346 * Only one object can be added to the @c SWALLOW part (but you still can
9347 * have many @c SWALLOW parts and one object on each of them). Use the @c
9348 * elm_layout_content_* set of functions to set, retrieve and unset objects
9349 * as content of the @c SWALLOW. After being set to this part, the object
9350 * size, position, visibility, clipping and other description properties
9351 * will be totally controled by the description of the given part (inside
9352 * the Edje theme file).
9354 * One can use @c evas_object_size_hint_* functions on the child to have some
9355 * kind of control over its behavior, but the resulting behavior will still
9356 * depend heavily on the @c SWALLOW part description.
9358 * The Edje theme also can change the part description, based on signals or
9359 * scripts running inside the theme. This change can also be animated. All of
9360 * this will affect the child object set as content accordingly. The object
9361 * size will be changed if the part size is changed, it will animate move if
9362 * the part is moving, and so on.
9364 * The following picture demonstrates a Layout widget with a child object
9365 * added to its @c SWALLOW:
9367 * @image html layout_swallow.png
9368 * @image latex layout_swallow.eps width=\textwidth
9370 * @section secBox Box (BOX part)
9372 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9373 * allows one to add objects to the box and have them distributed along its
9374 * area, accordingly to the specified @a layout property (now by @a layout we
9375 * mean the chosen layouting design of the Box, not the Layout widget
9378 * A similar effect for having a box with its position, size and other things
9379 * controled by the Layout theme would be to create an Elementary @ref Box
9380 * widget and add it as a Content in the @c SWALLOW part.
9382 * The main difference of using the Layout Box is that its behavior, the box
9383 * properties like layouting format, padding, align, etc. will be all
9384 * controled by the theme. This means, for example, that a signal could be
9385 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9386 * handled the signal by changing the box padding, or align, or both. Using
9387 * the Elementary @ref Box widget is not necessarily harder or easier, it
9388 * just depends on the circunstances and requirements.
9390 * The Layout Box can be used through the @c elm_layout_box_* set of
9393 * The following picture demonstrates a Layout widget with many child objects
9394 * added to its @c BOX part:
9396 * @image html layout_box.png
9397 * @image latex layout_box.eps width=\textwidth
9399 * @section secTable Table (TABLE part)
9401 * Just like the @ref secBox, the Layout Table is very similar to the
9402 * Elementary @ref Table widget. It allows one to add objects to the Table
9403 * specifying the row and column where the object should be added, and any
9404 * column or row span if necessary.
9406 * Again, we could have this design by adding a @ref Table widget to the @c
9407 * SWALLOW part using elm_layout_content_set(). The same difference happens
9408 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9409 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9411 * The Layout Table can be used through the @c elm_layout_table_* set of
9414 * The following picture demonstrates a Layout widget with many child objects
9415 * added to its @c TABLE part:
9417 * @image html layout_table.png
9418 * @image latex layout_table.eps width=\textwidth
9420 * @section secPredef Predefined Layouts
9422 * Another interesting thing about the Layout widget is that it offers some
9423 * predefined themes that come with the default Elementary theme. These
9424 * themes can be set by the call elm_layout_theme_set(), and provide some
9425 * basic functionality depending on the theme used.
9427 * Most of them already send some signals, some already provide a toolbar or
9428 * back and next buttons.
9430 * These are available predefined theme layouts. All of them have class = @c
9431 * layout, group = @c application, and style = one of the following options:
9433 * @li @c toolbar-content - application with toolbar and main content area
9434 * @li @c toolbar-content-back - application with toolbar and main content
9435 * area with a back button and title area
9436 * @li @c toolbar-content-back-next - application with toolbar and main
9437 * content area with a back and next buttons and title area
9438 * @li @c content-back - application with a main content area with a back
9439 * button and title area
9440 * @li @c content-back-next - application with a main content area with a
9441 * back and next buttons and title area
9442 * @li @c toolbar-vbox - application with toolbar and main content area as a
9444 * @li @c toolbar-table - application with toolbar and main content area as a
9447 * @section secExamples Examples
9449 * Some examples of the Layout widget can be found here:
9450 * @li @ref layout_example_01
9451 * @li @ref layout_example_02
9452 * @li @ref layout_example_03
9453 * @li @ref layout_example_edc
9458 * Add a new layout to the parent
9460 * @param parent The parent object
9461 * @return The new object or NULL if it cannot be created
9463 * @see elm_layout_file_set()
9464 * @see elm_layout_theme_set()
9468 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9470 * Set the file that will be used as layout
9472 * @param obj The layout object
9473 * @param file The path to file (edj) that will be used as layout
9474 * @param group The group that the layout belongs in edje file
9476 * @return (1 = success, 0 = error)
9480 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9482 * Set the edje group from the elementary theme that will be used as layout
9484 * @param obj The layout object
9485 * @param clas the clas of the group
9486 * @param group the group
9487 * @param style the style to used
9489 * @return (1 = success, 0 = error)
9493 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9495 * Set the layout content.
9497 * @param obj The layout object
9498 * @param swallow The swallow part name in the edje file
9499 * @param content The child that will be added in this layout object
9501 * Once the content object is set, a previously set one will be deleted.
9502 * If you want to keep that old content object, use the
9503 * elm_layout_content_unset() function.
9505 * @note In an Edje theme, the part used as a content container is called @c
9506 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9507 * expected to be a part name just like the second parameter of
9508 * elm_layout_box_append().
9510 * @see elm_layout_box_append()
9511 * @see elm_layout_content_get()
9512 * @see elm_layout_content_unset()
9517 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9519 * Get the child object in the given content part.
9521 * @param obj The layout object
9522 * @param swallow The SWALLOW part to get its content
9524 * @return The swallowed object or NULL if none or an error occurred
9526 * @see elm_layout_content_set()
9530 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9532 * Unset the layout content.
9534 * @param obj The layout object
9535 * @param swallow The swallow part name in the edje file
9536 * @return The content that was being used
9538 * Unparent and return the content object which was set for this part.
9540 * @see elm_layout_content_set()
9544 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9546 * Set the text of the given part
9548 * @param obj The layout object
9549 * @param part The TEXT part where to set the text
9550 * @param text The text to set
9553 * @deprecated use elm_object_text_* instead.
9555 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9557 * Get the text set in the given part
9559 * @param obj The layout object
9560 * @param part The TEXT part to retrieve the text off
9562 * @return The text set in @p part
9565 * @deprecated use elm_object_text_* instead.
9567 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9569 * Append child to layout box part.
9571 * @param obj the layout object
9572 * @param part the box part to which the object will be appended.
9573 * @param child the child object to append to box.
9575 * Once the object is appended, it will become child of the layout. Its
9576 * lifetime will be bound to the layout, whenever the layout dies the child
9577 * will be deleted automatically. One should use elm_layout_box_remove() to
9578 * make this layout forget about the object.
9580 * @see elm_layout_box_prepend()
9581 * @see elm_layout_box_insert_before()
9582 * @see elm_layout_box_insert_at()
9583 * @see elm_layout_box_remove()
9587 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9589 * Prepend child to layout box part.
9591 * @param obj the layout object
9592 * @param part the box part to prepend.
9593 * @param child the child object to prepend to box.
9595 * Once the object is prepended, it will become child of the layout. Its
9596 * lifetime will be bound to the layout, whenever the layout dies the child
9597 * will be deleted automatically. One should use elm_layout_box_remove() to
9598 * make this layout forget about the object.
9600 * @see elm_layout_box_append()
9601 * @see elm_layout_box_insert_before()
9602 * @see elm_layout_box_insert_at()
9603 * @see elm_layout_box_remove()
9607 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9609 * Insert child to layout box part before a reference object.
9611 * @param obj the layout object
9612 * @param part the box part to insert.
9613 * @param child the child object to insert into box.
9614 * @param reference another reference object to insert before in box.
9616 * Once the object is inserted, it will become child of the layout. Its
9617 * lifetime will be bound to the layout, whenever the layout dies the child
9618 * will be deleted automatically. One should use elm_layout_box_remove() to
9619 * make this layout forget about the object.
9621 * @see elm_layout_box_append()
9622 * @see elm_layout_box_prepend()
9623 * @see elm_layout_box_insert_before()
9624 * @see elm_layout_box_remove()
9628 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9630 * Insert child to layout box part at a given position.
9632 * @param obj the layout object
9633 * @param part the box part to insert.
9634 * @param child the child object to insert into box.
9635 * @param pos the numeric position >=0 to insert the child.
9637 * Once the object is inserted, it will become child of the layout. Its
9638 * lifetime will be bound to the layout, whenever the layout dies the child
9639 * will be deleted automatically. One should use elm_layout_box_remove() to
9640 * make this layout forget about the object.
9642 * @see elm_layout_box_append()
9643 * @see elm_layout_box_prepend()
9644 * @see elm_layout_box_insert_before()
9645 * @see elm_layout_box_remove()
9649 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9651 * Remove a child of the given part box.
9653 * @param obj The layout object
9654 * @param part The box part name to remove child.
9655 * @param child The object to remove from box.
9656 * @return The object that was being used, or NULL if not found.
9658 * The object will be removed from the box part and its lifetime will
9659 * not be handled by the layout anymore. This is equivalent to
9660 * elm_layout_content_unset() for box.
9662 * @see elm_layout_box_append()
9663 * @see elm_layout_box_remove_all()
9667 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9669 * Remove all child of the given part box.
9671 * @param obj The layout object
9672 * @param part The box part name to remove child.
9673 * @param clear If EINA_TRUE, then all objects will be deleted as
9674 * well, otherwise they will just be removed and will be
9675 * dangling on the canvas.
9677 * The objects will be removed from the box part and their lifetime will
9678 * not be handled by the layout anymore. This is equivalent to
9679 * elm_layout_box_remove() for all box children.
9681 * @see elm_layout_box_append()
9682 * @see elm_layout_box_remove()
9686 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9688 * Insert child to layout table part.
9690 * @param obj the layout object
9691 * @param part the box part to pack child.
9692 * @param child_obj the child object to pack into table.
9693 * @param col the column to which the child should be added. (>= 0)
9694 * @param row the row to which the child should be added. (>= 0)
9695 * @param colspan how many columns should be used to store this object. (>=
9697 * @param rowspan how many rows should be used to store this object. (>= 1)
9699 * Once the object is inserted, it will become child of the table. Its
9700 * lifetime will be bound to the layout, and whenever the layout dies the
9701 * child will be deleted automatically. One should use
9702 * elm_layout_table_remove() to make this layout forget about the object.
9704 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9705 * more space than a single cell. For instance, the following code:
9707 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9710 * Would result in an object being added like the following picture:
9712 * @image html layout_colspan.png
9713 * @image latex layout_colspan.eps width=\textwidth
9715 * @see elm_layout_table_unpack()
9716 * @see elm_layout_table_clear()
9720 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);
9722 * Unpack (remove) a child of the given part table.
9724 * @param obj The layout object
9725 * @param part The table part name to remove child.
9726 * @param child_obj The object to remove from table.
9727 * @return The object that was being used, or NULL if not found.
9729 * The object will be unpacked from the table part and its lifetime
9730 * will not be handled by the layout anymore. This is equivalent to
9731 * elm_layout_content_unset() for table.
9733 * @see elm_layout_table_pack()
9734 * @see elm_layout_table_clear()
9738 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9740 * Remove all child of the given part table.
9742 * @param obj The layout object
9743 * @param part The table part name to remove child.
9744 * @param clear If EINA_TRUE, then all objects will be deleted as
9745 * well, otherwise they will just be removed and will be
9746 * dangling on the canvas.
9748 * The objects will be removed from the table part and their lifetime will
9749 * not be handled by the layout anymore. This is equivalent to
9750 * elm_layout_table_unpack() for all table children.
9752 * @see elm_layout_table_pack()
9753 * @see elm_layout_table_unpack()
9757 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9759 * Get the edje layout
9761 * @param obj The layout object
9763 * @return A Evas_Object with the edje layout settings loaded
9764 * with function elm_layout_file_set
9766 * This returns the edje object. It is not expected to be used to then
9767 * swallow objects via edje_object_part_swallow() for example. Use
9768 * elm_layout_content_set() instead so child object handling and sizing is
9771 * @note This function should only be used if you really need to call some
9772 * low level Edje function on this edje object. All the common stuff (setting
9773 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9774 * with proper elementary functions.
9776 * @see elm_object_signal_callback_add()
9777 * @see elm_object_signal_emit()
9778 * @see elm_object_text_part_set()
9779 * @see elm_layout_content_set()
9780 * @see elm_layout_box_append()
9781 * @see elm_layout_table_pack()
9782 * @see elm_layout_data_get()
9786 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9788 * Get the edje data from the given layout
9790 * @param obj The layout object
9791 * @param key The data key
9793 * @return The edje data string
9795 * This function fetches data specified inside the edje theme of this layout.
9796 * This function return NULL if data is not found.
9798 * In EDC this comes from a data block within the group block that @p
9799 * obj was loaded from. E.g.
9806 * item: "key1" "value1";
9807 * item: "key2" "value2";
9815 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9819 * @param obj The layout object
9821 * Manually forces a sizing re-evaluation. This is useful when the minimum
9822 * size required by the edje theme of this layout has changed. The change on
9823 * the minimum size required by the edje theme is not immediately reported to
9824 * the elementary layout, so one needs to call this function in order to tell
9825 * the widget (layout) that it needs to reevaluate its own size.
9827 * The minimum size of the theme is calculated based on minimum size of
9828 * parts, the size of elements inside containers like box and table, etc. All
9829 * of this can change due to state changes, and that's when this function
9832 * Also note that a standard signal of "size,eval" "elm" emitted from the
9833 * edje object will cause this to happen too.
9837 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9840 * Sets a specific cursor for an edje part.
9842 * @param obj The layout object.
9843 * @param part_name a part from loaded edje group.
9844 * @param cursor cursor name to use, see Elementary_Cursor.h
9846 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9847 * part not exists or it has "mouse_events: 0".
9851 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9854 * Get the cursor to be shown when mouse is over an edje part
9856 * @param obj The layout object.
9857 * @param part_name a part from loaded edje group.
9858 * @return the cursor name.
9862 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9865 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9867 * @param obj The layout object.
9868 * @param part_name a part from loaded edje group, that had a cursor set
9869 * with elm_layout_part_cursor_set().
9873 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9876 * Sets a specific cursor style for an edje part.
9878 * @param obj The layout object.
9879 * @param part_name a part from loaded edje group.
9880 * @param style the theme style to use (default, transparent, ...)
9882 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9883 * part not exists or it did not had a cursor set.
9887 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9890 * Gets a specific cursor style for an edje part.
9892 * @param obj The layout object.
9893 * @param part_name a part from loaded edje group.
9895 * @return the theme style in use, defaults to "default". If the
9896 * object does not have a cursor set, then NULL is returned.
9900 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9903 * Sets if the cursor set should be searched on the theme or should use
9904 * the provided by the engine, only.
9906 * @note before you set if should look on theme you should define a
9907 * cursor with elm_layout_part_cursor_set(). By default it will only
9908 * look for cursors provided by the engine.
9910 * @param obj The layout object.
9911 * @param part_name a part from loaded edje group.
9912 * @param engine_only if cursors should be just provided by the engine
9913 * or should also search on widget's theme as well
9915 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9916 * part not exists or it did not had a cursor set.
9920 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);
9923 * Gets a specific cursor engine_only for an edje part.
9925 * @param obj The layout object.
9926 * @param part_name a part from loaded edje group.
9928 * @return whenever the cursor is just provided by engine or also from theme.
9932 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9935 * @def elm_layout_icon_set
9936 * Convienience macro to set the icon object in a layout that follows the
9937 * Elementary naming convention for its parts.
9941 #define elm_layout_icon_set(_ly, _obj) \
9944 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9945 if ((_obj)) sig = "elm,state,icon,visible"; \
9946 else sig = "elm,state,icon,hidden"; \
9947 elm_object_signal_emit((_ly), sig, "elm"); \
9951 * @def elm_layout_icon_get
9952 * Convienience macro to get the icon object from a layout that follows the
9953 * Elementary naming convention for its parts.
9957 #define elm_layout_icon_get(_ly) \
9958 elm_layout_content_get((_ly), "elm.swallow.icon")
9961 * @def elm_layout_end_set
9962 * Convienience macro to set the end object in a layout that follows the
9963 * Elementary naming convention for its parts.
9967 #define elm_layout_end_set(_ly, _obj) \
9970 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9971 if ((_obj)) sig = "elm,state,end,visible"; \
9972 else sig = "elm,state,end,hidden"; \
9973 elm_object_signal_emit((_ly), sig, "elm"); \
9977 * @def elm_layout_end_get
9978 * Convienience macro to get the end object in a layout that follows the
9979 * Elementary naming convention for its parts.
9983 #define elm_layout_end_get(_ly) \
9984 elm_layout_content_get((_ly), "elm.swallow.end")
9987 * @def elm_layout_label_set
9988 * Convienience macro to set the label in a layout that follows the
9989 * Elementary naming convention for its parts.
9992 * @deprecated use elm_object_text_* instead.
9994 #define elm_layout_label_set(_ly, _txt) \
9995 elm_layout_text_set((_ly), "elm.text", (_txt))
9998 * @def elm_layout_label_get
9999 * Convienience macro to get the label in a layout that follows the
10000 * Elementary naming convention for its parts.
10003 * @deprecated use elm_object_text_* instead.
10005 #define elm_layout_label_get(_ly) \
10006 elm_layout_text_get((_ly), "elm.text")
10008 /* smart callbacks called:
10009 * "theme,changed" - when elm theme is changed.
10013 * @defgroup Notify Notify
10015 * @image html img/widget/notify/preview-00.png
10016 * @image latex img/widget/notify/preview-00.eps
10018 * Display a container in a particular region of the parent(top, bottom,
10019 * etc. A timeout can be set to automatically hide the notify. This is so
10020 * that, after an evas_object_show() on a notify object, if a timeout was set
10021 * on it, it will @b automatically get hidden after that time.
10023 * Signals that you can add callbacks for are:
10024 * @li "timeout" - when timeout happens on notify and it's hidden
10025 * @li "block,clicked" - when a click outside of the notify happens
10027 * @ref tutorial_notify show usage of the API.
10032 * @brief Possible orient values for notify.
10034 * This values should be used in conjunction to elm_notify_orient_set() to
10035 * set the position in which the notify should appear(relative to its parent)
10036 * and in conjunction with elm_notify_orient_get() to know where the notify
10039 typedef enum _Elm_Notify_Orient
10041 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10042 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10043 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10044 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10045 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10046 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10047 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10048 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10049 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10050 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10051 } Elm_Notify_Orient;
10053 * @brief Add a new notify to the parent
10055 * @param parent The parent object
10056 * @return The new object or NULL if it cannot be created
10058 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10060 * @brief Set the content of the notify widget
10062 * @param obj The notify object
10063 * @param content The content will be filled in this notify object
10065 * Once the content object is set, a previously set one will be deleted. If
10066 * you want to keep that old content object, use the
10067 * elm_notify_content_unset() function.
10069 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10071 * @brief Unset the content of the notify widget
10073 * @param obj The notify object
10074 * @return The content that was being used
10076 * Unparent and return the content object which was set for this widget
10078 * @see elm_notify_content_set()
10080 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10082 * @brief Return the content of the notify widget
10084 * @param obj The notify object
10085 * @return The content that is being used
10087 * @see elm_notify_content_set()
10089 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10091 * @brief Set the notify parent
10093 * @param obj The notify object
10094 * @param content The new parent
10096 * Once the parent object is set, a previously set one will be disconnected
10099 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10101 * @brief Get the notify parent
10103 * @param obj The notify object
10104 * @return The parent
10106 * @see elm_notify_parent_set()
10108 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10110 * @brief Set the orientation
10112 * @param obj The notify object
10113 * @param orient The new orientation
10115 * Sets the position in which the notify will appear in its parent.
10117 * @see @ref Elm_Notify_Orient for possible values.
10119 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10121 * @brief Return the orientation
10122 * @param obj The notify object
10123 * @return The orientation of the notification
10125 * @see elm_notify_orient_set()
10126 * @see Elm_Notify_Orient
10128 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10130 * @brief Set the time interval after which the notify window is going to be
10133 * @param obj The notify object
10134 * @param time The timeout in seconds
10136 * This function sets a timeout and starts the timer controlling when the
10137 * notify is hidden. Since calling evas_object_show() on a notify restarts
10138 * the timer controlling when the notify is hidden, setting this before the
10139 * notify is shown will in effect mean starting the timer when the notify is
10142 * @note Set a value <= 0.0 to disable a running timer.
10144 * @note If the value > 0.0 and the notify is previously visible, the
10145 * timer will be started with this value, canceling any running timer.
10147 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10149 * @brief Return the timeout value (in seconds)
10150 * @param obj the notify object
10152 * @see elm_notify_timeout_set()
10154 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10156 * @brief Sets whether events should be passed to by a click outside
10159 * @param obj The notify object
10160 * @param repeats EINA_TRUE Events are repeats, else no
10162 * When true if the user clicks outside the window the events will be caught
10163 * by the others widgets, else the events are blocked.
10165 * @note The default value is EINA_TRUE.
10167 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10169 * @brief Return true if events are repeat below the notify object
10170 * @param obj the notify object
10172 * @see elm_notify_repeat_events_set()
10174 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10180 * @defgroup Hover Hover
10182 * @image html img/widget/hover/preview-00.png
10183 * @image latex img/widget/hover/preview-00.eps
10185 * A Hover object will hover over its @p parent object at the @p target
10186 * location. Anything in the background will be given a darker coloring to
10187 * indicate that the hover object is on top (at the default theme). When the
10188 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10189 * clicked that @b doesn't cause the hover to be dismissed.
10191 * @note The hover object will take up the entire space of @p target
10194 * Elementary has the following styles for the hover widget:
10198 * @li hoversel_vertical
10200 * The following are the available position for content:
10212 * Signals that you can add callbacks for are:
10213 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10214 * @li "smart,changed" - a content object placed under the "smart"
10215 * policy was replaced to a new slot direction.
10217 * See @ref tutorial_hover for more information.
10221 typedef enum _Elm_Hover_Axis
10223 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10224 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10225 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10226 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10229 * @brief Adds a hover object to @p parent
10231 * @param parent The parent object
10232 * @return The hover object or NULL if one could not be created
10234 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10236 * @brief Sets the target object for the hover.
10238 * @param obj The hover object
10239 * @param target The object to center the hover onto. The hover
10241 * This function will cause the hover to be centered on the target object.
10243 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10245 * @brief Gets the target object for the hover.
10247 * @param obj The hover object
10248 * @param parent The object to locate the hover over.
10250 * @see elm_hover_target_set()
10252 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10254 * @brief Sets the parent object for the hover.
10256 * @param obj The hover object
10257 * @param parent The object to locate the hover over.
10259 * This function will cause the hover to take up the entire space that the
10260 * parent object fills.
10262 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10264 * @brief Gets the parent object for the hover.
10266 * @param obj The hover object
10267 * @return The parent object to locate the hover over.
10269 * @see elm_hover_parent_set()
10271 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10273 * @brief Sets the content of the hover object and the direction in which it
10276 * @param obj The hover object
10277 * @param swallow The direction that the object will be displayed
10278 * at. Accepted values are "left", "top-left", "top", "top-right",
10279 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10281 * @param content The content to place at @p swallow
10283 * Once the content object is set for a given direction, a previously
10284 * set one (on the same direction) will be deleted. If you want to
10285 * keep that old content object, use the elm_hover_content_unset()
10288 * All directions may have contents at the same time, except for
10289 * "smart". This is a special placement hint and its use case
10290 * independs of the calculations coming from
10291 * elm_hover_best_content_location_get(). Its use is for cases when
10292 * one desires only one hover content, but with a dinamic special
10293 * placement within the hover area. The content's geometry, whenever
10294 * it changes, will be used to decide on a best location not
10295 * extrapolating the hover's parent object view to show it in (still
10296 * being the hover's target determinant of its medium part -- move and
10297 * resize it to simulate finger sizes, for example). If one of the
10298 * directions other than "smart" are used, a previously content set
10299 * using it will be deleted, and vice-versa.
10301 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10303 * @brief Get the content of the hover object, in a given direction.
10305 * Return the content object which was set for this widget in the
10306 * @p swallow direction.
10308 * @param obj The hover object
10309 * @param swallow The direction that the object was display at.
10310 * @return The content that was being used
10312 * @see elm_hover_content_set()
10314 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10316 * @brief Unset the content of the hover object, in a given direction.
10318 * Unparent and return the content object set at @p swallow direction.
10320 * @param obj The hover object
10321 * @param swallow The direction that the object was display at.
10322 * @return The content that was being used.
10324 * @see elm_hover_content_set()
10326 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10328 * @brief Returns the best swallow location for content in the hover.
10330 * @param obj The hover object
10331 * @param pref_axis The preferred orientation axis for the hover object to use
10332 * @return The edje location to place content into the hover or @c
10335 * Best is defined here as the location at which there is the most available
10338 * @p pref_axis may be one of
10339 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10340 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10341 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10342 * - @c ELM_HOVER_AXIS_BOTH -- both
10344 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10345 * nescessarily be along the horizontal axis("left" or "right"). If
10346 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10347 * be along the vertical axis("top" or "bottom"). Chossing
10348 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10349 * returned position may be in either axis.
10351 * @see elm_hover_content_set()
10353 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10360 * @defgroup Entry Entry
10362 * @image html img/widget/entry/preview-00.png
10363 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10364 * @image html img/widget/entry/preview-01.png
10365 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10366 * @image html img/widget/entry/preview-02.png
10367 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10368 * @image html img/widget/entry/preview-03.png
10369 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10371 * An entry is a convenience widget which shows a box that the user can
10372 * enter text into. Entries by default don't scroll, so they grow to
10373 * accomodate the entire text, resizing the parent window as needed. This
10374 * can be changed with the elm_entry_scrollable_set() function.
10376 * They can also be single line or multi line (the default) and when set
10377 * to multi line mode they support text wrapping in any of the modes
10378 * indicated by #Elm_Wrap_Type.
10380 * Other features include password mode, filtering of inserted text with
10381 * elm_entry_text_filter_append() and related functions, inline "items" and
10382 * formatted markup text.
10384 * @section entry-markup Formatted text
10386 * The markup tags supported by the Entry are defined by the theme, but
10387 * even when writing new themes or extensions it's a good idea to stick to
10388 * a sane default, to maintain coherency and avoid application breakages.
10389 * Currently defined by the default theme are the following tags:
10390 * @li \<br\>: Inserts a line break.
10391 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10393 * @li \<tab\>: Inserts a tab.
10394 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10396 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10397 * @li \<link\>...\</link\>: Underlines the enclosed text.
10398 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10400 * @section entry-special Special markups
10402 * Besides those used to format text, entries support two special markup
10403 * tags used to insert clickable portions of text or items inlined within
10406 * @subsection entry-anchors Anchors
10408 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10409 * \</a\> tags and an event will be generated when this text is clicked,
10413 * This text is outside <a href=anc-01>but this one is an anchor</a>
10416 * The @c href attribute in the opening tag gives the name that will be
10417 * used to identify the anchor and it can be any valid utf8 string.
10419 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10420 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10421 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10422 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10425 * @subsection entry-items Items
10427 * Inlined in the text, any other @c Evas_Object can be inserted by using
10428 * \<item\> tags this way:
10431 * <item size=16x16 vsize=full href=emoticon/haha></item>
10434 * Just like with anchors, the @c href identifies each item, but these need,
10435 * in addition, to indicate their size, which is done using any one of
10436 * @c size, @c absize or @c relsize attributes. These attributes take their
10437 * value in the WxH format, where W is the width and H the height of the
10440 * @li absize: Absolute pixel size for the item. Whatever value is set will
10441 * be the item's size regardless of any scale value the object may have
10442 * been set to. The final line height will be adjusted to fit larger items.
10443 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10445 * @li relsize: Size is adjusted for the item to fit within the current
10448 * Besides their size, items are specificed a @c vsize value that affects
10449 * how their final size and position are calculated. The possible values
10451 * @li ascent: Item will be placed within the line's baseline and its
10452 * ascent. That is, the height between the line where all characters are
10453 * positioned and the highest point in the line. For @c size and @c absize
10454 * items, the descent value will be added to the total line height to make
10455 * them fit. @c relsize items will be adjusted to fit within this space.
10456 * @li full: Items will be placed between the descent and ascent, or the
10457 * lowest point in the line and its highest.
10459 * The next image shows different configurations of items and how they
10460 * are the previously mentioned options affect their sizes. In all cases,
10461 * the green line indicates the ascent, blue for the baseline and red for
10464 * @image html entry_item.png
10465 * @image latex entry_item.eps width=\textwidth
10467 * And another one to show how size differs from absize. In the first one,
10468 * the scale value is set to 1.0, while the second one is using one of 2.0.
10470 * @image html entry_item_scale.png
10471 * @image latex entry_item_scale.eps width=\textwidth
10473 * After the size for an item is calculated, the entry will request an
10474 * object to place in its space. For this, the functions set with
10475 * elm_entry_item_provider_append() and related functions will be called
10476 * in order until one of them returns a @c non-NULL value. If no providers
10477 * are available, or all of them return @c NULL, then the entry falls back
10478 * to one of the internal defaults, provided the name matches with one of
10481 * All of the following are currently supported:
10484 * - emoticon/angry-shout
10485 * - emoticon/crazy-laugh
10486 * - emoticon/evil-laugh
10488 * - emoticon/goggle-smile
10489 * - emoticon/grumpy
10490 * - emoticon/grumpy-smile
10491 * - emoticon/guilty
10492 * - emoticon/guilty-smile
10494 * - emoticon/half-smile
10495 * - emoticon/happy-panting
10497 * - emoticon/indifferent
10499 * - emoticon/knowing-grin
10501 * - emoticon/little-bit-sorry
10502 * - emoticon/love-lots
10504 * - emoticon/minimal-smile
10505 * - emoticon/not-happy
10506 * - emoticon/not-impressed
10508 * - emoticon/opensmile
10511 * - emoticon/squint-laugh
10512 * - emoticon/surprised
10513 * - emoticon/suspicious
10514 * - emoticon/tongue-dangling
10515 * - emoticon/tongue-poke
10517 * - emoticon/unhappy
10518 * - emoticon/very-sorry
10521 * - emoticon/worried
10524 * Alternatively, an item may reference an image by its path, using
10525 * the URI form @c file:///path/to/an/image.png and the entry will then
10526 * use that image for the item.
10528 * @section entry-files Loading and saving files
10530 * Entries have convinience functions to load text from a file and save
10531 * changes back to it after a short delay. The automatic saving is enabled
10532 * by default, but can be disabled with elm_entry_autosave_set() and files
10533 * can be loaded directly as plain text or have any markup in them
10534 * recognized. See elm_entry_file_set() for more details.
10536 * @section entry-signals Emitted signals
10538 * This widget emits the following signals:
10540 * @li "changed": The text within the entry was changed.
10541 * @li "changed,user": The text within the entry was changed because of user interaction.
10542 * @li "activated": The enter key was pressed on a single line entry.
10543 * @li "press": A mouse button has been pressed on the entry.
10544 * @li "longpressed": A mouse button has been pressed and held for a couple
10546 * @li "clicked": The entry has been clicked (mouse press and release).
10547 * @li "clicked,double": The entry has been double clicked.
10548 * @li "clicked,triple": The entry has been triple clicked.
10549 * @li "focused": The entry has received focus.
10550 * @li "unfocused": The entry has lost focus.
10551 * @li "selection,paste": A paste of the clipboard contents was requested.
10552 * @li "selection,copy": A copy of the selected text into the clipboard was
10554 * @li "selection,cut": A cut of the selected text into the clipboard was
10556 * @li "selection,start": A selection has begun and no previous selection
10558 * @li "selection,changed": The current selection has changed.
10559 * @li "selection,cleared": The current selection has been cleared.
10560 * @li "cursor,changed": The cursor has changed position.
10561 * @li "anchor,clicked": An anchor has been clicked. The event_info
10562 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10563 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10564 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10565 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10566 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10567 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10568 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10569 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10570 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10571 * @li "preedit,changed": The preedit string has changed.
10573 * @section entry-examples
10575 * An overview of the Entry API can be seen in @ref entry_example_01
10580 * @typedef Elm_Entry_Anchor_Info
10582 * The info sent in the callback for the "anchor,clicked" signals emitted
10585 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10587 * @struct _Elm_Entry_Anchor_Info
10589 * The info sent in the callback for the "anchor,clicked" signals emitted
10592 struct _Elm_Entry_Anchor_Info
10594 const char *name; /**< The name of the anchor, as stated in its href */
10595 int button; /**< The mouse button used to click on it */
10596 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10597 y, /**< Anchor geometry, relative to canvas */
10598 w, /**< Anchor geometry, relative to canvas */
10599 h; /**< Anchor geometry, relative to canvas */
10602 * @typedef Elm_Entry_Filter_Cb
10603 * This callback type is used by entry filters to modify text.
10604 * @param data The data specified as the last param when adding the filter
10605 * @param entry The entry object
10606 * @param text A pointer to the location of the text being filtered. This data can be modified,
10607 * but any additional allocations must be managed by the user.
10608 * @see elm_entry_text_filter_append
10609 * @see elm_entry_text_filter_prepend
10611 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10614 * This adds an entry to @p parent object.
10616 * By default, entries are:
10620 * @li autosave is enabled
10622 * @param parent The parent object
10623 * @return The new object or NULL if it cannot be created
10625 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10627 * Sets the entry to single line mode.
10629 * In single line mode, entries don't ever wrap when the text reaches the
10630 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10631 * key will generate an @c "activate" event instead of adding a new line.
10633 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10634 * and pressing enter will break the text into a different line
10635 * without generating any events.
10637 * @param obj The entry object
10638 * @param single_line If true, the text in the entry
10639 * will be on a single line.
10641 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10643 * Gets whether the entry is set to be single line.
10645 * @param obj The entry object
10646 * @return single_line If true, the text in the entry is set to display
10647 * on a single line.
10649 * @see elm_entry_single_line_set()
10651 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10653 * Sets the entry to password mode.
10655 * In password mode, entries are implicitly single line and the display of
10656 * any text in them is replaced with asterisks (*).
10658 * @param obj The entry object
10659 * @param password If true, password mode is enabled.
10661 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10663 * Gets whether the entry is set to password mode.
10665 * @param obj The entry object
10666 * @return If true, the entry is set to display all characters
10667 * as asterisks (*).
10669 * @see elm_entry_password_set()
10671 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10673 * This sets the text displayed within the entry to @p entry.
10675 * @param obj The entry object
10676 * @param entry The text to be displayed
10678 * @deprecated Use elm_object_text_set() instead.
10680 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10682 * This returns the text currently shown in object @p entry.
10683 * See also elm_entry_entry_set().
10685 * @param obj The entry object
10686 * @return The currently displayed text or NULL on failure
10688 * @deprecated Use elm_object_text_get() instead.
10690 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10692 * Appends @p entry to the text of the entry.
10694 * Adds the text in @p entry to the end of any text already present in the
10697 * The appended text is subject to any filters set for the widget.
10699 * @param obj The entry object
10700 * @param entry The text to be displayed
10702 * @see elm_entry_text_filter_append()
10704 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10706 * Gets whether the entry is empty.
10708 * Empty means no text at all. If there are any markup tags, like an item
10709 * tag for which no provider finds anything, and no text is displayed, this
10710 * function still returns EINA_FALSE.
10712 * @param obj The entry object
10713 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10715 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10717 * Gets any selected text within the entry.
10719 * If there's any selected text in the entry, this function returns it as
10720 * a string in markup format. NULL is returned if no selection exists or
10721 * if an error occurred.
10723 * The returned value points to an internal string and should not be freed
10724 * or modified in any way. If the @p entry object is deleted or its
10725 * contents are changed, the returned pointer should be considered invalid.
10727 * @param obj The entry object
10728 * @return The selected text within the entry or NULL on failure
10730 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10732 * Inserts the given text into the entry at the current cursor position.
10734 * This inserts text at the cursor position as if it was typed
10735 * by the user (note that this also allows markup which a user
10736 * can't just "type" as it would be converted to escaped text, so this
10737 * call can be used to insert things like emoticon items or bold push/pop
10738 * tags, other font and color change tags etc.)
10740 * If any selection exists, it will be replaced by the inserted text.
10742 * The inserted text is subject to any filters set for the widget.
10744 * @param obj The entry object
10745 * @param entry The text to insert
10747 * @see elm_entry_text_filter_append()
10749 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10751 * Set the line wrap type to use on multi-line entries.
10753 * Sets the wrap type used by the entry to any of the specified in
10754 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10755 * line (without inserting a line break or paragraph separator) when it
10756 * reaches the far edge of the widget.
10758 * Note that this only makes sense for multi-line entries. A widget set
10759 * to be single line will never wrap.
10761 * @param obj The entry object
10762 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10764 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10766 * Gets the wrap mode the entry was set to use.
10768 * @param obj The entry object
10769 * @return Wrap type
10771 * @see also elm_entry_line_wrap_set()
10773 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10775 * Sets if the entry is to be editable or not.
10777 * By default, entries are editable and when focused, any text input by the
10778 * user will be inserted at the current cursor position. But calling this
10779 * function with @p editable as EINA_FALSE will prevent the user from
10780 * inputting text into the entry.
10782 * The only way to change the text of a non-editable entry is to use
10783 * elm_object_text_set(), elm_entry_entry_insert() and other related
10786 * @param obj The entry object
10787 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10788 * if not, the entry is read-only and no user input is allowed.
10790 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10792 * Gets whether the entry is editable or not.
10794 * @param obj The entry object
10795 * @return If true, the entry is editable by the user.
10796 * If false, it is not editable by the user
10798 * @see elm_entry_editable_set()
10800 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10802 * This drops any existing text selection within the entry.
10804 * @param obj The entry object
10806 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10808 * This selects all text within the entry.
10810 * @param obj The entry object
10812 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10814 * This moves the cursor one place to the right within the entry.
10816 * @param obj The entry object
10817 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10819 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10821 * This moves the cursor one place to the left within the entry.
10823 * @param obj The entry object
10824 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10826 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10828 * This moves the cursor one line up within the entry.
10830 * @param obj The entry object
10831 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10833 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10835 * This moves the cursor one line down within the entry.
10837 * @param obj The entry object
10838 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10840 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10842 * This moves the cursor to the beginning of the entry.
10844 * @param obj The entry object
10846 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10848 * This moves the cursor to the end of the entry.
10850 * @param obj The entry object
10852 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10854 * This moves the cursor to the beginning of the current line.
10856 * @param obj The entry object
10858 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10860 * This moves the cursor to the end of the current line.
10862 * @param obj The entry object
10864 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10866 * This begins a selection within the entry as though
10867 * the user were holding down the mouse button to make a selection.
10869 * @param obj The entry object
10871 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10873 * This ends a selection within the entry as though
10874 * the user had just released the mouse button while making a selection.
10876 * @param obj The entry object
10878 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10880 * Gets whether a format node exists at the current cursor position.
10882 * A format node is anything that defines how the text is rendered. It can
10883 * be a visible format node, such as a line break or a paragraph separator,
10884 * or an invisible one, such as bold begin or end tag.
10885 * This function returns whether any format node exists at the current
10888 * @param obj The entry object
10889 * @return EINA_TRUE if the current cursor position contains a format node,
10890 * EINA_FALSE otherwise.
10892 * @see elm_entry_cursor_is_visible_format_get()
10894 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10896 * Gets if the current cursor position holds a visible format node.
10898 * @param obj The entry object
10899 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10900 * if it's an invisible one or no format exists.
10902 * @see elm_entry_cursor_is_format_get()
10904 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10906 * Gets the character pointed by the cursor at its current position.
10908 * This function returns a string with the utf8 character stored at the
10909 * current cursor position.
10910 * Only the text is returned, any format that may exist will not be part
10911 * of the return value.
10913 * @param obj The entry object
10914 * @return The text pointed by the cursors.
10916 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10918 * This function returns the geometry of the cursor.
10920 * It's useful if you want to draw something on the cursor (or where it is),
10921 * or for example in the case of scrolled entry where you want to show the
10924 * @param obj The entry object
10925 * @param x returned geometry
10926 * @param y returned geometry
10927 * @param w returned geometry
10928 * @param h returned geometry
10929 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10931 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);
10933 * Sets the cursor position in the entry to the given value
10935 * The value in @p pos is the index of the character position within the
10936 * contents of the string as returned by elm_entry_cursor_pos_get().
10938 * @param obj The entry object
10939 * @param pos The position of the cursor
10941 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10943 * Retrieves the current position of the cursor in the entry
10945 * @param obj The entry object
10946 * @return The cursor position
10948 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10950 * This executes a "cut" action on the selected text in the entry.
10952 * @param obj The entry object
10954 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10956 * This executes a "copy" action on the selected text in the entry.
10958 * @param obj The entry object
10960 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10962 * This executes a "paste" action in the entry.
10964 * @param obj The entry object
10966 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10968 * This clears and frees the items in a entry's contextual (longpress)
10971 * @param obj The entry object
10973 * @see elm_entry_context_menu_item_add()
10975 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10977 * This adds an item to the entry's contextual menu.
10979 * A longpress on an entry will make the contextual menu show up, if this
10980 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10981 * By default, this menu provides a few options like enabling selection mode,
10982 * which is useful on embedded devices that need to be explicit about it,
10983 * and when a selection exists it also shows the copy and cut actions.
10985 * With this function, developers can add other options to this menu to
10986 * perform any action they deem necessary.
10988 * @param obj The entry object
10989 * @param label The item's text label
10990 * @param icon_file The item's icon file
10991 * @param icon_type The item's icon type
10992 * @param func The callback to execute when the item is clicked
10993 * @param data The data to associate with the item for related functions
10995 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);
10997 * This disables the entry's contextual (longpress) menu.
10999 * @param obj The entry object
11000 * @param disabled If true, the menu is disabled
11002 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11004 * This returns whether the entry's contextual (longpress) menu is
11007 * @param obj The entry object
11008 * @return If true, the menu is disabled
11010 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11012 * This appends a custom item provider to the list for that entry
11014 * This appends the given callback. The list is walked from beginning to end
11015 * with each function called given the item href string in the text. If the
11016 * function returns an object handle other than NULL (it should create an
11017 * object to do this), then this object is used to replace that item. If
11018 * not the next provider is called until one provides an item object, or the
11019 * default provider in entry does.
11021 * @param obj The entry object
11022 * @param func The function called to provide the item object
11023 * @param data The data passed to @p func
11025 * @see @ref entry-items
11027 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);
11029 * This prepends a custom item provider to the list for that entry
11031 * This prepends the given callback. See elm_entry_item_provider_append() for
11034 * @param obj The entry object
11035 * @param func The function called to provide the item object
11036 * @param data The data passed to @p func
11038 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);
11040 * This removes a custom item provider to the list for that entry
11042 * This removes the given callback. See elm_entry_item_provider_append() for
11045 * @param obj The entry object
11046 * @param func The function called to provide the item object
11047 * @param data The data passed to @p func
11049 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);
11051 * Append a filter function for text inserted in the entry
11053 * Append the given callback to the list. This functions will be called
11054 * whenever any text is inserted into the entry, with the text to be inserted
11055 * as a parameter. The callback function is free to alter the text in any way
11056 * it wants, but it must remember to free the given pointer and update it.
11057 * If the new text is to be discarded, the function can free it and set its
11058 * text parameter to NULL. This will also prevent any following filters from
11061 * @param obj The entry object
11062 * @param func The function to use as text filter
11063 * @param data User data to pass to @p func
11065 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11067 * Prepend a filter function for text insdrted in the entry
11069 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11070 * for more information
11072 * @param obj The entry object
11073 * @param func The function to use as text filter
11074 * @param data User data to pass to @p func
11076 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11078 * Remove a filter from the list
11080 * Removes the given callback from the filter list. See
11081 * elm_entry_text_filter_append() for more information.
11083 * @param obj The entry object
11084 * @param func The filter function to remove
11085 * @param data The user data passed when adding the function
11087 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11089 * This converts a markup (HTML-like) string into UTF-8.
11091 * The returned string is a malloc'ed buffer and it should be freed when
11092 * not needed anymore.
11094 * @param s The string (in markup) to be converted
11095 * @return The converted string (in UTF-8). It should be freed.
11097 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11099 * This converts a UTF-8 string into markup (HTML-like).
11101 * The returned string is a malloc'ed buffer and it should be freed when
11102 * not needed anymore.
11104 * @param s The string (in UTF-8) to be converted
11105 * @return The converted string (in markup). It should be freed.
11107 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11109 * This sets the file (and implicitly loads it) for the text to display and
11110 * then edit. All changes are written back to the file after a short delay if
11111 * the entry object is set to autosave (which is the default).
11113 * If the entry had any other file set previously, any changes made to it
11114 * will be saved if the autosave feature is enabled, otherwise, the file
11115 * will be silently discarded and any non-saved changes will be lost.
11117 * @param obj The entry object
11118 * @param file The path to the file to load and save
11119 * @param format The file format
11121 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11123 * Gets the file being edited by the entry.
11125 * This function can be used to retrieve any file set on the entry for
11126 * edition, along with the format used to load and save it.
11128 * @param obj The entry object
11129 * @param file The path to the file to load and save
11130 * @param format The file format
11132 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11134 * This function writes any changes made to the file set with
11135 * elm_entry_file_set()
11137 * @param obj The entry object
11139 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11141 * This sets the entry object to 'autosave' the loaded text file or not.
11143 * @param obj The entry object
11144 * @param autosave Autosave the loaded file or not
11146 * @see elm_entry_file_set()
11148 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11150 * This gets the entry object's 'autosave' status.
11152 * @param obj The entry object
11153 * @return Autosave the loaded file or not
11155 * @see elm_entry_file_set()
11157 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11159 * Control pasting of text and images for the widget.
11161 * Normally the entry allows both text and images to be pasted. By setting
11162 * textonly to be true, this prevents images from being pasted.
11164 * Note this only changes the behaviour of text.
11166 * @param obj The entry object
11167 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11168 * text+image+other.
11170 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11172 * Getting elm_entry text paste/drop mode.
11174 * In textonly mode, only text may be pasted or dropped into the widget.
11176 * @param obj The entry object
11177 * @return If the widget only accepts text from pastes.
11179 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11181 * Enable or disable scrolling in entry
11183 * Normally the entry is not scrollable unless you enable it with this call.
11185 * @param obj The entry object
11186 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11188 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11190 * Get the scrollable state of the entry
11192 * Normally the entry is not scrollable. This gets the scrollable state
11193 * of the entry. See elm_entry_scrollable_set() for more information.
11195 * @param obj The entry object
11196 * @return The scrollable state
11198 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11200 * This sets a widget to be displayed to the left of a scrolled entry.
11202 * @param obj The scrolled entry object
11203 * @param icon The widget to display on the left side of the scrolled
11206 * @note A previously set widget will be destroyed.
11207 * @note If the object being set does not have minimum size hints set,
11208 * it won't get properly displayed.
11210 * @see elm_entry_end_set()
11212 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11214 * Gets the leftmost widget of the scrolled entry. This object is
11215 * owned by the scrolled entry and should not be modified.
11217 * @param obj The scrolled entry object
11218 * @return the left widget inside the scroller
11220 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11222 * Unset the leftmost widget of the scrolled entry, unparenting and
11225 * @param obj The scrolled entry object
11226 * @return the previously set icon sub-object of this entry, on
11229 * @see elm_entry_icon_set()
11231 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11233 * Sets the visibility of the left-side widget of the scrolled entry,
11234 * set by elm_entry_icon_set().
11236 * @param obj The scrolled entry object
11237 * @param setting EINA_TRUE if the object should be displayed,
11238 * EINA_FALSE if not.
11240 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11242 * This sets a widget to be displayed to the end of a scrolled entry.
11244 * @param obj The scrolled entry object
11245 * @param end The widget to display on the right side of the scrolled
11248 * @note A previously set widget will be destroyed.
11249 * @note If the object being set does not have minimum size hints set,
11250 * it won't get properly displayed.
11252 * @see elm_entry_icon_set
11254 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11256 * Gets the endmost widget of the scrolled entry. This object is owned
11257 * by the scrolled entry and should not be modified.
11259 * @param obj The scrolled entry object
11260 * @return the right widget inside the scroller
11262 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11264 * Unset the endmost widget of the scrolled entry, unparenting and
11267 * @param obj The scrolled entry object
11268 * @return the previously set icon sub-object of this entry, on
11271 * @see elm_entry_icon_set()
11273 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11275 * Sets the visibility of the end widget of the scrolled entry, set by
11276 * elm_entry_end_set().
11278 * @param obj The scrolled entry object
11279 * @param setting EINA_TRUE if the object should be displayed,
11280 * EINA_FALSE if not.
11282 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11284 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11287 * Setting an entry to single-line mode with elm_entry_single_line_set()
11288 * will automatically disable the display of scrollbars when the entry
11289 * moves inside its scroller.
11291 * @param obj The scrolled entry object
11292 * @param h The horizontal scrollbar policy to apply
11293 * @param v The vertical scrollbar policy to apply
11295 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11297 * This enables/disables bouncing within the entry.
11299 * This function sets whether the entry will bounce when scrolling reaches
11300 * the end of the contained entry.
11302 * @param obj The scrolled entry object
11303 * @param h The horizontal bounce state
11304 * @param v The vertical bounce state
11306 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11308 * Get the bounce mode
11310 * @param obj The Entry object
11311 * @param h_bounce Allow bounce horizontally
11312 * @param v_bounce Allow bounce vertically
11314 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11316 /* pre-made filters for entries */
11318 * @typedef Elm_Entry_Filter_Limit_Size
11320 * Data for the elm_entry_filter_limit_size() entry filter.
11322 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11324 * @struct _Elm_Entry_Filter_Limit_Size
11326 * Data for the elm_entry_filter_limit_size() entry filter.
11328 struct _Elm_Entry_Filter_Limit_Size
11330 int max_char_count; /**< The maximum number of characters allowed. */
11331 int max_byte_count; /**< The maximum number of bytes allowed*/
11334 * Filter inserted text based on user defined character and byte limits
11336 * Add this filter to an entry to limit the characters that it will accept
11337 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11338 * The funtion works on the UTF-8 representation of the string, converting
11339 * it from the set markup, thus not accounting for any format in it.
11341 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11342 * it as data when setting the filter. In it, it's possible to set limits
11343 * by character count or bytes (any of them is disabled if 0), and both can
11344 * be set at the same time. In that case, it first checks for characters,
11347 * The function will cut the inserted text in order to allow only the first
11348 * number of characters that are still allowed. The cut is made in
11349 * characters, even when limiting by bytes, in order to always contain
11350 * valid ones and avoid half unicode characters making it in.
11352 * This filter, like any others, does not apply when setting the entry text
11353 * directly with elm_object_text_set() (or the deprecated
11354 * elm_entry_entry_set()).
11356 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11358 * @typedef Elm_Entry_Filter_Accept_Set
11360 * Data for the elm_entry_filter_accept_set() entry filter.
11362 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11364 * @struct _Elm_Entry_Filter_Accept_Set
11366 * Data for the elm_entry_filter_accept_set() entry filter.
11368 struct _Elm_Entry_Filter_Accept_Set
11370 const char *accepted; /**< Set of characters accepted in the entry. */
11371 const char *rejected; /**< Set of characters rejected from the entry. */
11374 * Filter inserted text based on accepted or rejected sets of characters
11376 * Add this filter to an entry to restrict the set of accepted characters
11377 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11378 * This structure contains both accepted and rejected sets, but they are
11379 * mutually exclusive.
11381 * The @c accepted set takes preference, so if it is set, the filter will
11382 * only work based on the accepted characters, ignoring anything in the
11383 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11385 * In both cases, the function filters by matching utf8 characters to the
11386 * raw markup text, so it can be used to remove formatting tags.
11388 * This filter, like any others, does not apply when setting the entry text
11389 * directly with elm_object_text_set() (or the deprecated
11390 * elm_entry_entry_set()).
11392 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11394 * Set the input panel layout of the entry
11396 * @param obj The entry object
11397 * @param layout layout type
11399 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11401 * Get the input panel layout of the entry
11403 * @param obj The entry object
11404 * @return layout type
11406 * @see elm_entry_input_panel_layout_set
11408 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11413 /* composite widgets - these basically put together basic widgets above
11414 * in convenient packages that do more than basic stuff */
11418 * @defgroup Anchorview Anchorview
11420 * @image html img/widget/anchorview/preview-00.png
11421 * @image latex img/widget/anchorview/preview-00.eps
11423 * Anchorview is for displaying text that contains markup with anchors
11424 * like <c>\<a href=1234\>something\</\></c> in it.
11426 * Besides being styled differently, the anchorview widget provides the
11427 * necessary functionality so that clicking on these anchors brings up a
11428 * popup with user defined content such as "call", "add to contacts" or
11429 * "open web page". This popup is provided using the @ref Hover widget.
11431 * This widget is very similar to @ref Anchorblock, so refer to that
11432 * widget for an example. The only difference Anchorview has is that the
11433 * widget is already provided with scrolling functionality, so if the
11434 * text set to it is too large to fit in the given space, it will scroll,
11435 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11436 * text can be displayed.
11438 * This widget emits the following signals:
11439 * @li "anchor,clicked": will be called when an anchor is clicked. The
11440 * @p event_info parameter on the callback will be a pointer of type
11441 * ::Elm_Entry_Anchorview_Info.
11443 * See @ref Anchorblock for an example on how to use both of them.
11452 * @typedef Elm_Entry_Anchorview_Info
11454 * The info sent in the callback for "anchor,clicked" signals emitted by
11455 * the Anchorview widget.
11457 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11459 * @struct _Elm_Entry_Anchorview_Info
11461 * The info sent in the callback for "anchor,clicked" signals emitted by
11462 * the Anchorview widget.
11464 struct _Elm_Entry_Anchorview_Info
11466 const char *name; /**< Name of the anchor, as indicated in its href
11468 int button; /**< The mouse button used to click on it */
11469 Evas_Object *hover; /**< The hover object to use for the popup */
11471 Evas_Coord x, y, w, h;
11472 } anchor, /**< Geometry selection of text used as anchor */
11473 hover_parent; /**< Geometry of the object used as parent by the
11475 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11476 for content on the left side of
11477 the hover. Before calling the
11478 callback, the widget will make the
11479 necessary calculations to check
11480 which sides are fit to be set with
11481 content, based on the position the
11482 hover is activated and its distance
11483 to the edges of its parent object
11485 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11486 the right side of the hover.
11487 See @ref hover_left */
11488 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11489 of the hover. See @ref hover_left */
11490 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11491 below the hover. See @ref
11495 * Add a new Anchorview object
11497 * @param parent The parent object
11498 * @return The new object or NULL if it cannot be created
11500 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11502 * Set the text to show in the anchorview
11504 * Sets the text of the anchorview to @p text. This text can include markup
11505 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11506 * text that will be specially styled and react to click events, ended with
11507 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11508 * "anchor,clicked" signal that you can attach a callback to with
11509 * evas_object_smart_callback_add(). The name of the anchor given in the
11510 * event info struct will be the one set in the href attribute, in this
11511 * case, anchorname.
11513 * Other markup can be used to style the text in different ways, but it's
11514 * up to the style defined in the theme which tags do what.
11515 * @deprecated use elm_object_text_set() instead.
11517 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11519 * Get the markup text set for the anchorview
11521 * Retrieves the text set on the anchorview, with markup tags included.
11523 * @param obj The anchorview object
11524 * @return The markup text set or @c NULL if nothing was set or an error
11526 * @deprecated use elm_object_text_set() instead.
11528 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11530 * Set the parent of the hover popup
11532 * Sets the parent object to use by the hover created by the anchorview
11533 * when an anchor is clicked. See @ref Hover for more details on this.
11534 * If no parent is set, the same anchorview object will be used.
11536 * @param obj The anchorview object
11537 * @param parent The object to use as parent for the hover
11539 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11541 * Get the parent of the hover popup
11543 * Get the object used as parent for the hover created by the anchorview
11544 * widget. See @ref Hover for more details on this.
11546 * @param obj The anchorview object
11547 * @return The object used as parent for the hover, NULL if none is set.
11549 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11551 * Set the style that the hover should use
11553 * When creating the popup hover, anchorview will request that it's
11554 * themed according to @p style.
11556 * @param obj The anchorview object
11557 * @param style The style to use for the underlying hover
11559 * @see elm_object_style_set()
11561 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11563 * Get the style that the hover should use
11565 * Get the style the hover created by anchorview will use.
11567 * @param obj The anchorview object
11568 * @return The style to use by the hover. NULL means the default is used.
11570 * @see elm_object_style_set()
11572 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11574 * Ends the hover popup in the anchorview
11576 * When an anchor is clicked, the anchorview widget will create a hover
11577 * object to use as a popup with user provided content. This function
11578 * terminates this popup, returning the anchorview to its normal state.
11580 * @param obj The anchorview object
11582 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11584 * Set bouncing behaviour when the scrolled content reaches an edge
11586 * Tell the internal scroller object whether it should bounce or not
11587 * when it reaches the respective edges for each axis.
11589 * @param obj The anchorview object
11590 * @param h_bounce Whether to bounce or not in the horizontal axis
11591 * @param v_bounce Whether to bounce or not in the vertical axis
11593 * @see elm_scroller_bounce_set()
11595 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11597 * Get the set bouncing behaviour of the internal scroller
11599 * Get whether the internal scroller should bounce when the edge of each
11600 * axis is reached scrolling.
11602 * @param obj The anchorview object
11603 * @param h_bounce Pointer where to store the bounce state of the horizontal
11605 * @param v_bounce Pointer where to store the bounce state of the vertical
11608 * @see elm_scroller_bounce_get()
11610 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11612 * Appends a custom item provider to the given anchorview
11614 * Appends the given function to the list of items providers. This list is
11615 * called, one function at a time, with the given @p data pointer, the
11616 * anchorview object and, in the @p item parameter, the item name as
11617 * referenced in its href string. Following functions in the list will be
11618 * called in order until one of them returns something different to NULL,
11619 * which should be an Evas_Object which will be used in place of the item
11622 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11623 * href=item/name\>\</item\>
11625 * @param obj The anchorview object
11626 * @param func The function to add to the list of providers
11627 * @param data User data that will be passed to the callback function
11629 * @see elm_entry_item_provider_append()
11631 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);
11633 * Prepend a custom item provider to the given anchorview
11635 * Like elm_anchorview_item_provider_append(), but it adds the function
11636 * @p func to the beginning of the list, instead of the end.
11638 * @param obj The anchorview object
11639 * @param func The function to add to the list of providers
11640 * @param data User data that will be passed to the callback function
11642 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);
11644 * Remove a custom item provider from the list of the given anchorview
11646 * Removes the function and data pairing that matches @p func and @p data.
11647 * That is, unless the same function and same user data are given, the
11648 * function will not be removed from the list. This allows us to add the
11649 * same callback several times, with different @p data pointers and be
11650 * able to remove them later without conflicts.
11652 * @param obj The anchorview object
11653 * @param func The function to remove from the list
11654 * @param data The data matching the function to remove from the list
11656 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);
11663 * @defgroup Anchorblock Anchorblock
11665 * @image html img/widget/anchorblock/preview-00.png
11666 * @image latex img/widget/anchorblock/preview-00.eps
11668 * Anchorblock is for displaying text that contains markup with anchors
11669 * like <c>\<a href=1234\>something\</\></c> in it.
11671 * Besides being styled differently, the anchorblock widget provides the
11672 * necessary functionality so that clicking on these anchors brings up a
11673 * popup with user defined content such as "call", "add to contacts" or
11674 * "open web page". This popup is provided using the @ref Hover widget.
11676 * This widget emits the following signals:
11677 * @li "anchor,clicked": will be called when an anchor is clicked. The
11678 * @p event_info parameter on the callback will be a pointer of type
11679 * ::Elm_Entry_Anchorblock_Info.
11685 * Since examples are usually better than plain words, we might as well
11686 * try @ref tutorial_anchorblock_example "one".
11689 * @addtogroup Anchorblock
11693 * @typedef Elm_Entry_Anchorblock_Info
11695 * The info sent in the callback for "anchor,clicked" signals emitted by
11696 * the Anchorblock widget.
11698 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11700 * @struct _Elm_Entry_Anchorblock_Info
11702 * The info sent in the callback for "anchor,clicked" signals emitted by
11703 * the Anchorblock widget.
11705 struct _Elm_Entry_Anchorblock_Info
11707 const char *name; /**< Name of the anchor, as indicated in its href
11709 int button; /**< The mouse button used to click on it */
11710 Evas_Object *hover; /**< The hover object to use for the popup */
11712 Evas_Coord x, y, w, h;
11713 } anchor, /**< Geometry selection of text used as anchor */
11714 hover_parent; /**< Geometry of the object used as parent by the
11716 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11717 for content on the left side of
11718 the hover. Before calling the
11719 callback, the widget will make the
11720 necessary calculations to check
11721 which sides are fit to be set with
11722 content, based on the position the
11723 hover is activated and its distance
11724 to the edges of its parent object
11726 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11727 the right side of the hover.
11728 See @ref hover_left */
11729 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11730 of the hover. See @ref hover_left */
11731 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11732 below the hover. See @ref
11736 * Add a new Anchorblock object
11738 * @param parent The parent object
11739 * @return The new object or NULL if it cannot be created
11741 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11743 * Set the text to show in the anchorblock
11745 * Sets the text of the anchorblock to @p text. This text can include markup
11746 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11747 * of text that will be specially styled and react to click events, ended
11748 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11749 * "anchor,clicked" signal that you can attach a callback to with
11750 * evas_object_smart_callback_add(). The name of the anchor given in the
11751 * event info struct will be the one set in the href attribute, in this
11752 * case, anchorname.
11754 * Other markup can be used to style the text in different ways, but it's
11755 * up to the style defined in the theme which tags do what.
11756 * @deprecated use elm_object_text_set() instead.
11758 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11760 * Get the markup text set for the anchorblock
11762 * Retrieves the text set on the anchorblock, with markup tags included.
11764 * @param obj The anchorblock object
11765 * @return The markup text set or @c NULL if nothing was set or an error
11767 * @deprecated use elm_object_text_set() instead.
11769 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11771 * Set the parent of the hover popup
11773 * Sets the parent object to use by the hover created by the anchorblock
11774 * when an anchor is clicked. See @ref Hover for more details on this.
11776 * @param obj The anchorblock object
11777 * @param parent The object to use as parent for the hover
11779 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11781 * Get the parent of the hover popup
11783 * Get the object used as parent for the hover created by the anchorblock
11784 * widget. See @ref Hover for more details on this.
11785 * If no parent is set, the same anchorblock object will be used.
11787 * @param obj The anchorblock object
11788 * @return The object used as parent for the hover, NULL if none is set.
11790 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11792 * Set the style that the hover should use
11794 * When creating the popup hover, anchorblock will request that it's
11795 * themed according to @p style.
11797 * @param obj The anchorblock object
11798 * @param style The style to use for the underlying hover
11800 * @see elm_object_style_set()
11802 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11804 * Get the style that the hover should use
11806 * Get the style the hover created by anchorblock will use.
11808 * @param obj The anchorblock object
11809 * @return The style to use by the hover. NULL means the default is used.
11811 * @see elm_object_style_set()
11813 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11815 * Ends the hover popup in the anchorblock
11817 * When an anchor is clicked, the anchorblock widget will create a hover
11818 * object to use as a popup with user provided content. This function
11819 * terminates this popup, returning the anchorblock to its normal state.
11821 * @param obj The anchorblock object
11823 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11825 * Appends a custom item provider to the given anchorblock
11827 * Appends the given function to the list of items providers. This list is
11828 * called, one function at a time, with the given @p data pointer, the
11829 * anchorblock object and, in the @p item parameter, the item name as
11830 * referenced in its href string. Following functions in the list will be
11831 * called in order until one of them returns something different to NULL,
11832 * which should be an Evas_Object which will be used in place of the item
11835 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11836 * href=item/name\>\</item\>
11838 * @param obj The anchorblock object
11839 * @param func The function to add to the list of providers
11840 * @param data User data that will be passed to the callback function
11842 * @see elm_entry_item_provider_append()
11844 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);
11846 * Prepend a custom item provider to the given anchorblock
11848 * Like elm_anchorblock_item_provider_append(), but it adds the function
11849 * @p func to the beginning of the list, instead of the end.
11851 * @param obj The anchorblock object
11852 * @param func The function to add to the list of providers
11853 * @param data User data that will be passed to the callback function
11855 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);
11857 * Remove a custom item provider from the list of the given anchorblock
11859 * Removes the function and data pairing that matches @p func and @p data.
11860 * That is, unless the same function and same user data are given, the
11861 * function will not be removed from the list. This allows us to add the
11862 * same callback several times, with different @p data pointers and be
11863 * able to remove them later without conflicts.
11865 * @param obj The anchorblock object
11866 * @param func The function to remove from the list
11867 * @param data The data matching the function to remove from the list
11869 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);
11875 * @defgroup Bubble Bubble
11877 * @image html img/widget/bubble/preview-00.png
11878 * @image latex img/widget/bubble/preview-00.eps
11879 * @image html img/widget/bubble/preview-01.png
11880 * @image latex img/widget/bubble/preview-01.eps
11881 * @image html img/widget/bubble/preview-02.png
11882 * @image latex img/widget/bubble/preview-02.eps
11884 * @brief The Bubble is a widget to show text similarly to how speech is
11885 * represented in comics.
11887 * The bubble widget contains 5 important visual elements:
11888 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11889 * @li The @p icon is an image to which the frame's arrow points to.
11890 * @li The @p label is a text which appears to the right of the icon if the
11891 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11893 * @li The @p info is a text which appears to the right of the label. Info's
11894 * font is of a ligther color than label.
11895 * @li The @p content is an evas object that is shown inside the frame.
11897 * The position of the arrow, icon, label and info depends on which corner is
11898 * selected. The four available corners are:
11899 * @li "top_left" - Default
11901 * @li "bottom_left"
11902 * @li "bottom_right"
11904 * Signals that you can add callbacks for are:
11905 * @li "clicked" - This is called when a user has clicked the bubble.
11907 * For an example of using a buble see @ref bubble_01_example_page "this".
11912 * Add a new bubble to the parent
11914 * @param parent The parent object
11915 * @return The new object or NULL if it cannot be created
11917 * This function adds a text bubble to the given parent evas object.
11919 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11921 * Set the label of the bubble
11923 * @param obj The bubble object
11924 * @param label The string to set in the label
11926 * This function sets the title of the bubble. Where this appears depends on
11927 * the selected corner.
11928 * @deprecated use elm_object_text_set() instead.
11930 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11932 * Get the label of the bubble
11934 * @param obj The bubble object
11935 * @return The string of set in the label
11937 * This function gets the title of the bubble.
11938 * @deprecated use elm_object_text_get() instead.
11940 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11942 * Set the info of the bubble
11944 * @param obj The bubble object
11945 * @param info The given info about the bubble
11947 * This function sets the info of the bubble. Where this appears depends on
11948 * the selected corner.
11949 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11951 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11953 * Get the info of the bubble
11955 * @param obj The bubble object
11957 * @return The "info" string of the bubble
11959 * This function gets the info text.
11960 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11962 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11964 * Set the content to be shown in the bubble
11966 * Once the content object is set, a previously set one will be deleted.
11967 * If you want to keep the old content object, use the
11968 * elm_bubble_content_unset() function.
11970 * @param obj The bubble object
11971 * @param content The given content of the bubble
11973 * This function sets the content shown on the middle of the bubble.
11975 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11977 * Get the content shown in the bubble
11979 * Return the content object which is set for this widget.
11981 * @param obj The bubble object
11982 * @return The content that is being used
11984 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11986 * Unset the content shown in the bubble
11988 * Unparent and return the content object which was set for this widget.
11990 * @param obj The bubble object
11991 * @return The content that was being used
11993 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11995 * Set the icon of the bubble
11997 * Once the icon object is set, a previously set one will be deleted.
11998 * If you want to keep the old content object, use the
11999 * elm_icon_content_unset() function.
12001 * @param obj The bubble object
12002 * @param icon The given icon for the bubble
12004 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12006 * Get the icon of the bubble
12008 * @param obj The bubble object
12009 * @return The icon for the bubble
12011 * This function gets the icon shown on the top left of bubble.
12013 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12015 * Unset the icon of the bubble
12017 * Unparent and return the icon object which was set for this widget.
12019 * @param obj The bubble object
12020 * @return The icon that was being used
12022 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12024 * Set the corner of the bubble
12026 * @param obj The bubble object.
12027 * @param corner The given corner for the bubble.
12029 * This function sets the corner of the bubble. The corner will be used to
12030 * determine where the arrow in the frame points to and where label, icon and
12033 * Possible values for corner are:
12034 * @li "top_left" - Default
12036 * @li "bottom_left"
12037 * @li "bottom_right"
12039 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12041 * Get the corner of the bubble
12043 * @param obj The bubble object.
12044 * @return The given corner for the bubble.
12046 * This function gets the selected corner of the bubble.
12048 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12054 * @defgroup Photo Photo
12056 * For displaying the photo of a person (contact). Simple yet
12057 * with a very specific purpose.
12059 * Signals that you can add callbacks for are:
12061 * "clicked" - This is called when a user has clicked the photo
12062 * "drag,start" - Someone started dragging the image out of the object
12063 * "drag,end" - Dragged item was dropped (somewhere)
12069 * Add a new photo to the parent
12071 * @param parent The parent object
12072 * @return The new object or NULL if it cannot be created
12076 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12079 * Set the file that will be used as photo
12081 * @param obj The photo object
12082 * @param file The path to file that will be used as photo
12084 * @return (1 = success, 0 = error)
12088 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12091 * Set the file that will be used as thumbnail in the photo.
12093 * @param obj The photo object.
12094 * @param file The path to file that will be used as thumb.
12095 * @param group The key used in case of an EET file.
12099 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12102 * Set the size that will be used on the photo
12104 * @param obj The photo object
12105 * @param size The size that the photo will be
12109 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12112 * Set if the photo should be completely visible or not.
12114 * @param obj The photo object
12115 * @param fill if true the photo will be completely visible
12119 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12122 * Set editability of the photo.
12124 * An editable photo can be dragged to or from, and can be cut or
12125 * pasted too. Note that pasting an image or dropping an item on
12126 * the image will delete the existing content.
12128 * @param obj The photo object.
12129 * @param set To set of clear editablity.
12131 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12137 /* gesture layer */
12139 * @defgroup Elm_Gesture_Layer Gesture Layer
12140 * Gesture Layer Usage:
12142 * Use Gesture Layer to detect gestures.
12143 * The advantage is that you don't have to implement
12144 * gesture detection, just set callbacks of gesture state.
12145 * By using gesture layer we make standard interface.
12147 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12148 * with a parent object parameter.
12149 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12150 * call. Usually with same object as target (2nd parameter).
12152 * Now you need to tell gesture layer what gestures you follow.
12153 * This is done with @ref elm_gesture_layer_cb_set call.
12154 * By setting the callback you actually saying to gesture layer:
12155 * I would like to know when the gesture @ref Elm_Gesture_Types
12156 * switches to state @ref Elm_Gesture_State.
12158 * Next, you need to implement the actual action that follows the input
12159 * in your callback.
12161 * Note that if you like to stop being reported about a gesture, just set
12162 * all callbacks referring this gesture to NULL.
12163 * (again with @ref elm_gesture_layer_cb_set)
12165 * The information reported by gesture layer to your callback is depending
12166 * on @ref Elm_Gesture_Types:
12167 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12168 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12169 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12171 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12172 * @ref ELM_GESTURE_MOMENTUM.
12174 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12175 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12176 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12177 * Note that we consider a flick as a line-gesture that should be completed
12178 * in flick-time-limit as defined in @ref Config.
12180 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12182 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12185 * Gesture Layer Tweaks:
12187 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12188 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12190 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12191 * so gesture starts when user touches (a *DOWN event) touch-surface
12192 * and ends when no fingers touches surface (a *UP event).
12196 * @enum _Elm_Gesture_Types
12197 * Enum of supported gesture types.
12198 * @ingroup Elm_Gesture_Layer
12200 enum _Elm_Gesture_Types
12202 ELM_GESTURE_FIRST = 0,
12204 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12205 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12206 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12207 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12209 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12211 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12212 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12214 ELM_GESTURE_ZOOM, /**< Zoom */
12215 ELM_GESTURE_ROTATE, /**< Rotate */
12221 * @typedef Elm_Gesture_Types
12222 * gesture types enum
12223 * @ingroup Elm_Gesture_Layer
12225 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12228 * @enum _Elm_Gesture_State
12229 * Enum of gesture states.
12230 * @ingroup Elm_Gesture_Layer
12232 enum _Elm_Gesture_State
12234 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12235 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12236 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12237 ELM_GESTURE_STATE_END, /**< Gesture completed */
12238 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12242 * @typedef Elm_Gesture_State
12243 * gesture states enum
12244 * @ingroup Elm_Gesture_Layer
12246 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12249 * @struct _Elm_Gesture_Taps_Info
12250 * Struct holds taps info for user
12251 * @ingroup Elm_Gesture_Layer
12253 struct _Elm_Gesture_Taps_Info
12255 Evas_Coord x, y; /**< Holds center point between fingers */
12256 unsigned int n; /**< Number of fingers tapped */
12257 unsigned int timestamp; /**< event timestamp */
12261 * @typedef Elm_Gesture_Taps_Info
12262 * holds taps info for user
12263 * @ingroup Elm_Gesture_Layer
12265 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12268 * @struct _Elm_Gesture_Momentum_Info
12269 * Struct holds momentum info for user
12270 * x1 and y1 are not necessarily in sync
12271 * x1 holds x value of x direction starting point
12272 * and same holds for y1.
12273 * This is noticeable when doing V-shape movement
12274 * @ingroup Elm_Gesture_Layer
12276 struct _Elm_Gesture_Momentum_Info
12277 { /* Report line ends, timestamps, and momentum computed */
12278 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12279 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12280 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12281 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12283 unsigned int tx; /**< Timestamp of start of final x-swipe */
12284 unsigned int ty; /**< Timestamp of start of final y-swipe */
12286 Evas_Coord mx; /**< Momentum on X */
12287 Evas_Coord my; /**< Momentum on Y */
12291 * @typedef Elm_Gesture_Momentum_Info
12292 * holds momentum info for user
12293 * @ingroup Elm_Gesture_Layer
12295 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12298 * @struct _Elm_Gesture_Line_Info
12299 * Struct holds line info for user
12300 * @ingroup Elm_Gesture_Layer
12302 struct _Elm_Gesture_Line_Info
12303 { /* Report line ends, timestamps, and momentum computed */
12304 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12305 unsigned int n; /**< Number of fingers (lines) */
12306 /* FIXME should be radians, bot degrees */
12307 double angle; /**< Angle (direction) of lines */
12311 * @typedef Elm_Gesture_Line_Info
12312 * Holds line info for user
12313 * @ingroup Elm_Gesture_Layer
12315 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12318 * @struct _Elm_Gesture_Zoom_Info
12319 * Struct holds zoom info for user
12320 * @ingroup Elm_Gesture_Layer
12322 struct _Elm_Gesture_Zoom_Info
12324 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12325 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12326 double zoom; /**< Zoom value: 1.0 means no zoom */
12327 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12331 * @typedef Elm_Gesture_Zoom_Info
12332 * Holds zoom info for user
12333 * @ingroup Elm_Gesture_Layer
12335 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12338 * @struct _Elm_Gesture_Rotate_Info
12339 * Struct holds rotation info for user
12340 * @ingroup Elm_Gesture_Layer
12342 struct _Elm_Gesture_Rotate_Info
12344 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12345 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12346 double base_angle; /**< Holds start-angle */
12347 double angle; /**< Rotation value: 0.0 means no rotation */
12348 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12352 * @typedef Elm_Gesture_Rotate_Info
12353 * Holds rotation info for user
12354 * @ingroup Elm_Gesture_Layer
12356 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12359 * @typedef Elm_Gesture_Event_Cb
12360 * User callback used to stream gesture info from gesture layer
12361 * @param data user data
12362 * @param event_info gesture report info
12363 * Returns a flag field to be applied on the causing event.
12364 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12365 * upon the event, in an irreversible way.
12367 * @ingroup Elm_Gesture_Layer
12369 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12372 * Use function to set callbacks to be notified about
12373 * change of state of gesture.
12374 * When a user registers a callback with this function
12375 * this means this gesture has to be tested.
12377 * When ALL callbacks for a gesture are set to NULL
12378 * it means user isn't interested in gesture-state
12379 * and it will not be tested.
12381 * @param obj Pointer to gesture-layer.
12382 * @param idx The gesture you would like to track its state.
12383 * @param cb callback function pointer.
12384 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12385 * @param data user info to be sent to callback (usually, Smart Data)
12387 * @ingroup Elm_Gesture_Layer
12389 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);
12392 * Call this function to get repeat-events settings.
12394 * @param obj Pointer to gesture-layer.
12396 * @return repeat events settings.
12397 * @see elm_gesture_layer_hold_events_set()
12398 * @ingroup Elm_Gesture_Layer
12400 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12403 * This function called in order to make gesture-layer repeat events.
12404 * Set this of you like to get the raw events only if gestures were not detected.
12405 * Clear this if you like gesture layer to fwd events as testing gestures.
12407 * @param obj Pointer to gesture-layer.
12408 * @param r Repeat: TRUE/FALSE
12410 * @ingroup Elm_Gesture_Layer
12412 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12415 * This function sets step-value for zoom action.
12416 * Set step to any positive value.
12417 * Cancel step setting by setting to 0.0
12419 * @param obj Pointer to gesture-layer.
12420 * @param s new zoom step value.
12422 * @ingroup Elm_Gesture_Layer
12424 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12427 * This function sets step-value for rotate action.
12428 * Set step to any positive value.
12429 * Cancel step setting by setting to 0.0
12431 * @param obj Pointer to gesture-layer.
12432 * @param s new roatate step value.
12434 * @ingroup Elm_Gesture_Layer
12436 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12439 * This function called to attach gesture-layer to an Evas_Object.
12440 * @param obj Pointer to gesture-layer.
12441 * @param t Pointer to underlying object (AKA Target)
12443 * @return TRUE, FALSE on success, failure.
12445 * @ingroup Elm_Gesture_Layer
12447 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12450 * Call this function to construct a new gesture-layer object.
12451 * This does not activate the gesture layer. You have to
12452 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12454 * @param parent the parent object.
12456 * @return Pointer to new gesture-layer object.
12458 * @ingroup Elm_Gesture_Layer
12460 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12463 * @defgroup Thumb Thumb
12465 * @image html img/widget/thumb/preview-00.png
12466 * @image latex img/widget/thumb/preview-00.eps
12468 * A thumb object is used for displaying the thumbnail of an image or video.
12469 * You must have compiled Elementary with Ethumb_Client support and the DBus
12470 * service must be present and auto-activated in order to have thumbnails to
12473 * Once the thumbnail object becomes visible, it will check if there is a
12474 * previously generated thumbnail image for the file set on it. If not, it
12475 * will start generating this thumbnail.
12477 * Different config settings will cause different thumbnails to be generated
12478 * even on the same file.
12480 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12481 * Ethumb documentation to change this path, and to see other configuration
12484 * Signals that you can add callbacks for are:
12486 * - "clicked" - This is called when a user has clicked the thumb without dragging
12488 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12489 * - "press" - This is called when a user has pressed down the thumb.
12490 * - "generate,start" - The thumbnail generation started.
12491 * - "generate,stop" - The generation process stopped.
12492 * - "generate,error" - The generation failed.
12493 * - "load,error" - The thumbnail image loading failed.
12495 * available styles:
12499 * An example of use of thumbnail:
12501 * - @ref thumb_example_01
12505 * @addtogroup Thumb
12510 * @enum _Elm_Thumb_Animation_Setting
12511 * @typedef Elm_Thumb_Animation_Setting
12513 * Used to set if a video thumbnail is animating or not.
12517 typedef enum _Elm_Thumb_Animation_Setting
12519 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12520 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12521 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12522 ELM_THUMB_ANIMATION_LAST
12523 } Elm_Thumb_Animation_Setting;
12526 * Add a new thumb object to the parent.
12528 * @param parent The parent object.
12529 * @return The new object or NULL if it cannot be created.
12531 * @see elm_thumb_file_set()
12532 * @see elm_thumb_ethumb_client_get()
12536 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12538 * Reload thumbnail if it was generated before.
12540 * @param obj The thumb object to reload
12542 * This is useful if the ethumb client configuration changed, like its
12543 * size, aspect or any other property one set in the handle returned
12544 * by elm_thumb_ethumb_client_get().
12546 * If the options didn't change, the thumbnail won't be generated again, but
12547 * the old one will still be used.
12549 * @see elm_thumb_file_set()
12553 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12555 * Set the file that will be used as thumbnail.
12557 * @param obj The thumb object.
12558 * @param file The path to file that will be used as thumb.
12559 * @param key The key used in case of an EET file.
12561 * The file can be an image or a video (in that case, acceptable extensions are:
12562 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12563 * function elm_thumb_animate().
12565 * @see elm_thumb_file_get()
12566 * @see elm_thumb_reload()
12567 * @see elm_thumb_animate()
12571 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12573 * Get the image or video path and key used to generate the thumbnail.
12575 * @param obj The thumb object.
12576 * @param file Pointer to filename.
12577 * @param key Pointer to key.
12579 * @see elm_thumb_file_set()
12580 * @see elm_thumb_path_get()
12584 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12586 * Get the path and key to the image or video generated by ethumb.
12588 * One just need to make sure that the thumbnail was generated before getting
12589 * its path; otherwise, the path will be NULL. One way to do that is by asking
12590 * for the path when/after the "generate,stop" smart callback is called.
12592 * @param obj The thumb object.
12593 * @param file Pointer to thumb path.
12594 * @param key Pointer to thumb key.
12596 * @see elm_thumb_file_get()
12600 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12602 * Set the animation state for the thumb object. If its content is an animated
12603 * video, you may start/stop the animation or tell it to play continuously and
12606 * @param obj The thumb object.
12607 * @param setting The animation setting.
12609 * @see elm_thumb_file_set()
12613 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12615 * Get the animation state for the thumb object.
12617 * @param obj The thumb object.
12618 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12621 * @see elm_thumb_animate_set()
12625 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12627 * Get the ethumb_client handle so custom configuration can be made.
12629 * @return Ethumb_Client instance or NULL.
12631 * This must be called before the objects are created to be sure no object is
12632 * visible and no generation started.
12634 * Example of usage:
12637 * #include <Elementary.h>
12638 * #ifndef ELM_LIB_QUICKLAUNCH
12640 * elm_main(int argc, char **argv)
12642 * Ethumb_Client *client;
12644 * elm_need_ethumb();
12648 * client = elm_thumb_ethumb_client_get();
12651 * ERR("could not get ethumb_client");
12654 * ethumb_client_size_set(client, 100, 100);
12655 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12658 * // Create elm_thumb objects here
12668 * @note There's only one client handle for Ethumb, so once a configuration
12669 * change is done to it, any other request for thumbnails (for any thumbnail
12670 * object) will use that configuration. Thus, this configuration is global.
12674 EAPI void *elm_thumb_ethumb_client_get(void);
12676 * Get the ethumb_client connection state.
12678 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12681 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12683 * Make the thumbnail 'editable'.
12685 * @param obj Thumb object.
12686 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12688 * This means the thumbnail is a valid drag target for drag and drop, and can be
12689 * cut or pasted too.
12691 * @see elm_thumb_editable_get()
12695 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12697 * Make the thumbnail 'editable'.
12699 * @param obj Thumb object.
12700 * @return Editability.
12702 * This means the thumbnail is a valid drag target for drag and drop, and can be
12703 * cut or pasted too.
12705 * @see elm_thumb_editable_set()
12709 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12716 * @defgroup Hoversel Hoversel
12718 * @image html img/widget/hoversel/preview-00.png
12719 * @image latex img/widget/hoversel/preview-00.eps
12721 * A hoversel is a button that pops up a list of items (automatically
12722 * choosing the direction to display) that have a label and, optionally, an
12723 * icon to select from. It is a convenience widget to avoid the need to do
12724 * all the piecing together yourself. It is intended for a small number of
12725 * items in the hoversel menu (no more than 8), though is capable of many
12728 * Signals that you can add callbacks for are:
12729 * "clicked" - the user clicked the hoversel button and popped up the sel
12730 * "selected" - an item in the hoversel list is selected. event_info is the item
12731 * "dismissed" - the hover is dismissed
12733 * See @ref tutorial_hoversel for an example.
12736 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12738 * @brief Add a new Hoversel object
12740 * @param parent The parent object
12741 * @return The new object or NULL if it cannot be created
12743 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12745 * @brief This sets the hoversel to expand horizontally.
12747 * @param obj The hoversel object
12748 * @param horizontal If true, the hover will expand horizontally to the
12751 * @note The initial button will display horizontally regardless of this
12754 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12756 * @brief This returns whether the hoversel is set to expand horizontally.
12758 * @param obj The hoversel object
12759 * @return If true, the hover will expand horizontally to the right.
12761 * @see elm_hoversel_horizontal_set()
12763 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12765 * @brief Set the Hover parent
12767 * @param obj The hoversel object
12768 * @param parent The parent to use
12770 * Sets the hover parent object, the area that will be darkened when the
12771 * hoversel is clicked. Should probably be the window that the hoversel is
12772 * in. See @ref Hover objects for more information.
12774 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12776 * @brief Get the Hover parent
12778 * @param obj The hoversel object
12779 * @return The used parent
12781 * Gets the hover parent object.
12783 * @see elm_hoversel_hover_parent_set()
12785 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12787 * @brief Set the hoversel button label
12789 * @param obj The hoversel object
12790 * @param label The label text.
12792 * This sets the label of the button that is always visible (before it is
12793 * clicked and expanded).
12795 * @deprecated elm_object_text_set()
12797 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12799 * @brief Get the hoversel button label
12801 * @param obj The hoversel object
12802 * @return The label text.
12804 * @deprecated elm_object_text_get()
12806 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12808 * @brief Set the icon of the hoversel button
12810 * @param obj The hoversel object
12811 * @param icon The icon object
12813 * Sets the icon of the button that is always visible (before it is clicked
12814 * and expanded). Once the icon object is set, a previously set one will be
12815 * deleted, if you want to keep that old content object, use the
12816 * elm_hoversel_icon_unset() function.
12818 * @see elm_button_icon_set()
12820 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12822 * @brief Get the icon of the hoversel button
12824 * @param obj The hoversel object
12825 * @return The icon object
12827 * Get the icon of the button that is always visible (before it is clicked
12828 * and expanded). Also see elm_button_icon_get().
12830 * @see elm_hoversel_icon_set()
12832 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12834 * @brief Get and unparent the icon of the hoversel button
12836 * @param obj The hoversel object
12837 * @return The icon object that was being used
12839 * Unparent and return the icon of the button that is always visible
12840 * (before it is clicked and expanded).
12842 * @see elm_hoversel_icon_set()
12843 * @see elm_button_icon_unset()
12845 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12847 * @brief This triggers the hoversel popup from code, the same as if the user
12848 * had clicked the button.
12850 * @param obj The hoversel object
12852 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12854 * @brief This dismisses the hoversel popup as if the user had clicked
12855 * outside the hover.
12857 * @param obj The hoversel object
12859 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12861 * @brief Returns whether the hoversel is expanded.
12863 * @param obj The hoversel object
12864 * @return This will return EINA_TRUE if the hoversel is expanded or
12865 * EINA_FALSE if it is not expanded.
12867 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12869 * @brief This will remove all the children items from the hoversel.
12871 * @param obj The hoversel object
12873 * @warning Should @b not be called while the hoversel is active; use
12874 * elm_hoversel_expanded_get() to check first.
12876 * @see elm_hoversel_item_del_cb_set()
12877 * @see elm_hoversel_item_del()
12879 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12881 * @brief Get the list of items within the given hoversel.
12883 * @param obj The hoversel object
12884 * @return Returns a list of Elm_Hoversel_Item*
12886 * @see elm_hoversel_item_add()
12888 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12890 * @brief Add an item to the hoversel button
12892 * @param obj The hoversel object
12893 * @param label The text label to use for the item (NULL if not desired)
12894 * @param icon_file An image file path on disk to use for the icon or standard
12895 * icon name (NULL if not desired)
12896 * @param icon_type The icon type if relevant
12897 * @param func Convenience function to call when this item is selected
12898 * @param data Data to pass to item-related functions
12899 * @return A handle to the item added.
12901 * This adds an item to the hoversel to show when it is clicked. Note: if you
12902 * need to use an icon from an edje file then use
12903 * elm_hoversel_item_icon_set() right after the this function, and set
12904 * icon_file to NULL here.
12906 * For more information on what @p icon_file and @p icon_type are see the
12907 * @ref Icon "icon documentation".
12909 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);
12911 * @brief Delete an item from the hoversel
12913 * @param item The item to delete
12915 * This deletes the item from the hoversel (should not be called while the
12916 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12918 * @see elm_hoversel_item_add()
12919 * @see elm_hoversel_item_del_cb_set()
12921 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12923 * @brief Set the function to be called when an item from the hoversel is
12926 * @param item The item to set the callback on
12927 * @param func The function called
12929 * That function will receive these parameters:
12930 * @li void *item_data
12931 * @li Evas_Object *the_item_object
12932 * @li Elm_Hoversel_Item *the_object_struct
12934 * @see elm_hoversel_item_add()
12936 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12938 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12939 * that will be passed to associated function callbacks.
12941 * @param item The item to get the data from
12942 * @return The data pointer set with elm_hoversel_item_add()
12944 * @see elm_hoversel_item_add()
12946 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12948 * @brief This returns the label text of the given hoversel item.
12950 * @param item The item to get the label
12951 * @return The label text of the hoversel item
12953 * @see elm_hoversel_item_add()
12955 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12957 * @brief This sets the icon for the given hoversel item.
12959 * @param item The item to set the icon
12960 * @param icon_file An image file path on disk to use for the icon or standard
12962 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12963 * to NULL if the icon is not an edje file
12964 * @param icon_type The icon type
12966 * The icon can be loaded from the standard set, from an image file, or from
12969 * @see elm_hoversel_item_add()
12971 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);
12973 * @brief Get the icon object of the hoversel item
12975 * @param item The item to get the icon from
12976 * @param icon_file The image file path on disk used for the icon or standard
12978 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12979 * if the icon is not an edje file
12980 * @param icon_type The icon type
12982 * @see elm_hoversel_item_icon_set()
12983 * @see elm_hoversel_item_add()
12985 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);
12991 * @defgroup Toolbar Toolbar
12992 * @ingroup Elementary
12994 * @image html img/widget/toolbar/preview-00.png
12995 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12997 * @image html img/toolbar.png
12998 * @image latex img/toolbar.eps width=\textwidth
13000 * A toolbar is a widget that displays a list of items inside
13001 * a box. It can be scrollable, show a menu with items that don't fit
13002 * to toolbar size or even crop them.
13004 * Only one item can be selected at a time.
13006 * Items can have multiple states, or show menus when selected by the user.
13008 * Smart callbacks one can listen to:
13009 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13011 * Available styles for it:
13013 * - @c "transparent" - no background or shadow, just show the content
13015 * List of examples:
13016 * @li @ref toolbar_example_01
13017 * @li @ref toolbar_example_02
13018 * @li @ref toolbar_example_03
13022 * @addtogroup Toolbar
13027 * @enum _Elm_Toolbar_Shrink_Mode
13028 * @typedef Elm_Toolbar_Shrink_Mode
13030 * Set toolbar's items display behavior, it can be scrollabel,
13031 * show a menu with exceeding items, or simply hide them.
13033 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13036 * Values <b> don't </b> work as bitmask, only one can be choosen.
13038 * @see elm_toolbar_mode_shrink_set()
13039 * @see elm_toolbar_mode_shrink_get()
13043 typedef enum _Elm_Toolbar_Shrink_Mode
13045 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
13046 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
13047 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13048 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
13049 } Elm_Toolbar_Shrink_Mode;
13051 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(). */
13053 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(). */
13056 * Add a new toolbar widget to the given parent Elementary
13057 * (container) object.
13059 * @param parent The parent object.
13060 * @return a new toolbar widget handle or @c NULL, on errors.
13062 * This function inserts a new toolbar widget on the canvas.
13066 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13069 * Set the icon size, in pixels, to be used by toolbar items.
13071 * @param obj The toolbar object
13072 * @param icon_size The icon size in pixels
13074 * @note Default value is @c 32. It reads value from elm config.
13076 * @see elm_toolbar_icon_size_get()
13080 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13083 * Get the icon size, in pixels, to be used by toolbar items.
13085 * @param obj The toolbar object.
13086 * @return The icon size in pixels.
13088 * @see elm_toolbar_icon_size_set() for details.
13092 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13095 * Sets icon lookup order, for toolbar items' icons.
13097 * @param obj The toolbar object.
13098 * @param order The icon lookup order.
13100 * Icons added before calling this function will not be affected.
13101 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13103 * @see elm_toolbar_icon_order_lookup_get()
13107 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13110 * Gets the icon lookup order.
13112 * @param obj The toolbar object.
13113 * @return The icon lookup order.
13115 * @see elm_toolbar_icon_order_lookup_set() for details.
13119 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13122 * Set whether the toolbar items' should be selected by the user or not.
13124 * @param obj The toolbar object.
13125 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13128 * This will turn off the ability to select items entirely and they will
13129 * neither appear selected nor emit selected signals. The clicked
13130 * callback function will still be called.
13132 * Selection is enabled by default.
13134 * @see elm_toolbar_no_select_mode_get().
13138 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13141 * Set whether the toolbar items' should be selected by the user or not.
13143 * @param obj The toolbar object.
13144 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13145 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13147 * @see elm_toolbar_no_select_mode_set() for details.
13151 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13154 * Append item to the toolbar.
13156 * @param obj The toolbar object.
13157 * @param icon A string with icon name or the absolute path of an image file.
13158 * @param label The label of the item.
13159 * @param func The function to call when the item is clicked.
13160 * @param data The data to associate with the item for related callbacks.
13161 * @return The created item or @c NULL upon failure.
13163 * A new item will be created and appended to the toolbar, i.e., will
13164 * be set as @b last item.
13166 * Items created with this method can be deleted with
13167 * elm_toolbar_item_del().
13169 * Associated @p data can be properly freed when item is deleted if a
13170 * callback function is set with elm_toolbar_item_del_cb_set().
13172 * If a function is passed as argument, it will be called everytime this item
13173 * is selected, i.e., the user clicks over an unselected item.
13174 * If such function isn't needed, just passing
13175 * @c NULL as @p func is enough. The same should be done for @p data.
13177 * Toolbar will load icon image from fdo or current theme.
13178 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13179 * If an absolute path is provided it will load it direct from a file.
13181 * @see elm_toolbar_item_icon_set()
13182 * @see elm_toolbar_item_del()
13183 * @see elm_toolbar_item_del_cb_set()
13187 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);
13190 * Prepend item to the toolbar.
13192 * @param obj The toolbar object.
13193 * @param icon A string with icon name or the absolute path of an image file.
13194 * @param label The label of the item.
13195 * @param func The function to call when the item is clicked.
13196 * @param data The data to associate with the item for related callbacks.
13197 * @return The created item or @c NULL upon failure.
13199 * A new item will be created and prepended to the toolbar, i.e., will
13200 * be set as @b first item.
13202 * Items created with this method can be deleted with
13203 * elm_toolbar_item_del().
13205 * Associated @p data can be properly freed when item is deleted if a
13206 * callback function is set with elm_toolbar_item_del_cb_set().
13208 * If a function is passed as argument, it will be called everytime this item
13209 * is selected, i.e., the user clicks over an unselected item.
13210 * If such function isn't needed, just passing
13211 * @c NULL as @p func is enough. The same should be done for @p data.
13213 * Toolbar will load icon image from fdo or current theme.
13214 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13215 * If an absolute path is provided it will load it direct from a file.
13217 * @see elm_toolbar_item_icon_set()
13218 * @see elm_toolbar_item_del()
13219 * @see elm_toolbar_item_del_cb_set()
13223 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);
13226 * Insert a new item into the toolbar object before item @p before.
13228 * @param obj The toolbar object.
13229 * @param before The toolbar item to insert before.
13230 * @param icon A string with icon name or the absolute path of an image file.
13231 * @param label The label of the item.
13232 * @param func The function to call when the item is clicked.
13233 * @param data The data to associate with the item for related callbacks.
13234 * @return The created item or @c NULL upon failure.
13236 * A new item will be created and added to the toolbar. Its position in
13237 * this toolbar will be just before item @p before.
13239 * Items created with this method can be deleted with
13240 * elm_toolbar_item_del().
13242 * Associated @p data can be properly freed when item is deleted if a
13243 * callback function is set with elm_toolbar_item_del_cb_set().
13245 * If a function is passed as argument, it will be called everytime this item
13246 * is selected, i.e., the user clicks over an unselected item.
13247 * If such function isn't needed, just passing
13248 * @c NULL as @p func is enough. The same should be done for @p data.
13250 * Toolbar will load icon image from fdo or current theme.
13251 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13252 * If an absolute path is provided it will load it direct from a file.
13254 * @see elm_toolbar_item_icon_set()
13255 * @see elm_toolbar_item_del()
13256 * @see elm_toolbar_item_del_cb_set()
13260 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);
13263 * Insert a new item into the toolbar object after item @p after.
13265 * @param obj The toolbar object.
13266 * @param before The toolbar item to insert before.
13267 * @param icon A string with icon name or the absolute path of an image file.
13268 * @param label The label of the item.
13269 * @param func The function to call when the item is clicked.
13270 * @param data The data to associate with the item for related callbacks.
13271 * @return The created item or @c NULL upon failure.
13273 * A new item will be created and added to the toolbar. Its position in
13274 * this toolbar will be just after item @p after.
13276 * Items created with this method can be deleted with
13277 * elm_toolbar_item_del().
13279 * Associated @p data can be properly freed when item is deleted if a
13280 * callback function is set with elm_toolbar_item_del_cb_set().
13282 * If a function is passed as argument, it will be called everytime this item
13283 * is selected, i.e., the user clicks over an unselected item.
13284 * If such function isn't needed, just passing
13285 * @c NULL as @p func is enough. The same should be done for @p data.
13287 * Toolbar will load icon image from fdo or current theme.
13288 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13289 * If an absolute path is provided it will load it direct from a file.
13291 * @see elm_toolbar_item_icon_set()
13292 * @see elm_toolbar_item_del()
13293 * @see elm_toolbar_item_del_cb_set()
13297 EAPI Elm_Toolbar_Item *elm_toolbar_item_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);
13300 * Get the first item in the given toolbar widget's list of
13303 * @param obj The toolbar object
13304 * @return The first item or @c NULL, if it has no items (and on
13307 * @see elm_toolbar_item_append()
13308 * @see elm_toolbar_last_item_get()
13312 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13315 * Get the last item in the given toolbar widget's list of
13318 * @param obj The toolbar object
13319 * @return The last item or @c NULL, if it has no items (and on
13322 * @see elm_toolbar_item_prepend()
13323 * @see elm_toolbar_first_item_get()
13327 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13330 * Get the item after @p item in toolbar.
13332 * @param item The toolbar item.
13333 * @return The item after @p item, or @c NULL if none or on failure.
13335 * @note If it is the last item, @c NULL will be returned.
13337 * @see elm_toolbar_item_append()
13341 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13344 * Get the item before @p item in toolbar.
13346 * @param item The toolbar item.
13347 * @return The item before @p item, or @c NULL if none or on failure.
13349 * @note If it is the first item, @c NULL will be returned.
13351 * @see elm_toolbar_item_prepend()
13355 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13358 * Get the toolbar object from an item.
13360 * @param item The item.
13361 * @return The toolbar object.
13363 * This returns the toolbar object itself that an item belongs to.
13367 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13370 * Set the priority of a toolbar item.
13372 * @param item The toolbar item.
13373 * @param priority The item priority. The default is zero.
13375 * This is used only when the toolbar shrink mode is set to
13376 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13377 * When space is less than required, items with low priority
13378 * will be removed from the toolbar and added to a dynamically-created menu,
13379 * while items with higher priority will remain on the toolbar,
13380 * with the same order they were added.
13382 * @see elm_toolbar_item_priority_get()
13386 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13389 * Get the priority of a toolbar item.
13391 * @param item The toolbar item.
13392 * @return The @p item priority, or @c 0 on failure.
13394 * @see elm_toolbar_item_priority_set() for details.
13398 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13401 * Get the label of item.
13403 * @param item The item of toolbar.
13404 * @return The label of item.
13406 * The return value is a pointer to the label associated to @p item when
13407 * it was created, with function elm_toolbar_item_append() or similar,
13409 * with function elm_toolbar_item_label_set. If no label
13410 * was passed as argument, it will return @c NULL.
13412 * @see elm_toolbar_item_label_set() for more details.
13413 * @see elm_toolbar_item_append()
13417 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13420 * Set the label of item.
13422 * @param item The item of toolbar.
13423 * @param text The label of item.
13425 * The label to be displayed by the item.
13426 * Label will be placed at icons bottom (if set).
13428 * If a label was passed as argument on item creation, with function
13429 * elm_toolbar_item_append() or similar, it will be already
13430 * displayed by the item.
13432 * @see elm_toolbar_item_label_get()
13433 * @see elm_toolbar_item_append()
13437 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13440 * Return the data associated with a given toolbar widget item.
13442 * @param item The toolbar widget item handle.
13443 * @return The data associated with @p item.
13445 * @see elm_toolbar_item_data_set()
13449 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13452 * Set the data associated with a given toolbar widget item.
13454 * @param item The toolbar widget item handle.
13455 * @param data The new data pointer to set to @p item.
13457 * This sets new item data on @p item.
13459 * @warning The old data pointer won't be touched by this function, so
13460 * the user had better to free that old data himself/herself.
13464 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13467 * Returns a pointer to a toolbar item by its label.
13469 * @param obj The toolbar object.
13470 * @param label The label of the item to find.
13472 * @return The pointer to the toolbar item matching @p label or @c NULL
13477 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13480 * Get whether the @p item is selected or not.
13482 * @param item The toolbar item.
13483 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13484 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13486 * @see elm_toolbar_selected_item_set() for details.
13487 * @see elm_toolbar_item_selected_get()
13491 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13494 * Set the selected state of an item.
13496 * @param item The toolbar item
13497 * @param selected The selected state
13499 * This sets the selected state of the given item @p it.
13500 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13502 * If a new item is selected the previosly selected will be unselected.
13503 * Previoulsy selected item can be get with function
13504 * elm_toolbar_selected_item_get().
13506 * Selected items will be highlighted.
13508 * @see elm_toolbar_item_selected_get()
13509 * @see elm_toolbar_selected_item_get()
13513 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13516 * Get the selected item.
13518 * @param obj The toolbar object.
13519 * @return The selected toolbar item.
13521 * The selected item can be unselected with function
13522 * elm_toolbar_item_selected_set().
13524 * The selected item always will be highlighted on toolbar.
13526 * @see elm_toolbar_selected_items_get()
13530 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13533 * Set the icon associated with @p item.
13535 * @param obj The parent of this item.
13536 * @param item The toolbar item.
13537 * @param icon A string with icon name or the absolute path of an image file.
13539 * Toolbar will load icon image from fdo or current theme.
13540 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13541 * If an absolute path is provided it will load it direct from a file.
13543 * @see elm_toolbar_icon_order_lookup_set()
13544 * @see elm_toolbar_icon_order_lookup_get()
13548 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13551 * Get the string used to set the icon of @p item.
13553 * @param item The toolbar item.
13554 * @return The string associated with the icon object.
13556 * @see elm_toolbar_item_icon_set() for details.
13560 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13563 * Delete them item from the toolbar.
13565 * @param item The item of toolbar to be deleted.
13567 * @see elm_toolbar_item_append()
13568 * @see elm_toolbar_item_del_cb_set()
13572 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13575 * Set the function called when a toolbar item is freed.
13577 * @param item The item to set the callback on.
13578 * @param func The function called.
13580 * If there is a @p func, then it will be called prior item's memory release.
13581 * That will be called with the following arguments:
13583 * @li item's Evas object;
13586 * This way, a data associated to a toolbar item could be properly freed.
13590 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13593 * Get a value whether toolbar item is disabled or not.
13595 * @param item The item.
13596 * @return The disabled state.
13598 * @see elm_toolbar_item_disabled_set() for more details.
13602 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13605 * Sets the disabled/enabled state of a toolbar item.
13607 * @param item The item.
13608 * @param disabled The disabled state.
13610 * A disabled item cannot be selected or unselected. It will also
13611 * change its appearance (generally greyed out). This sets the
13612 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13617 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13620 * Set or unset item as a separator.
13622 * @param item The toolbar item.
13623 * @param setting @c EINA_TRUE to set item @p item as separator or
13624 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13626 * Items aren't set as separator by default.
13628 * If set as separator it will display separator theme, so won't display
13631 * @see elm_toolbar_item_separator_get()
13635 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13638 * Get a value whether item is a separator or not.
13640 * @param item The toolbar item.
13641 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13642 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13644 * @see elm_toolbar_item_separator_set() for details.
13648 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13651 * Set the shrink state of toolbar @p obj.
13653 * @param obj The toolbar object.
13654 * @param shrink_mode Toolbar's items display behavior.
13656 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13657 * but will enforce a minimun size so all the items will fit, won't scroll
13658 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13659 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13660 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13664 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13667 * Get the shrink mode of toolbar @p obj.
13669 * @param obj The toolbar object.
13670 * @return Toolbar's items display behavior.
13672 * @see elm_toolbar_mode_shrink_set() for details.
13676 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13679 * Enable/disable homogenous mode.
13681 * @param obj The toolbar object
13682 * @param homogeneous Assume the items within the toolbar are of the
13683 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13685 * This will enable the homogeneous mode where items are of the same size.
13686 * @see elm_toolbar_homogeneous_get()
13690 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13693 * Get whether the homogenous mode is enabled.
13695 * @param obj The toolbar object.
13696 * @return Assume the items within the toolbar are of the same height
13697 * and width (EINA_TRUE = on, EINA_FALSE = off).
13699 * @see elm_toolbar_homogeneous_set()
13703 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13706 * Enable/disable homogenous mode.
13708 * @param obj The toolbar object
13709 * @param homogeneous Assume the items within the toolbar are of the
13710 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13712 * This will enable the homogeneous mode where items are of the same size.
13713 * @see elm_toolbar_homogeneous_get()
13715 * @deprecated use elm_toolbar_homogeneous_set() instead.
13719 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13722 * Get whether the homogenous mode is enabled.
13724 * @param obj The toolbar object.
13725 * @return Assume the items within the toolbar are of the same height
13726 * and width (EINA_TRUE = on, EINA_FALSE = off).
13728 * @see elm_toolbar_homogeneous_set()
13729 * @deprecated use elm_toolbar_homogeneous_get() instead.
13733 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13736 * Set the parent object of the toolbar items' menus.
13738 * @param obj The toolbar object.
13739 * @param parent The parent of the menu objects.
13741 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13743 * For more details about setting the parent for toolbar menus, see
13744 * elm_menu_parent_set().
13746 * @see elm_menu_parent_set() for details.
13747 * @see elm_toolbar_item_menu_set() for details.
13751 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13754 * Get the parent object of the toolbar items' menus.
13756 * @param obj The toolbar object.
13757 * @return The parent of the menu objects.
13759 * @see elm_toolbar_menu_parent_set() for details.
13763 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13766 * Set the alignment of the items.
13768 * @param obj The toolbar object.
13769 * @param align The new alignment, a float between <tt> 0.0 </tt>
13770 * and <tt> 1.0 </tt>.
13772 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13773 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13776 * Centered items by default.
13778 * @see elm_toolbar_align_get()
13782 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13785 * Get the alignment of the items.
13787 * @param obj The toolbar object.
13788 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13791 * @see elm_toolbar_align_set() for details.
13795 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13798 * Set whether the toolbar item opens a menu.
13800 * @param item The toolbar item.
13801 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13803 * A toolbar item can be set to be a menu, using this function.
13805 * Once it is set to be a menu, it can be manipulated through the
13806 * menu-like function elm_toolbar_menu_parent_set() and the other
13807 * elm_menu functions, using the Evas_Object @c menu returned by
13808 * elm_toolbar_item_menu_get().
13810 * So, items to be displayed in this item's menu should be added with
13811 * elm_menu_item_add().
13813 * The following code exemplifies the most basic usage:
13815 * tb = elm_toolbar_add(win)
13816 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13817 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13818 * elm_toolbar_menu_parent_set(tb, win);
13819 * menu = elm_toolbar_item_menu_get(item);
13820 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13821 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13825 * @see elm_toolbar_item_menu_get()
13829 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13832 * Get toolbar item's menu.
13834 * @param item The toolbar item.
13835 * @return Item's menu object or @c NULL on failure.
13837 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13838 * this function will set it.
13840 * @see elm_toolbar_item_menu_set() for details.
13844 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13847 * Add a new state to @p item.
13849 * @param item The item.
13850 * @param icon A string with icon name or the absolute path of an image file.
13851 * @param label The label of the new state.
13852 * @param func The function to call when the item is clicked when this
13853 * state is selected.
13854 * @param data The data to associate with the state.
13855 * @return The toolbar item state, or @c NULL upon failure.
13857 * Toolbar will load icon image from fdo or current theme.
13858 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13859 * If an absolute path is provided it will load it direct from a file.
13861 * States created with this function can be removed with
13862 * elm_toolbar_item_state_del().
13864 * @see elm_toolbar_item_state_del()
13865 * @see elm_toolbar_item_state_sel()
13866 * @see elm_toolbar_item_state_get()
13870 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);
13873 * Delete a previoulsy added state to @p item.
13875 * @param item The toolbar item.
13876 * @param state The state to be deleted.
13877 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13879 * @see elm_toolbar_item_state_add()
13881 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13884 * Set @p state as the current state of @p it.
13886 * @param it The item.
13887 * @param state The state to use.
13888 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13890 * If @p state is @c NULL, it won't select any state and the default item's
13891 * icon and label will be used. It's the same behaviour than
13892 * elm_toolbar_item_state_unser().
13894 * @see elm_toolbar_item_state_unset()
13898 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13901 * Unset the state of @p it.
13903 * @param it The item.
13905 * The default icon and label from this item will be displayed.
13907 * @see elm_toolbar_item_state_set() for more details.
13911 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13914 * Get the current state of @p it.
13916 * @param item The item.
13917 * @return The selected state or @c NULL if none is selected or on failure.
13919 * @see elm_toolbar_item_state_set() for details.
13920 * @see elm_toolbar_item_state_unset()
13921 * @see elm_toolbar_item_state_add()
13925 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13928 * Get the state after selected state in toolbar's @p item.
13930 * @param it The toolbar item to change state.
13931 * @return The state after current state, or @c NULL on failure.
13933 * If last state is selected, this function will return first state.
13935 * @see elm_toolbar_item_state_set()
13936 * @see elm_toolbar_item_state_add()
13940 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13943 * Get the state before selected state in toolbar's @p item.
13945 * @param it The toolbar item to change state.
13946 * @return The state before current state, or @c NULL on failure.
13948 * If first state is selected, this function will return last state.
13950 * @see elm_toolbar_item_state_set()
13951 * @see elm_toolbar_item_state_add()
13955 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13958 * Set the text to be shown in a given toolbar item's tooltips.
13960 * @param item Target item.
13961 * @param text The text to set in the content.
13963 * Setup the text as tooltip to object. The item can have only one tooltip,
13964 * so any previous tooltip data - set with this function or
13965 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13967 * @see elm_object_tooltip_text_set() for more details.
13971 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13974 * Set the content to be shown in the tooltip item.
13976 * Setup the tooltip to item. The item can have only one tooltip,
13977 * so any previous tooltip data is removed. @p func(with @p data) will
13978 * be called every time that need show the tooltip and it should
13979 * return a valid Evas_Object. This object is then managed fully by
13980 * tooltip system and is deleted when the tooltip is gone.
13982 * @param item the toolbar item being attached a tooltip.
13983 * @param func the function used to create the tooltip contents.
13984 * @param data what to provide to @a func as callback data/context.
13985 * @param del_cb called when data is not needed anymore, either when
13986 * another callback replaces @a func, the tooltip is unset with
13987 * elm_toolbar_item_tooltip_unset() or the owner @a item
13988 * dies. This callback receives as the first parameter the
13989 * given @a data, and @c event_info is the item.
13991 * @see elm_object_tooltip_content_cb_set() for more details.
13995 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);
13998 * Unset tooltip from item.
14000 * @param item toolbar item to remove previously set tooltip.
14002 * Remove tooltip from item. The callback provided as del_cb to
14003 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14004 * it is not used anymore.
14006 * @see elm_object_tooltip_unset() for more details.
14007 * @see elm_toolbar_item_tooltip_content_cb_set()
14011 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14014 * Sets a different style for this item tooltip.
14016 * @note before you set a style you should define a tooltip with
14017 * elm_toolbar_item_tooltip_content_cb_set() or
14018 * elm_toolbar_item_tooltip_text_set()
14020 * @param item toolbar item with tooltip already set.
14021 * @param style the theme style to use (default, transparent, ...)
14023 * @see elm_object_tooltip_style_set() for more details.
14027 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14030 * Get the style for this item tooltip.
14032 * @param item toolbar item with tooltip already set.
14033 * @return style the theme style in use, defaults to "default". If the
14034 * object does not have a tooltip set, then NULL is returned.
14036 * @see elm_object_tooltip_style_get() for more details.
14037 * @see elm_toolbar_item_tooltip_style_set()
14041 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14044 * Set the type of mouse pointer/cursor decoration to be shown,
14045 * when the mouse pointer is over the given toolbar widget item
14047 * @param item toolbar item to customize cursor on
14048 * @param cursor the cursor type's name
14050 * This function works analogously as elm_object_cursor_set(), but
14051 * here the cursor's changing area is restricted to the item's
14052 * area, and not the whole widget's. Note that that item cursors
14053 * have precedence over widget cursors, so that a mouse over an
14054 * item with custom cursor set will always show @b that cursor.
14056 * If this function is called twice for an object, a previously set
14057 * cursor will be unset on the second call.
14059 * @see elm_object_cursor_set()
14060 * @see elm_toolbar_item_cursor_get()
14061 * @see elm_toolbar_item_cursor_unset()
14065 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14068 * Get the type of mouse pointer/cursor decoration set to be shown,
14069 * when the mouse pointer is over the given toolbar widget item
14071 * @param item toolbar item with custom cursor set
14072 * @return the cursor type's name or @c NULL, if no custom cursors
14073 * were set to @p item (and on errors)
14075 * @see elm_object_cursor_get()
14076 * @see elm_toolbar_item_cursor_set()
14077 * @see elm_toolbar_item_cursor_unset()
14081 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14084 * Unset any custom mouse pointer/cursor decoration set to be
14085 * shown, when the mouse pointer is over the given toolbar widget
14086 * item, thus making it show the @b default cursor again.
14088 * @param item a toolbar item
14090 * Use this call to undo any custom settings on this item's cursor
14091 * decoration, bringing it back to defaults (no custom style set).
14093 * @see elm_object_cursor_unset()
14094 * @see elm_toolbar_item_cursor_set()
14098 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14101 * Set a different @b style for a given custom cursor set for a
14104 * @param item toolbar item with custom cursor set
14105 * @param style the <b>theme style</b> to use (e.g. @c "default",
14106 * @c "transparent", etc)
14108 * This function only makes sense when one is using custom mouse
14109 * cursor decorations <b>defined in a theme file</b>, which can have,
14110 * given a cursor name/type, <b>alternate styles</b> on it. It
14111 * works analogously as elm_object_cursor_style_set(), but here
14112 * applyed only to toolbar item objects.
14114 * @warning Before you set a cursor style you should have definen a
14115 * custom cursor previously on the item, with
14116 * elm_toolbar_item_cursor_set()
14118 * @see elm_toolbar_item_cursor_engine_only_set()
14119 * @see elm_toolbar_item_cursor_style_get()
14123 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14126 * Get the current @b style set for a given toolbar item's custom
14129 * @param item toolbar item with custom cursor set.
14130 * @return style the cursor style in use. If the object does not
14131 * have a cursor set, then @c NULL is returned.
14133 * @see elm_toolbar_item_cursor_style_set() for more details
14137 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14140 * Set if the (custom)cursor for a given toolbar item should be
14141 * searched in its theme, also, or should only rely on the
14142 * rendering engine.
14144 * @param item item with custom (custom) cursor already set on
14145 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14146 * only on those provided by the rendering engine, @c EINA_FALSE to
14147 * have them searched on the widget's theme, as well.
14149 * @note This call is of use only if you've set a custom cursor
14150 * for toolbar items, with elm_toolbar_item_cursor_set().
14152 * @note By default, cursors will only be looked for between those
14153 * provided by the rendering engine.
14157 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14160 * Get if the (custom) cursor for a given toolbar item is being
14161 * searched in its theme, also, or is only relying on the rendering
14164 * @param item a toolbar item
14165 * @return @c EINA_TRUE, if cursors are being looked for only on
14166 * those provided by the rendering engine, @c EINA_FALSE if they
14167 * are being searched on the widget's theme, as well.
14169 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14173 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14176 * Change a toolbar's orientation
14177 * @param obj The toolbar object
14178 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14179 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14182 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14185 * Get a toolbar's orientation
14186 * @param obj The toolbar object
14187 * @return If @c EINA_TRUE, the toolbar is vertical
14188 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14191 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14198 * @defgroup Tooltips Tooltips
14200 * The Tooltip is an (internal, for now) smart object used to show a
14201 * content in a frame on mouse hover of objects(or widgets), with
14202 * tips/information about them.
14207 EAPI double elm_tooltip_delay_get(void);
14208 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14209 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14210 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14211 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14212 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);
14213 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14214 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14215 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14216 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14217 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14224 * @defgroup Cursors Cursors
14226 * The Elementary cursor is an internal smart object used to
14227 * customize the mouse cursor displayed over objects (or
14228 * widgets). In the most common scenario, the cursor decoration
14229 * comes from the graphical @b engine Elementary is running
14230 * on. Those engines may provide different decorations for cursors,
14231 * and Elementary provides functions to choose them (think of X11
14232 * cursors, as an example).
14234 * There's also the possibility of, besides using engine provided
14235 * cursors, also use ones coming from Edje theming files. Both
14236 * globally and per widget, Elementary makes it possible for one to
14237 * make the cursors lookup to be held on engines only or on
14238 * Elementary's theme file, too.
14244 * Set the cursor to be shown when mouse is over the object
14246 * Set the cursor that will be displayed when mouse is over the
14247 * object. The object can have only one cursor set to it, so if
14248 * this function is called twice for an object, the previous set
14250 * If using X cursors, a definition of all the valid cursor names
14251 * is listed on Elementary_Cursors.h. If an invalid name is set
14252 * the default cursor will be used.
14254 * @param obj the object being set a cursor.
14255 * @param cursor the cursor name to be used.
14259 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14262 * Get the cursor to be shown when mouse is over the object
14264 * @param obj an object with cursor already set.
14265 * @return the cursor name.
14269 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14272 * Unset cursor for object
14274 * Unset cursor for object, and set the cursor to default if the mouse
14275 * was over this object.
14277 * @param obj Target object
14278 * @see elm_object_cursor_set()
14282 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14285 * Sets a different style for this object cursor.
14287 * @note before you set a style you should define a cursor with
14288 * elm_object_cursor_set()
14290 * @param obj an object with cursor already set.
14291 * @param style the theme style to use (default, transparent, ...)
14295 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14298 * Get the style for this object cursor.
14300 * @param obj an object with cursor already set.
14301 * @return style the theme style in use, defaults to "default". If the
14302 * object does not have a cursor set, then NULL is returned.
14306 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14309 * Set if the cursor set should be searched on the theme or should use
14310 * the provided by the engine, only.
14312 * @note before you set if should look on theme you should define a cursor
14313 * with elm_object_cursor_set(). By default it will only look for cursors
14314 * provided by the engine.
14316 * @param obj an object with cursor already set.
14317 * @param engine_only boolean to define it cursors should be looked only
14318 * between the provided by the engine or searched on widget's theme as well.
14322 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14325 * Get the cursor engine only usage for this object cursor.
14327 * @param obj an object with cursor already set.
14328 * @return engine_only boolean to define it cursors should be
14329 * looked only between the provided by the engine or searched on
14330 * widget's theme as well. If the object does not have a cursor
14331 * set, then EINA_FALSE is returned.
14335 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14338 * Get the configured cursor engine only usage
14340 * This gets the globally configured exclusive usage of engine cursors.
14342 * @return 1 if only engine cursors should be used
14345 EAPI int elm_cursor_engine_only_get(void);
14348 * Set the configured cursor engine only usage
14350 * This sets the globally configured exclusive usage of engine cursors.
14351 * It won't affect cursors set before changing this value.
14353 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14354 * look for them on theme before.
14355 * @return EINA_TRUE if value is valid and setted (0 or 1)
14358 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14365 * @defgroup Menu Menu
14367 * @image html img/widget/menu/preview-00.png
14368 * @image latex img/widget/menu/preview-00.eps
14370 * A menu is a list of items displayed above its parent. When the menu is
14371 * showing its parent is darkened. Each item can have a sub-menu. The menu
14372 * object can be used to display a menu on a right click event, in a toolbar,
14375 * Signals that you can add callbacks for are:
14376 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14377 * event_info is NULL.
14379 * @see @ref tutorial_menu
14382 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14384 * @brief Add a new menu to the parent
14386 * @param parent The parent object.
14387 * @return The new object or NULL if it cannot be created.
14389 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14391 * @brief Set the parent for the given menu widget
14393 * @param obj The menu object.
14394 * @param parent The new parent.
14396 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14398 * @brief Get the parent for the given menu widget
14400 * @param obj The menu object.
14401 * @return The parent.
14403 * @see elm_menu_parent_set()
14405 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14407 * @brief Move the menu to a new position
14409 * @param obj The menu object.
14410 * @param x The new position.
14411 * @param y The new position.
14413 * Sets the top-left position of the menu to (@p x,@p y).
14415 * @note @p x and @p y coordinates are relative to parent.
14417 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14419 * @brief Close a opened menu
14421 * @param obj the menu object
14424 * Hides the menu and all it's sub-menus.
14426 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14428 * @brief Returns a list of @p item's items.
14430 * @param obj The menu object
14431 * @return An Eina_List* of @p item's items
14433 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14435 * @brief Get the Evas_Object of an Elm_Menu_Item
14437 * @param item The menu item object.
14438 * @return The edje object containing the swallowed content
14440 * @warning Don't manipulate this object!
14442 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14444 * @brief Add an item at the end of the given menu widget
14446 * @param obj The menu object.
14447 * @param parent The parent menu item (optional)
14448 * @param icon A icon display on the item. The icon will be destryed by the menu.
14449 * @param label The label of the item.
14450 * @param func Function called when the user select the item.
14451 * @param data Data sent by the callback.
14452 * @return Returns the new item.
14454 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);
14456 * @brief Add an object swallowed in an item at the end of the given menu
14459 * @param obj The menu object.
14460 * @param parent The parent menu item (optional)
14461 * @param subobj The object to swallow
14462 * @param func Function called when the user select the item.
14463 * @param data Data sent by the callback.
14464 * @return Returns the new item.
14466 * Add an evas object as an item to the menu.
14468 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);
14470 * @brief Set the label of a menu item
14472 * @param item The menu item object.
14473 * @param label The label to set for @p item
14475 * @warning Don't use this funcion on items created with
14476 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14478 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14480 * @brief Get the label of a menu item
14482 * @param item The menu item object.
14483 * @return The label of @p item
14485 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14487 * @brief Set the icon of a menu item to the standard icon with name @p icon
14489 * @param item The menu item object.
14490 * @param icon The icon object to set for the content of @p item
14492 * Once this icon is set, any previously set icon will be deleted.
14494 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14496 * @brief Get the string representation from the icon of a menu item
14498 * @param item The menu item object.
14499 * @return The string representation of @p item's icon or NULL
14501 * @see elm_menu_item_object_icon_name_set()
14503 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14505 * @brief Set the content object of a menu item
14507 * @param item The menu item object
14508 * @param The content object or NULL
14509 * @return EINA_TRUE on success, else EINA_FALSE
14511 * Use this function to change the object swallowed by a menu item, deleting
14512 * any previously swallowed object.
14514 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14516 * @brief Get the content object of a menu item
14518 * @param item The menu item object
14519 * @return The content object or NULL
14520 * @note If @p item was added with elm_menu_item_add_object, this
14521 * function will return the object passed, else it will return the
14524 * @see elm_menu_item_object_content_set()
14526 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14528 * @brief Set the selected state of @p item.
14530 * @param item The menu item object.
14531 * @param selected The selected/unselected state of the item
14533 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14535 * @brief Get the selected state of @p item.
14537 * @param item The menu item object.
14538 * @return The selected/unselected state of the item
14540 * @see elm_menu_item_selected_set()
14542 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14544 * @brief Set the disabled state of @p item.
14546 * @param item The menu item object.
14547 * @param disabled The enabled/disabled state of the item
14549 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14551 * @brief Get the disabled state of @p item.
14553 * @param item The menu item object.
14554 * @return The enabled/disabled state of the item
14556 * @see elm_menu_item_disabled_set()
14558 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14560 * @brief Add a separator item to menu @p obj under @p parent.
14562 * @param obj The menu object
14563 * @param parent The item to add the separator under
14564 * @return The created item or NULL on failure
14566 * This is item is a @ref Separator.
14568 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14570 * @brief Returns whether @p item is a separator.
14572 * @param item The item to check
14573 * @return If true, @p item is a separator
14575 * @see elm_menu_item_separator_add()
14577 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14579 * @brief Deletes an item from the menu.
14581 * @param item The item to delete.
14583 * @see elm_menu_item_add()
14585 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14587 * @brief Set the function called when a menu item is deleted.
14589 * @param item The item to set the callback on
14590 * @param func The function called
14592 * @see elm_menu_item_add()
14593 * @see elm_menu_item_del()
14595 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14597 * @brief Returns the data associated with menu item @p item.
14599 * @param item The item
14600 * @return The data associated with @p item or NULL if none was set.
14602 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14604 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14606 * @brief Sets the data to be associated with menu item @p item.
14608 * @param item The item
14609 * @param data The data to be associated with @p item
14611 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14613 * @brief Returns a list of @p item's subitems.
14615 * @param item The item
14616 * @return An Eina_List* of @p item's subitems
14618 * @see elm_menu_add()
14620 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14622 * @brief Get the position of a menu item
14624 * @param item The menu item
14625 * @return The item's index
14627 * This function returns the index position of a menu item in a menu.
14628 * For a sub-menu, this number is relative to the first item in the sub-menu.
14630 * @note Index values begin with 0
14632 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14634 * @brief @brief Return a menu item's owner menu
14636 * @param item The menu item
14637 * @return The menu object owning @p item, or NULL on failure
14639 * Use this function to get the menu object owning an item.
14641 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14643 * @brief Get the selected item in the menu
14645 * @param obj The menu object
14646 * @return The selected item, or NULL if none
14648 * @see elm_menu_item_selected_get()
14649 * @see elm_menu_item_selected_set()
14651 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14653 * @brief Get the last item in the menu
14655 * @param obj The menu object
14656 * @return The last item, or NULL if none
14658 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14660 * @brief Get the first item in the menu
14662 * @param obj The menu object
14663 * @return The first item, or NULL if none
14665 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14667 * @brief Get the next item in the menu.
14669 * @param item The menu item object.
14670 * @return The item after it, or NULL if none
14672 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14674 * @brief Get the previous item in the menu.
14676 * @param item The menu item object.
14677 * @return The item before it, or NULL if none
14679 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14685 * @defgroup List List
14686 * @ingroup Elementary
14688 * @image html img/widget/list/preview-00.png
14689 * @image latex img/widget/list/preview-00.eps width=\textwidth
14691 * @image html img/list.png
14692 * @image latex img/list.eps width=\textwidth
14694 * A list widget is a container whose children are displayed vertically or
14695 * horizontally, in order, and can be selected.
14696 * The list can accept only one or multiple items selection. Also has many
14697 * modes of items displaying.
14699 * A list is a very simple type of list widget. For more robust
14700 * lists, @ref Genlist should probably be used.
14702 * Smart callbacks one can listen to:
14703 * - @c "activated" - The user has double-clicked or pressed
14704 * (enter|return|spacebar) on an item. The @c event_info parameter
14705 * is the item that was activated.
14706 * - @c "clicked,double" - The user has double-clicked an item.
14707 * The @c event_info parameter is the item that was double-clicked.
14708 * - "selected" - when the user selected an item
14709 * - "unselected" - when the user unselected an item
14710 * - "longpressed" - an item in the list is long-pressed
14711 * - "scroll,edge,top" - the list is scrolled until the top edge
14712 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14713 * - "scroll,edge,left" - the list is scrolled until the left edge
14714 * - "scroll,edge,right" - the list is scrolled until the right edge
14716 * Available styles for it:
14719 * List of examples:
14720 * @li @ref list_example_01
14721 * @li @ref list_example_02
14722 * @li @ref list_example_03
14731 * @enum _Elm_List_Mode
14732 * @typedef Elm_List_Mode
14734 * Set list's resize behavior, transverse axis scroll and
14735 * items cropping. See each mode's description for more details.
14737 * @note Default value is #ELM_LIST_SCROLL.
14739 * Values <b> don't </b> work as bitmask, only one can be choosen.
14741 * @see elm_list_mode_set()
14742 * @see elm_list_mode_get()
14746 typedef enum _Elm_List_Mode
14748 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. */
14749 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). */
14750 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. */
14751 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. */
14752 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14755 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(). */
14758 * Add a new list widget to the given parent Elementary
14759 * (container) object.
14761 * @param parent The parent object.
14762 * @return a new list widget handle or @c NULL, on errors.
14764 * This function inserts a new list widget on the canvas.
14768 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14773 * @param obj The list object
14775 * @note Call before running show() on the list object.
14776 * @warning If not called, it won't display the list properly.
14779 * li = elm_list_add(win);
14780 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14781 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14783 * evas_object_show(li);
14788 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14791 * Enable or disable multiple items selection on the list object.
14793 * @param obj The list object
14794 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14797 * Disabled by default. If disabled, the user can select a single item of
14798 * the list each time. Selected items are highlighted on list.
14799 * If enabled, many items can be selected.
14801 * If a selected item is selected again, it will be unselected.
14803 * @see elm_list_multi_select_get()
14807 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14810 * Get a value whether multiple items selection is enabled or not.
14812 * @see elm_list_multi_select_set() for details.
14814 * @param obj The list object.
14815 * @return @c EINA_TRUE means multiple items selection is enabled.
14816 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14817 * @c EINA_FALSE is returned.
14821 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14824 * Set which mode to use for the list object.
14826 * @param obj The list object
14827 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14828 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14830 * Set list's resize behavior, transverse axis scroll and
14831 * items cropping. See each mode's description for more details.
14833 * @note Default value is #ELM_LIST_SCROLL.
14835 * Only one can be set, if a previous one was set, it will be changed
14836 * by the new mode set. Bitmask won't work as well.
14838 * @see elm_list_mode_get()
14842 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14845 * Get the mode the list is at.
14847 * @param obj The list object
14848 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14849 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14851 * @note see elm_list_mode_set() for more information.
14855 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14858 * Enable or disable horizontal mode on the list object.
14860 * @param obj The list object.
14861 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14862 * disable it, i.e., to enable vertical mode.
14864 * @note Vertical mode is set by default.
14866 * On horizontal mode items are displayed on list from left to right,
14867 * instead of from top to bottom. Also, the list will scroll horizontally.
14868 * Each item will presents left icon on top and right icon, or end, at
14871 * @see elm_list_horizontal_get()
14875 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14878 * Get a value whether horizontal mode is enabled or not.
14880 * @param obj The list object.
14881 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14882 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14883 * @c EINA_FALSE is returned.
14885 * @see elm_list_horizontal_set() for details.
14889 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14892 * Enable or disable always select mode on the list object.
14894 * @param obj The list object
14895 * @param always_select @c EINA_TRUE to enable always select mode or
14896 * @c EINA_FALSE to disable it.
14898 * @note Always select mode is disabled by default.
14900 * Default behavior of list items is to only call its callback function
14901 * the first time it's pressed, i.e., when it is selected. If a selected
14902 * item is pressed again, and multi-select is disabled, it won't call
14903 * this function (if multi-select is enabled it will unselect the item).
14905 * If always select is enabled, it will call the callback function
14906 * everytime a item is pressed, so it will call when the item is selected,
14907 * and again when a selected item is pressed.
14909 * @see elm_list_always_select_mode_get()
14910 * @see elm_list_multi_select_set()
14914 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14917 * Get a value whether always select mode is enabled or not, meaning that
14918 * an item will always call its callback function, even if already selected.
14920 * @param obj The list object
14921 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14922 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14923 * @c EINA_FALSE is returned.
14925 * @see elm_list_always_select_mode_set() for details.
14929 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14932 * Set bouncing behaviour when the scrolled content reaches an edge.
14934 * Tell the internal scroller object whether it should bounce or not
14935 * when it reaches the respective edges for each axis.
14937 * @param obj The list object
14938 * @param h_bounce Whether to bounce or not in the horizontal axis.
14939 * @param v_bounce Whether to bounce or not in the vertical axis.
14941 * @see elm_scroller_bounce_set()
14945 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14948 * Get the bouncing behaviour of the internal scroller.
14950 * Get whether the internal scroller should bounce when the edge of each
14951 * axis is reached scrolling.
14953 * @param obj The list object.
14954 * @param h_bounce Pointer where to store the bounce state of the horizontal
14956 * @param v_bounce Pointer where to store the bounce state of the vertical
14959 * @see elm_scroller_bounce_get()
14960 * @see elm_list_bounce_set()
14964 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14967 * Set the scrollbar policy.
14969 * @param obj The list object
14970 * @param policy_h Horizontal scrollbar policy.
14971 * @param policy_v Vertical scrollbar policy.
14973 * This sets the scrollbar visibility policy for the given scroller.
14974 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
14975 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14976 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14977 * This applies respectively for the horizontal and vertical scrollbars.
14979 * The both are disabled by default, i.e., are set to
14980 * #ELM_SCROLLER_POLICY_OFF.
14984 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14987 * Get the scrollbar policy.
14989 * @see elm_list_scroller_policy_get() for details.
14991 * @param obj The list object.
14992 * @param policy_h Pointer where to store horizontal scrollbar policy.
14993 * @param policy_v Pointer where to store vertical scrollbar policy.
14997 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);
15000 * Append a new item to the list object.
15002 * @param obj The list object.
15003 * @param label The label of the list item.
15004 * @param icon The icon object to use for the left side of the item. An
15005 * icon can be any Evas object, but usually it is an icon created
15006 * with elm_icon_add().
15007 * @param end The icon object to use for the right side of the item. An
15008 * icon can be any Evas object.
15009 * @param func The function to call when the item is clicked.
15010 * @param data The data to associate with the item for related callbacks.
15012 * @return The created item or @c NULL upon failure.
15014 * A new item will be created and appended to the list, i.e., will
15015 * be set as @b last item.
15017 * Items created with this method can be deleted with
15018 * elm_list_item_del().
15020 * Associated @p data can be properly freed when item is deleted if a
15021 * callback function is set with elm_list_item_del_cb_set().
15023 * If a function is passed as argument, it will be called everytime this item
15024 * is selected, i.e., the user clicks over an unselected item.
15025 * If always select is enabled it will call this function every time
15026 * user clicks over an item (already selected or not).
15027 * If such function isn't needed, just passing
15028 * @c NULL as @p func is enough. The same should be done for @p data.
15030 * Simple example (with no function callback or data associated):
15032 * li = elm_list_add(win);
15033 * ic = elm_icon_add(win);
15034 * elm_icon_file_set(ic, "path/to/image", NULL);
15035 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15036 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15038 * evas_object_show(li);
15041 * @see elm_list_always_select_mode_set()
15042 * @see elm_list_item_del()
15043 * @see elm_list_item_del_cb_set()
15044 * @see elm_list_clear()
15045 * @see elm_icon_add()
15049 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);
15052 * Prepend a new item to the list object.
15054 * @param obj The list object.
15055 * @param label The label of the list item.
15056 * @param icon The icon object to use for the left side of the item. An
15057 * icon can be any Evas object, but usually it is an icon created
15058 * with elm_icon_add().
15059 * @param end The icon object to use for the right side of the item. An
15060 * icon can be any Evas object.
15061 * @param func The function to call when the item is clicked.
15062 * @param data The data to associate with the item for related callbacks.
15064 * @return The created item or @c NULL upon failure.
15066 * A new item will be created and prepended to the list, i.e., will
15067 * be set as @b first item.
15069 * Items created with this method can be deleted with
15070 * elm_list_item_del().
15072 * Associated @p data can be properly freed when item is deleted if a
15073 * callback function is set with elm_list_item_del_cb_set().
15075 * If a function is passed as argument, it will be called everytime this item
15076 * is selected, i.e., the user clicks over an unselected item.
15077 * If always select is enabled it will call this function every time
15078 * user clicks over an item (already selected or not).
15079 * If such function isn't needed, just passing
15080 * @c NULL as @p func is enough. The same should be done for @p data.
15082 * @see elm_list_item_append() for a simple code example.
15083 * @see elm_list_always_select_mode_set()
15084 * @see elm_list_item_del()
15085 * @see elm_list_item_del_cb_set()
15086 * @see elm_list_clear()
15087 * @see elm_icon_add()
15091 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);
15094 * Insert a new item into the list object before item @p before.
15096 * @param obj The list object.
15097 * @param before The list item to insert before.
15098 * @param label The label of the list item.
15099 * @param icon The icon object to use for the left side of the item. An
15100 * icon can be any Evas object, but usually it is an icon created
15101 * with elm_icon_add().
15102 * @param end The icon object to use for the right side of the item. An
15103 * icon can be any Evas object.
15104 * @param func The function to call when the item is clicked.
15105 * @param data The data to associate with the item for related callbacks.
15107 * @return The created item or @c NULL upon failure.
15109 * A new item will be created and added to the list. Its position in
15110 * this list will be just before item @p before.
15112 * Items created with this method can be deleted with
15113 * elm_list_item_del().
15115 * Associated @p data can be properly freed when item is deleted if a
15116 * callback function is set with elm_list_item_del_cb_set().
15118 * If a function is passed as argument, it will be called everytime this item
15119 * is selected, i.e., the user clicks over an unselected item.
15120 * If always select is enabled it will call this function every time
15121 * user clicks over an item (already selected or not).
15122 * If such function isn't needed, just passing
15123 * @c NULL as @p func is enough. The same should be done for @p data.
15125 * @see elm_list_item_append() for a simple code example.
15126 * @see elm_list_always_select_mode_set()
15127 * @see elm_list_item_del()
15128 * @see elm_list_item_del_cb_set()
15129 * @see elm_list_clear()
15130 * @see elm_icon_add()
15134 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);
15137 * Insert a new item into the list object after item @p after.
15139 * @param obj The list object.
15140 * @param after The list item to insert after.
15141 * @param label The label of the list item.
15142 * @param icon The icon object to use for the left side of the item. An
15143 * icon can be any Evas object, but usually it is an icon created
15144 * with elm_icon_add().
15145 * @param end The icon object to use for the right side of the item. An
15146 * icon can be any Evas object.
15147 * @param func The function to call when the item is clicked.
15148 * @param data The data to associate with the item for related callbacks.
15150 * @return The created item or @c NULL upon failure.
15152 * A new item will be created and added to the list. Its position in
15153 * this list will be just after item @p after.
15155 * Items created with this method can be deleted with
15156 * elm_list_item_del().
15158 * Associated @p data can be properly freed when item is deleted if a
15159 * callback function is set with elm_list_item_del_cb_set().
15161 * If a function is passed as argument, it will be called everytime this item
15162 * is selected, i.e., the user clicks over an unselected item.
15163 * If always select is enabled it will call this function every time
15164 * user clicks over an item (already selected or not).
15165 * If such function isn't needed, just passing
15166 * @c NULL as @p func is enough. The same should be done for @p data.
15168 * @see elm_list_item_append() for a simple code example.
15169 * @see elm_list_always_select_mode_set()
15170 * @see elm_list_item_del()
15171 * @see elm_list_item_del_cb_set()
15172 * @see elm_list_clear()
15173 * @see elm_icon_add()
15177 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);
15180 * Insert a new item into the sorted list object.
15182 * @param obj The list object.
15183 * @param label The label of the list item.
15184 * @param icon The icon object to use for the left side of the item. An
15185 * icon can be any Evas object, but usually it is an icon created
15186 * with elm_icon_add().
15187 * @param end The icon object to use for the right side of the item. An
15188 * icon can be any Evas object.
15189 * @param func The function to call when the item is clicked.
15190 * @param data The data to associate with the item for related callbacks.
15191 * @param cmp_func The comparing function to be used to sort list
15192 * items <b>by #Elm_List_Item item handles</b>. This function will
15193 * receive two items and compare them, returning a non-negative integer
15194 * if the second item should be place after the first, or negative value
15195 * if should be placed before.
15197 * @return The created item or @c NULL upon failure.
15199 * @note This function inserts values into a list object assuming it was
15200 * sorted and the result will be sorted.
15202 * A new item will be created and added to the list. Its position in
15203 * this list will be found comparing the new item with previously inserted
15204 * items using function @p cmp_func.
15206 * Items created with this method can be deleted with
15207 * elm_list_item_del().
15209 * Associated @p data can be properly freed when item is deleted if a
15210 * callback function is set with elm_list_item_del_cb_set().
15212 * If a function is passed as argument, it will be called everytime this item
15213 * is selected, i.e., the user clicks over an unselected item.
15214 * If always select is enabled it will call this function every time
15215 * user clicks over an item (already selected or not).
15216 * If such function isn't needed, just passing
15217 * @c NULL as @p func is enough. The same should be done for @p data.
15219 * @see elm_list_item_append() for a simple code example.
15220 * @see elm_list_always_select_mode_set()
15221 * @see elm_list_item_del()
15222 * @see elm_list_item_del_cb_set()
15223 * @see elm_list_clear()
15224 * @see elm_icon_add()
15228 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);
15231 * Remove all list's items.
15233 * @param obj The list object
15235 * @see elm_list_item_del()
15236 * @see elm_list_item_append()
15240 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15243 * Get a list of all the list items.
15245 * @param obj The list object
15246 * @return An @c Eina_List of list items, #Elm_List_Item,
15247 * or @c NULL on failure.
15249 * @see elm_list_item_append()
15250 * @see elm_list_item_del()
15251 * @see elm_list_clear()
15255 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15258 * Get the selected item.
15260 * @param obj The list object.
15261 * @return The selected list item.
15263 * The selected item can be unselected with function
15264 * elm_list_item_selected_set().
15266 * The selected item always will be highlighted on list.
15268 * @see elm_list_selected_items_get()
15272 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15275 * Return a list of the currently selected list items.
15277 * @param obj The list object.
15278 * @return An @c Eina_List of list items, #Elm_List_Item,
15279 * or @c NULL on failure.
15281 * Multiple items can be selected if multi select is enabled. It can be
15282 * done with elm_list_multi_select_set().
15284 * @see elm_list_selected_item_get()
15285 * @see elm_list_multi_select_set()
15289 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15292 * Set the selected state of an item.
15294 * @param item The list item
15295 * @param selected The selected state
15297 * This sets the selected state of the given item @p it.
15298 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15300 * If a new item is selected the previosly selected will be unselected,
15301 * unless multiple selection is enabled with elm_list_multi_select_set().
15302 * Previoulsy selected item can be get with function
15303 * elm_list_selected_item_get().
15305 * Selected items will be highlighted.
15307 * @see elm_list_item_selected_get()
15308 * @see elm_list_selected_item_get()
15309 * @see elm_list_multi_select_set()
15313 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15316 * Get whether the @p item is selected or not.
15318 * @param item The list item.
15319 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15320 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15322 * @see elm_list_selected_item_set() for details.
15323 * @see elm_list_item_selected_get()
15327 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15330 * Set or unset item as a separator.
15332 * @param it The list item.
15333 * @param setting @c EINA_TRUE to set item @p it as separator or
15334 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15336 * Items aren't set as separator by default.
15338 * If set as separator it will display separator theme, so won't display
15341 * @see elm_list_item_separator_get()
15345 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15348 * Get a value whether item is a separator or not.
15350 * @see elm_list_item_separator_set() for details.
15352 * @param it The list item.
15353 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15354 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15358 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15361 * Show @p item in the list view.
15363 * @param item The list item to be shown.
15365 * It won't animate list until item is visible. If such behavior is wanted,
15366 * use elm_list_bring_in() intead.
15370 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15373 * Bring in the given item to list view.
15375 * @param item The item.
15377 * This causes list to jump to the given item @p item and show it
15378 * (by scrolling), if it is not fully visible.
15380 * This may use animation to do so and take a period of time.
15382 * If animation isn't wanted, elm_list_item_show() can be used.
15386 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15389 * Delete them item from the list.
15391 * @param item The item of list to be deleted.
15393 * If deleting all list items is required, elm_list_clear()
15394 * should be used instead of getting items list and deleting each one.
15396 * @see elm_list_clear()
15397 * @see elm_list_item_append()
15398 * @see elm_list_item_del_cb_set()
15402 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15405 * Set the function called when a list item is freed.
15407 * @param item The item to set the callback on
15408 * @param func The function called
15410 * If there is a @p func, then it will be called prior item's memory release.
15411 * That will be called with the following arguments:
15413 * @li item's Evas object;
15416 * This way, a data associated to a list item could be properly freed.
15420 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15423 * Get the data associated to the item.
15425 * @param item The list item
15426 * @return The data associated to @p item
15428 * The return value is a pointer to data associated to @p item when it was
15429 * created, with function elm_list_item_append() or similar. If no data
15430 * was passed as argument, it will return @c NULL.
15432 * @see elm_list_item_append()
15436 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15439 * Get the left side icon associated to the item.
15441 * @param item The list item
15442 * @return The left side icon associated to @p item
15444 * The return value is a pointer to the icon associated to @p item when
15446 * created, with function elm_list_item_append() or similar, or later
15447 * with function elm_list_item_icon_set(). If no icon
15448 * was passed as argument, it will return @c NULL.
15450 * @see elm_list_item_append()
15451 * @see elm_list_item_icon_set()
15455 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15458 * Set the left side icon associated to the item.
15460 * @param item The list item
15461 * @param icon The left side icon object to associate with @p item
15463 * The icon object to use at left side of the item. An
15464 * icon can be any Evas object, but usually it is an icon created
15465 * with elm_icon_add().
15467 * Once the icon object is set, a previously set one will be deleted.
15468 * @warning Setting the same icon for two items will cause the icon to
15469 * dissapear from the first item.
15471 * If an icon was passed as argument on item creation, with function
15472 * elm_list_item_append() or similar, it will be already
15473 * associated to the item.
15475 * @see elm_list_item_append()
15476 * @see elm_list_item_icon_get()
15480 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15483 * Get the right side icon associated to the item.
15485 * @param item The list item
15486 * @return The right side icon associated to @p item
15488 * The return value is a pointer to the icon associated to @p item when
15490 * created, with function elm_list_item_append() or similar, or later
15491 * with function elm_list_item_icon_set(). If no icon
15492 * was passed as argument, it will return @c NULL.
15494 * @see elm_list_item_append()
15495 * @see elm_list_item_icon_set()
15499 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15502 * Set the right side icon associated to the item.
15504 * @param item The list item
15505 * @param end The right side icon object to associate with @p item
15507 * The icon object to use at right side of the item. An
15508 * icon can be any Evas object, but usually it is an icon created
15509 * with elm_icon_add().
15511 * Once the icon object is set, a previously set one will be deleted.
15512 * @warning Setting the same icon for two items will cause the icon to
15513 * dissapear from the first item.
15515 * If an icon was passed as argument on item creation, with function
15516 * elm_list_item_append() or similar, it will be already
15517 * associated to the item.
15519 * @see elm_list_item_append()
15520 * @see elm_list_item_end_get()
15524 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15527 * Gets the base object of the item.
15529 * @param item The list item
15530 * @return The base object associated with @p item
15532 * Base object is the @c Evas_Object that represents that item.
15536 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15537 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15540 * Get the label of item.
15542 * @param item The item of list.
15543 * @return The label of item.
15545 * The return value is a pointer to the label associated to @p item when
15546 * it was created, with function elm_list_item_append(), or later
15547 * with function elm_list_item_label_set. If no label
15548 * was passed as argument, it will return @c NULL.
15550 * @see elm_list_item_label_set() for more details.
15551 * @see elm_list_item_append()
15555 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15558 * Set the label of item.
15560 * @param item The item of list.
15561 * @param text The label of item.
15563 * The label to be displayed by the item.
15564 * Label will be placed between left and right side icons (if set).
15566 * If a label was passed as argument on item creation, with function
15567 * elm_list_item_append() or similar, it will be already
15568 * displayed by the item.
15570 * @see elm_list_item_label_get()
15571 * @see elm_list_item_append()
15575 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15579 * Get the item before @p it in list.
15581 * @param it The list item.
15582 * @return The item before @p it, or @c NULL if none or on failure.
15584 * @note If it is the first item, @c NULL will be returned.
15586 * @see elm_list_item_append()
15587 * @see elm_list_items_get()
15591 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15594 * Get the item after @p it in list.
15596 * @param it The list item.
15597 * @return The item after @p it, or @c NULL if none or on failure.
15599 * @note If it is the last item, @c NULL will be returned.
15601 * @see elm_list_item_append()
15602 * @see elm_list_items_get()
15606 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15609 * Sets the disabled/enabled state of a list item.
15611 * @param it The item.
15612 * @param disabled The disabled state.
15614 * A disabled item cannot be selected or unselected. It will also
15615 * change its appearance (generally greyed out). This sets the
15616 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15621 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15624 * Get a value whether list item is disabled or not.
15626 * @param it The item.
15627 * @return The disabled state.
15629 * @see elm_list_item_disabled_set() for more details.
15633 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15636 * Set the text to be shown in a given list item's tooltips.
15638 * @param item Target item.
15639 * @param text The text to set in the content.
15641 * Setup the text as tooltip to object. The item can have only one tooltip,
15642 * so any previous tooltip data - set with this function or
15643 * elm_list_item_tooltip_content_cb_set() - is removed.
15645 * @see elm_object_tooltip_text_set() for more details.
15649 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15653 * @brief Disable size restrictions on an object's tooltip
15654 * @param item The tooltip's anchor object
15655 * @param disable If EINA_TRUE, size restrictions are disabled
15656 * @return EINA_FALSE on failure, EINA_TRUE on success
15658 * This function allows a tooltip to expand beyond its parant window's canvas.
15659 * It will instead be limited only by the size of the display.
15661 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15663 * @brief Retrieve size restriction state of an object's tooltip
15664 * @param obj The tooltip's anchor object
15665 * @return If EINA_TRUE, size restrictions are disabled
15667 * This function returns whether a tooltip is allowed to expand beyond
15668 * its parant window's canvas.
15669 * It will instead be limited only by the size of the display.
15671 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15674 * Set the content to be shown in the tooltip item.
15676 * Setup the tooltip to item. The item can have only one tooltip,
15677 * so any previous tooltip data is removed. @p func(with @p data) will
15678 * be called every time that need show the tooltip and it should
15679 * return a valid Evas_Object. This object is then managed fully by
15680 * tooltip system and is deleted when the tooltip is gone.
15682 * @param item the list item being attached a tooltip.
15683 * @param func the function used to create the tooltip contents.
15684 * @param data what to provide to @a func as callback data/context.
15685 * @param del_cb called when data is not needed anymore, either when
15686 * another callback replaces @a func, the tooltip is unset with
15687 * elm_list_item_tooltip_unset() or the owner @a item
15688 * dies. This callback receives as the first parameter the
15689 * given @a data, and @c event_info is the item.
15691 * @see elm_object_tooltip_content_cb_set() for more details.
15695 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);
15698 * Unset tooltip from item.
15700 * @param item list item to remove previously set tooltip.
15702 * Remove tooltip from item. The callback provided as del_cb to
15703 * elm_list_item_tooltip_content_cb_set() will be called to notify
15704 * it is not used anymore.
15706 * @see elm_object_tooltip_unset() for more details.
15707 * @see elm_list_item_tooltip_content_cb_set()
15711 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15714 * Sets a different style for this item tooltip.
15716 * @note before you set a style you should define a tooltip with
15717 * elm_list_item_tooltip_content_cb_set() or
15718 * elm_list_item_tooltip_text_set()
15720 * @param item list item with tooltip already set.
15721 * @param style the theme style to use (default, transparent, ...)
15723 * @see elm_object_tooltip_style_set() for more details.
15727 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15730 * Get the style for this item tooltip.
15732 * @param item list item with tooltip already set.
15733 * @return style the theme style in use, defaults to "default". If the
15734 * object does not have a tooltip set, then NULL is returned.
15736 * @see elm_object_tooltip_style_get() for more details.
15737 * @see elm_list_item_tooltip_style_set()
15741 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15744 * Set the type of mouse pointer/cursor decoration to be shown,
15745 * when the mouse pointer is over the given list widget item
15747 * @param item list item to customize cursor on
15748 * @param cursor the cursor type's name
15750 * This function works analogously as elm_object_cursor_set(), but
15751 * here the cursor's changing area is restricted to the item's
15752 * area, and not the whole widget's. Note that that item cursors
15753 * have precedence over widget cursors, so that a mouse over an
15754 * item with custom cursor set will always show @b that cursor.
15756 * If this function is called twice for an object, a previously set
15757 * cursor will be unset on the second call.
15759 * @see elm_object_cursor_set()
15760 * @see elm_list_item_cursor_get()
15761 * @see elm_list_item_cursor_unset()
15765 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15768 * Get the type of mouse pointer/cursor decoration set to be shown,
15769 * when the mouse pointer is over the given list widget item
15771 * @param item list item with custom cursor set
15772 * @return the cursor type's name or @c NULL, if no custom cursors
15773 * were set to @p item (and on errors)
15775 * @see elm_object_cursor_get()
15776 * @see elm_list_item_cursor_set()
15777 * @see elm_list_item_cursor_unset()
15781 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15784 * Unset any custom mouse pointer/cursor decoration set to be
15785 * shown, when the mouse pointer is over the given list widget
15786 * item, thus making it show the @b default cursor again.
15788 * @param item a list item
15790 * Use this call to undo any custom settings on this item's cursor
15791 * decoration, bringing it back to defaults (no custom style set).
15793 * @see elm_object_cursor_unset()
15794 * @see elm_list_item_cursor_set()
15798 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15801 * Set a different @b style for a given custom cursor set for a
15804 * @param item list item with custom cursor set
15805 * @param style the <b>theme style</b> to use (e.g. @c "default",
15806 * @c "transparent", etc)
15808 * This function only makes sense when one is using custom mouse
15809 * cursor decorations <b>defined in a theme file</b>, which can have,
15810 * given a cursor name/type, <b>alternate styles</b> on it. It
15811 * works analogously as elm_object_cursor_style_set(), but here
15812 * applyed only to list item objects.
15814 * @warning Before you set a cursor style you should have definen a
15815 * custom cursor previously on the item, with
15816 * elm_list_item_cursor_set()
15818 * @see elm_list_item_cursor_engine_only_set()
15819 * @see elm_list_item_cursor_style_get()
15823 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15826 * Get the current @b style set for a given list item's custom
15829 * @param item list item with custom cursor set.
15830 * @return style the cursor style in use. If the object does not
15831 * have a cursor set, then @c NULL is returned.
15833 * @see elm_list_item_cursor_style_set() for more details
15837 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15840 * Set if the (custom)cursor for a given list item should be
15841 * searched in its theme, also, or should only rely on the
15842 * rendering engine.
15844 * @param item item with custom (custom) cursor already set on
15845 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15846 * only on those provided by the rendering engine, @c EINA_FALSE to
15847 * have them searched on the widget's theme, as well.
15849 * @note This call is of use only if you've set a custom cursor
15850 * for list items, with elm_list_item_cursor_set().
15852 * @note By default, cursors will only be looked for between those
15853 * provided by the rendering engine.
15857 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15860 * Get if the (custom) cursor for a given list item is being
15861 * searched in its theme, also, or is only relying on the rendering
15864 * @param item a list item
15865 * @return @c EINA_TRUE, if cursors are being looked for only on
15866 * those provided by the rendering engine, @c EINA_FALSE if they
15867 * are being searched on the widget's theme, as well.
15869 * @see elm_list_item_cursor_engine_only_set(), for more details
15873 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15880 * @defgroup Slider Slider
15881 * @ingroup Elementary
15883 * @image html img/widget/slider/preview-00.png
15884 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15886 * The slider adds a dragable “slider” widget for selecting the value of
15887 * something within a range.
15889 * A slider can be horizontal or vertical. It can contain an Icon and has a
15890 * primary label as well as a units label (that is formatted with floating
15891 * point values and thus accepts a printf-style format string, like
15892 * “%1.2f units”. There is also an indicator string that may be somewhere
15893 * else (like on the slider itself) that also accepts a format string like
15894 * units. Label, Icon Unit and Indicator strings/objects are optional.
15896 * A slider may be inverted which means values invert, with high vales being
15897 * on the left or top and low values on the right or bottom (as opposed to
15898 * normally being low on the left or top and high on the bottom and right).
15900 * The slider should have its minimum and maximum values set by the
15901 * application with elm_slider_min_max_set() and value should also be set by
15902 * the application before use with elm_slider_value_set(). The span of the
15903 * slider is its length (horizontally or vertically). This will be scaled by
15904 * the object or applications scaling factor. At any point code can query the
15905 * slider for its value with elm_slider_value_get().
15907 * Smart callbacks one can listen to:
15908 * - "changed" - Whenever the slider value is changed by the user.
15909 * - "slider,drag,start" - dragging the slider indicator around has started.
15910 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15911 * - "delay,changed" - A short time after the value is changed by the user.
15912 * This will be called only when the user stops dragging for
15913 * a very short period or when they release their
15914 * finger/mouse, so it avoids possibly expensive reactions to
15915 * the value change.
15917 * Available styles for it:
15920 * Here is an example on its usage:
15921 * @li @ref slider_example
15925 * @addtogroup Slider
15930 * Add a new slider widget to the given parent Elementary
15931 * (container) object.
15933 * @param parent The parent object.
15934 * @return a new slider widget handle or @c NULL, on errors.
15936 * This function inserts a new slider widget on the canvas.
15940 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15943 * Set the label of a given slider widget
15945 * @param obj The progress bar object
15946 * @param label The text label string, in UTF-8
15949 * @deprecated use elm_object_text_set() instead.
15951 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15954 * Get the label of a given slider widget
15956 * @param obj The progressbar object
15957 * @return The text label string, in UTF-8
15960 * @deprecated use elm_object_text_get() instead.
15962 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15965 * Set the icon object of the slider object.
15967 * @param obj The slider object.
15968 * @param icon The icon object.
15970 * On horizontal mode, icon is placed at left, and on vertical mode,
15973 * @note Once the icon object is set, a previously set one will be deleted.
15974 * If you want to keep that old content object, use the
15975 * elm_slider_icon_unset() function.
15977 * @warning If the object being set does not have minimum size hints set,
15978 * it won't get properly displayed.
15982 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15985 * Unset an icon set on a given slider widget.
15987 * @param obj The slider object.
15988 * @return The icon object that was being used, if any was set, or
15989 * @c NULL, otherwise (and on errors).
15991 * On horizontal mode, icon is placed at left, and on vertical mode,
15994 * This call will unparent and return the icon object which was set
15995 * for this widget, previously, on success.
15997 * @see elm_slider_icon_set() for more details
15998 * @see elm_slider_icon_get()
16002 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16005 * Retrieve the icon object set for a given slider widget.
16007 * @param obj The slider object.
16008 * @return The icon object's handle, if @p obj had one set, or @c NULL,
16009 * otherwise (and on errors).
16011 * On horizontal mode, icon is placed at left, and on vertical mode,
16014 * @see elm_slider_icon_set() for more details
16015 * @see elm_slider_icon_unset()
16019 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16022 * Set the end object of the slider object.
16024 * @param obj The slider object.
16025 * @param end The end object.
16027 * On horizontal mode, end is placed at left, and on vertical mode,
16028 * placed at bottom.
16030 * @note Once the icon object is set, a previously set one will be deleted.
16031 * If you want to keep that old content object, use the
16032 * elm_slider_end_unset() function.
16034 * @warning If the object being set does not have minimum size hints set,
16035 * it won't get properly displayed.
16039 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16042 * Unset an end object set on a given slider widget.
16044 * @param obj The slider object.
16045 * @return The end object that was being used, if any was set, or
16046 * @c NULL, otherwise (and on errors).
16048 * On horizontal mode, end is placed at left, and on vertical mode,
16049 * placed at bottom.
16051 * This call will unparent and return the icon object which was set
16052 * for this widget, previously, on success.
16054 * @see elm_slider_end_set() for more details.
16055 * @see elm_slider_end_get()
16059 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16062 * Retrieve the end object set for a given slider widget.
16064 * @param obj The slider object.
16065 * @return The end object's handle, if @p obj had one set, or @c NULL,
16066 * otherwise (and on errors).
16068 * On horizontal mode, icon is placed at right, and on vertical mode,
16069 * placed at bottom.
16071 * @see elm_slider_end_set() for more details.
16072 * @see elm_slider_end_unset()
16076 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16079 * Set the (exact) length of the bar region of a given slider widget.
16081 * @param obj The slider object.
16082 * @param size The length of the slider's bar region.
16084 * This sets the minimum width (when in horizontal mode) or height
16085 * (when in vertical mode) of the actual bar area of the slider
16086 * @p obj. This in turn affects the object's minimum size. Use
16087 * this when you're not setting other size hints expanding on the
16088 * given direction (like weight and alignment hints) and you would
16089 * like it to have a specific size.
16091 * @note Icon, end, label, indicator and unit text around @p obj
16092 * will require their
16093 * own space, which will make @p obj to require more the @p size,
16096 * @see elm_slider_span_size_get()
16100 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16103 * Get the length set for the bar region of a given slider widget
16105 * @param obj The slider object.
16106 * @return The length of the slider's bar region.
16108 * If that size was not set previously, with
16109 * elm_slider_span_size_set(), this call will return @c 0.
16113 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16116 * Set the format string for the unit label.
16118 * @param obj The slider object.
16119 * @param format The format string for the unit display.
16121 * Unit label is displayed all the time, if set, after slider's bar.
16122 * In horizontal mode, at right and in vertical mode, at bottom.
16124 * If @c NULL, unit label won't be visible. If not it sets the format
16125 * string for the label text. To the label text is provided a floating point
16126 * value, so the label text can display up to 1 floating point value.
16127 * Note that this is optional.
16129 * Use a format string such as "%1.2f meters" for example, and it will
16130 * display values like: "3.14 meters" for a value equal to 3.14159.
16132 * Default is unit label disabled.
16134 * @see elm_slider_indicator_format_get()
16138 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16141 * Get the unit label format of the slider.
16143 * @param obj The slider object.
16144 * @return The unit label format string in UTF-8.
16146 * Unit label is displayed all the time, if set, after slider's bar.
16147 * In horizontal mode, at right and in vertical mode, at bottom.
16149 * @see elm_slider_unit_format_set() for more
16150 * information on how this works.
16154 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16157 * Set the format string for the indicator label.
16159 * @param obj The slider object.
16160 * @param indicator The format string for the indicator display.
16162 * The slider may display its value somewhere else then unit label,
16163 * for example, above the slider knob that is dragged around. This function
16164 * sets the format string used for this.
16166 * If @c NULL, indicator label won't be visible. If not it sets the format
16167 * string for the label text. To the label text is provided a floating point
16168 * value, so the label text can display up to 1 floating point value.
16169 * Note that this is optional.
16171 * Use a format string such as "%1.2f meters" for example, and it will
16172 * display values like: "3.14 meters" for a value equal to 3.14159.
16174 * Default is indicator label disabled.
16176 * @see elm_slider_indicator_format_get()
16180 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16183 * Get the indicator label format of the slider.
16185 * @param obj The slider object.
16186 * @return The indicator label format string in UTF-8.
16188 * The slider may display its value somewhere else then unit label,
16189 * for example, above the slider knob that is dragged around. This function
16190 * gets the format string used for this.
16192 * @see elm_slider_indicator_format_set() for more
16193 * information on how this works.
16197 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16200 * Set the format function pointer for the indicator label
16202 * @param obj The slider object.
16203 * @param func The indicator format function.
16204 * @param free_func The freeing function for the format string.
16206 * Set the callback function to format the indicator string.
16208 * @see elm_slider_indicator_format_set() for more info on how this works.
16212 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);
16215 * Set the format function pointer for the units label
16217 * @param obj The slider object.
16218 * @param func The units format function.
16219 * @param free_func The freeing function for the format string.
16221 * Set the callback function to format the indicator string.
16223 * @see elm_slider_units_format_set() for more info on how this works.
16227 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);
16230 * Set the orientation of a given slider widget.
16232 * @param obj The slider object.
16233 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16234 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16236 * Use this function to change how your slider is to be
16237 * disposed: vertically or horizontally.
16239 * By default it's displayed horizontally.
16241 * @see elm_slider_horizontal_get()
16245 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16248 * Retrieve the orientation of a given slider widget
16250 * @param obj The slider object.
16251 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16252 * @c EINA_FALSE if it's @b vertical (and on errors).
16254 * @see elm_slider_horizontal_set() for more details.
16258 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16261 * Set the minimum and maximum values for the slider.
16263 * @param obj The slider object.
16264 * @param min The minimum value.
16265 * @param max The maximum value.
16267 * Define the allowed range of values to be selected by the user.
16269 * If actual value is less than @p min, it will be updated to @p min. If it
16270 * is bigger then @p max, will be updated to @p max. Actual value can be
16271 * get with elm_slider_value_get().
16273 * By default, min is equal to 0.0, and max is equal to 1.0.
16275 * @warning Maximum must be greater than minimum, otherwise behavior
16278 * @see elm_slider_min_max_get()
16282 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16285 * Get the minimum and maximum values of the slider.
16287 * @param obj The slider object.
16288 * @param min Pointer where to store the minimum value.
16289 * @param max Pointer where to store the maximum value.
16291 * @note If only one value is needed, the other pointer can be passed
16294 * @see elm_slider_min_max_set() for details.
16298 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16301 * Set the value the slider displays.
16303 * @param obj The slider object.
16304 * @param val The value to be displayed.
16306 * Value will be presented on the unit label following format specified with
16307 * elm_slider_unit_format_set() and on indicator with
16308 * elm_slider_indicator_format_set().
16310 * @warning The value must to be between min and max values. This values
16311 * are set by elm_slider_min_max_set().
16313 * @see elm_slider_value_get()
16314 * @see elm_slider_unit_format_set()
16315 * @see elm_slider_indicator_format_set()
16316 * @see elm_slider_min_max_set()
16320 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16323 * Get the value displayed by the spinner.
16325 * @param obj The spinner object.
16326 * @return The value displayed.
16328 * @see elm_spinner_value_set() for details.
16332 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16335 * Invert a given slider widget's displaying values order
16337 * @param obj The slider object.
16338 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16339 * @c EINA_FALSE to bring it back to default, non-inverted values.
16341 * A slider may be @b inverted, in which state it gets its
16342 * values inverted, with high vales being on the left or top and
16343 * low values on the right or bottom, as opposed to normally have
16344 * the low values on the former and high values on the latter,
16345 * respectively, for horizontal and vertical modes.
16347 * @see elm_slider_inverted_get()
16351 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16354 * Get whether a given slider widget's displaying values are
16357 * @param obj The slider object.
16358 * @return @c EINA_TRUE, if @p obj has inverted values,
16359 * @c EINA_FALSE otherwise (and on errors).
16361 * @see elm_slider_inverted_set() for more details.
16365 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16368 * Set whether to enlarge slider indicator (augmented knob) or not.
16370 * @param obj The slider object.
16371 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16372 * let the knob always at default size.
16374 * By default, indicator will be bigger while dragged by the user.
16376 * @warning It won't display values set with
16377 * elm_slider_indicator_format_set() if you disable indicator.
16381 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16384 * Get whether a given slider widget's enlarging indicator or not.
16386 * @param obj The slider object.
16387 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16388 * @c EINA_FALSE otherwise (and on errors).
16390 * @see elm_slider_indicator_show_set() for details.
16394 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16401 * @addtogroup Actionslider Actionslider
16403 * @image html img/widget/actionslider/preview-00.png
16404 * @image latex img/widget/actionslider/preview-00.eps
16406 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16407 * properties. The indicator is the element the user drags to choose a label.
16408 * When the position is set with magnet, when released the indicator will be
16409 * moved to it if it's nearest the magnetized position.
16411 * @note By default all positions are set as enabled.
16413 * Signals that you can add callbacks for are:
16415 * "selected" - when user selects an enabled position (the label is passed
16418 * "pos_changed" - when the indicator reaches any of the positions("left",
16419 * "right" or "center").
16421 * See an example of actionslider usage @ref actionslider_example_page "here"
16424 typedef enum _Elm_Actionslider_Pos
16426 ELM_ACTIONSLIDER_NONE = 0,
16427 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16428 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16429 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16430 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16431 } Elm_Actionslider_Pos;
16434 * Add a new actionslider to the parent.
16436 * @param parent The parent object
16437 * @return The new actionslider object or NULL if it cannot be created
16439 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16441 * Set actionslider labels.
16443 * @param obj The actionslider object
16444 * @param left_label The label to be set on the left.
16445 * @param center_label The label to be set on the center.
16446 * @param right_label The label to be set on the right.
16447 * @deprecated use elm_object_text_set() instead.
16449 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);
16451 * Get actionslider labels.
16453 * @param obj The actionslider object
16454 * @param left_label A char** to place the left_label of @p obj into.
16455 * @param center_label A char** to place the center_label of @p obj into.
16456 * @param right_label A char** to place the right_label of @p obj into.
16457 * @deprecated use elm_object_text_set() instead.
16459 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);
16461 * Get actionslider selected label.
16463 * @param obj The actionslider object
16464 * @return The selected label
16466 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16468 * Set actionslider indicator position.
16470 * @param obj The actionslider object.
16471 * @param pos The position of the indicator.
16473 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16475 * Get actionslider indicator position.
16477 * @param obj The actionslider object.
16478 * @return The position of the indicator.
16480 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16482 * Set actionslider magnet position. To make multiple positions magnets @c or
16483 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16485 * @param obj The actionslider object.
16486 * @param pos Bit mask indicating the magnet positions.
16488 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16490 * Get actionslider magnet position.
16492 * @param obj The actionslider object.
16493 * @return The positions with magnet property.
16495 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16497 * Set actionslider enabled position. To set multiple positions as enabled @c or
16498 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16500 * @note All the positions are enabled by default.
16502 * @param obj The actionslider object.
16503 * @param pos Bit mask indicating the enabled positions.
16505 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16507 * Get actionslider enabled position.
16509 * @param obj The actionslider object.
16510 * @return The enabled positions.
16512 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16514 * Set the label used on the indicator.
16516 * @param obj The actionslider object
16517 * @param label The label to be set on the indicator.
16518 * @deprecated use elm_object_text_set() instead.
16520 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16522 * Get the label used on the indicator object.
16524 * @param obj The actionslider object
16525 * @return The indicator label
16526 * @deprecated use elm_object_text_get() instead.
16528 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16534 * @defgroup Genlist Genlist
16536 * @image html img/widget/genlist/preview-00.png
16537 * @image latex img/widget/genlist/preview-00.eps
16538 * @image html img/genlist.png
16539 * @image latex img/genlist.eps
16541 * This widget aims to have more expansive list than the simple list in
16542 * Elementary that could have more flexible items and allow many more entries
16543 * while still being fast and low on memory usage. At the same time it was
16544 * also made to be able to do tree structures. But the price to pay is more
16545 * complexity when it comes to usage. If all you want is a simple list with
16546 * icons and a single label, use the normal @ref List object.
16548 * Genlist has a fairly large API, mostly because it's relatively complex,
16549 * trying to be both expansive, powerful and efficient. First we will begin
16550 * an overview on the theory behind genlist.
16552 * @section Genlist_Item_Class Genlist item classes - creating items
16554 * In order to have the ability to add and delete items on the fly, genlist
16555 * implements a class (callback) system where the application provides a
16556 * structure with information about that type of item (genlist may contain
16557 * multiple different items with different classes, states and styles).
16558 * Genlist will call the functions in this struct (methods) when an item is
16559 * "realized" (i.e., created dynamically, while the user is scrolling the
16560 * grid). All objects will simply be deleted when no longer needed with
16561 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16562 * following members:
16563 * - @c item_style - This is a constant string and simply defines the name
16564 * of the item style. It @b must be specified and the default should be @c
16566 * - @c mode_item_style - This is a constant string and simply defines the
16567 * name of the style that will be used for mode animations. It can be left
16568 * as @c NULL if you don't plan to use Genlist mode. See
16569 * elm_genlist_item_mode_set() for more info.
16571 * - @c func - A struct with pointers to functions that will be called when
16572 * an item is going to be actually created. All of them receive a @c data
16573 * parameter that will point to the same data passed to
16574 * elm_genlist_item_append() and related item creation functions, and a @c
16575 * obj parameter that points to the genlist object itself.
16577 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16578 * state_get and @c del. The 3 first functions also receive a @c part
16579 * parameter described below. A brief description of these functions follows:
16581 * - @c label_get - The @c part parameter is the name string of one of the
16582 * existing text parts in the Edje group implementing the item's theme.
16583 * This function @b must return a strdup'()ed string, as the caller will
16584 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16585 * - @c icon_get - The @c part parameter is the name string of one of the
16586 * existing (icon) swallow parts in the Edje group implementing the item's
16587 * theme. It must return @c NULL, when no icon is desired, or a valid
16588 * object handle, otherwise. The object will be deleted by the genlist on
16589 * its deletion or when the item is "unrealized". See
16590 * #Elm_Genlist_Item_Icon_Get_Cb.
16591 * - @c func.state_get - The @c part parameter is the name string of one of
16592 * the state parts in the Edje group implementing the item's theme. Return
16593 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16594 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16595 * and @c "elm" as "emission" and "source" arguments, respectively, when
16596 * the state is true (the default is false), where @c XXX is the name of
16597 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16598 * - @c func.del - This is intended for use when genlist items are deleted,
16599 * so any data attached to the item (e.g. its data parameter on creation)
16600 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16602 * available item styles:
16604 * - default_style - The text part is a textblock
16606 * @image html img/widget/genlist/preview-04.png
16607 * @image latex img/widget/genlist/preview-04.eps
16611 * @image html img/widget/genlist/preview-01.png
16612 * @image latex img/widget/genlist/preview-01.eps
16614 * - icon_top_text_bottom
16616 * @image html img/widget/genlist/preview-02.png
16617 * @image latex img/widget/genlist/preview-02.eps
16621 * @image html img/widget/genlist/preview-03.png
16622 * @image latex img/widget/genlist/preview-03.eps
16624 * @section Genlist_Items Structure of items
16626 * An item in a genlist can have 0 or more text labels (they can be regular
16627 * text or textblock Evas objects - that's up to the style to determine), 0
16628 * or more icons (which are simply objects swallowed into the genlist item's
16629 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16630 * behavior left to the user to define. The Edje part names for each of
16631 * these properties will be looked up, in the theme file for the genlist,
16632 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16633 * "states", respectively. For each of those properties, if more than one
16634 * part is provided, they must have names listed separated by spaces in the
16635 * data fields. For the default genlist item theme, we have @b one label
16636 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16637 * "elm.swallow.end") and @b no state parts.
16639 * A genlist item may be at one of several styles. Elementary provides one
16640 * by default - "default", but this can be extended by system or application
16641 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16644 * @section Genlist_Manipulation Editing and Navigating
16646 * Items can be added by several calls. All of them return a @ref
16647 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16648 * They all take a data parameter that is meant to be used for a handle to
16649 * the applications internal data (eg the struct with the original item
16650 * data). The parent parameter is the parent genlist item this belongs to if
16651 * it is a tree or an indexed group, and NULL if there is no parent. The
16652 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16653 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16654 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16655 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16656 * is set then this item is group index item that is displayed at the top
16657 * until the next group comes. The func parameter is a convenience callback
16658 * that is called when the item is selected and the data parameter will be
16659 * the func_data parameter, obj be the genlist object and event_info will be
16660 * the genlist item.
16662 * elm_genlist_item_append() adds an item to the end of the list, or if
16663 * there is a parent, to the end of all the child items of the parent.
16664 * elm_genlist_item_prepend() is the same but adds to the beginning of
16665 * the list or children list. elm_genlist_item_insert_before() inserts at
16666 * item before another item and elm_genlist_item_insert_after() inserts after
16667 * the indicated item.
16669 * The application can clear the list with elm_genlist_clear() which deletes
16670 * all the items in the list and elm_genlist_item_del() will delete a specific
16671 * item. elm_genlist_item_subitems_clear() will clear all items that are
16672 * children of the indicated parent item.
16674 * To help inspect list items you can jump to the item at the top of the list
16675 * with elm_genlist_first_item_get() which will return the item pointer, and
16676 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16677 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16678 * and previous items respectively relative to the indicated item. Using
16679 * these calls you can walk the entire item list/tree. Note that as a tree
16680 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16681 * let you know which item is the parent (and thus know how to skip them if
16684 * @section Genlist_Muti_Selection Multi-selection
16686 * If the application wants multiple items to be able to be selected,
16687 * elm_genlist_multi_select_set() can enable this. If the list is
16688 * single-selection only (the default), then elm_genlist_selected_item_get()
16689 * will return the selected item, if any, or NULL I none is selected. If the
16690 * list is multi-select then elm_genlist_selected_items_get() will return a
16691 * list (that is only valid as long as no items are modified (added, deleted,
16692 * selected or unselected)).
16694 * @section Genlist_Usage_Hints Usage hints
16696 * There are also convenience functions. elm_genlist_item_genlist_get() will
16697 * return the genlist object the item belongs to. elm_genlist_item_show()
16698 * will make the scroller scroll to show that specific item so its visible.
16699 * elm_genlist_item_data_get() returns the data pointer set by the item
16700 * creation functions.
16702 * If an item changes (state of boolean changes, label or icons change),
16703 * then use elm_genlist_item_update() to have genlist update the item with
16704 * the new state. Genlist will re-realize the item thus call the functions
16705 * in the _Elm_Genlist_Item_Class for that item.
16707 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16708 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16709 * to expand/contract an item and get its expanded state, use
16710 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16711 * again to make an item disabled (unable to be selected and appear
16712 * differently) use elm_genlist_item_disabled_set() to set this and
16713 * elm_genlist_item_disabled_get() to get the disabled state.
16715 * In general to indicate how the genlist should expand items horizontally to
16716 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16717 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16718 * mode means that if items are too wide to fit, the scroller will scroll
16719 * horizontally. Otherwise items are expanded to fill the width of the
16720 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16721 * to the viewport width and limited to that size. This can be combined with
16722 * a different style that uses edjes' ellipsis feature (cutting text off like
16725 * Items will only call their selection func and callback when first becoming
16726 * selected. Any further clicks will do nothing, unless you enable always
16727 * select with elm_genlist_always_select_mode_set(). This means even if
16728 * selected, every click will make the selected callbacks be called.
16729 * elm_genlist_no_select_mode_set() will turn off the ability to select
16730 * items entirely and they will neither appear selected nor call selected
16731 * callback functions.
16733 * Remember that you can create new styles and add your own theme augmentation
16734 * per application with elm_theme_extension_add(). If you absolutely must
16735 * have a specific style that overrides any theme the user or system sets up
16736 * you can use elm_theme_overlay_add() to add such a file.
16738 * @section Genlist_Implementation Implementation
16740 * Evas tracks every object you create. Every time it processes an event
16741 * (mouse move, down, up etc.) it needs to walk through objects and find out
16742 * what event that affects. Even worse every time it renders display updates,
16743 * in order to just calculate what to re-draw, it needs to walk through many
16744 * many many objects. Thus, the more objects you keep active, the more
16745 * overhead Evas has in just doing its work. It is advisable to keep your
16746 * active objects to the minimum working set you need. Also remember that
16747 * object creation and deletion carries an overhead, so there is a
16748 * middle-ground, which is not easily determined. But don't keep massive lists
16749 * of objects you can't see or use. Genlist does this with list objects. It
16750 * creates and destroys them dynamically as you scroll around. It groups them
16751 * into blocks so it can determine the visibility etc. of a whole block at
16752 * once as opposed to having to walk the whole list. This 2-level list allows
16753 * for very large numbers of items to be in the list (tests have used up to
16754 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16755 * may be different sizes, every item added needs to be calculated as to its
16756 * size and thus this presents a lot of overhead on populating the list, this
16757 * genlist employs a queue. Any item added is queued and spooled off over
16758 * time, actually appearing some time later, so if your list has many members
16759 * you may find it takes a while for them to all appear, with your process
16760 * consuming a lot of CPU while it is busy spooling.
16762 * Genlist also implements a tree structure, but it does so with callbacks to
16763 * the application, with the application filling in tree structures when
16764 * requested (allowing for efficient building of a very deep tree that could
16765 * even be used for file-management). See the above smart signal callbacks for
16768 * @section Genlist_Smart_Events Genlist smart events
16770 * Signals that you can add callbacks for are:
16771 * - @c "activated" - The user has double-clicked or pressed
16772 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16773 * item that was activated.
16774 * - @c "clicked,double" - The user has double-clicked an item. The @c
16775 * event_info parameter is the item that was double-clicked.
16776 * - @c "selected" - This is called when a user has made an item selected.
16777 * The event_info parameter is the genlist item that was selected.
16778 * - @c "unselected" - This is called when a user has made an item
16779 * unselected. The event_info parameter is the genlist item that was
16781 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16782 * called and the item is now meant to be expanded. The event_info
16783 * parameter is the genlist item that was indicated to expand. It is the
16784 * job of this callback to then fill in the child items.
16785 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16786 * called and the item is now meant to be contracted. The event_info
16787 * parameter is the genlist item that was indicated to contract. It is the
16788 * job of this callback to then delete the child items.
16789 * - @c "expand,request" - This is called when a user has indicated they want
16790 * to expand a tree branch item. The callback should decide if the item can
16791 * expand (has any children) and then call elm_genlist_item_expanded_set()
16792 * appropriately to set the state. The event_info parameter is the genlist
16793 * item that was indicated to expand.
16794 * - @c "contract,request" - This is called when a user has indicated they
16795 * want to contract a tree branch item. The callback should decide if the
16796 * item can contract (has any children) and then call
16797 * elm_genlist_item_expanded_set() appropriately to set the state. The
16798 * event_info parameter is the genlist item that was indicated to contract.
16799 * - @c "realized" - This is called when the item in the list is created as a
16800 * real evas object. event_info parameter is the genlist item that was
16801 * created. The object may be deleted at any time, so it is up to the
16802 * caller to not use the object pointer from elm_genlist_item_object_get()
16803 * in a way where it may point to freed objects.
16804 * - @c "unrealized" - This is called just before an item is unrealized.
16805 * After this call icon objects provided will be deleted and the item
16806 * object itself delete or be put into a floating cache.
16807 * - @c "drag,start,up" - This is called when the item in the list has been
16808 * dragged (not scrolled) up.
16809 * - @c "drag,start,down" - This is called when the item in the list has been
16810 * dragged (not scrolled) down.
16811 * - @c "drag,start,left" - This is called when the item in the list has been
16812 * dragged (not scrolled) left.
16813 * - @c "drag,start,right" - This is called when the item in the list has
16814 * been dragged (not scrolled) right.
16815 * - @c "drag,stop" - This is called when the item in the list has stopped
16817 * - @c "drag" - This is called when the item in the list is being dragged.
16818 * - @c "longpressed" - This is called when the item is pressed for a certain
16819 * amount of time. By default it's 1 second.
16820 * - @c "scroll,anim,start" - This is called when scrolling animation has
16822 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16824 * - @c "scroll,drag,start" - This is called when dragging the content has
16826 * - @c "scroll,drag,stop" - This is called when dragging the content has
16828 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16830 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16831 * until the bottom edge.
16832 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16833 * until the left edge.
16834 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16835 * until the right edge.
16836 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16838 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16840 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16842 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16844 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16845 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16846 * multi-touch pinched in.
16847 * - @c "swipe" - This is called when the genlist is swiped.
16849 * @section Genlist_Examples Examples
16851 * Here is a list of examples that use the genlist, trying to show some of
16852 * its capabilities:
16853 * - @ref genlist_example_01
16854 * - @ref genlist_example_02
16855 * - @ref genlist_example_03
16856 * - @ref genlist_example_04
16857 * - @ref genlist_example_05
16861 * @addtogroup Genlist
16866 * @enum _Elm_Genlist_Item_Flags
16867 * @typedef Elm_Genlist_Item_Flags
16869 * Defines if the item is of any special type (has subitems or it's the
16870 * index of a group), or is just a simple item.
16874 typedef enum _Elm_Genlist_Item_Flags
16876 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16877 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16878 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16879 } Elm_Genlist_Item_Flags;
16880 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16881 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16882 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16883 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16884 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. */
16885 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. */
16886 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16887 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16889 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16890 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16891 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16892 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16895 * @struct _Elm_Genlist_Item_Class
16897 * Genlist item class definition structs.
16899 * This struct contains the style and fetching functions that will define the
16900 * contents of each item.
16902 * @see @ref Genlist_Item_Class
16904 struct _Elm_Genlist_Item_Class
16906 const char *item_style; /**< style of this class. */
16909 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16910 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16911 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16912 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16913 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16915 const char *mode_item_style;
16919 * Add a new genlist widget to the given parent Elementary
16920 * (container) object
16922 * @param parent The parent object
16923 * @return a new genlist widget handle or @c NULL, on errors
16925 * This function inserts a new genlist widget on the canvas.
16927 * @see elm_genlist_item_append()
16928 * @see elm_genlist_item_del()
16929 * @see elm_genlist_clear()
16933 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16935 * Remove all items from a given genlist widget.
16937 * @param obj The genlist object
16939 * This removes (and deletes) all items in @p obj, leaving it empty.
16941 * @see elm_genlist_item_del(), to remove just one item.
16945 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16947 * Enable or disable multi-selection in the genlist
16949 * @param obj The genlist object
16950 * @param multi Multi-select enable/disable. Default is disabled.
16952 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16953 * the list. This allows more than 1 item to be selected. To retrieve the list
16954 * of selected items, use elm_genlist_selected_items_get().
16956 * @see elm_genlist_selected_items_get()
16957 * @see elm_genlist_multi_select_get()
16961 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16963 * Gets if multi-selection in genlist is enabled or disabled.
16965 * @param obj The genlist object
16966 * @return Multi-select enabled/disabled
16967 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16969 * @see elm_genlist_multi_select_set()
16973 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16975 * This sets the horizontal stretching mode.
16977 * @param obj The genlist object
16978 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16980 * This sets the mode used for sizing items horizontally. Valid modes
16981 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16982 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16983 * the scroller will scroll horizontally. Otherwise items are expanded
16984 * to fill the width of the viewport of the scroller. If it is
16985 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16986 * limited to that size.
16988 * @see elm_genlist_horizontal_get()
16992 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16993 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16995 * Gets the horizontal stretching mode.
16997 * @param obj The genlist object
16998 * @return The mode to use
16999 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17001 * @see elm_genlist_horizontal_set()
17005 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17006 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17008 * Set the always select mode.
17010 * @param obj The genlist object
17011 * @param always_select The always select mode (@c EINA_TRUE = on, @c
17012 * EINA_FALSE = off). Default is @c EINA_FALSE.
17014 * Items will only call their selection func and callback when first
17015 * becoming selected. Any further clicks will do nothing, unless you
17016 * enable always select with elm_genlist_always_select_mode_set().
17017 * This means that, even if selected, every click will make the selected
17018 * callbacks be called.
17020 * @see elm_genlist_always_select_mode_get()
17024 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17026 * Get the always select mode.
17028 * @param obj The genlist object
17029 * @return The always select mode
17030 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17032 * @see elm_genlist_always_select_mode_set()
17036 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17038 * Enable/disable the no select mode.
17040 * @param obj The genlist object
17041 * @param no_select The no select mode
17042 * (EINA_TRUE = on, EINA_FALSE = off)
17044 * This will turn off the ability to select items entirely and they
17045 * will neither appear selected nor call selected callback functions.
17047 * @see elm_genlist_no_select_mode_get()
17051 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17053 * Gets whether the no select mode is enabled.
17055 * @param obj The genlist object
17056 * @return The no select mode
17057 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17059 * @see elm_genlist_no_select_mode_set()
17063 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17065 * Enable/disable compress mode.
17067 * @param obj The genlist object
17068 * @param compress The compress mode
17069 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17071 * This will enable the compress mode where items are "compressed"
17072 * horizontally to fit the genlist scrollable viewport width. This is
17073 * special for genlist. Do not rely on
17074 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17075 * work as genlist needs to handle it specially.
17077 * @see elm_genlist_compress_mode_get()
17081 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17083 * Get whether the compress mode is enabled.
17085 * @param obj The genlist object
17086 * @return The compress mode
17087 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17089 * @see elm_genlist_compress_mode_set()
17093 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17095 * Enable/disable height-for-width mode.
17097 * @param obj The genlist object
17098 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17099 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17101 * With height-for-width mode the item width will be fixed (restricted
17102 * to a minimum of) to the list width when calculating its size in
17103 * order to allow the height to be calculated based on it. This allows,
17104 * for instance, text block to wrap lines if the Edje part is
17105 * configured with "text.min: 0 1".
17107 * @note This mode will make list resize slower as it will have to
17108 * recalculate every item height again whenever the list width
17111 * @note When height-for-width mode is enabled, it also enables
17112 * compress mode (see elm_genlist_compress_mode_set()) and
17113 * disables homogeneous (see elm_genlist_homogeneous_set()).
17117 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17119 * Get whether the height-for-width mode is enabled.
17121 * @param obj The genlist object
17122 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17127 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17129 * Enable/disable horizontal and vertical bouncing effect.
17131 * @param obj The genlist object
17132 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17133 * EINA_FALSE = off). Default is @c EINA_FALSE.
17134 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17135 * EINA_FALSE = off). Default is @c EINA_TRUE.
17137 * This will enable or disable the scroller bouncing effect for the
17138 * genlist. See elm_scroller_bounce_set() for details.
17140 * @see elm_scroller_bounce_set()
17141 * @see elm_genlist_bounce_get()
17145 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17147 * Get whether the horizontal and vertical bouncing effect is enabled.
17149 * @param obj The genlist object
17150 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17152 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17155 * @see elm_genlist_bounce_set()
17159 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17161 * Enable/disable homogenous mode.
17163 * @param obj The genlist object
17164 * @param homogeneous Assume the items within the genlist are of the
17165 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17168 * This will enable the homogeneous mode where items are of the same
17169 * height and width so that genlist may do the lazy-loading at its
17170 * maximum (which increases the performance for scrolling the list). This
17171 * implies 'compressed' mode.
17173 * @see elm_genlist_compress_mode_set()
17174 * @see elm_genlist_homogeneous_get()
17178 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17180 * Get whether the homogenous mode is enabled.
17182 * @param obj The genlist object
17183 * @return Assume the items within the genlist are of the same height
17184 * and width (EINA_TRUE = on, EINA_FALSE = off)
17186 * @see elm_genlist_homogeneous_set()
17190 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17192 * Set the maximum number of items within an item block
17194 * @param obj The genlist object
17195 * @param n Maximum number of items within an item block. Default is 32.
17197 * This will configure the block count to tune to the target with
17198 * particular performance matrix.
17200 * A block of objects will be used to reduce the number of operations due to
17201 * many objects in the screen. It can determine the visibility, or if the
17202 * object has changed, it theme needs to be updated, etc. doing this kind of
17203 * calculation to the entire block, instead of per object.
17205 * The default value for the block count is enough for most lists, so unless
17206 * you know you will have a lot of objects visible in the screen at the same
17207 * time, don't try to change this.
17209 * @see elm_genlist_block_count_get()
17210 * @see @ref Genlist_Implementation
17214 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17216 * Get the maximum number of items within an item block
17218 * @param obj The genlist object
17219 * @return Maximum number of items within an item block
17221 * @see elm_genlist_block_count_set()
17225 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17227 * Set the timeout in seconds for the longpress event.
17229 * @param obj The genlist object
17230 * @param timeout timeout in seconds. Default is 1.
17232 * This option will change how long it takes to send an event "longpressed"
17233 * after the mouse down signal is sent to the list. If this event occurs, no
17234 * "clicked" event will be sent.
17236 * @see elm_genlist_longpress_timeout_set()
17240 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17242 * Get the timeout in seconds for the longpress event.
17244 * @param obj The genlist object
17245 * @return timeout in seconds
17247 * @see elm_genlist_longpress_timeout_get()
17251 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17253 * Append a new item in a given genlist widget.
17255 * @param obj The genlist object
17256 * @param itc The item class for the item
17257 * @param data The item data
17258 * @param parent The parent item, or NULL if none
17259 * @param flags Item flags
17260 * @param func Convenience function called when the item is selected
17261 * @param func_data Data passed to @p func above.
17262 * @return A handle to the item added or @c NULL if not possible
17264 * This adds the given item to the end of the list or the end of
17265 * the children list if the @p parent is given.
17267 * @see elm_genlist_item_prepend()
17268 * @see elm_genlist_item_insert_before()
17269 * @see elm_genlist_item_insert_after()
17270 * @see elm_genlist_item_del()
17274 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);
17276 * Prepend a new item in a given genlist widget.
17278 * @param obj The genlist object
17279 * @param itc The item class for the item
17280 * @param data The item data
17281 * @param parent The parent item, or NULL if none
17282 * @param flags Item flags
17283 * @param func Convenience function called when the item is selected
17284 * @param func_data Data passed to @p func above.
17285 * @return A handle to the item added or NULL if not possible
17287 * This adds an item to the beginning of the list or beginning of the
17288 * children of the parent if given.
17290 * @see elm_genlist_item_append()
17291 * @see elm_genlist_item_insert_before()
17292 * @see elm_genlist_item_insert_after()
17293 * @see elm_genlist_item_del()
17297 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);
17299 * Insert an item before another in a genlist widget
17301 * @param obj The genlist object
17302 * @param itc The item class for the item
17303 * @param data The item data
17304 * @param before The item to place this new one before.
17305 * @param flags Item flags
17306 * @param func Convenience function called when the item is selected
17307 * @param func_data Data passed to @p func above.
17308 * @return A handle to the item added or @c NULL if not possible
17310 * This inserts an item before another in the list. It will be in the
17311 * same tree level or group as the item it is inserted before.
17313 * @see elm_genlist_item_append()
17314 * @see elm_genlist_item_prepend()
17315 * @see elm_genlist_item_insert_after()
17316 * @see elm_genlist_item_del()
17320 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);
17322 * Insert an item after another in a genlist widget
17324 * @param obj The genlist object
17325 * @param itc The item class for the item
17326 * @param data The item data
17327 * @param after The item to place this new one after.
17328 * @param flags Item flags
17329 * @param func Convenience function called when the item is selected
17330 * @param func_data Data passed to @p func above.
17331 * @return A handle to the item added or @c NULL if not possible
17333 * This inserts an item after another in the list. It will be in the
17334 * same tree level or group as the item it is inserted after.
17336 * @see elm_genlist_item_append()
17337 * @see elm_genlist_item_prepend()
17338 * @see elm_genlist_item_insert_before()
17339 * @see elm_genlist_item_del()
17343 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);
17345 * Insert a new item into the sorted genlist object
17347 * @param obj The genlist object
17348 * @param itc The item class for the item
17349 * @param data The item data
17350 * @param parent The parent item, or NULL if none
17351 * @param flags Item flags
17352 * @param comp The function called for the sort
17353 * @param func Convenience function called when item selected
17354 * @param func_data Data passed to @p func above.
17355 * @return A handle to the item added or NULL if not possible
17359 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);
17360 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);
17361 /* operations to retrieve existing items */
17363 * Get the selectd item in the genlist.
17365 * @param obj The genlist object
17366 * @return The selected item, or NULL if none is selected.
17368 * This gets the selected item in the list (if multi-selection is enabled, only
17369 * the item that was first selected in the list is returned - which is not very
17370 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17373 * If no item is selected, NULL is returned.
17375 * @see elm_genlist_selected_items_get()
17379 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17381 * Get a list of selected items in the genlist.
17383 * @param obj The genlist object
17384 * @return The list of selected items, or NULL if none are selected.
17386 * It returns a list of the selected items. This list pointer is only valid so
17387 * long as the selection doesn't change (no items are selected or unselected, or
17388 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17389 * pointers. The order of the items in this list is the order which they were
17390 * selected, i.e. the first item in this list is the first item that was
17391 * selected, and so on.
17393 * @note If not in multi-select mode, consider using function
17394 * elm_genlist_selected_item_get() instead.
17396 * @see elm_genlist_multi_select_set()
17397 * @see elm_genlist_selected_item_get()
17401 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17403 * Get a list of realized items in genlist
17405 * @param obj The genlist object
17406 * @return The list of realized items, nor NULL if none are realized.
17408 * This returns a list of the realized items in the genlist. The list
17409 * contains Elm_Genlist_Item pointers. The list must be freed by the
17410 * caller when done with eina_list_free(). The item pointers in the
17411 * list are only valid so long as those items are not deleted or the
17412 * genlist is not deleted.
17414 * @see elm_genlist_realized_items_update()
17418 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17420 * Get the item that is at the x, y canvas coords.
17422 * @param obj The gelinst object.
17423 * @param x The input x coordinate
17424 * @param y The input y coordinate
17425 * @param posret The position relative to the item returned here
17426 * @return The item at the coordinates or NULL if none
17428 * This returns the item at the given coordinates (which are canvas
17429 * relative, not object-relative). If an item is at that coordinate,
17430 * that item handle is returned, and if @p posret is not NULL, the
17431 * integer pointed to is set to a value of -1, 0 or 1, depending if
17432 * the coordinate is on the upper portion of that item (-1), on the
17433 * middle section (0) or on the lower part (1). If NULL is returned as
17434 * an item (no item found there), then posret may indicate -1 or 1
17435 * based if the coordinate is above or below all items respectively in
17440 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);
17442 * Get the first item in the genlist
17444 * This returns the first item in the list.
17446 * @param obj The genlist object
17447 * @return The first item, or NULL if none
17451 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17453 * Get the last item in the genlist
17455 * This returns the last item in the list.
17457 * @return The last item, or NULL if none
17461 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17463 * Set the scrollbar policy
17465 * @param obj The genlist object
17466 * @param policy_h Horizontal scrollbar policy.
17467 * @param policy_v Vertical scrollbar policy.
17469 * This sets the scrollbar visibility policy for the given genlist
17470 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17471 * made visible if it is needed, and otherwise kept hidden.
17472 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17473 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17474 * respectively for the horizontal and vertical scrollbars. Default is
17475 * #ELM_SMART_SCROLLER_POLICY_AUTO
17477 * @see elm_genlist_scroller_policy_get()
17481 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17483 * Get the scrollbar policy
17485 * @param obj The genlist object
17486 * @param policy_h Pointer to store the horizontal scrollbar policy.
17487 * @param policy_v Pointer to store the vertical scrollbar policy.
17489 * @see elm_genlist_scroller_policy_set()
17493 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);
17495 * Get the @b next item in a genlist widget's internal list of items,
17496 * given a handle to one of those items.
17498 * @param item The genlist item to fetch next from
17499 * @return The item after @p item, or @c NULL if there's none (and
17502 * This returns the item placed after the @p item, on the container
17505 * @see elm_genlist_item_prev_get()
17509 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17511 * Get the @b previous item in a genlist widget's internal list of items,
17512 * given a handle to one of those items.
17514 * @param item The genlist item to fetch previous from
17515 * @return The item before @p item, or @c NULL if there's none (and
17518 * This returns the item placed before the @p item, on the container
17521 * @see elm_genlist_item_next_get()
17525 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17527 * Get the genlist object's handle which contains a given genlist
17530 * @param item The item to fetch the container from
17531 * @return The genlist (parent) object
17533 * This returns the genlist object itself that an item belongs to.
17537 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17539 * Get the parent item of the given item
17541 * @param it The item
17542 * @return The parent of the item or @c NULL if it has no parent.
17544 * This returns the item that was specified as parent of the item @p it on
17545 * elm_genlist_item_append() and insertion related functions.
17549 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17551 * Remove all sub-items (children) of the given item
17553 * @param it The item
17555 * This removes all items that are children (and their descendants) of the
17556 * given item @p it.
17558 * @see elm_genlist_clear()
17559 * @see elm_genlist_item_del()
17563 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17565 * Set whether a given genlist item is selected or not
17567 * @param it The item
17568 * @param selected Use @c EINA_TRUE, to make it selected, @c
17569 * EINA_FALSE to make it unselected
17571 * This sets the selected state of an item. If multi selection is
17572 * not enabled on the containing genlist and @p selected is @c
17573 * EINA_TRUE, any other previously selected items will get
17574 * unselected in favor of this new one.
17576 * @see elm_genlist_item_selected_get()
17580 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17582 * Get whether a given genlist item is selected or not
17584 * @param it The item
17585 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17587 * @see elm_genlist_item_selected_set() for more details
17591 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17593 * Sets the expanded state of an item.
17595 * @param it The item
17596 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17598 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17601 * The theme will respond to this change visually, and a signal "expanded" or
17602 * "contracted" will be sent from the genlist with a pointer to the item that
17603 * has been expanded/contracted.
17605 * Calling this function won't show or hide any child of this item (if it is
17606 * a parent). You must manually delete and create them on the callbacks fo
17607 * the "expanded" or "contracted" signals.
17609 * @see elm_genlist_item_expanded_get()
17613 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17615 * Get the expanded state of an item
17617 * @param it The item
17618 * @return The expanded state
17620 * This gets the expanded state of an item.
17622 * @see elm_genlist_item_expanded_set()
17626 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17628 * Get the depth of expanded item
17630 * @param it The genlist item object
17631 * @return The depth of expanded item
17635 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17637 * Set whether a given genlist item is disabled or not.
17639 * @param it The item
17640 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17641 * to enable it back.
17643 * A disabled item cannot be selected or unselected. It will also
17644 * change its appearance, to signal the user it's disabled.
17646 * @see elm_genlist_item_disabled_get()
17650 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17652 * Get whether a given genlist item is disabled or not.
17654 * @param it The item
17655 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17658 * @see elm_genlist_item_disabled_set() for more details
17662 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17664 * Sets the display only state of an item.
17666 * @param it The item
17667 * @param display_only @c EINA_TRUE if the item is display only, @c
17668 * EINA_FALSE otherwise.
17670 * A display only item cannot be selected or unselected. It is for
17671 * display only and not selecting or otherwise clicking, dragging
17672 * etc. by the user, thus finger size rules will not be applied to
17675 * It's good to set group index items to display only state.
17677 * @see elm_genlist_item_display_only_get()
17681 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17683 * Get the display only state of an item
17685 * @param it The item
17686 * @return @c EINA_TRUE if the item is display only, @c
17687 * EINA_FALSE otherwise.
17689 * @see elm_genlist_item_display_only_set()
17693 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17695 * Show the portion of a genlist's internal list containing a given
17696 * item, immediately.
17698 * @param it The item to display
17700 * This causes genlist to jump to the given item @p it and show it (by
17701 * immediately scrolling to that position), if it is not fully visible.
17703 * @see elm_genlist_item_bring_in()
17704 * @see elm_genlist_item_top_show()
17705 * @see elm_genlist_item_middle_show()
17709 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17711 * Animatedly bring in, to the visible are of a genlist, a given
17714 * @param it The item to display
17716 * This causes genlist to jump to the given item @p it and show it (by
17717 * animatedly scrolling), if it is not fully visible. This may use animation
17718 * to do so and take a period of time
17720 * @see elm_genlist_item_show()
17721 * @see elm_genlist_item_top_bring_in()
17722 * @see elm_genlist_item_middle_bring_in()
17726 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17728 * Show the portion of a genlist's internal list containing a given
17729 * item, immediately.
17731 * @param it The item to display
17733 * This causes genlist to jump to the given item @p it and show it (by
17734 * immediately scrolling to that position), if it is not fully visible.
17736 * The item will be positioned at the top of the genlist viewport.
17738 * @see elm_genlist_item_show()
17739 * @see elm_genlist_item_top_bring_in()
17743 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17745 * Animatedly bring in, to the visible are of a genlist, a given
17748 * @param it The item
17750 * This causes genlist to jump to the given item @p it and show it (by
17751 * animatedly scrolling), if it is not fully visible. This may use animation
17752 * to do so and take a period of time
17754 * The item will be positioned at the top of the genlist viewport.
17756 * @see elm_genlist_item_bring_in()
17757 * @see elm_genlist_item_top_show()
17761 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17763 * Show the portion of a genlist's internal list containing a given
17764 * item, immediately.
17766 * @param it The item to display
17768 * This causes genlist to jump to the given item @p it and show it (by
17769 * immediately scrolling to that position), if it is not fully visible.
17771 * The item will be positioned at the middle of the genlist viewport.
17773 * @see elm_genlist_item_show()
17774 * @see elm_genlist_item_middle_bring_in()
17778 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17780 * Animatedly bring in, to the visible are of a genlist, a given
17783 * @param it The item
17785 * This causes genlist to jump to the given item @p it and show it (by
17786 * animatedly scrolling), if it is not fully visible. This may use animation
17787 * to do so and take a period of time
17789 * The item will be positioned at the middle of the genlist viewport.
17791 * @see elm_genlist_item_bring_in()
17792 * @see elm_genlist_item_middle_show()
17796 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17798 * Remove a genlist item from the its parent, deleting it.
17800 * @param item The item to be removed.
17801 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17803 * @see elm_genlist_clear(), to remove all items in a genlist at
17808 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17810 * Return the data associated to a given genlist item
17812 * @param item The genlist item.
17813 * @return the data associated to this item.
17815 * This returns the @c data value passed on the
17816 * elm_genlist_item_append() and related item addition calls.
17818 * @see elm_genlist_item_append()
17819 * @see elm_genlist_item_data_set()
17823 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17825 * Set the data associated to a given genlist item
17827 * @param item The genlist item
17828 * @param data The new data pointer to set on it
17830 * This @b overrides the @c data value passed on the
17831 * elm_genlist_item_append() and related item addition calls. This
17832 * function @b won't call elm_genlist_item_update() automatically,
17833 * so you'd issue it afterwards if you want to hove the item
17834 * updated to reflect the that new data.
17836 * @see elm_genlist_item_data_get()
17840 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17842 * Tells genlist to "orphan" icons fetchs by the item class
17844 * @param it The item
17846 * This instructs genlist to release references to icons in the item,
17847 * meaning that they will no longer be managed by genlist and are
17848 * floating "orphans" that can be re-used elsewhere if the user wants
17853 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17855 * Get the real Evas object created to implement the view of a
17856 * given genlist item
17858 * @param item The genlist item.
17859 * @return the Evas object implementing this item's view.
17861 * This returns the actual Evas object used to implement the
17862 * specified genlist item's view. This may be @c NULL, as it may
17863 * not have been created or may have been deleted, at any time, by
17864 * the genlist. <b>Do not modify this object</b> (move, resize,
17865 * show, hide, etc.), as the genlist is controlling it. This
17866 * function is for querying, emitting custom signals or hooking
17867 * lower level callbacks for events on that object. Do not delete
17868 * this object under any circumstances.
17870 * @see elm_genlist_item_data_get()
17874 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17876 * Update the contents of an item
17878 * @param it The item
17880 * This updates an item by calling all the item class functions again
17881 * to get the icons, labels and states. Use this when the original
17882 * item data has changed and the changes are desired to be reflected.
17884 * Use elm_genlist_realized_items_update() to update all already realized
17887 * @see elm_genlist_realized_items_update()
17891 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17893 * Update the item class of an item
17895 * @param it The item
17896 * @param itc The item class for the item
17898 * This sets another class fo the item, changing the way that it is
17899 * displayed. After changing the item class, elm_genlist_item_update() is
17900 * called on the item @p it.
17904 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17905 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17907 * Set the text to be shown in a given genlist item's tooltips.
17909 * @param item The genlist item
17910 * @param text The text to set in the content
17912 * This call will setup the text to be used as tooltip to that item
17913 * (analogous to elm_object_tooltip_text_set(), but being item
17914 * tooltips with higher precedence than object tooltips). It can
17915 * have only one tooltip at a time, so any previous tooltip data
17916 * will get removed.
17918 * In order to set an icon or something else as a tooltip, look at
17919 * elm_genlist_item_tooltip_content_cb_set().
17923 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17925 * Set the content to be shown in a given genlist item's tooltips
17927 * @param item The genlist item.
17928 * @param func The function returning the tooltip contents.
17929 * @param data What to provide to @a func as callback data/context.
17930 * @param del_cb Called when data is not needed anymore, either when
17931 * another callback replaces @p func, the tooltip is unset with
17932 * elm_genlist_item_tooltip_unset() or the owner @p item
17933 * dies. This callback receives as its first parameter the
17934 * given @p data, being @c event_info the item handle.
17936 * This call will setup the tooltip's contents to @p item
17937 * (analogous to elm_object_tooltip_content_cb_set(), but being
17938 * item tooltips with higher precedence than object tooltips). It
17939 * can have only one tooltip at a time, so any previous tooltip
17940 * content will get removed. @p func (with @p data) will be called
17941 * every time Elementary needs to show the tooltip and it should
17942 * return a valid Evas object, which will be fully managed by the
17943 * tooltip system, getting deleted when the tooltip is gone.
17945 * In order to set just a text as a tooltip, look at
17946 * elm_genlist_item_tooltip_text_set().
17950 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);
17952 * Unset a tooltip from a given genlist item
17954 * @param item genlist item to remove a previously set tooltip from.
17956 * This call removes any tooltip set on @p item. The callback
17957 * provided as @c del_cb to
17958 * elm_genlist_item_tooltip_content_cb_set() will be called to
17959 * notify it is not used anymore (and have resources cleaned, if
17962 * @see elm_genlist_item_tooltip_content_cb_set()
17966 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17968 * Set a different @b style for a given genlist item's tooltip.
17970 * @param item genlist item with tooltip set
17971 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17972 * "default", @c "transparent", etc)
17974 * Tooltips can have <b>alternate styles</b> to be displayed on,
17975 * which are defined by the theme set on Elementary. This function
17976 * works analogously as elm_object_tooltip_style_set(), but here
17977 * applied only to genlist item objects. The default style for
17978 * tooltips is @c "default".
17980 * @note before you set a style you should define a tooltip with
17981 * elm_genlist_item_tooltip_content_cb_set() or
17982 * elm_genlist_item_tooltip_text_set()
17984 * @see elm_genlist_item_tooltip_style_get()
17988 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17990 * Get the style set a given genlist item's tooltip.
17992 * @param item genlist item with tooltip already set on.
17993 * @return style the theme style in use, which defaults to
17994 * "default". If the object does not have a tooltip set,
17995 * then @c NULL is returned.
17997 * @see elm_genlist_item_tooltip_style_set() for more details
18001 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18003 * @brief Disable size restrictions on an object's tooltip
18004 * @param item The tooltip's anchor object
18005 * @param disable If EINA_TRUE, size restrictions are disabled
18006 * @return EINA_FALSE on failure, EINA_TRUE on success
18008 * This function allows a tooltip to expand beyond its parant window's canvas.
18009 * It will instead be limited only by the size of the display.
18011 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18013 * @brief Retrieve size restriction state of an object's tooltip
18014 * @param item The tooltip's anchor object
18015 * @return If EINA_TRUE, size restrictions are disabled
18017 * This function returns whether a tooltip is allowed to expand beyond
18018 * its parant window's canvas.
18019 * It will instead be limited only by the size of the display.
18021 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18023 * Set the type of mouse pointer/cursor decoration to be shown,
18024 * when the mouse pointer is over the given genlist widget item
18026 * @param item genlist item to customize cursor on
18027 * @param cursor the cursor type's name
18029 * This function works analogously as elm_object_cursor_set(), but
18030 * here the cursor's changing area is restricted to the item's
18031 * area, and not the whole widget's. Note that that item cursors
18032 * have precedence over widget cursors, so that a mouse over @p
18033 * item will always show cursor @p type.
18035 * If this function is called twice for an object, a previously set
18036 * cursor will be unset on the second call.
18038 * @see elm_object_cursor_set()
18039 * @see elm_genlist_item_cursor_get()
18040 * @see elm_genlist_item_cursor_unset()
18044 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18046 * Get the type of mouse pointer/cursor decoration set to be shown,
18047 * when the mouse pointer is over the given genlist widget item
18049 * @param item genlist item with custom cursor set
18050 * @return the cursor type's name or @c NULL, if no custom cursors
18051 * were set to @p item (and on errors)
18053 * @see elm_object_cursor_get()
18054 * @see elm_genlist_item_cursor_set() for more details
18055 * @see elm_genlist_item_cursor_unset()
18059 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18061 * Unset any custom mouse pointer/cursor decoration set to be
18062 * shown, when the mouse pointer is over the given genlist widget
18063 * item, thus making it show the @b default cursor again.
18065 * @param item a genlist item
18067 * Use this call to undo any custom settings on this item's cursor
18068 * decoration, bringing it back to defaults (no custom style set).
18070 * @see elm_object_cursor_unset()
18071 * @see elm_genlist_item_cursor_set() for more details
18075 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18077 * Set a different @b style for a given custom cursor set for a
18080 * @param item genlist item with custom cursor set
18081 * @param style the <b>theme style</b> to use (e.g. @c "default",
18082 * @c "transparent", etc)
18084 * This function only makes sense when one is using custom mouse
18085 * cursor decorations <b>defined in a theme file</b> , which can
18086 * have, given a cursor name/type, <b>alternate styles</b> on
18087 * it. It works analogously as elm_object_cursor_style_set(), but
18088 * here applied only to genlist item objects.
18090 * @warning Before you set a cursor style you should have defined a
18091 * custom cursor previously on the item, with
18092 * elm_genlist_item_cursor_set()
18094 * @see elm_genlist_item_cursor_engine_only_set()
18095 * @see elm_genlist_item_cursor_style_get()
18099 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18101 * Get the current @b style set for a given genlist item's custom
18104 * @param item genlist item with custom cursor set.
18105 * @return style the cursor style in use. If the object does not
18106 * have a cursor set, then @c NULL is returned.
18108 * @see elm_genlist_item_cursor_style_set() for more details
18112 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18114 * Set if the (custom) cursor for a given genlist item should be
18115 * searched in its theme, also, or should only rely on the
18116 * rendering engine.
18118 * @param item item with custom (custom) cursor already set on
18119 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18120 * only on those provided by the rendering engine, @c EINA_FALSE to
18121 * have them searched on the widget's theme, as well.
18123 * @note This call is of use only if you've set a custom cursor
18124 * for genlist items, with elm_genlist_item_cursor_set().
18126 * @note By default, cursors will only be looked for between those
18127 * provided by the rendering engine.
18131 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18133 * Get if the (custom) cursor for a given genlist item is being
18134 * searched in its theme, also, or is only relying on the rendering
18137 * @param item a genlist item
18138 * @return @c EINA_TRUE, if cursors are being looked for only on
18139 * those provided by the rendering engine, @c EINA_FALSE if they
18140 * are being searched on the widget's theme, as well.
18142 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18146 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18148 * Update the contents of all realized items.
18150 * @param obj The genlist object.
18152 * This updates all realized items by calling all the item class functions again
18153 * to get the icons, labels and states. Use this when the original
18154 * item data has changed and the changes are desired to be reflected.
18156 * To update just one item, use elm_genlist_item_update().
18158 * @see elm_genlist_realized_items_get()
18159 * @see elm_genlist_item_update()
18163 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18165 * Activate a genlist mode on an item
18167 * @param item The genlist item
18168 * @param mode Mode name
18169 * @param mode_set Boolean to define set or unset mode.
18171 * A genlist mode is a different way of selecting an item. Once a mode is
18172 * activated on an item, any other selected item is immediately unselected.
18173 * This feature provides an easy way of implementing a new kind of animation
18174 * for selecting an item, without having to entirely rewrite the item style
18175 * theme. However, the elm_genlist_selected_* API can't be used to get what
18176 * item is activate for a mode.
18178 * The current item style will still be used, but applying a genlist mode to
18179 * an item will select it using a different kind of animation.
18181 * The current active item for a mode can be found by
18182 * elm_genlist_mode_item_get().
18184 * The characteristics of genlist mode are:
18185 * - Only one mode can be active at any time, and for only one item.
18186 * - Genlist handles deactivating other items when one item is activated.
18187 * - A mode is defined in the genlist theme (edc), and more modes can easily
18189 * - A mode style and the genlist item style are different things. They
18190 * can be combined to provide a default style to the item, with some kind
18191 * of animation for that item when the mode is activated.
18193 * When a mode is activated on an item, a new view for that item is created.
18194 * The theme of this mode defines the animation that will be used to transit
18195 * the item from the old view to the new view. This second (new) view will be
18196 * active for that item while the mode is active on the item, and will be
18197 * destroyed after the mode is totally deactivated from that item.
18199 * @see elm_genlist_mode_get()
18200 * @see elm_genlist_mode_item_get()
18204 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18206 * Get the last (or current) genlist mode used.
18208 * @param obj The genlist object
18210 * This function just returns the name of the last used genlist mode. It will
18211 * be the current mode if it's still active.
18213 * @see elm_genlist_item_mode_set()
18214 * @see elm_genlist_mode_item_get()
18218 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18220 * Get active genlist mode item
18222 * @param obj The genlist object
18223 * @return The active item for that current mode. Or @c NULL if no item is
18224 * activated with any mode.
18226 * This function returns the item that was activated with a mode, by the
18227 * function elm_genlist_item_mode_set().
18229 * @see elm_genlist_item_mode_set()
18230 * @see elm_genlist_mode_get()
18234 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18239 * @param obj The genlist object
18240 * @param reorder_mode The reorder mode
18241 * (EINA_TRUE = on, EINA_FALSE = off)
18245 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18248 * Get the reorder mode
18250 * @param obj The genlist object
18251 * @return The reorder mode
18252 * (EINA_TRUE = on, EINA_FALSE = off)
18256 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18263 * @defgroup Check Check
18265 * @image html img/widget/check/preview-00.png
18266 * @image latex img/widget/check/preview-00.eps
18267 * @image html img/widget/check/preview-01.png
18268 * @image latex img/widget/check/preview-01.eps
18269 * @image html img/widget/check/preview-02.png
18270 * @image latex img/widget/check/preview-02.eps
18272 * @brief The check widget allows for toggling a value between true and
18275 * Check objects are a lot like radio objects in layout and functionality
18276 * except they do not work as a group, but independently and only toggle the
18277 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18278 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18279 * returns the current state. For convenience, like the radio objects, you
18280 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18281 * for it to modify.
18283 * Signals that you can add callbacks for are:
18284 * "changed" - This is called whenever the user changes the state of one of
18285 * the check object(event_info is NULL).
18287 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18291 * @brief Add a new Check object
18293 * @param parent The parent object
18294 * @return The new object or NULL if it cannot be created
18296 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18298 * @brief Set the text label of the check object
18300 * @param obj The check object
18301 * @param label The text label string in UTF-8
18303 * @deprecated use elm_object_text_set() instead.
18305 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18307 * @brief Get the text label of the check object
18309 * @param obj The check object
18310 * @return The text label string in UTF-8
18312 * @deprecated use elm_object_text_get() instead.
18314 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18316 * @brief Set the icon object of the check object
18318 * @param obj The check object
18319 * @param icon The icon object
18321 * Once the icon object is set, a previously set one will be deleted.
18322 * If you want to keep that old content object, use the
18323 * elm_check_icon_unset() function.
18325 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18327 * @brief Get the icon object of the check object
18329 * @param obj The check object
18330 * @return The icon object
18332 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18334 * @brief Unset the icon used for the check object
18336 * @param obj The check object
18337 * @return The icon object that was being used
18339 * Unparent and return the icon object which was set for this widget.
18341 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18343 * @brief Set the on/off state of the check object
18345 * @param obj The check object
18346 * @param state The state to use (1 == on, 0 == off)
18348 * This sets the state of the check. If set
18349 * with elm_check_state_pointer_set() the state of that variable is also
18350 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18352 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18354 * @brief Get the state of the check object
18356 * @param obj The check object
18357 * @return The boolean state
18359 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18361 * @brief Set a convenience pointer to a boolean to change
18363 * @param obj The check object
18364 * @param statep Pointer to the boolean to modify
18366 * This sets a pointer to a boolean, that, in addition to the check objects
18367 * state will also be modified directly. To stop setting the object pointed
18368 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18369 * then when this is called, the check objects state will also be modified to
18370 * reflect the value of the boolean @p statep points to, just like calling
18371 * elm_check_state_set().
18373 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18379 * @defgroup Radio Radio
18381 * @image html img/widget/radio/preview-00.png
18382 * @image latex img/widget/radio/preview-00.eps
18384 * @brief Radio is a widget that allows for 1 or more options to be displayed
18385 * and have the user choose only 1 of them.
18387 * A radio object contains an indicator, an optional Label and an optional
18388 * icon object. While it's possible to have a group of only one radio they,
18389 * are normally used in groups of 2 or more. To add a radio to a group use
18390 * elm_radio_group_add(). The radio object(s) will select from one of a set
18391 * of integer values, so any value they are configuring needs to be mapped to
18392 * a set of integers. To configure what value that radio object represents,
18393 * use elm_radio_state_value_set() to set the integer it represents. To set
18394 * the value the whole group(which one is currently selected) is to indicate
18395 * use elm_radio_value_set() on any group member, and to get the groups value
18396 * use elm_radio_value_get(). For convenience the radio objects are also able
18397 * to directly set an integer(int) to the value that is selected. To specify
18398 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18399 * The radio objects will modify this directly. That implies the pointer must
18400 * point to valid memory for as long as the radio objects exist.
18402 * Signals that you can add callbacks for are:
18403 * @li changed - This is called whenever the user changes the state of one of
18404 * the radio objects within the group of radio objects that work together.
18406 * @ref tutorial_radio show most of this API in action.
18410 * @brief Add a new radio to the parent
18412 * @param parent The parent object
18413 * @return The new object or NULL if it cannot be created
18415 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18417 * @brief Set the text label of the radio object
18419 * @param obj The radio object
18420 * @param label The text label string in UTF-8
18422 * @deprecated use elm_object_text_set() instead.
18424 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18426 * @brief Get the text label of the radio object
18428 * @param obj The radio object
18429 * @return The text label string in UTF-8
18431 * @deprecated use elm_object_text_set() instead.
18433 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18435 * @brief Set the icon object of the radio object
18437 * @param obj The radio object
18438 * @param icon The icon object
18440 * Once the icon object is set, a previously set one will be deleted. If you
18441 * want to keep that old content object, use the elm_radio_icon_unset()
18444 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18446 * @brief Get the icon object of the radio object
18448 * @param obj The radio object
18449 * @return The icon object
18451 * @see elm_radio_icon_set()
18453 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18455 * @brief Unset the icon used for the radio object
18457 * @param obj The radio object
18458 * @return The icon object that was being used
18460 * Unparent and return the icon object which was set for this widget.
18462 * @see elm_radio_icon_set()
18464 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18466 * @brief Add this radio to a group of other radio objects
18468 * @param obj The radio object
18469 * @param group Any object whose group the @p obj is to join.
18471 * Radio objects work in groups. Each member should have a different integer
18472 * value assigned. In order to have them work as a group, they need to know
18473 * about each other. This adds the given radio object to the group of which
18474 * the group object indicated is a member.
18476 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18478 * @brief Set the integer value that this radio object represents
18480 * @param obj The radio object
18481 * @param value The value to use if this radio object is selected
18483 * This sets the value of the radio.
18485 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18487 * @brief Get the integer value that this radio object represents
18489 * @param obj The radio object
18490 * @return The value used if this radio object is selected
18492 * This gets the value of the radio.
18494 * @see elm_radio_value_set()
18496 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18498 * @brief Set the value of the radio.
18500 * @param obj The radio object
18501 * @param value The value to use for the group
18503 * This sets the value of the radio group and will also set the value if
18504 * pointed to, to the value supplied, but will not call any callbacks.
18506 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18508 * @brief Get the state of the radio object
18510 * @param obj The radio object
18511 * @return The integer state
18513 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18515 * @brief Set a convenience pointer to a integer to change
18517 * @param obj The radio object
18518 * @param valuep Pointer to the integer to modify
18520 * This sets a pointer to a integer, that, in addition to the radio objects
18521 * state will also be modified directly. To stop setting the object pointed
18522 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18523 * when this is called, the radio objects state will also be modified to
18524 * reflect the value of the integer valuep points to, just like calling
18525 * elm_radio_value_set().
18527 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18533 * @defgroup Pager Pager
18535 * @image html img/widget/pager/preview-00.png
18536 * @image latex img/widget/pager/preview-00.eps
18538 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18540 * The flipping between “pages” of objects is animated. All content in pager
18541 * is kept in a stack, the last content to be added will be on the top of the
18542 * stack(be visible).
18544 * Objects can be pushed or popped from the stack or deleted as normal.
18545 * Pushes and pops will animate (and a pop will delete the object once the
18546 * animation is finished). Any object already in the pager can be promoted to
18547 * the top(from its current stacking position) through the use of
18548 * elm_pager_content_promote(). Objects are pushed to the top with
18549 * elm_pager_content_push() and when the top item is no longer wanted, simply
18550 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18551 * object is no longer needed and is not the top item, just delete it as
18552 * normal. You can query which objects are the top and bottom with
18553 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18555 * Signals that you can add callbacks for are:
18556 * "hide,finished" - when the previous page is hided
18558 * This widget has the following styles available:
18561 * @li fade_translucide
18562 * @li fade_invisible
18563 * @note This styles affect only the flipping animations, the appearance when
18564 * not animating is unaffected by styles.
18566 * @ref tutorial_pager gives a good overview of the usage of the API.
18570 * Add a new pager to the parent
18572 * @param parent The parent object
18573 * @return The new object or NULL if it cannot be created
18577 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18579 * @brief Push an object to the top of the pager stack (and show it).
18581 * @param obj The pager object
18582 * @param content The object to push
18584 * The object pushed becomes a child of the pager, it will be controlled and
18585 * deleted when the pager is deleted.
18587 * @note If the content is already in the stack use
18588 * elm_pager_content_promote().
18589 * @warning Using this function on @p content already in the stack results in
18590 * undefined behavior.
18592 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18594 * @brief Pop the object that is on top of the stack
18596 * @param obj The pager object
18598 * This pops the object that is on the top(visible) of the pager, makes it
18599 * disappear, then deletes the object. The object that was underneath it on
18600 * the stack will become visible.
18602 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18604 * @brief Moves an object already in the pager stack to the top of the stack.
18606 * @param obj The pager object
18607 * @param content The object to promote
18609 * This will take the @p content and move it to the top of the stack as
18610 * if it had been pushed there.
18612 * @note If the content isn't already in the stack use
18613 * elm_pager_content_push().
18614 * @warning Using this function on @p content not already in the stack
18615 * results in undefined behavior.
18617 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18619 * @brief Return the object at the bottom of the pager stack
18621 * @param obj The pager object
18622 * @return The bottom object or NULL if none
18624 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18626 * @brief Return the object at the top of the pager stack
18628 * @param obj The pager object
18629 * @return The top object or NULL if none
18631 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18637 * @defgroup Slideshow Slideshow
18639 * @image html img/widget/slideshow/preview-00.png
18640 * @image latex img/widget/slideshow/preview-00.eps
18642 * This widget, as the name indicates, is a pre-made image
18643 * slideshow panel, with API functions acting on (child) image
18644 * items presentation. Between those actions, are:
18645 * - advance to next/previous image
18646 * - select the style of image transition animation
18647 * - set the exhibition time for each image
18648 * - start/stop the slideshow
18650 * The transition animations are defined in the widget's theme,
18651 * consequently new animations can be added without having to
18652 * update the widget's code.
18654 * @section Slideshow_Items Slideshow items
18656 * For slideshow items, just like for @ref Genlist "genlist" ones,
18657 * the user defines a @b classes, specifying functions that will be
18658 * called on the item's creation and deletion times.
18660 * The #Elm_Slideshow_Item_Class structure contains the following
18663 * - @c func.get - When an item is displayed, this function is
18664 * called, and it's where one should create the item object, de
18665 * facto. For example, the object can be a pure Evas image object
18666 * or an Elementary @ref Photocam "photocam" widget. See
18667 * #SlideshowItemGetFunc.
18668 * - @c func.del - When an item is no more displayed, this function
18669 * is called, where the user must delete any data associated to
18670 * the item. See #SlideshowItemDelFunc.
18672 * @section Slideshow_Caching Slideshow caching
18674 * The slideshow provides facilities to have items adjacent to the
18675 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18676 * you, so that the system does not have to decode image data
18677 * anymore at the time it has to actually switch images on its
18678 * viewport. The user is able to set the numbers of items to be
18679 * cached @b before and @b after the current item, in the widget's
18682 * Smart events one can add callbacks for are:
18684 * - @c "changed" - when the slideshow switches its view to a new
18687 * List of examples for the slideshow widget:
18688 * @li @ref slideshow_example
18692 * @addtogroup Slideshow
18696 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18697 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18698 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18699 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18700 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18703 * @struct _Elm_Slideshow_Item_Class
18705 * Slideshow item class definition. See @ref Slideshow_Items for
18708 struct _Elm_Slideshow_Item_Class
18710 struct _Elm_Slideshow_Item_Class_Func
18712 SlideshowItemGetFunc get;
18713 SlideshowItemDelFunc del;
18715 }; /**< #Elm_Slideshow_Item_Class member definitions */
18718 * Add a new slideshow widget to the given parent Elementary
18719 * (container) object
18721 * @param parent The parent object
18722 * @return A new slideshow widget handle or @c NULL, on errors
18724 * This function inserts a new slideshow widget on the canvas.
18726 * @ingroup Slideshow
18728 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18731 * Add (append) a new item in a given slideshow widget.
18733 * @param obj The slideshow object
18734 * @param itc The item class for the item
18735 * @param data The item's data
18736 * @return A handle to the item added or @c NULL, on errors
18738 * Add a new item to @p obj's internal list of items, appending it.
18739 * The item's class must contain the function really fetching the
18740 * image object to show for this item, which could be an Evas image
18741 * object or an Elementary photo, for example. The @p data
18742 * parameter is going to be passed to both class functions of the
18745 * @see #Elm_Slideshow_Item_Class
18746 * @see elm_slideshow_item_sorted_insert()
18748 * @ingroup Slideshow
18750 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18753 * Insert a new item into the given slideshow widget, using the @p func
18754 * function to sort items (by item handles).
18756 * @param obj The slideshow object
18757 * @param itc The item class for the item
18758 * @param data The item's data
18759 * @param func The comparing function to be used to sort slideshow
18760 * items <b>by #Elm_Slideshow_Item item handles</b>
18761 * @return Returns The slideshow item handle, on success, or
18762 * @c NULL, on errors
18764 * Add a new item to @p obj's internal list of items, in a position
18765 * determined by the @p func comparing function. The item's class
18766 * must contain the function really fetching the image object to
18767 * show for this item, which could be an Evas image object or an
18768 * Elementary photo, for example. The @p data parameter is going to
18769 * be passed to both class functions of the item.
18771 * @see #Elm_Slideshow_Item_Class
18772 * @see elm_slideshow_item_add()
18774 * @ingroup Slideshow
18776 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);
18779 * Display a given slideshow widget's item, programmatically.
18781 * @param obj The slideshow object
18782 * @param item The item to display on @p obj's viewport
18784 * The change between the current item and @p item will use the
18785 * transition @p obj is set to use (@see
18786 * elm_slideshow_transition_set()).
18788 * @ingroup Slideshow
18790 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18793 * Slide to the @b next item, in a given slideshow widget
18795 * @param obj The slideshow object
18797 * The sliding animation @p obj is set to use will be the
18798 * transition effect used, after this call is issued.
18800 * @note If the end of the slideshow's internal list of items is
18801 * reached, it'll wrap around to the list's beginning, again.
18803 * @ingroup Slideshow
18805 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18808 * Slide to the @b previous item, in a given slideshow widget
18810 * @param obj The slideshow object
18812 * The sliding animation @p obj is set to use will be the
18813 * transition effect used, after this call is issued.
18815 * @note If the beginning of the slideshow's internal list of items
18816 * is reached, it'll wrap around to the list's end, again.
18818 * @ingroup Slideshow
18820 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18823 * Returns the list of sliding transition/effect names available, for a
18824 * given slideshow widget.
18826 * @param obj The slideshow object
18827 * @return The list of transitions (list of @b stringshared strings
18830 * The transitions, which come from @p obj's theme, must be an EDC
18831 * data item named @c "transitions" on the theme file, with (prefix)
18832 * names of EDC programs actually implementing them.
18834 * The available transitions for slideshows on the default theme are:
18835 * - @c "fade" - the current item fades out, while the new one
18836 * fades in to the slideshow's viewport.
18837 * - @c "black_fade" - the current item fades to black, and just
18838 * then, the new item will fade in.
18839 * - @c "horizontal" - the current item slides horizontally, until
18840 * it gets out of the slideshow's viewport, while the new item
18841 * comes from the left to take its place.
18842 * - @c "vertical" - the current item slides vertically, until it
18843 * gets out of the slideshow's viewport, while the new item comes
18844 * from the bottom to take its place.
18845 * - @c "square" - the new item starts to appear from the middle of
18846 * the current one, but with a tiny size, growing until its
18847 * target (full) size and covering the old one.
18849 * @warning The stringshared strings get no new references
18850 * exclusive to the user grabbing the list, here, so if you'd like
18851 * to use them out of this call's context, you'd better @c
18852 * eina_stringshare_ref() them.
18854 * @see elm_slideshow_transition_set()
18856 * @ingroup Slideshow
18858 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18861 * Set the current slide transition/effect in use for a given
18864 * @param obj The slideshow object
18865 * @param transition The new transition's name string
18867 * If @p transition is implemented in @p obj's theme (i.e., is
18868 * contained in the list returned by
18869 * elm_slideshow_transitions_get()), this new sliding effect will
18870 * be used on the widget.
18872 * @see elm_slideshow_transitions_get() for more details
18874 * @ingroup Slideshow
18876 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18879 * Get the current slide transition/effect in use for a given
18882 * @param obj The slideshow object
18883 * @return The current transition's name
18885 * @see elm_slideshow_transition_set() for more details
18887 * @ingroup Slideshow
18889 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18892 * Set the interval between each image transition on a given
18893 * slideshow widget, <b>and start the slideshow, itself</b>
18895 * @param obj The slideshow object
18896 * @param timeout The new displaying timeout for images
18898 * After this call, the slideshow widget will start cycling its
18899 * view, sequentially and automatically, with the images of the
18900 * items it has. The time between each new image displayed is going
18901 * to be @p timeout, in @b seconds. If a different timeout was set
18902 * previously and an slideshow was in progress, it will continue
18903 * with the new time between transitions, after this call.
18905 * @note A value less than or equal to 0 on @p timeout will disable
18906 * the widget's internal timer, thus halting any slideshow which
18907 * could be happening on @p obj.
18909 * @see elm_slideshow_timeout_get()
18911 * @ingroup Slideshow
18913 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18916 * Get the interval set for image transitions on a given slideshow
18919 * @param obj The slideshow object
18920 * @return Returns the timeout set on it
18922 * @see elm_slideshow_timeout_set() for more details
18924 * @ingroup Slideshow
18926 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18929 * Set if, after a slideshow is started, for a given slideshow
18930 * widget, its items should be displayed cyclically or not.
18932 * @param obj The slideshow object
18933 * @param loop Use @c EINA_TRUE to make it cycle through items or
18934 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18937 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18938 * ignore what is set by this functions, i.e., they'll @b always
18939 * cycle through items. This affects only the "automatic"
18940 * slideshow, as set by elm_slideshow_timeout_set().
18942 * @see elm_slideshow_loop_get()
18944 * @ingroup Slideshow
18946 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18949 * Get if, after a slideshow is started, for a given slideshow
18950 * widget, its items are to be displayed cyclically or not.
18952 * @param obj The slideshow object
18953 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18954 * through or @c EINA_FALSE, otherwise
18956 * @see elm_slideshow_loop_set() for more details
18958 * @ingroup Slideshow
18960 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18963 * Remove all items from a given slideshow widget
18965 * @param obj The slideshow object
18967 * This removes (and deletes) all items in @p obj, leaving it
18970 * @see elm_slideshow_item_del(), to remove just one item.
18972 * @ingroup Slideshow
18974 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18977 * Get the internal list of items in a given slideshow widget.
18979 * @param obj The slideshow object
18980 * @return The list of items (#Elm_Slideshow_Item as data) or
18981 * @c NULL on errors.
18983 * This list is @b not to be modified in any way and must not be
18984 * freed. Use the list members with functions like
18985 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18987 * @warning This list is only valid until @p obj object's internal
18988 * items list is changed. It should be fetched again with another
18989 * call to this function when changes happen.
18991 * @ingroup Slideshow
18993 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18996 * Delete a given item from a slideshow widget.
18998 * @param item The slideshow item
19000 * @ingroup Slideshow
19002 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19005 * Return the data associated with a given slideshow item
19007 * @param item The slideshow item
19008 * @return Returns the data associated to this item
19010 * @ingroup Slideshow
19012 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19015 * Returns the currently displayed item, in a given slideshow widget
19017 * @param obj The slideshow object
19018 * @return A handle to the item being displayed in @p obj or
19019 * @c NULL, if none is (and on errors)
19021 * @ingroup Slideshow
19023 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19026 * Get the real Evas object created to implement the view of a
19027 * given slideshow item
19029 * @param item The slideshow item.
19030 * @return the Evas object implementing this item's view.
19032 * This returns the actual Evas object used to implement the
19033 * specified slideshow item's view. This may be @c NULL, as it may
19034 * not have been created or may have been deleted, at any time, by
19035 * the slideshow. <b>Do not modify this object</b> (move, resize,
19036 * show, hide, etc.), as the slideshow is controlling it. This
19037 * function is for querying, emitting custom signals or hooking
19038 * lower level callbacks for events on that object. Do not delete
19039 * this object under any circumstances.
19041 * @see elm_slideshow_item_data_get()
19043 * @ingroup Slideshow
19045 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19048 * Get the the item, in a given slideshow widget, placed at
19049 * position @p nth, in its internal items list
19051 * @param obj The slideshow object
19052 * @param nth The number of the item to grab a handle to (0 being
19054 * @return The item stored in @p obj at position @p nth or @c NULL,
19055 * if there's no item with that index (and on errors)
19057 * @ingroup Slideshow
19059 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19062 * Set the current slide layout in use for a given slideshow widget
19064 * @param obj The slideshow object
19065 * @param layout The new layout's name string
19067 * If @p layout is implemented in @p obj's theme (i.e., is contained
19068 * in the list returned by elm_slideshow_layouts_get()), this new
19069 * images layout will be used on the widget.
19071 * @see elm_slideshow_layouts_get() for more details
19073 * @ingroup Slideshow
19075 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19078 * Get the current slide layout in use for a given slideshow widget
19080 * @param obj The slideshow object
19081 * @return The current layout's name
19083 * @see elm_slideshow_layout_set() for more details
19085 * @ingroup Slideshow
19087 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19090 * Returns the list of @b layout names available, for a given
19091 * slideshow widget.
19093 * @param obj The slideshow object
19094 * @return The list of layouts (list of @b stringshared strings
19097 * Slideshow layouts will change how the widget is to dispose each
19098 * image item in its viewport, with regard to cropping, scaling,
19101 * The layouts, which come from @p obj's theme, must be an EDC
19102 * data item name @c "layouts" on the theme file, with (prefix)
19103 * names of EDC programs actually implementing them.
19105 * The available layouts for slideshows on the default theme are:
19106 * - @c "fullscreen" - item images with original aspect, scaled to
19107 * touch top and down slideshow borders or, if the image's heigh
19108 * is not enough, left and right slideshow borders.
19109 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19110 * one, but always leaving 10% of the slideshow's dimensions of
19111 * distance between the item image's borders and the slideshow
19112 * borders, for each axis.
19114 * @warning The stringshared strings get no new references
19115 * exclusive to the user grabbing the list, here, so if you'd like
19116 * to use them out of this call's context, you'd better @c
19117 * eina_stringshare_ref() them.
19119 * @see elm_slideshow_layout_set()
19121 * @ingroup Slideshow
19123 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19126 * Set the number of items to cache, on a given slideshow widget,
19127 * <b>before the current item</b>
19129 * @param obj The slideshow object
19130 * @param count Number of items to cache before the current one
19132 * The default value for this property is @c 2. See
19133 * @ref Slideshow_Caching "slideshow caching" for more details.
19135 * @see elm_slideshow_cache_before_get()
19137 * @ingroup Slideshow
19139 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19142 * Retrieve the number of items to cache, on a given slideshow widget,
19143 * <b>before the current item</b>
19145 * @param obj The slideshow object
19146 * @return The number of items set to be cached before the current one
19148 * @see elm_slideshow_cache_before_set() for more details
19150 * @ingroup Slideshow
19152 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19155 * Set the number of items to cache, on a given slideshow widget,
19156 * <b>after the current item</b>
19158 * @param obj The slideshow object
19159 * @param count Number of items to cache after the current one
19161 * The default value for this property is @c 2. See
19162 * @ref Slideshow_Caching "slideshow caching" for more details.
19164 * @see elm_slideshow_cache_after_get()
19166 * @ingroup Slideshow
19168 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19171 * Retrieve the number of items to cache, on a given slideshow widget,
19172 * <b>after the current item</b>
19174 * @param obj The slideshow object
19175 * @return The number of items set to be cached after the current one
19177 * @see elm_slideshow_cache_after_set() for more details
19179 * @ingroup Slideshow
19181 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19184 * Get the number of items stored in a given slideshow widget
19186 * @param obj The slideshow object
19187 * @return The number of items on @p obj, at the moment of this call
19189 * @ingroup Slideshow
19191 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19198 * @defgroup Fileselector File Selector
19200 * @image html img/widget/fileselector/preview-00.png
19201 * @image latex img/widget/fileselector/preview-00.eps
19203 * A file selector is a widget that allows a user to navigate
19204 * through a file system, reporting file selections back via its
19207 * It contains shortcut buttons for home directory (@c ~) and to
19208 * jump one directory upwards (..), as well as cancel/ok buttons to
19209 * confirm/cancel a given selection. After either one of those two
19210 * former actions, the file selector will issue its @c "done" smart
19213 * There's a text entry on it, too, showing the name of the current
19214 * selection. There's the possibility of making it editable, so it
19215 * is useful on file saving dialogs on applications, where one
19216 * gives a file name to save contents to, in a given directory in
19217 * the system. This custom file name will be reported on the @c
19218 * "done" smart callback (explained in sequence).
19220 * Finally, it has a view to display file system items into in two
19225 * If Elementary is built with support of the Ethumb thumbnailing
19226 * library, the second form of view will display preview thumbnails
19227 * of files which it supports.
19229 * Smart callbacks one can register to:
19231 * - @c "selected" - the user has clicked on a file (when not in
19232 * folders-only mode) or directory (when in folders-only mode)
19233 * - @c "directory,open" - the list has been populated with new
19234 * content (@c event_info is a pointer to the directory's
19235 * path, a @b stringshared string)
19236 * - @c "done" - the user has clicked on the "ok" or "cancel"
19237 * buttons (@c event_info is a pointer to the selection's
19238 * path, a @b stringshared string)
19240 * Here is an example on its usage:
19241 * @li @ref fileselector_example
19245 * @addtogroup Fileselector
19250 * Defines how a file selector widget is to layout its contents
19251 * (file system entries).
19253 typedef enum _Elm_Fileselector_Mode
19255 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19256 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19257 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19258 } Elm_Fileselector_Mode;
19261 * Add a new file selector widget to the given parent Elementary
19262 * (container) object
19264 * @param parent The parent object
19265 * @return a new file selector widget handle or @c NULL, on errors
19267 * This function inserts a new file selector widget on the canvas.
19269 * @ingroup Fileselector
19271 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19274 * Enable/disable the file name entry box where the user can type
19275 * in a name for a file, in a given file selector widget
19277 * @param obj The file selector object
19278 * @param is_save @c EINA_TRUE to make the file selector a "saving
19279 * dialog", @c EINA_FALSE otherwise
19281 * Having the entry editable is useful on file saving dialogs on
19282 * applications, where one gives a file name to save contents to,
19283 * in a given directory in the system. This custom file name will
19284 * be reported on the @c "done" smart callback.
19286 * @see elm_fileselector_is_save_get()
19288 * @ingroup Fileselector
19290 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19293 * Get whether the given file selector is in "saving dialog" mode
19295 * @param obj The file selector object
19296 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19297 * mode, @c EINA_FALSE otherwise (and on errors)
19299 * @see elm_fileselector_is_save_set() for more details
19301 * @ingroup Fileselector
19303 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19306 * Enable/disable folder-only view for a given file selector widget
19308 * @param obj The file selector object
19309 * @param only @c EINA_TRUE to make @p obj only display
19310 * directories, @c EINA_FALSE to make files to be displayed in it
19313 * If enabled, the widget's view will only display folder items,
19316 * @see elm_fileselector_folder_only_get()
19318 * @ingroup Fileselector
19320 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19323 * Get whether folder-only view is set for a given file selector
19326 * @param obj The file selector object
19327 * @return only @c EINA_TRUE if @p obj is only displaying
19328 * directories, @c EINA_FALSE if files are being displayed in it
19329 * too (and on errors)
19331 * @see elm_fileselector_folder_only_get()
19333 * @ingroup Fileselector
19335 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19338 * Enable/disable the "ok" and "cancel" buttons on a given file
19341 * @param obj The file selector object
19342 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19344 * @note A file selector without those buttons will never emit the
19345 * @c "done" smart event, and is only usable if one is just hooking
19346 * to the other two events.
19348 * @see elm_fileselector_buttons_ok_cancel_get()
19350 * @ingroup Fileselector
19352 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19355 * Get whether the "ok" and "cancel" buttons on a given file
19356 * selector widget are being shown.
19358 * @param obj The file selector object
19359 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19360 * otherwise (and on errors)
19362 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19364 * @ingroup Fileselector
19366 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19369 * Enable/disable a tree view in the given file selector widget,
19370 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19372 * @param obj The file selector object
19373 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19376 * In a tree view, arrows are created on the sides of directories,
19377 * allowing them to expand in place.
19379 * @note If it's in other mode, the changes made by this function
19380 * will only be visible when one switches back to "list" mode.
19382 * @see elm_fileselector_expandable_get()
19384 * @ingroup Fileselector
19386 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19389 * Get whether tree view is enabled for the given file selector
19392 * @param obj The file selector object
19393 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19394 * otherwise (and or errors)
19396 * @see elm_fileselector_expandable_set() for more details
19398 * @ingroup Fileselector
19400 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19403 * Set, programmatically, the @b directory that a given file
19404 * selector widget will display contents from
19406 * @param obj The file selector object
19407 * @param path The path to display in @p obj
19409 * This will change the @b directory that @p obj is displaying. It
19410 * will also clear the text entry area on the @p obj object, which
19411 * displays select files' names.
19413 * @see elm_fileselector_path_get()
19415 * @ingroup Fileselector
19417 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19420 * Get the parent directory's path that a given file selector
19421 * widget is displaying
19423 * @param obj The file selector object
19424 * @return The (full) path of the directory the file selector is
19425 * displaying, a @b stringshared string
19427 * @see elm_fileselector_path_set()
19429 * @ingroup Fileselector
19431 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19434 * Set, programmatically, the currently selected file/directory in
19435 * the given file selector widget
19437 * @param obj The file selector object
19438 * @param path The (full) path to a file or directory
19439 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19440 * latter case occurs if the directory or file pointed to do not
19443 * @see elm_fileselector_selected_get()
19445 * @ingroup Fileselector
19447 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19450 * Get the currently selected item's (full) path, in the given file
19453 * @param obj The file selector object
19454 * @return The absolute path of the selected item, a @b
19455 * stringshared string
19457 * @note Custom editions on @p obj object's text entry, if made,
19458 * will appear on the return string of this function, naturally.
19460 * @see elm_fileselector_selected_set() for more details
19462 * @ingroup Fileselector
19464 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19467 * Set the mode in which a given file selector widget will display
19468 * (layout) file system entries in its view
19470 * @param obj The file selector object
19471 * @param mode The mode of the fileselector, being it one of
19472 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19473 * first one, naturally, will display the files in a list. The
19474 * latter will make the widget to display its entries in a grid
19477 * @note By using elm_fileselector_expandable_set(), the user may
19478 * trigger a tree view for that list.
19480 * @note If Elementary is built with support of the Ethumb
19481 * thumbnailing library, the second form of view will display
19482 * preview thumbnails of files which it supports. You must have
19483 * elm_need_ethumb() called in your Elementary for thumbnailing to
19486 * @see elm_fileselector_expandable_set().
19487 * @see elm_fileselector_mode_get().
19489 * @ingroup Fileselector
19491 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19494 * Get the mode in which a given file selector widget is displaying
19495 * (layouting) file system entries in its view
19497 * @param obj The fileselector object
19498 * @return The mode in which the fileselector is at
19500 * @see elm_fileselector_mode_set() for more details
19502 * @ingroup Fileselector
19504 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19511 * @defgroup Progressbar Progress bar
19513 * The progress bar is a widget for visually representing the
19514 * progress status of a given job/task.
19516 * A progress bar may be horizontal or vertical. It may display an
19517 * icon besides it, as well as primary and @b units labels. The
19518 * former is meant to label the widget as a whole, while the
19519 * latter, which is formatted with floating point values (and thus
19520 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19521 * units"</c>), is meant to label the widget's <b>progress
19522 * value</b>. Label, icon and unit strings/objects are @b optional
19523 * for progress bars.
19525 * A progress bar may be @b inverted, in which state it gets its
19526 * values inverted, with high values being on the left or top and
19527 * low values on the right or bottom, as opposed to normally have
19528 * the low values on the former and high values on the latter,
19529 * respectively, for horizontal and vertical modes.
19531 * The @b span of the progress, as set by
19532 * elm_progressbar_span_size_set(), is its length (horizontally or
19533 * vertically), unless one puts size hints on the widget to expand
19534 * on desired directions, by any container. That length will be
19535 * scaled by the object or applications scaling factor. At any
19536 * point code can query the progress bar for its value with
19537 * elm_progressbar_value_get().
19539 * Available widget styles for progress bars:
19541 * - @c "wheel" (simple style, no text, no progression, only
19542 * "pulse" effect is available)
19544 * Here is an example on its usage:
19545 * @li @ref progressbar_example
19549 * Add a new progress bar widget to the given parent Elementary
19550 * (container) object
19552 * @param parent The parent object
19553 * @return a new progress bar widget handle or @c NULL, on errors
19555 * This function inserts a new progress bar widget on the canvas.
19557 * @ingroup Progressbar
19559 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19562 * Set whether a given progress bar widget is at "pulsing mode" or
19565 * @param obj The progress bar object
19566 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19567 * @c EINA_FALSE to put it back to its default one
19569 * By default, progress bars will display values from the low to
19570 * high value boundaries. There are, though, contexts in which the
19571 * state of progression of a given task is @b unknown. For those,
19572 * one can set a progress bar widget to a "pulsing state", to give
19573 * the user an idea that some computation is being held, but
19574 * without exact progress values. In the default theme it will
19575 * animate its bar with the contents filling in constantly and back
19576 * to non-filled, in a loop. To start and stop this pulsing
19577 * animation, one has to explicitly call elm_progressbar_pulse().
19579 * @see elm_progressbar_pulse_get()
19580 * @see elm_progressbar_pulse()
19582 * @ingroup Progressbar
19584 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19587 * Get whether a given progress bar widget is at "pulsing mode" or
19590 * @param obj The progress bar object
19591 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19592 * if it's in the default one (and on errors)
19594 * @ingroup Progressbar
19596 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19599 * Start/stop a given progress bar "pulsing" animation, if its
19602 * @param obj The progress bar object
19603 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19604 * @c EINA_FALSE to @b stop it
19606 * @note This call won't do anything if @p obj is not under "pulsing mode".
19608 * @see elm_progressbar_pulse_set() for more details.
19610 * @ingroup Progressbar
19612 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19615 * Set the progress value (in percentage) on a given progress bar
19618 * @param obj The progress bar object
19619 * @param val The progress value (@b must be between @c 0.0 and @c
19622 * Use this call to set progress bar levels.
19624 * @note If you passes a value out of the specified range for @p
19625 * val, it will be interpreted as the @b closest of the @b boundary
19626 * values in the range.
19628 * @ingroup Progressbar
19630 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19633 * Get the progress value (in percentage) on a given progress bar
19636 * @param obj The progress bar object
19637 * @return The value of the progressbar
19639 * @see elm_progressbar_value_set() for more details
19641 * @ingroup Progressbar
19643 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19646 * Set the label of a given progress bar widget
19648 * @param obj The progress bar object
19649 * @param label The text label string, in UTF-8
19651 * @ingroup Progressbar
19652 * @deprecated use elm_object_text_set() instead.
19654 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19657 * Get the label of a given progress bar widget
19659 * @param obj The progressbar object
19660 * @return The text label string, in UTF-8
19662 * @ingroup Progressbar
19663 * @deprecated use elm_object_text_set() instead.
19665 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19668 * Set the icon object of a given progress bar widget
19670 * @param obj The progress bar object
19671 * @param icon The icon object
19673 * Use this call to decorate @p obj with an icon next to it.
19675 * @note Once the icon object is set, a previously set one will be
19676 * deleted. If you want to keep that old content object, use the
19677 * elm_progressbar_icon_unset() function.
19679 * @see elm_progressbar_icon_get()
19681 * @ingroup Progressbar
19683 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19686 * Retrieve the icon object set for a given progress bar widget
19688 * @param obj The progress bar object
19689 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19690 * otherwise (and on errors)
19692 * @see elm_progressbar_icon_set() for more details
19694 * @ingroup Progressbar
19696 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19699 * Unset an icon set on a given progress bar widget
19701 * @param obj The progress bar object
19702 * @return The icon object that was being used, if any was set, or
19703 * @c NULL, otherwise (and on errors)
19705 * This call will unparent and return the icon object which was set
19706 * for this widget, previously, on success.
19708 * @see elm_progressbar_icon_set() for more details
19710 * @ingroup Progressbar
19712 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19715 * Set the (exact) length of the bar region of a given progress bar
19718 * @param obj The progress bar object
19719 * @param size The length of the progress bar's bar region
19721 * This sets the minimum width (when in horizontal mode) or height
19722 * (when in vertical mode) of the actual bar area of the progress
19723 * bar @p obj. This in turn affects the object's minimum size. Use
19724 * this when you're not setting other size hints expanding on the
19725 * given direction (like weight and alignment hints) and you would
19726 * like it to have a specific size.
19728 * @note Icon, label and unit text around @p obj will require their
19729 * own space, which will make @p obj to require more the @p size,
19732 * @see elm_progressbar_span_size_get()
19734 * @ingroup Progressbar
19736 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19739 * Get the length set for the bar region of a given progress bar
19742 * @param obj The progress bar object
19743 * @return The length of the progress bar's bar region
19745 * If that size was not set previously, with
19746 * elm_progressbar_span_size_set(), this call will return @c 0.
19748 * @ingroup Progressbar
19750 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19753 * Set the format string for a given progress bar widget's units
19756 * @param obj The progress bar object
19757 * @param format The format string for @p obj's units label
19759 * If @c NULL is passed on @p format, it will make @p obj's units
19760 * area to be hidden completely. If not, it'll set the <b>format
19761 * string</b> for the units label's @b text. The units label is
19762 * provided a floating point value, so the units text is up display
19763 * at most one floating point falue. Note that the units label is
19764 * optional. Use a format string such as "%1.2f meters" for
19767 * @note The default format string for a progress bar is an integer
19768 * percentage, as in @c "%.0f %%".
19770 * @see elm_progressbar_unit_format_get()
19772 * @ingroup Progressbar
19774 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19777 * Retrieve the format string set for a given progress bar widget's
19780 * @param obj The progress bar object
19781 * @return The format set string for @p obj's units label or
19782 * @c NULL, if none was set (and on errors)
19784 * @see elm_progressbar_unit_format_set() for more details
19786 * @ingroup Progressbar
19788 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19791 * Set the orientation of a given progress bar widget
19793 * @param obj The progress bar object
19794 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19795 * @b horizontal, @c EINA_FALSE to make it @b vertical
19797 * Use this function to change how your progress bar is to be
19798 * disposed: vertically or horizontally.
19800 * @see elm_progressbar_horizontal_get()
19802 * @ingroup Progressbar
19804 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19807 * Retrieve the orientation of a given progress bar widget
19809 * @param obj The progress bar object
19810 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19811 * @c EINA_FALSE if it's @b vertical (and on errors)
19813 * @see elm_progressbar_horizontal_set() for more details
19815 * @ingroup Progressbar
19817 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19820 * Invert a given progress bar widget's displaying values order
19822 * @param obj The progress bar object
19823 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19824 * @c EINA_FALSE to bring it back to default, non-inverted values.
19826 * A progress bar may be @b inverted, in which state it gets its
19827 * values inverted, with high values being on the left or top and
19828 * low values on the right or bottom, as opposed to normally have
19829 * the low values on the former and high values on the latter,
19830 * respectively, for horizontal and vertical modes.
19832 * @see elm_progressbar_inverted_get()
19834 * @ingroup Progressbar
19836 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19839 * Get whether a given progress bar widget's displaying values are
19842 * @param obj The progress bar object
19843 * @return @c EINA_TRUE, if @p obj has inverted values,
19844 * @c EINA_FALSE otherwise (and on errors)
19846 * @see elm_progressbar_inverted_set() for more details
19848 * @ingroup Progressbar
19850 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19853 * @defgroup Separator Separator
19855 * @brief Separator is a very thin object used to separate other objects.
19857 * A separator can be vertical or horizontal.
19859 * @ref tutorial_separator is a good example of how to use a separator.
19863 * @brief Add a separator object to @p parent
19865 * @param parent The parent object
19867 * @return The separator object, or NULL upon failure
19869 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19871 * @brief Set the horizontal mode of a separator object
19873 * @param obj The separator object
19874 * @param horizontal If true, the separator is horizontal
19876 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19878 * @brief Get the horizontal mode of a separator object
19880 * @param obj The separator object
19881 * @return If true, the separator is horizontal
19883 * @see elm_separator_horizontal_set()
19885 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19891 * @defgroup Spinner Spinner
19892 * @ingroup Elementary
19894 * @image html img/widget/spinner/preview-00.png
19895 * @image latex img/widget/spinner/preview-00.eps
19897 * A spinner is a widget which allows the user to increase or decrease
19898 * numeric values using arrow buttons, or edit values directly, clicking
19899 * over it and typing the new value.
19901 * By default the spinner will not wrap and has a label
19902 * of "%.0f" (just showing the integer value of the double).
19904 * A spinner has a label that is formatted with floating
19905 * point values and thus accepts a printf-style format string, like
19908 * It also allows specific values to be replaced by pre-defined labels.
19910 * Smart callbacks one can register to:
19912 * - "changed" - Whenever the spinner value is changed.
19913 * - "delay,changed" - A short time after the value is changed by the user.
19914 * This will be called only when the user stops dragging for a very short
19915 * period or when they release their finger/mouse, so it avoids possibly
19916 * expensive reactions to the value change.
19918 * Available styles for it:
19920 * - @c "vertical": up/down buttons at the right side and text left aligned.
19922 * Here is an example on its usage:
19923 * @ref spinner_example
19927 * @addtogroup Spinner
19932 * Add a new spinner widget to the given parent Elementary
19933 * (container) object.
19935 * @param parent The parent object.
19936 * @return a new spinner widget handle or @c NULL, on errors.
19938 * This function inserts a new spinner widget on the canvas.
19943 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19946 * Set the format string of the displayed label.
19948 * @param obj The spinner object.
19949 * @param fmt The format string for the label display.
19951 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19952 * string for the label text. The label text is provided a floating point
19953 * value, so the label text can display up to 1 floating point value.
19954 * Note that this is optional.
19956 * Use a format string such as "%1.2f meters" for example, and it will
19957 * display values like: "3.14 meters" for a value equal to 3.14159.
19959 * Default is "%0.f".
19961 * @see elm_spinner_label_format_get()
19965 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19968 * Get the label format of the spinner.
19970 * @param obj The spinner object.
19971 * @return The text label format string in UTF-8.
19973 * @see elm_spinner_label_format_set() for details.
19977 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19980 * Set the minimum and maximum values for the spinner.
19982 * @param obj The spinner object.
19983 * @param min The minimum value.
19984 * @param max The maximum value.
19986 * Define the allowed range of values to be selected by the user.
19988 * If actual value is less than @p min, it will be updated to @p min. If it
19989 * is bigger then @p max, will be updated to @p max. Actual value can be
19990 * get with elm_spinner_value_get().
19992 * By default, min is equal to 0, and max is equal to 100.
19994 * @warning Maximum must be greater than minimum.
19996 * @see elm_spinner_min_max_get()
20000 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20003 * Get the minimum and maximum values of the spinner.
20005 * @param obj The spinner object.
20006 * @param min Pointer where to store the minimum value.
20007 * @param max Pointer where to store the maximum value.
20009 * @note If only one value is needed, the other pointer can be passed
20012 * @see elm_spinner_min_max_set() for details.
20016 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20019 * Set the step used to increment or decrement the spinner value.
20021 * @param obj The spinner object.
20022 * @param step The step value.
20024 * This value will be incremented or decremented to the displayed value.
20025 * It will be incremented while the user keep right or top arrow pressed,
20026 * and will be decremented while the user keep left or bottom arrow pressed.
20028 * The interval to increment / decrement can be set with
20029 * elm_spinner_interval_set().
20031 * By default step value is equal to 1.
20033 * @see elm_spinner_step_get()
20037 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20040 * Get the step used to increment or decrement the spinner value.
20042 * @param obj The spinner object.
20043 * @return The step value.
20045 * @see elm_spinner_step_get() for more details.
20049 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20052 * Set the value the spinner displays.
20054 * @param obj The spinner object.
20055 * @param val The value to be displayed.
20057 * Value will be presented on the label following format specified with
20058 * elm_spinner_format_set().
20060 * @warning The value must to be between min and max values. This values
20061 * are set by elm_spinner_min_max_set().
20063 * @see elm_spinner_value_get().
20064 * @see elm_spinner_format_set().
20065 * @see elm_spinner_min_max_set().
20069 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20072 * Get the value displayed by the spinner.
20074 * @param obj The spinner object.
20075 * @return The value displayed.
20077 * @see elm_spinner_value_set() for details.
20081 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20084 * Set whether the spinner should wrap when it reaches its
20085 * minimum or maximum value.
20087 * @param obj The spinner object.
20088 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20091 * Disabled by default. If disabled, when the user tries to increment the
20093 * but displayed value plus step value is bigger than maximum value,
20095 * won't allow it. The same happens when the user tries to decrement it,
20096 * but the value less step is less than minimum value.
20098 * When wrap is enabled, in such situations it will allow these changes,
20099 * but will get the value that would be less than minimum and subtracts
20100 * from maximum. Or add the value that would be more than maximum to
20104 * @li min value = 10
20105 * @li max value = 50
20106 * @li step value = 20
20107 * @li displayed value = 20
20109 * When the user decrement value (using left or bottom arrow), it will
20110 * displays @c 40, because max - (min - (displayed - step)) is
20111 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20113 * @see elm_spinner_wrap_get().
20117 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20120 * Get whether the spinner should wrap when it reaches its
20121 * minimum or maximum value.
20123 * @param obj The spinner object
20124 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20125 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20127 * @see elm_spinner_wrap_set() for details.
20131 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20134 * Set whether the spinner can be directly edited by the user or not.
20136 * @param obj The spinner object.
20137 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20138 * don't allow users to edit it directly.
20140 * Spinner objects can have edition @b disabled, in which state they will
20141 * be changed only by arrows.
20142 * Useful for contexts
20143 * where you don't want your users to interact with it writting the value.
20145 * when using special values, the user can see real value instead
20146 * of special label on edition.
20148 * It's enabled by default.
20150 * @see elm_spinner_editable_get()
20154 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20157 * Get whether the spinner can be directly edited by the user or not.
20159 * @param obj The spinner object.
20160 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20161 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20163 * @see elm_spinner_editable_set() for details.
20167 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20170 * Set a special string to display in the place of the numerical value.
20172 * @param obj The spinner object.
20173 * @param value The value to be replaced.
20174 * @param label The label to be used.
20176 * It's useful for cases when a user should select an item that is
20177 * better indicated by a label than a value. For example, weekdays or months.
20181 * sp = elm_spinner_add(win);
20182 * elm_spinner_min_max_set(sp, 1, 3);
20183 * elm_spinner_special_value_add(sp, 1, "January");
20184 * elm_spinner_special_value_add(sp, 2, "February");
20185 * elm_spinner_special_value_add(sp, 3, "March");
20186 * evas_object_show(sp);
20191 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20194 * Set the interval on time updates for an user mouse button hold
20195 * on spinner widgets' arrows.
20197 * @param obj The spinner object.
20198 * @param interval The (first) interval value in seconds.
20200 * This interval value is @b decreased while the user holds the
20201 * mouse pointer either incrementing or decrementing spinner's value.
20203 * This helps the user to get to a given value distant from the
20204 * current one easier/faster, as it will start to change quicker and
20205 * quicker on mouse button holds.
20207 * The calculation for the next change interval value, starting from
20208 * the one set with this call, is the previous interval divided by
20209 * @c 1.05, so it decreases a little bit.
20211 * The default starting interval value for automatic changes is
20214 * @see elm_spinner_interval_get()
20218 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20221 * Get the interval on time updates for an user mouse button hold
20222 * on spinner widgets' arrows.
20224 * @param obj The spinner object.
20225 * @return The (first) interval value, in seconds, set on it.
20227 * @see elm_spinner_interval_set() for more details.
20231 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20238 * @defgroup Index Index
20240 * @image html img/widget/index/preview-00.png
20241 * @image latex img/widget/index/preview-00.eps
20243 * An index widget gives you an index for fast access to whichever
20244 * group of other UI items one might have. It's a list of text
20245 * items (usually letters, for alphabetically ordered access).
20247 * Index widgets are by default hidden and just appear when the
20248 * user clicks over it's reserved area in the canvas. In its
20249 * default theme, it's an area one @ref Fingers "finger" wide on
20250 * the right side of the index widget's container.
20252 * When items on the index are selected, smart callbacks get
20253 * called, so that its user can make other container objects to
20254 * show a given area or child object depending on the index item
20255 * selected. You'd probably be using an index together with @ref
20256 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20259 * Smart events one can add callbacks for are:
20260 * - @c "changed" - When the selected index item changes. @c
20261 * event_info is the selected item's data pointer.
20262 * - @c "delay,changed" - When the selected index item changes, but
20263 * after a small idling period. @c event_info is the selected
20264 * item's data pointer.
20265 * - @c "selected" - When the user releases a mouse button and
20266 * selects an item. @c event_info is the selected item's data
20268 * - @c "level,up" - when the user moves a finger from the first
20269 * level to the second level
20270 * - @c "level,down" - when the user moves a finger from the second
20271 * level to the first level
20273 * The @c "delay,changed" event is so that it'll wait a small time
20274 * before actually reporting those events and, moreover, just the
20275 * last event happening on those time frames will actually be
20278 * Here are some examples on its usage:
20279 * @li @ref index_example_01
20280 * @li @ref index_example_02
20284 * @addtogroup Index
20288 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20291 * Add a new index widget to the given parent Elementary
20292 * (container) object
20294 * @param parent The parent object
20295 * @return a new index widget handle or @c NULL, on errors
20297 * This function inserts a new index widget on the canvas.
20301 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20304 * Set whether a given index widget is or not visible,
20307 * @param obj The index object
20308 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20310 * Not to be confused with visible as in @c evas_object_show() --
20311 * visible with regard to the widget's auto hiding feature.
20313 * @see elm_index_active_get()
20317 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20320 * Get whether a given index widget is currently visible or not.
20322 * @param obj The index object
20323 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20325 * @see elm_index_active_set() for more details
20329 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20332 * Set the items level for a given index widget.
20334 * @param obj The index object.
20335 * @param level @c 0 or @c 1, the currently implemented levels.
20337 * @see elm_index_item_level_get()
20341 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20344 * Get the items level set for a given index widget.
20346 * @param obj The index object.
20347 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20349 * @see elm_index_item_level_set() for more information
20353 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20356 * Returns the last selected item's data, for a given index widget.
20358 * @param obj The index object.
20359 * @return The item @b data associated to the last selected item on
20360 * @p obj (or @c NULL, on errors).
20362 * @warning The returned value is @b not an #Elm_Index_Item item
20363 * handle, but the data associated to it (see the @c item parameter
20364 * in elm_index_item_append(), as an example).
20368 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20371 * Append a new item on a given index widget.
20373 * @param obj The index object.
20374 * @param letter Letter under which the item should be indexed
20375 * @param item The item data to set for the index's item
20377 * Despite the most common usage of the @p letter argument is for
20378 * single char strings, one could use arbitrary strings as index
20381 * @c item will be the pointer returned back on @c "changed", @c
20382 * "delay,changed" and @c "selected" smart events.
20386 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20389 * Prepend a new item on a given index widget.
20391 * @param obj The index object.
20392 * @param letter Letter under which the item should be indexed
20393 * @param item The item data to set for the index's item
20395 * Despite the most common usage of the @p letter argument is for
20396 * single char strings, one could use arbitrary strings as index
20399 * @c item will be the pointer returned back on @c "changed", @c
20400 * "delay,changed" and @c "selected" smart events.
20404 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20407 * Append a new item, on a given index widget, <b>after the item
20408 * having @p relative as data</b>.
20410 * @param obj The index object.
20411 * @param letter Letter under which the item should be indexed
20412 * @param item The item data to set for the index's item
20413 * @param relative The item data of the index item to be the
20414 * predecessor of this new one
20416 * Despite the most common usage of the @p letter argument is for
20417 * single char strings, one could use arbitrary strings as index
20420 * @c item will be the pointer returned back on @c "changed", @c
20421 * "delay,changed" and @c "selected" smart events.
20423 * @note If @p relative is @c NULL or if it's not found to be data
20424 * set on any previous item on @p obj, this function will behave as
20425 * elm_index_item_append().
20429 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20432 * Prepend a new item, on a given index widget, <b>after the item
20433 * having @p relative as data</b>.
20435 * @param obj The index object.
20436 * @param letter Letter under which the item should be indexed
20437 * @param item The item data to set for the index's item
20438 * @param relative The item data of the index item to be the
20439 * successor of this new one
20441 * Despite the most common usage of the @p letter argument is for
20442 * single char strings, one could use arbitrary strings as index
20445 * @c item will be the pointer returned back on @c "changed", @c
20446 * "delay,changed" and @c "selected" smart events.
20448 * @note If @p relative is @c NULL or if it's not found to be data
20449 * set on any previous item on @p obj, this function will behave as
20450 * elm_index_item_prepend().
20454 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20457 * Insert a new item into the given index widget, using @p cmp_func
20458 * function to sort items (by item handles).
20460 * @param obj The index object.
20461 * @param letter Letter under which the item should be indexed
20462 * @param item The item data to set for the index's item
20463 * @param cmp_func The comparing function to be used to sort index
20464 * items <b>by #Elm_Index_Item item handles</b>
20465 * @param cmp_data_func A @b fallback function to be called for the
20466 * sorting of index items <b>by item data</b>). It will be used
20467 * when @p cmp_func returns @c 0 (equality), which means an index
20468 * item with provided item data already exists. To decide which
20469 * data item should be pointed to by the index item in question, @p
20470 * cmp_data_func will be used. If @p cmp_data_func returns a
20471 * non-negative value, the previous index item data will be
20472 * replaced by the given @p item pointer. If the previous data need
20473 * to be freed, it should be done by the @p cmp_data_func function,
20474 * because all references to it will be lost. If this function is
20475 * not provided (@c NULL is given), index items will be @b
20476 * duplicated, if @p cmp_func returns @c 0.
20478 * Despite the most common usage of the @p letter argument is for
20479 * single char strings, one could use arbitrary strings as index
20482 * @c item will be the pointer returned back on @c "changed", @c
20483 * "delay,changed" and @c "selected" smart events.
20487 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);
20490 * Remove an item from a given index widget, <b>to be referenced by
20491 * it's data value</b>.
20493 * @param obj The index object
20494 * @param item The item's data pointer for the item to be removed
20497 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20498 * that callback function will be called by this one.
20500 * @warning The item to be removed from @p obj will be found via
20501 * its item data pointer, and not by an #Elm_Index_Item handle.
20505 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20508 * Find a given index widget's item, <b>using item data</b>.
20510 * @param obj The index object
20511 * @param item The item data pointed to by the desired index item
20512 * @return The index item handle, if found, or @c NULL otherwise
20516 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20519 * Removes @b all items from a given index widget.
20521 * @param obj The index object.
20523 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20524 * that callback function will be called for each item in @p obj.
20528 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20531 * Go to a given items level on a index widget
20533 * @param obj The index object
20534 * @param level The index level (one of @c 0 or @c 1)
20538 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20541 * Return the data associated with a given index widget item
20543 * @param it The index widget item handle
20544 * @return The data associated with @p it
20546 * @see elm_index_item_data_set()
20550 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20553 * Set the data associated with a given index widget item
20555 * @param it The index widget item handle
20556 * @param data The new data pointer to set to @p it
20558 * This sets new item data on @p it.
20560 * @warning The old data pointer won't be touched by this function, so
20561 * the user had better to free that old data himself/herself.
20565 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20568 * Set the function to be called when a given index widget item is freed.
20570 * @param it The item to set the callback on
20571 * @param func The function to call on the item's deletion
20573 * When called, @p func will have both @c data and @c event_info
20574 * arguments with the @p it item's data value and, naturally, the
20575 * @c obj argument with a handle to the parent index widget.
20579 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20582 * Get the letter (string) set on a given index widget item.
20584 * @param it The index item handle
20585 * @return The letter string set on @p it
20589 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20596 * @defgroup Photocam Photocam
20598 * @image html img/widget/photocam/preview-00.png
20599 * @image latex img/widget/photocam/preview-00.eps
20601 * This is a widget specifically for displaying high-resolution digital
20602 * camera photos giving speedy feedback (fast load), low memory footprint
20603 * and zooming and panning as well as fitting logic. It is entirely focused
20604 * on jpeg images, and takes advantage of properties of the jpeg format (via
20605 * evas loader features in the jpeg loader).
20607 * Signals that you can add callbacks for are:
20608 * @li "clicked" - This is called when a user has clicked the photo without
20610 * @li "press" - This is called when a user has pressed down on the photo.
20611 * @li "longpressed" - This is called when a user has pressed down on the
20612 * photo for a long time without dragging around.
20613 * @li "clicked,double" - This is called when a user has double-clicked the
20615 * @li "load" - Photo load begins.
20616 * @li "loaded" - This is called when the image file load is complete for the
20617 * first view (low resolution blurry version).
20618 * @li "load,detail" - Photo detailed data load begins.
20619 * @li "loaded,detail" - This is called when the image file load is complete
20620 * for the detailed image data (full resolution needed).
20621 * @li "zoom,start" - Zoom animation started.
20622 * @li "zoom,stop" - Zoom animation stopped.
20623 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20624 * @li "scroll" - the content has been scrolled (moved)
20625 * @li "scroll,anim,start" - scrolling animation has started
20626 * @li "scroll,anim,stop" - scrolling animation has stopped
20627 * @li "scroll,drag,start" - dragging the contents around has started
20628 * @li "scroll,drag,stop" - dragging the contents around has stopped
20630 * @ref tutorial_photocam shows the API in action.
20634 * @brief Types of zoom available.
20636 typedef enum _Elm_Photocam_Zoom_Mode
20638 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20639 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20640 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20641 ELM_PHOTOCAM_ZOOM_MODE_LAST
20642 } Elm_Photocam_Zoom_Mode;
20644 * @brief Add a new Photocam object
20646 * @param parent The parent object
20647 * @return The new object or NULL if it cannot be created
20649 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20651 * @brief Set the photo file to be shown
20653 * @param obj The photocam object
20654 * @param file The photo file
20655 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20657 * This sets (and shows) the specified file (with a relative or absolute
20658 * path) and will return a load error (same error that
20659 * evas_object_image_load_error_get() will return). The image will change and
20660 * adjust its size at this point and begin a background load process for this
20661 * photo that at some time in the future will be displayed at the full
20664 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20666 * @brief Returns the path of the current image file
20668 * @param obj The photocam object
20669 * @return Returns the path
20671 * @see elm_photocam_file_set()
20673 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20675 * @brief Set the zoom level of the photo
20677 * @param obj The photocam object
20678 * @param zoom The zoom level to set
20680 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20681 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20682 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20683 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20686 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20688 * @brief Get the zoom level of the photo
20690 * @param obj The photocam object
20691 * @return The current zoom level
20693 * This returns the current zoom level of the photocam object. Note that if
20694 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20695 * (which is the default), the zoom level may be changed at any time by the
20696 * photocam object itself to account for photo size and photocam viewpoer
20699 * @see elm_photocam_zoom_set()
20700 * @see elm_photocam_zoom_mode_set()
20702 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20704 * @brief Set the zoom mode
20706 * @param obj The photocam object
20707 * @param mode The desired mode
20709 * This sets the zoom mode to manual or one of several automatic levels.
20710 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20711 * elm_photocam_zoom_set() and will stay at that level until changed by code
20712 * or until zoom mode is changed. This is the default mode. The Automatic
20713 * modes will allow the photocam object to automatically adjust zoom mode
20714 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20715 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20716 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20717 * pixels within the frame are left unfilled.
20719 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20721 * @brief Get the zoom mode
20723 * @param obj The photocam object
20724 * @return The current zoom mode
20726 * This gets the current zoom mode of the photocam object.
20728 * @see elm_photocam_zoom_mode_set()
20730 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20732 * @brief Get the current image pixel width and height
20734 * @param obj The photocam object
20735 * @param w A pointer to the width return
20736 * @param h A pointer to the height return
20738 * This gets the current photo pixel width and height (for the original).
20739 * The size will be returned in the integers @p w and @p h that are pointed
20742 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20744 * @brief Get the area of the image that is currently shown
20747 * @param x A pointer to the X-coordinate of region
20748 * @param y A pointer to the Y-coordinate of region
20749 * @param w A pointer to the width
20750 * @param h A pointer to the height
20752 * @see elm_photocam_image_region_show()
20753 * @see elm_photocam_image_region_bring_in()
20755 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20757 * @brief Set the viewed portion of the image
20759 * @param obj The photocam object
20760 * @param x X-coordinate of region in image original pixels
20761 * @param y Y-coordinate of region in image original pixels
20762 * @param w Width of region in image original pixels
20763 * @param h Height of region in image original pixels
20765 * This shows the region of the image without using animation.
20767 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20769 * @brief Bring in the viewed portion of the image
20771 * @param obj The photocam object
20772 * @param x X-coordinate of region in image original pixels
20773 * @param y Y-coordinate of region in image original pixels
20774 * @param w Width of region in image original pixels
20775 * @param h Height of region in image original pixels
20777 * This shows the region of the image using animation.
20779 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20781 * @brief Set the paused state for photocam
20783 * @param obj The photocam object
20784 * @param paused The pause state to set
20786 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20787 * photocam. The default is off. This will stop zooming using animation on
20788 * zoom levels changes and change instantly. This will stop any existing
20789 * animations that are running.
20791 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20793 * @brief Get the paused state for photocam
20795 * @param obj The photocam object
20796 * @return The current paused state
20798 * This gets the current paused state for the photocam object.
20800 * @see elm_photocam_paused_set()
20802 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20804 * @brief Get the internal low-res image used for photocam
20806 * @param obj The photocam object
20807 * @return The internal image object handle, or NULL if none exists
20809 * This gets the internal image object inside photocam. Do not modify it. It
20810 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20811 * deleted at any time as well.
20813 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20815 * @brief Set the photocam scrolling bouncing.
20817 * @param obj The photocam object
20818 * @param h_bounce bouncing for horizontal
20819 * @param v_bounce bouncing for vertical
20821 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20823 * @brief Get the photocam scrolling bouncing.
20825 * @param obj The photocam object
20826 * @param h_bounce bouncing for horizontal
20827 * @param v_bounce bouncing for vertical
20829 * @see elm_photocam_bounce_set()
20831 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20837 * @defgroup Map Map
20838 * @ingroup Elementary
20840 * @image html img/widget/map/preview-00.png
20841 * @image latex img/widget/map/preview-00.eps
20843 * This is a widget specifically for displaying a map. It uses basically
20844 * OpenStreetMap provider http://www.openstreetmap.org/,
20845 * but custom providers can be added.
20847 * It supports some basic but yet nice features:
20848 * @li zoom and scroll
20849 * @li markers with content to be displayed when user clicks over it
20850 * @li group of markers
20853 * Smart callbacks one can listen to:
20855 * - "clicked" - This is called when a user has clicked the map without
20857 * - "press" - This is called when a user has pressed down on the map.
20858 * - "longpressed" - This is called when a user has pressed down on the map
20859 * for a long time without dragging around.
20860 * - "clicked,double" - This is called when a user has double-clicked
20862 * - "load,detail" - Map detailed data load begins.
20863 * - "loaded,detail" - This is called when all currently visible parts of
20864 * the map are loaded.
20865 * - "zoom,start" - Zoom animation started.
20866 * - "zoom,stop" - Zoom animation stopped.
20867 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20868 * - "scroll" - the content has been scrolled (moved).
20869 * - "scroll,anim,start" - scrolling animation has started.
20870 * - "scroll,anim,stop" - scrolling animation has stopped.
20871 * - "scroll,drag,start" - dragging the contents around has started.
20872 * - "scroll,drag,stop" - dragging the contents around has stopped.
20873 * - "downloaded" - This is called when all currently required map images
20875 * - "route,load" - This is called when route request begins.
20876 * - "route,loaded" - This is called when route request ends.
20877 * - "name,load" - This is called when name request begins.
20878 * - "name,loaded- This is called when name request ends.
20880 * Available style for map widget:
20883 * Available style for markers:
20888 * Available style for marker bubble:
20891 * List of examples:
20892 * @li @ref map_example_01
20893 * @li @ref map_example_02
20894 * @li @ref map_example_03
20903 * @enum _Elm_Map_Zoom_Mode
20904 * @typedef Elm_Map_Zoom_Mode
20906 * Set map's zoom behavior. It can be set to manual or automatic.
20908 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20910 * Values <b> don't </b> work as bitmask, only one can be choosen.
20912 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20913 * than the scroller view.
20915 * @see elm_map_zoom_mode_set()
20916 * @see elm_map_zoom_mode_get()
20920 typedef enum _Elm_Map_Zoom_Mode
20922 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20923 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20924 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20925 ELM_MAP_ZOOM_MODE_LAST
20926 } Elm_Map_Zoom_Mode;
20929 * @enum _Elm_Map_Route_Sources
20930 * @typedef Elm_Map_Route_Sources
20932 * Set route service to be used. By default used source is
20933 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20935 * @see elm_map_route_source_set()
20936 * @see elm_map_route_source_get()
20940 typedef enum _Elm_Map_Route_Sources
20942 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20943 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. */
20944 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20945 ELM_MAP_ROUTE_SOURCE_LAST
20946 } Elm_Map_Route_Sources;
20948 typedef enum _Elm_Map_Name_Sources
20950 ELM_MAP_NAME_SOURCE_NOMINATIM,
20951 ELM_MAP_NAME_SOURCE_LAST
20952 } Elm_Map_Name_Sources;
20955 * @enum _Elm_Map_Route_Type
20956 * @typedef Elm_Map_Route_Type
20958 * Set type of transport used on route.
20960 * @see elm_map_route_add()
20964 typedef enum _Elm_Map_Route_Type
20966 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20967 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20968 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20969 ELM_MAP_ROUTE_TYPE_LAST
20970 } Elm_Map_Route_Type;
20973 * @enum _Elm_Map_Route_Method
20974 * @typedef Elm_Map_Route_Method
20976 * Set the routing method, what should be priorized, time or distance.
20978 * @see elm_map_route_add()
20982 typedef enum _Elm_Map_Route_Method
20984 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20985 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20986 ELM_MAP_ROUTE_METHOD_LAST
20987 } Elm_Map_Route_Method;
20989 typedef enum _Elm_Map_Name_Method
20991 ELM_MAP_NAME_METHOD_SEARCH,
20992 ELM_MAP_NAME_METHOD_REVERSE,
20993 ELM_MAP_NAME_METHOD_LAST
20994 } Elm_Map_Name_Method;
20996 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(). */
20997 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(). */
20998 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(). */
20999 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(). */
21000 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
21001 typedef struct _Elm_Map_Track Elm_Map_Track;
21003 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. */
21004 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21005 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21006 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21008 typedef char *(*ElmMapModuleSourceFunc) (void);
21009 typedef int (*ElmMapModuleZoomMinFunc) (void);
21010 typedef int (*ElmMapModuleZoomMaxFunc) (void);
21011 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21012 typedef int (*ElmMapModuleRouteSourceFunc) (void);
21013 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21014 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21015 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21016 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21019 * Add a new map widget to the given parent Elementary (container) object.
21021 * @param parent The parent object.
21022 * @return a new map widget handle or @c NULL, on errors.
21024 * This function inserts a new map widget on the canvas.
21028 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21031 * Set the zoom level of the map.
21033 * @param obj The map object.
21034 * @param zoom The zoom level to set.
21036 * This sets the zoom level.
21038 * It will respect limits defined by elm_map_source_zoom_min_set() and
21039 * elm_map_source_zoom_max_set().
21041 * By default these values are 0 (world map) and 18 (maximum zoom).
21043 * This function should be used when zoom mode is set to
21044 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21045 * with elm_map_zoom_mode_set().
21047 * @see elm_map_zoom_mode_set().
21048 * @see elm_map_zoom_get().
21052 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21055 * Get the zoom level of the map.
21057 * @param obj The map object.
21058 * @return The current zoom level.
21060 * This returns the current zoom level of the map object.
21062 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21063 * (which is the default), the zoom level may be changed at any time by the
21064 * map object itself to account for map size and map viewport size.
21066 * @see elm_map_zoom_set() for details.
21070 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21073 * Set the zoom mode used by the map object.
21075 * @param obj The map object.
21076 * @param mode The zoom mode of the map, being it one of
21077 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21078 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21080 * This sets the zoom mode to manual or one of the automatic levels.
21081 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21082 * elm_map_zoom_set() and will stay at that level until changed by code
21083 * or until zoom mode is changed. This is the default mode.
21085 * The Automatic modes will allow the map object to automatically
21086 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21087 * adjust zoom so the map fits inside the scroll frame with no pixels
21088 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21089 * ensure no pixels within the frame are left unfilled. Do not forget that
21090 * the valid sizes are 2^zoom, consequently the map may be smaller than
21091 * the scroller view.
21093 * @see elm_map_zoom_set()
21097 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21100 * Get the zoom mode used by the map object.
21102 * @param obj The map object.
21103 * @return The zoom mode of the map, being it one of
21104 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21105 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21107 * This function returns the current zoom mode used by the map object.
21109 * @see elm_map_zoom_mode_set() for more details.
21113 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21116 * Get the current coordinates of the map.
21118 * @param obj The map object.
21119 * @param lon Pointer where to store longitude.
21120 * @param lat Pointer where to store latitude.
21122 * This gets the current center coordinates of the map object. It can be
21123 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21125 * @see elm_map_geo_region_bring_in()
21126 * @see elm_map_geo_region_show()
21130 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21133 * Animatedly bring in given coordinates to the center of the map.
21135 * @param obj The map object.
21136 * @param lon Longitude to center at.
21137 * @param lat Latitude to center at.
21139 * This causes map to jump to the given @p lat and @p lon coordinates
21140 * and show it (by scrolling) in the center of the viewport, if it is not
21141 * already centered. This will use animation to do so and take a period
21142 * of time to complete.
21144 * @see elm_map_geo_region_show() for a function to avoid animation.
21145 * @see elm_map_geo_region_get()
21149 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21152 * Show the given coordinates at the center of the map, @b immediately.
21154 * @param obj The map object.
21155 * @param lon Longitude to center at.
21156 * @param lat Latitude to center at.
21158 * This causes map to @b redraw its viewport's contents to the
21159 * region contining the given @p lat and @p lon, that will be moved to the
21160 * center of the map.
21162 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21163 * @see elm_map_geo_region_get()
21167 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21170 * Pause or unpause the map.
21172 * @param obj The map object.
21173 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21176 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21179 * The default is off.
21181 * This will stop zooming using animation, changing zoom levels will
21182 * change instantly. This will stop any existing animations that are running.
21184 * @see elm_map_paused_get()
21188 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21191 * Get a value whether map is paused or not.
21193 * @param obj The map object.
21194 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21195 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21197 * This gets the current paused state for the map object.
21199 * @see elm_map_paused_set() for details.
21203 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21206 * Set to show markers during zoom level changes or not.
21208 * @param obj The map object.
21209 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21212 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21215 * The default is off.
21217 * This will stop zooming using animation, changing zoom levels will
21218 * change instantly. This will stop any existing animations that are running.
21220 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21223 * The default is off.
21225 * Enabling it will force the map to stop displaying the markers during
21226 * zoom level changes. Set to on if you have a large number of markers.
21228 * @see elm_map_paused_markers_get()
21232 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21235 * Get a value whether markers will be displayed on zoom level changes or not
21237 * @param obj The map object.
21238 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21239 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21241 * This gets the current markers paused state for the map object.
21243 * @see elm_map_paused_markers_set() for details.
21247 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21250 * Get the information of downloading status.
21252 * @param obj The map object.
21253 * @param try_num Pointer where to store number of tiles being downloaded.
21254 * @param finish_num Pointer where to store number of tiles successfully
21257 * This gets the current downloading status for the map object, the number
21258 * of tiles being downloaded and the number of tiles already downloaded.
21262 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21265 * Convert a pixel coordinate (x,y) into a geographic coordinate
21266 * (longitude, latitude).
21268 * @param obj The map object.
21269 * @param x the coordinate.
21270 * @param y the coordinate.
21271 * @param size the size in pixels of the map.
21272 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21273 * @param lon Pointer where to store the longitude that correspond to x.
21274 * @param lat Pointer where to store the latitude that correspond to y.
21276 * @note Origin pixel point is the top left corner of the viewport.
21277 * Map zoom and size are taken on account.
21279 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21283 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);
21286 * Convert a geographic coordinate (longitude, latitude) into a pixel
21287 * coordinate (x, y).
21289 * @param obj The map object.
21290 * @param lon the longitude.
21291 * @param lat the latitude.
21292 * @param size the size in pixels of the map. The map is a square
21293 * and generally his size is : pow(2.0, zoom)*256.
21294 * @param x Pointer where to store the horizontal pixel coordinate that
21295 * correspond to the longitude.
21296 * @param y Pointer where to store the vertical pixel coordinate that
21297 * correspond to the latitude.
21299 * @note Origin pixel point is the top left corner of the viewport.
21300 * Map zoom and size are taken on account.
21302 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21306 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);
21309 * Convert a geographic coordinate (longitude, latitude) into a name
21312 * @param obj The map object.
21313 * @param lon the longitude.
21314 * @param lat the latitude.
21315 * @return name A #Elm_Map_Name handle for this coordinate.
21317 * To get the string for this address, elm_map_name_address_get()
21320 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21324 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21327 * Convert a name (address) into a geographic coordinate
21328 * (longitude, latitude).
21330 * @param obj The map object.
21331 * @param name The address.
21332 * @return name A #Elm_Map_Name handle for this address.
21334 * To get the longitude and latitude, elm_map_name_region_get()
21337 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21341 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21344 * Convert a pixel coordinate into a rotated pixel coordinate.
21346 * @param obj The map object.
21347 * @param x horizontal coordinate of the point to rotate.
21348 * @param y vertical coordinate of the point to rotate.
21349 * @param cx rotation's center horizontal position.
21350 * @param cy rotation's center vertical position.
21351 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21352 * @param xx Pointer where to store rotated x.
21353 * @param yy Pointer where to store rotated y.
21357 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);
21360 * Add a new marker to the map object.
21362 * @param obj The map object.
21363 * @param lon The longitude of the marker.
21364 * @param lat The latitude of the marker.
21365 * @param clas The class, to use when marker @b isn't grouped to others.
21366 * @param clas_group The class group, to use when marker is grouped to others
21367 * @param data The data passed to the callbacks.
21369 * @return The created marker or @c NULL upon failure.
21371 * A marker will be created and shown in a specific point of the map, defined
21372 * by @p lon and @p lat.
21374 * It will be displayed using style defined by @p class when this marker
21375 * is displayed alone (not grouped). A new class can be created with
21376 * elm_map_marker_class_new().
21378 * If the marker is grouped to other markers, it will be displayed with
21379 * style defined by @p class_group. Markers with the same group are grouped
21380 * if they are close. A new group class can be created with
21381 * elm_map_marker_group_class_new().
21383 * Markers created with this method can be deleted with
21384 * elm_map_marker_remove().
21386 * A marker can have associated content to be displayed by a bubble,
21387 * when a user click over it, as well as an icon. These objects will
21388 * be fetch using class' callback functions.
21390 * @see elm_map_marker_class_new()
21391 * @see elm_map_marker_group_class_new()
21392 * @see elm_map_marker_remove()
21396 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);
21399 * Set the maximum numbers of markers' content to be displayed in a group.
21401 * @param obj The map object.
21402 * @param max The maximum numbers of items displayed in a bubble.
21404 * A bubble will be displayed when the user clicks over the group,
21405 * and will place the content of markers that belong to this group
21408 * A group can have a long list of markers, consequently the creation
21409 * of the content of the bubble can be very slow.
21411 * In order to avoid this, a maximum number of items is displayed
21414 * By default this number is 30.
21416 * Marker with the same group class are grouped if they are close.
21418 * @see elm_map_marker_add()
21422 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21425 * Remove a marker from the map.
21427 * @param marker The marker to remove.
21429 * @see elm_map_marker_add()
21433 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21436 * Get the current coordinates of the marker.
21438 * @param marker marker.
21439 * @param lat Pointer where to store the marker's latitude.
21440 * @param lon Pointer where to store the marker's longitude.
21442 * These values are set when adding markers, with function
21443 * elm_map_marker_add().
21445 * @see elm_map_marker_add()
21449 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21452 * Animatedly bring in given marker to the center of the map.
21454 * @param marker The marker to center at.
21456 * This causes map to jump to the given @p marker's coordinates
21457 * and show it (by scrolling) in the center of the viewport, if it is not
21458 * already centered. This will use animation to do so and take a period
21459 * of time to complete.
21461 * @see elm_map_marker_show() for a function to avoid animation.
21462 * @see elm_map_marker_region_get()
21466 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21469 * Show the given marker at the center of the map, @b immediately.
21471 * @param marker The marker to center at.
21473 * This causes map to @b redraw its viewport's contents to the
21474 * region contining the given @p marker's coordinates, that will be
21475 * moved to the center of the map.
21477 * @see elm_map_marker_bring_in() for a function to move with animation.
21478 * @see elm_map_markers_list_show() if more than one marker need to be
21480 * @see elm_map_marker_region_get()
21484 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21487 * Move and zoom the map to display a list of markers.
21489 * @param markers A list of #Elm_Map_Marker handles.
21491 * The map will be centered on the center point of the markers in the list.
21492 * Then the map will be zoomed in order to fit the markers using the maximum
21493 * zoom which allows display of all the markers.
21495 * @warning All the markers should belong to the same map object.
21497 * @see elm_map_marker_show() to show a single marker.
21498 * @see elm_map_marker_bring_in()
21502 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21505 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21507 * @param marker The marker wich content should be returned.
21508 * @return Return the evas object if it exists, else @c NULL.
21510 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21511 * elm_map_marker_class_get_cb_set() should be used.
21513 * This content is what will be inside the bubble that will be displayed
21514 * when an user clicks over the marker.
21516 * This returns the actual Evas object used to be placed inside
21517 * the bubble. This may be @c NULL, as it may
21518 * not have been created or may have been deleted, at any time, by
21519 * the map. <b>Do not modify this object</b> (move, resize,
21520 * show, hide, etc.), as the map is controlling it. This
21521 * function is for querying, emitting custom signals or hooking
21522 * lower level callbacks for events on that object. Do not delete
21523 * this object under any circumstances.
21527 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21530 * Update the marker
21532 * @param marker The marker to be updated.
21534 * If a content is set to this marker, it will call function to delete it,
21535 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21536 * #ElmMapMarkerGetFunc.
21538 * These functions are set for the marker class with
21539 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21543 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21546 * Close all the bubbles opened by the user.
21548 * @param obj The map object.
21550 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21551 * when the user clicks on a marker.
21553 * This functions is set for the marker class with
21554 * elm_map_marker_class_get_cb_set().
21558 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21561 * Create a new group class.
21563 * @param obj The map object.
21564 * @return Returns the new group class.
21566 * Each marker must be associated to a group class. Markers in the same
21567 * group are grouped if they are close.
21569 * The group class defines the style of the marker when a marker is grouped
21570 * to others markers. When it is alone, another class will be used.
21572 * A group class will need to be provided when creating a marker with
21573 * elm_map_marker_add().
21575 * Some properties and functions can be set by class, as:
21576 * - style, with elm_map_group_class_style_set()
21577 * - data - to be associated to the group class. It can be set using
21578 * elm_map_group_class_data_set().
21579 * - min zoom to display markers, set with
21580 * elm_map_group_class_zoom_displayed_set().
21581 * - max zoom to group markers, set using
21582 * elm_map_group_class_zoom_grouped_set().
21583 * - visibility - set if markers will be visible or not, set with
21584 * elm_map_group_class_hide_set().
21585 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21586 * It can be set using elm_map_group_class_icon_cb_set().
21588 * @see elm_map_marker_add()
21589 * @see elm_map_group_class_style_set()
21590 * @see elm_map_group_class_data_set()
21591 * @see elm_map_group_class_zoom_displayed_set()
21592 * @see elm_map_group_class_zoom_grouped_set()
21593 * @see elm_map_group_class_hide_set()
21594 * @see elm_map_group_class_icon_cb_set()
21598 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21601 * Set the marker's style of a group class.
21603 * @param clas The group class.
21604 * @param style The style to be used by markers.
21606 * Each marker must be associated to a group class, and will use the style
21607 * defined by such class when grouped to other markers.
21609 * The following styles are provided by default theme:
21610 * @li @c radio - blue circle
21611 * @li @c radio2 - green circle
21614 * @see elm_map_group_class_new() for more details.
21615 * @see elm_map_marker_add()
21619 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21622 * Set the icon callback function of a group class.
21624 * @param clas The group class.
21625 * @param icon_get The callback function that will return the icon.
21627 * Each marker must be associated to a group class, and it can display a
21628 * custom icon. The function @p icon_get must return this icon.
21630 * @see elm_map_group_class_new() for more details.
21631 * @see elm_map_marker_add()
21635 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21638 * Set the data associated to the group class.
21640 * @param clas The group class.
21641 * @param data The new user data.
21643 * This data will be passed for callback functions, like icon get callback,
21644 * that can be set with elm_map_group_class_icon_cb_set().
21646 * If a data was previously set, the object will lose the pointer for it,
21647 * so if needs to be freed, you must do it yourself.
21649 * @see elm_map_group_class_new() for more details.
21650 * @see elm_map_group_class_icon_cb_set()
21651 * @see elm_map_marker_add()
21655 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21658 * Set the minimum zoom from where the markers are displayed.
21660 * @param clas The group class.
21661 * @param zoom The minimum zoom.
21663 * Markers only will be displayed when the map is displayed at @p zoom
21666 * @see elm_map_group_class_new() for more details.
21667 * @see elm_map_marker_add()
21671 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21674 * Set the zoom from where the markers are no more grouped.
21676 * @param clas The group class.
21677 * @param zoom The maximum zoom.
21679 * Markers only will be grouped when the map is displayed at
21680 * less than @p zoom.
21682 * @see elm_map_group_class_new() for more details.
21683 * @see elm_map_marker_add()
21687 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21690 * Set if the markers associated to the group class @clas are hidden or not.
21692 * @param clas The group class.
21693 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21696 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21701 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21704 * Create a new marker class.
21706 * @param obj The map object.
21707 * @return Returns the new group class.
21709 * Each marker must be associated to a class.
21711 * The marker class defines the style of the marker when a marker is
21712 * displayed alone, i.e., not grouped to to others markers. When grouped
21713 * it will use group class style.
21715 * A marker class will need to be provided when creating a marker with
21716 * elm_map_marker_add().
21718 * Some properties and functions can be set by class, as:
21719 * - style, with elm_map_marker_class_style_set()
21720 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21721 * It can be set using elm_map_marker_class_icon_cb_set().
21722 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21723 * Set using elm_map_marker_class_get_cb_set().
21724 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21725 * Set using elm_map_marker_class_del_cb_set().
21727 * @see elm_map_marker_add()
21728 * @see elm_map_marker_class_style_set()
21729 * @see elm_map_marker_class_icon_cb_set()
21730 * @see elm_map_marker_class_get_cb_set()
21731 * @see elm_map_marker_class_del_cb_set()
21735 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21738 * Set the marker's style of a marker class.
21740 * @param clas The marker class.
21741 * @param style The style to be used by markers.
21743 * Each marker must be associated to a marker class, and will use the style
21744 * defined by such class when alone, i.e., @b not grouped to other markers.
21746 * The following styles are provided by default theme:
21751 * @see elm_map_marker_class_new() for more details.
21752 * @see elm_map_marker_add()
21756 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21759 * Set the icon callback function of a marker class.
21761 * @param clas The marker class.
21762 * @param icon_get The callback function that will return the icon.
21764 * Each marker must be associated to a marker class, and it can display a
21765 * custom icon. The function @p icon_get must return this icon.
21767 * @see elm_map_marker_class_new() for more details.
21768 * @see elm_map_marker_add()
21772 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21775 * Set the bubble content callback function of a marker class.
21777 * @param clas The marker class.
21778 * @param get The callback function that will return the content.
21780 * Each marker must be associated to a marker class, and it can display a
21781 * a content on a bubble that opens when the user click over the marker.
21782 * The function @p get must return this content object.
21784 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21787 * @see elm_map_marker_class_new() for more details.
21788 * @see elm_map_marker_class_del_cb_set()
21789 * @see elm_map_marker_add()
21793 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21796 * Set the callback function used to delete bubble content of a marker class.
21798 * @param clas The marker class.
21799 * @param del The callback function that will delete the content.
21801 * Each marker must be associated to a marker class, and it can display a
21802 * a content on a bubble that opens when the user click over the marker.
21803 * The function to return such content can be set with
21804 * elm_map_marker_class_get_cb_set().
21806 * If this content must be freed, a callback function need to be
21807 * set for that task with this function.
21809 * If this callback is defined it will have to delete (or not) the
21810 * object inside, but if the callback is not defined the object will be
21811 * destroyed with evas_object_del().
21813 * @see elm_map_marker_class_new() for more details.
21814 * @see elm_map_marker_class_get_cb_set()
21815 * @see elm_map_marker_add()
21819 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21822 * Get the list of available sources.
21824 * @param obj The map object.
21825 * @return The source names list.
21827 * It will provide a list with all available sources, that can be set as
21828 * current source with elm_map_source_name_set(), or get with
21829 * elm_map_source_name_get().
21831 * Available sources:
21837 * @see elm_map_source_name_set() for more details.
21838 * @see elm_map_source_name_get()
21842 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21845 * Set the source of the map.
21847 * @param obj The map object.
21848 * @param source The source to be used.
21850 * Map widget retrieves images that composes the map from a web service.
21851 * This web service can be set with this method.
21853 * A different service can return a different maps with different
21854 * information and it can use different zoom values.
21856 * The @p source_name need to match one of the names provided by
21857 * elm_map_source_names_get().
21859 * The current source can be get using elm_map_source_name_get().
21861 * @see elm_map_source_names_get()
21862 * @see elm_map_source_name_get()
21867 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21870 * Get the name of currently used source.
21872 * @param obj The map object.
21873 * @return Returns the name of the source in use.
21875 * @see elm_map_source_name_set() for more details.
21879 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21882 * Set the source of the route service to be used by the map.
21884 * @param obj The map object.
21885 * @param source The route service to be used, being it one of
21886 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21887 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21889 * Each one has its own algorithm, so the route retrieved may
21890 * differ depending on the source route. Now, only the default is working.
21892 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21893 * http://www.yournavigation.org/.
21895 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21896 * assumptions. Its routing core is based on Contraction Hierarchies.
21898 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21900 * @see elm_map_route_source_get().
21904 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21907 * Get the current route source.
21909 * @param obj The map object.
21910 * @return The source of the route service used by the map.
21912 * @see elm_map_route_source_set() for details.
21916 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21919 * Set the minimum zoom of the source.
21921 * @param obj The map object.
21922 * @param zoom New minimum zoom value to be used.
21924 * By default, it's 0.
21928 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21931 * Get the minimum zoom of the source.
21933 * @param obj The map object.
21934 * @return Returns the minimum zoom of the source.
21936 * @see elm_map_source_zoom_min_set() for details.
21940 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21943 * Set the maximum zoom of the source.
21945 * @param obj The map object.
21946 * @param zoom New maximum zoom value to be used.
21948 * By default, it's 18.
21952 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21955 * Get the maximum zoom of the source.
21957 * @param obj The map object.
21958 * @return Returns the maximum zoom of the source.
21960 * @see elm_map_source_zoom_min_set() for details.
21964 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21967 * Set the user agent used by the map object to access routing services.
21969 * @param obj The map object.
21970 * @param user_agent The user agent to be used by the map.
21972 * User agent is a client application implementing a network protocol used
21973 * in communications within a client–server distributed computing system
21975 * The @p user_agent identification string will transmitted in a header
21976 * field @c User-Agent.
21978 * @see elm_map_user_agent_get()
21982 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21985 * Get the user agent used by the map object.
21987 * @param obj The map object.
21988 * @return The user agent identification string used by the map.
21990 * @see elm_map_user_agent_set() for details.
21994 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21997 * Add a new route to the map object.
21999 * @param obj The map object.
22000 * @param type The type of transport to be considered when tracing a route.
22001 * @param method The routing method, what should be priorized.
22002 * @param flon The start longitude.
22003 * @param flat The start latitude.
22004 * @param tlon The destination longitude.
22005 * @param tlat The destination latitude.
22007 * @return The created route or @c NULL upon failure.
22009 * A route will be traced by point on coordinates (@p flat, @p flon)
22010 * to point on coordinates (@p tlat, @p tlon), using the route service
22011 * set with elm_map_route_source_set().
22013 * It will take @p type on consideration to define the route,
22014 * depending if the user will be walking or driving, the route may vary.
22015 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22016 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22018 * Another parameter is what the route should priorize, the minor distance
22019 * or the less time to be spend on the route. So @p method should be one
22020 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22022 * Routes created with this method can be deleted with
22023 * elm_map_route_remove(), colored with elm_map_route_color_set(),
22024 * and distance can be get with elm_map_route_distance_get().
22026 * @see elm_map_route_remove()
22027 * @see elm_map_route_color_set()
22028 * @see elm_map_route_distance_get()
22029 * @see elm_map_route_source_set()
22033 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);
22036 * Remove a route from the map.
22038 * @param route The route to remove.
22040 * @see elm_map_route_add()
22044 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22047 * Set the route color.
22049 * @param route The route object.
22050 * @param r Red channel value, from 0 to 255.
22051 * @param g Green channel value, from 0 to 255.
22052 * @param b Blue channel value, from 0 to 255.
22053 * @param a Alpha channel value, from 0 to 255.
22055 * It uses an additive color model, so each color channel represents
22056 * how much of each primary colors must to be used. 0 represents
22057 * ausence of this color, so if all of the three are set to 0,
22058 * the color will be black.
22060 * These component values should be integers in the range 0 to 255,
22061 * (single 8-bit byte).
22063 * This sets the color used for the route. By default, it is set to
22064 * solid red (r = 255, g = 0, b = 0, a = 255).
22066 * For alpha channel, 0 represents completely transparent, and 255, opaque.
22068 * @see elm_map_route_color_get()
22072 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22075 * Get the route color.
22077 * @param route The route object.
22078 * @param r Pointer where to store the red channel value.
22079 * @param g Pointer where to store the green channel value.
22080 * @param b Pointer where to store the blue channel value.
22081 * @param a Pointer where to store the alpha channel value.
22083 * @see elm_map_route_color_set() for details.
22087 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22090 * Get the route distance in kilometers.
22092 * @param route The route object.
22093 * @return The distance of route (unit : km).
22097 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22100 * Get the information of route nodes.
22102 * @param route The route object.
22103 * @return Returns a string with the nodes of route.
22107 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22110 * Get the information of route waypoint.
22112 * @param route the route object.
22113 * @return Returns a string with information about waypoint of route.
22117 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22120 * Get the address of the name.
22122 * @param name The name handle.
22123 * @return Returns the address string of @p name.
22125 * This gets the coordinates of the @p name, created with one of the
22126 * conversion functions.
22128 * @see elm_map_utils_convert_name_into_coord()
22129 * @see elm_map_utils_convert_coord_into_name()
22133 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22136 * Get the current coordinates of the name.
22138 * @param name The name handle.
22139 * @param lat Pointer where to store the latitude.
22140 * @param lon Pointer where to store The longitude.
22142 * This gets the coordinates of the @p name, created with one of the
22143 * conversion functions.
22145 * @see elm_map_utils_convert_name_into_coord()
22146 * @see elm_map_utils_convert_coord_into_name()
22150 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22153 * Remove a name from the map.
22155 * @param name The name to remove.
22157 * Basically the struct handled by @p name will be freed, so convertions
22158 * between address and coordinates will be lost.
22160 * @see elm_map_utils_convert_name_into_coord()
22161 * @see elm_map_utils_convert_coord_into_name()
22165 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22170 * @param obj The map object.
22171 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22172 * @param cx Rotation's center horizontal position.
22173 * @param cy Rotation's center vertical position.
22175 * @see elm_map_rotate_get()
22179 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22182 * Get the rotate degree of the map
22184 * @param obj The map object
22185 * @param degree Pointer where to store degrees from 0.0 to 360.0
22186 * to rotate arount Z axis.
22187 * @param cx Pointer where to store rotation's center horizontal position.
22188 * @param cy Pointer where to store rotation's center vertical position.
22190 * @see elm_map_rotate_set() to set map rotation.
22194 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);
22197 * Enable or disable mouse wheel to be used to zoom in / out the map.
22199 * @param obj The map object.
22200 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22203 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22205 * It's disabled by default.
22207 * @see elm_map_wheel_disabled_get()
22211 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22214 * Get a value whether mouse wheel is enabled or not.
22216 * @param obj The map object.
22217 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22218 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22220 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22222 * @see elm_map_wheel_disabled_set() for details.
22226 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22230 * Add a track on the map
22232 * @param obj The map object.
22233 * @param emap The emap route object.
22234 * @return The route object. This is an elm object of type Route.
22236 * @see elm_route_add() for details.
22240 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22244 * Remove a track from the map
22246 * @param obj The map object.
22247 * @param route The track to remove.
22251 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22258 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22260 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22262 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22263 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22264 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22265 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22269 * @defgroup Panel Panel
22271 * @image html img/widget/panel/preview-00.png
22272 * @image latex img/widget/panel/preview-00.eps
22274 * @brief A panel is a type of animated container that contains subobjects.
22275 * It can be expanded or contracted by clicking the button on it's edge.
22277 * Orientations are as follows:
22278 * @li ELM_PANEL_ORIENT_TOP
22279 * @li ELM_PANEL_ORIENT_LEFT
22280 * @li ELM_PANEL_ORIENT_RIGHT
22282 * @ref tutorial_panel shows one way to use this widget.
22285 typedef enum _Elm_Panel_Orient
22287 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22288 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22289 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22290 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22291 } Elm_Panel_Orient;
22293 * @brief Adds a panel object
22295 * @param parent The parent object
22297 * @return The panel object, or NULL on failure
22299 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22301 * @brief Sets the orientation of the panel
22303 * @param parent The parent object
22304 * @param orient The panel orientation. Can be one of the following:
22305 * @li ELM_PANEL_ORIENT_TOP
22306 * @li ELM_PANEL_ORIENT_LEFT
22307 * @li ELM_PANEL_ORIENT_RIGHT
22309 * Sets from where the panel will (dis)appear.
22311 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22313 * @brief Get the orientation of the panel.
22315 * @param obj The panel object
22316 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22318 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22320 * @brief Set the content of the panel.
22322 * @param obj The panel object
22323 * @param content The panel content
22325 * Once the content object is set, a previously set one will be deleted.
22326 * If you want to keep that old content object, use the
22327 * elm_panel_content_unset() function.
22329 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22331 * @brief Get the content of the panel.
22333 * @param obj The panel object
22334 * @return The content that is being used
22336 * Return the content object which is set for this widget.
22338 * @see elm_panel_content_set()
22340 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22342 * @brief Unset the content of the panel.
22344 * @param obj The panel object
22345 * @return The content that was being used
22347 * Unparent and return the content object which was set for this widget.
22349 * @see elm_panel_content_set()
22351 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22353 * @brief Set the state of the panel.
22355 * @param obj The panel object
22356 * @param hidden If true, the panel will run the animation to contract
22358 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22360 * @brief Get the state of the panel.
22362 * @param obj The panel object
22363 * @param hidden If true, the panel is in the "hide" state
22365 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22367 * @brief Toggle the hidden state of the panel from code
22369 * @param obj The panel object
22371 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22377 * @defgroup Panes Panes
22378 * @ingroup Elementary
22380 * @image html img/widget/panes/preview-00.png
22381 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22383 * @image html img/panes.png
22384 * @image latex img/panes.eps width=\textwidth
22386 * The panes adds a dragable bar between two contents. When dragged
22387 * this bar will resize contents size.
22389 * Panes can be displayed vertically or horizontally, and contents
22390 * size proportion can be customized (homogeneous by default).
22392 * Smart callbacks one can listen to:
22393 * - "press" - The panes has been pressed (button wasn't released yet).
22394 * - "unpressed" - The panes was released after being pressed.
22395 * - "clicked" - The panes has been clicked>
22396 * - "clicked,double" - The panes has been double clicked
22398 * Available styles for it:
22401 * Here is an example on its usage:
22402 * @li @ref panes_example
22406 * @addtogroup Panes
22411 * Add a new panes widget to the given parent Elementary
22412 * (container) object.
22414 * @param parent The parent object.
22415 * @return a new panes widget handle or @c NULL, on errors.
22417 * This function inserts a new panes widget on the canvas.
22421 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22424 * Set the left content of the panes widget.
22426 * @param obj The panes object.
22427 * @param content The new left content object.
22429 * Once the content object is set, a previously set one will be deleted.
22430 * If you want to keep that old content object, use the
22431 * elm_panes_content_left_unset() function.
22433 * If panes is displayed vertically, left content will be displayed at
22436 * @see elm_panes_content_left_get()
22437 * @see elm_panes_content_right_set() to set content on the other side.
22441 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22444 * Set the right content of the panes widget.
22446 * @param obj The panes object.
22447 * @param content The new right content object.
22449 * Once the content object is set, a previously set one will be deleted.
22450 * If you want to keep that old content object, use the
22451 * elm_panes_content_right_unset() function.
22453 * If panes is displayed vertically, left content will be displayed at
22456 * @see elm_panes_content_right_get()
22457 * @see elm_panes_content_left_set() to set content on the other side.
22461 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22464 * Get the left content of the panes.
22466 * @param obj The panes object.
22467 * @return The left content object that is being used.
22469 * Return the left content object which is set for this widget.
22471 * @see elm_panes_content_left_set() for details.
22475 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22478 * Get the right content of the panes.
22480 * @param obj The panes object
22481 * @return The right content object that is being used
22483 * Return the right content object which is set for this widget.
22485 * @see elm_panes_content_right_set() for details.
22489 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22492 * Unset the left content used for the panes.
22494 * @param obj The panes object.
22495 * @return The left content object that was being used.
22497 * Unparent and return the left content object which was set for this widget.
22499 * @see elm_panes_content_left_set() for details.
22500 * @see elm_panes_content_left_get().
22504 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22507 * Unset the right content used for the panes.
22509 * @param obj The panes object.
22510 * @return The right content object that was being used.
22512 * Unparent and return the right content object which was set for this
22515 * @see elm_panes_content_right_set() for details.
22516 * @see elm_panes_content_right_get().
22520 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22523 * Get the size proportion of panes widget's left side.
22525 * @param obj The panes object.
22526 * @return float value between 0.0 and 1.0 representing size proportion
22529 * @see elm_panes_content_left_size_set() for more details.
22533 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22536 * Set the size proportion of panes widget's left side.
22538 * @param obj The panes object.
22539 * @param size Value between 0.0 and 1.0 representing size proportion
22542 * By default it's homogeneous, i.e., both sides have the same size.
22544 * If something different is required, it can be set with this function.
22545 * For example, if the left content should be displayed over
22546 * 75% of the panes size, @p size should be passed as @c 0.75.
22547 * This way, right content will be resized to 25% of panes size.
22549 * If displayed vertically, left content is displayed at top, and
22550 * right content at bottom.
22552 * @note This proportion will change when user drags the panes bar.
22554 * @see elm_panes_content_left_size_get()
22558 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22561 * Set the orientation of a given panes widget.
22563 * @param obj The panes object.
22564 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22565 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22567 * Use this function to change how your panes is to be
22568 * disposed: vertically or horizontally.
22570 * By default it's displayed horizontally.
22572 * @see elm_panes_horizontal_get()
22576 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22579 * Retrieve the orientation of a given panes widget.
22581 * @param obj The panes object.
22582 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22583 * @c EINA_FALSE if it's @b vertical (and on errors).
22585 * @see elm_panes_horizontal_set() for more details.
22589 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22596 * @defgroup Flip Flip
22598 * @image html img/widget/flip/preview-00.png
22599 * @image latex img/widget/flip/preview-00.eps
22601 * This widget holds 2 content objects(Evas_Object): one on the front and one
22602 * on the back. It allows you to flip from front to back and vice-versa using
22603 * various animations.
22605 * If either the front or back contents are not set the flip will treat that
22606 * as transparent. So if you wore to set the front content but not the back,
22607 * and then call elm_flip_go() you would see whatever is below the flip.
22609 * For a list of supported animations see elm_flip_go().
22611 * Signals that you can add callbacks for are:
22612 * "animate,begin" - when a flip animation was started
22613 * "animate,done" - when a flip animation is finished
22615 * @ref tutorial_flip show how to use most of the API.
22619 typedef enum _Elm_Flip_Mode
22621 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22622 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22623 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22624 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22625 ELM_FLIP_CUBE_LEFT,
22626 ELM_FLIP_CUBE_RIGHT,
22628 ELM_FLIP_CUBE_DOWN,
22629 ELM_FLIP_PAGE_LEFT,
22630 ELM_FLIP_PAGE_RIGHT,
22634 typedef enum _Elm_Flip_Interaction
22636 ELM_FLIP_INTERACTION_NONE,
22637 ELM_FLIP_INTERACTION_ROTATE,
22638 ELM_FLIP_INTERACTION_CUBE,
22639 ELM_FLIP_INTERACTION_PAGE
22640 } Elm_Flip_Interaction;
22641 typedef enum _Elm_Flip_Direction
22643 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22644 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22645 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22646 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22647 } Elm_Flip_Direction;
22649 * @brief Add a new flip to the parent
22651 * @param parent The parent object
22652 * @return The new object or NULL if it cannot be created
22654 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22656 * @brief Set the front content of the flip widget.
22658 * @param obj The flip object
22659 * @param content The new front content object
22661 * Once the content object is set, a previously set one will be deleted.
22662 * If you want to keep that old content object, use the
22663 * elm_flip_content_front_unset() function.
22665 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22667 * @brief Set the back content of the flip widget.
22669 * @param obj The flip object
22670 * @param content The new back content object
22672 * Once the content object is set, a previously set one will be deleted.
22673 * If you want to keep that old content object, use the
22674 * elm_flip_content_back_unset() function.
22676 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22678 * @brief Get the front content used for the flip
22680 * @param obj The flip object
22681 * @return The front content object that is being used
22683 * Return the front content object which is set for this widget.
22685 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22687 * @brief Get the back content used for the flip
22689 * @param obj The flip object
22690 * @return The back content object that is being used
22692 * Return the back content object which is set for this widget.
22694 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22696 * @brief Unset the front content used for the flip
22698 * @param obj The flip object
22699 * @return The front content object that was being used
22701 * Unparent and return the front content object which was set for this widget.
22703 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22705 * @brief Unset the back content used for the flip
22707 * @param obj The flip object
22708 * @return The back content object that was being used
22710 * Unparent and return the back content object which was set for this widget.
22712 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22714 * @brief Get flip front visibility state
22716 * @param obj The flip objct
22717 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22720 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22722 * @brief Set flip perspective
22724 * @param obj The flip object
22725 * @param foc The coordinate to set the focus on
22726 * @param x The X coordinate
22727 * @param y The Y coordinate
22729 * @warning This function currently does nothing.
22731 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22733 * @brief Runs the flip animation
22735 * @param obj The flip object
22736 * @param mode The mode type
22738 * Flips the front and back contents using the @p mode animation. This
22739 * efectively hides the currently visible content and shows the hidden one.
22741 * There a number of possible animations to use for the flipping:
22742 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22743 * around a horizontal axis in the middle of its height, the other content
22744 * is shown as the other side of the flip.
22745 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22746 * around a vertical axis in the middle of its width, the other content is
22747 * shown as the other side of the flip.
22748 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22749 * around a diagonal axis in the middle of its width, the other content is
22750 * shown as the other side of the flip.
22751 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22752 * around a diagonal axis in the middle of its height, the other content is
22753 * shown as the other side of the flip.
22754 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22755 * as if the flip was a cube, the other content is show as the right face of
22757 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22758 * right as if the flip was a cube, the other content is show as the left
22759 * face of the cube.
22760 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22761 * flip was a cube, the other content is show as the bottom face of the cube.
22762 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22763 * the flip was a cube, the other content is show as the upper face of the
22765 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22766 * if the flip was a book, the other content is shown as the page below that.
22767 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22768 * as if the flip was a book, the other content is shown as the page below
22770 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22771 * flip was a book, the other content is shown as the page below that.
22772 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22773 * flip was a book, the other content is shown as the page below that.
22775 * @image html elm_flip.png
22776 * @image latex elm_flip.eps width=\textwidth
22778 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22780 * @brief Set the interactive flip mode
22782 * @param obj The flip object
22783 * @param mode The interactive flip mode to use
22785 * This sets if the flip should be interactive (allow user to click and
22786 * drag a side of the flip to reveal the back page and cause it to flip).
22787 * By default a flip is not interactive. You may also need to set which
22788 * sides of the flip are "active" for flipping and how much space they use
22789 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22790 * and elm_flip_interacton_direction_hitsize_set()
22792 * The four avilable mode of interaction are:
22793 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22794 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22795 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22796 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22798 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22799 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22800 * happen, those can only be acheived with elm_flip_go();
22802 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22804 * @brief Get the interactive flip mode
22806 * @param obj The flip object
22807 * @return The interactive flip mode
22809 * Returns the interactive flip mode set by elm_flip_interaction_set()
22811 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22813 * @brief Set which directions of the flip respond to interactive flip
22815 * @param obj The flip object
22816 * @param dir The direction to change
22817 * @param enabled If that direction is enabled or not
22819 * By default all directions are disabled, so you may want to enable the
22820 * desired directions for flipping if you need interactive flipping. You must
22821 * call this function once for each direction that should be enabled.
22823 * @see elm_flip_interaction_set()
22825 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22827 * @brief Get the enabled state of that flip direction
22829 * @param obj The flip object
22830 * @param dir The direction to check
22831 * @return If that direction is enabled or not
22833 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22835 * @see elm_flip_interaction_set()
22837 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22839 * @brief Set the amount of the flip that is sensitive to interactive flip
22841 * @param obj The flip object
22842 * @param dir The direction to modify
22843 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22845 * Set the amount of the flip that is sensitive to interactive flip, with 0
22846 * representing no area in the flip and 1 representing the entire flip. There
22847 * is however a consideration to be made in that the area will never be
22848 * smaller than the finger size set(as set in your Elementary configuration).
22850 * @see elm_flip_interaction_set()
22852 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22854 * @brief Get the amount of the flip that is sensitive to interactive flip
22856 * @param obj The flip object
22857 * @param dir The direction to check
22858 * @return The size set for that direction
22860 * Returns the amount os sensitive area set by
22861 * elm_flip_interacton_direction_hitsize_set().
22863 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22868 /* scrolledentry */
22869 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22870 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22871 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22872 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22873 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22874 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22875 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22876 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22877 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22878 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22879 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22880 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22881 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22882 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22883 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22884 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22885 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22886 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22887 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22888 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22889 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22890 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22891 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22892 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22893 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22894 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22895 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22896 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22897 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22898 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22899 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22900 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22901 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22902 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22903 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22904 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);
22905 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22906 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22907 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);
22908 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22909 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);
22910 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22911 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22912 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22913 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22914 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22915 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22916 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22917 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22918 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);
22919 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);
22920 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);
22921 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);
22922 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);
22923 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);
22924 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22925 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22926 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22927 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22928 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22929 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22930 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22933 * @defgroup Conformant Conformant
22934 * @ingroup Elementary
22936 * @image html img/widget/conformant/preview-00.png
22937 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22939 * @image html img/conformant.png
22940 * @image latex img/conformant.eps width=\textwidth
22942 * The aim is to provide a widget that can be used in elementary apps to
22943 * account for space taken up by the indicator, virtual keypad & softkey
22944 * windows when running the illume2 module of E17.
22946 * So conformant content will be sized and positioned considering the
22947 * space required for such stuff, and when they popup, as a keyboard
22948 * shows when an entry is selected, conformant content won't change.
22950 * Available styles for it:
22953 * See how to use this widget in this example:
22954 * @ref conformant_example
22958 * @addtogroup Conformant
22963 * Add a new conformant widget to the given parent Elementary
22964 * (container) object.
22966 * @param parent The parent object.
22967 * @return A new conformant widget handle or @c NULL, on errors.
22969 * This function inserts a new conformant widget on the canvas.
22971 * @ingroup Conformant
22973 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22976 * Set the content of the conformant widget.
22978 * @param obj The conformant object.
22979 * @param content The content to be displayed by the conformant.
22981 * Content will be sized and positioned considering the space required
22982 * to display a virtual keyboard. So it won't fill all the conformant
22983 * size. This way is possible to be sure that content won't resize
22984 * or be re-positioned after the keyboard is displayed.
22986 * Once the content object is set, a previously set one will be deleted.
22987 * If you want to keep that old content object, use the
22988 * elm_conformat_content_unset() function.
22990 * @see elm_conformant_content_unset()
22991 * @see elm_conformant_content_get()
22993 * @ingroup Conformant
22995 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22998 * Get the content of the conformant widget.
23000 * @param obj The conformant object.
23001 * @return The content that is being used.
23003 * Return the content object which is set for this widget.
23004 * It won't be unparent from conformant. For that, use
23005 * elm_conformant_content_unset().
23007 * @see elm_conformant_content_set() for more details.
23008 * @see elm_conformant_content_unset()
23010 * @ingroup Conformant
23012 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23015 * Unset the content of the conformant widget.
23017 * @param obj The conformant object.
23018 * @return The content that was being used.
23020 * Unparent and return the content object which was set for this widget.
23022 * @see elm_conformant_content_set() for more details.
23024 * @ingroup Conformant
23026 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23029 * Returns the Evas_Object that represents the content area.
23031 * @param obj The conformant object.
23032 * @return The content area of the widget.
23034 * @ingroup Conformant
23036 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23043 * @defgroup Mapbuf Mapbuf
23044 * @ingroup Elementary
23046 * @image html img/widget/mapbuf/preview-00.png
23047 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23049 * This holds one content object and uses an Evas Map of transformation
23050 * points to be later used with this content. So the content will be
23051 * moved, resized, etc as a single image. So it will improve performance
23052 * when you have a complex interafce, with a lot of elements, and will
23053 * need to resize or move it frequently (the content object and its
23056 * See how to use this widget in this example:
23057 * @ref mapbuf_example
23061 * @addtogroup Mapbuf
23066 * Add a new mapbuf widget to the given parent Elementary
23067 * (container) object.
23069 * @param parent The parent object.
23070 * @return A new mapbuf widget handle or @c NULL, on errors.
23072 * This function inserts a new mapbuf widget on the canvas.
23076 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23079 * Set the content of the mapbuf.
23081 * @param obj The mapbuf object.
23082 * @param content The content that will be filled in this mapbuf object.
23084 * Once the content object is set, a previously set one will be deleted.
23085 * If you want to keep that old content object, use the
23086 * elm_mapbuf_content_unset() function.
23088 * To enable map, elm_mapbuf_enabled_set() should be used.
23092 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23095 * Get the content of the mapbuf.
23097 * @param obj The mapbuf object.
23098 * @return The content that is being used.
23100 * Return the content object which is set for this widget.
23102 * @see elm_mapbuf_content_set() for details.
23106 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23109 * Unset the content of the mapbuf.
23111 * @param obj The mapbuf object.
23112 * @return The content that was being used.
23114 * Unparent and return the content object which was set for this widget.
23116 * @see elm_mapbuf_content_set() for details.
23120 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23123 * Enable or disable the map.
23125 * @param obj The mapbuf object.
23126 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23128 * This enables the map that is set or disables it. On enable, the object
23129 * geometry will be saved, and the new geometry will change (position and
23130 * size) to reflect the map geometry set.
23132 * Also, when enabled, alpha and smooth states will be used, so if the
23133 * content isn't solid, alpha should be enabled, for example, otherwise
23134 * a black retangle will fill the content.
23136 * When disabled, the stored map will be freed and geometry prior to
23137 * enabling the map will be restored.
23139 * It's disabled by default.
23141 * @see elm_mapbuf_alpha_set()
23142 * @see elm_mapbuf_smooth_set()
23146 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23149 * Get a value whether map is enabled or not.
23151 * @param obj The mapbuf object.
23152 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23153 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23155 * @see elm_mapbuf_enabled_set() for details.
23159 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23162 * Enable or disable smooth map rendering.
23164 * @param obj The mapbuf object.
23165 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23168 * This sets smoothing for map rendering. If the object is a type that has
23169 * its own smoothing settings, then both the smooth settings for this object
23170 * and the map must be turned off.
23172 * By default smooth maps are enabled.
23176 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23179 * Get a value whether smooth map rendering is enabled or not.
23181 * @param obj The mapbuf object.
23182 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23183 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23185 * @see elm_mapbuf_smooth_set() for details.
23189 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23192 * Set or unset alpha flag for map rendering.
23194 * @param obj The mapbuf object.
23195 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23198 * This sets alpha flag for map rendering. If the object is a type that has
23199 * its own alpha settings, then this will take precedence. Only image objects
23200 * have this currently. It stops alpha blending of the map area, and is
23201 * useful if you know the object and/or all sub-objects is 100% solid.
23203 * Alpha is enabled by default.
23207 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23210 * Get a value whether alpha blending is enabled or not.
23212 * @param obj The mapbuf object.
23213 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23214 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23216 * @see elm_mapbuf_alpha_set() for details.
23220 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23227 * @defgroup Flipselector Flip Selector
23229 * @image html img/widget/flipselector/preview-00.png
23230 * @image latex img/widget/flipselector/preview-00.eps
23232 * A flip selector is a widget to show a set of @b text items, one
23233 * at a time, with the same sheet switching style as the @ref Clock
23234 * "clock" widget, when one changes the current displaying sheet
23235 * (thus, the "flip" in the name).
23237 * User clicks to flip sheets which are @b held for some time will
23238 * make the flip selector to flip continuosly and automatically for
23239 * the user. The interval between flips will keep growing in time,
23240 * so that it helps the user to reach an item which is distant from
23241 * the current selection.
23243 * Smart callbacks one can register to:
23244 * - @c "selected" - when the widget's selected text item is changed
23245 * - @c "overflowed" - when the widget's current selection is changed
23246 * from the first item in its list to the last
23247 * - @c "underflowed" - when the widget's current selection is changed
23248 * from the last item in its list to the first
23250 * Available styles for it:
23253 * Here is an example on its usage:
23254 * @li @ref flipselector_example
23258 * @addtogroup Flipselector
23262 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23265 * Add a new flip selector widget to the given parent Elementary
23266 * (container) widget
23268 * @param parent The parent object
23269 * @return a new flip selector widget handle or @c NULL, on errors
23271 * This function inserts a new flip selector widget on the canvas.
23273 * @ingroup Flipselector
23275 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23278 * Programmatically select the next item of a flip selector widget
23280 * @param obj The flipselector object
23282 * @note The selection will be animated. Also, if it reaches the
23283 * end of its list of member items, it will continue with the first
23286 * @ingroup Flipselector
23288 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23291 * Programmatically select the previous item of a flip selector
23294 * @param obj The flipselector object
23296 * @note The selection will be animated. Also, if it reaches the
23297 * beginning of its list of member items, it will continue with the
23298 * last one backwards.
23300 * @ingroup Flipselector
23302 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23305 * Append a (text) item to a flip selector widget
23307 * @param obj The flipselector object
23308 * @param label The (text) label of the new item
23309 * @param func Convenience callback function to take place when
23311 * @param data Data passed to @p func, above
23312 * @return A handle to the item added or @c NULL, on errors
23314 * The widget's list of labels to show will be appended with the
23315 * given value. If the user wishes so, a callback function pointer
23316 * can be passed, which will get called when this same item is
23319 * @note The current selection @b won't be modified by appending an
23320 * element to the list.
23322 * @note The maximum length of the text label is going to be
23323 * determined <b>by the widget's theme</b>. Strings larger than
23324 * that value are going to be @b truncated.
23326 * @ingroup Flipselector
23328 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23331 * Prepend a (text) item to a flip selector widget
23333 * @param obj The flipselector object
23334 * @param label The (text) label of the new item
23335 * @param func Convenience callback function to take place when
23337 * @param data Data passed to @p func, above
23338 * @return A handle to the item added or @c NULL, on errors
23340 * The widget's list of labels to show will be prepended with the
23341 * given value. If the user wishes so, a callback function pointer
23342 * can be passed, which will get called when this same item is
23345 * @note The current selection @b won't be modified by prepending
23346 * an element to the list.
23348 * @note The maximum length of the text label is going to be
23349 * determined <b>by the widget's theme</b>. Strings larger than
23350 * that value are going to be @b truncated.
23352 * @ingroup Flipselector
23354 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23357 * Get the internal list of items in a given flip selector widget.
23359 * @param obj The flipselector object
23360 * @return The list of items (#Elm_Flipselector_Item as data) or
23361 * @c NULL on errors.
23363 * This list is @b not to be modified in any way and must not be
23364 * freed. Use the list members with functions like
23365 * elm_flipselector_item_label_set(),
23366 * elm_flipselector_item_label_get(),
23367 * elm_flipselector_item_del(),
23368 * elm_flipselector_item_selected_get(),
23369 * elm_flipselector_item_selected_set().
23371 * @warning This list is only valid until @p obj object's internal
23372 * items list is changed. It should be fetched again with another
23373 * call to this function when changes happen.
23375 * @ingroup Flipselector
23377 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23380 * Get the first item in the given flip selector widget's list of
23383 * @param obj The flipselector object
23384 * @return The first item or @c NULL, if it has no items (and on
23387 * @see elm_flipselector_item_append()
23388 * @see elm_flipselector_last_item_get()
23390 * @ingroup Flipselector
23392 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23395 * Get the last item in the given flip selector widget's list of
23398 * @param obj The flipselector object
23399 * @return The last item or @c NULL, if it has no items (and on
23402 * @see elm_flipselector_item_prepend()
23403 * @see elm_flipselector_first_item_get()
23405 * @ingroup Flipselector
23407 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23410 * Get the currently selected item in a flip selector widget.
23412 * @param obj The flipselector object
23413 * @return The selected item or @c NULL, if the widget has no items
23416 * @ingroup Flipselector
23418 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23421 * Set whether a given flip selector widget's item should be the
23422 * currently selected one.
23424 * @param item The flip selector item
23425 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23427 * This sets whether @p item is or not the selected (thus, under
23428 * display) one. If @p item is different than one under display,
23429 * the latter will be unselected. If the @p item is set to be
23430 * unselected, on the other hand, the @b first item in the widget's
23431 * internal members list will be the new selected one.
23433 * @see elm_flipselector_item_selected_get()
23435 * @ingroup Flipselector
23437 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23440 * Get whether a given flip selector widget's item is the currently
23443 * @param item The flip selector item
23444 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23447 * @see elm_flipselector_item_selected_set()
23449 * @ingroup Flipselector
23451 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23454 * Delete a given item from a flip selector widget.
23456 * @param item The item to delete
23458 * @ingroup Flipselector
23460 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23463 * Get the label of a given flip selector widget's item.
23465 * @param item The item to get label from
23466 * @return The text label of @p item or @c NULL, on errors
23468 * @see elm_flipselector_item_label_set()
23470 * @ingroup Flipselector
23472 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23475 * Set the label of a given flip selector widget's item.
23477 * @param item The item to set label on
23478 * @param label The text label string, in UTF-8 encoding
23480 * @see elm_flipselector_item_label_get()
23482 * @ingroup Flipselector
23484 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23487 * Gets the item before @p item in a flip selector widget's
23488 * internal list of items.
23490 * @param item The item to fetch previous from
23491 * @return The item before the @p item, in its parent's list. If
23492 * there is no previous item for @p item or there's an
23493 * error, @c NULL is returned.
23495 * @see elm_flipselector_item_next_get()
23497 * @ingroup Flipselector
23499 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23502 * Gets the item after @p item in a flip selector widget's
23503 * internal list of items.
23505 * @param item The item to fetch next from
23506 * @return The item after the @p item, in its parent's list. If
23507 * there is no next item for @p item or there's an
23508 * error, @c NULL is returned.
23510 * @see elm_flipselector_item_next_get()
23512 * @ingroup Flipselector
23514 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23517 * Set the interval on time updates for an user mouse button hold
23518 * on a flip selector widget.
23520 * @param obj The flip selector object
23521 * @param interval The (first) interval value in seconds
23523 * This interval value is @b decreased while the user holds the
23524 * mouse pointer either flipping up or flipping doww a given flip
23527 * This helps the user to get to a given item distant from the
23528 * current one easier/faster, as it will start to flip quicker and
23529 * quicker on mouse button holds.
23531 * The calculation for the next flip interval value, starting from
23532 * the one set with this call, is the previous interval divided by
23533 * 1.05, so it decreases a little bit.
23535 * The default starting interval value for automatic flips is
23538 * @see elm_flipselector_interval_get()
23540 * @ingroup Flipselector
23542 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23545 * Get the interval on time updates for an user mouse button hold
23546 * on a flip selector widget.
23548 * @param obj The flip selector object
23549 * @return The (first) interval value, in seconds, set on it
23551 * @see elm_flipselector_interval_set() for more details
23553 * @ingroup Flipselector
23555 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23561 * @addtogroup Calendar
23566 * @enum _Elm_Calendar_Mark_Repeat
23567 * @typedef Elm_Calendar_Mark_Repeat
23569 * Event periodicity, used to define if a mark should be repeated
23570 * @b beyond event's day. It's set when a mark is added.
23572 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23573 * there will be marks every week after this date. Marks will be displayed
23574 * at 13th, 20th, 27th, 3rd June ...
23576 * Values don't work as bitmask, only one can be choosen.
23578 * @see elm_calendar_mark_add()
23580 * @ingroup Calendar
23582 typedef enum _Elm_Calendar_Mark_Repeat
23584 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23585 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23586 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23587 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*/
23588 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. */
23589 } Elm_Calendar_Mark_Repeat;
23591 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(). */
23594 * Add a new calendar widget to the given parent Elementary
23595 * (container) object.
23597 * @param parent The parent object.
23598 * @return a new calendar widget handle or @c NULL, on errors.
23600 * This function inserts a new calendar widget on the canvas.
23602 * @ref calendar_example_01
23604 * @ingroup Calendar
23606 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23609 * Get weekdays names displayed by the calendar.
23611 * @param obj The calendar object.
23612 * @return Array of seven strings to be used as weekday names.
23614 * By default, weekdays abbreviations get from system are displayed:
23615 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23616 * The first string is related to Sunday, the second to Monday...
23618 * @see elm_calendar_weekdays_name_set()
23620 * @ref calendar_example_05
23622 * @ingroup Calendar
23624 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23627 * Set weekdays names to be displayed by the calendar.
23629 * @param obj The calendar object.
23630 * @param weekdays Array of seven strings to be used as weekday names.
23631 * @warning It must have 7 elements, or it will access invalid memory.
23632 * @warning The strings must be NULL terminated ('@\0').
23634 * By default, weekdays abbreviations get from system are displayed:
23635 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23637 * The first string should be related to Sunday, the second to Monday...
23639 * The usage should be like this:
23641 * const char *weekdays[] =
23643 * "Sunday", "Monday", "Tuesday", "Wednesday",
23644 * "Thursday", "Friday", "Saturday"
23646 * elm_calendar_weekdays_names_set(calendar, weekdays);
23649 * @see elm_calendar_weekdays_name_get()
23651 * @ref calendar_example_02
23653 * @ingroup Calendar
23655 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23658 * Set the minimum and maximum values for the year
23660 * @param obj The calendar object
23661 * @param min The minimum year, greater than 1901;
23662 * @param max The maximum year;
23664 * Maximum must be greater than minimum, except if you don't wan't to set
23666 * Default values are 1902 and -1.
23668 * If the maximum year is a negative value, it will be limited depending
23669 * on the platform architecture (year 2037 for 32 bits);
23671 * @see elm_calendar_min_max_year_get()
23673 * @ref calendar_example_03
23675 * @ingroup Calendar
23677 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23680 * Get the minimum and maximum values for the year
23682 * @param obj The calendar object.
23683 * @param min The minimum year.
23684 * @param max The maximum year.
23686 * Default values are 1902 and -1.
23688 * @see elm_calendar_min_max_year_get() for more details.
23690 * @ref calendar_example_05
23692 * @ingroup Calendar
23694 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23697 * Enable or disable day selection
23699 * @param obj The calendar object.
23700 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23703 * Enabled by default. If disabled, the user still can select months,
23704 * but not days. Selected days are highlighted on calendar.
23705 * It should be used if you won't need such selection for the widget usage.
23707 * When a day is selected, or month is changed, smart callbacks for
23708 * signal "changed" will be called.
23710 * @see elm_calendar_day_selection_enable_get()
23712 * @ref calendar_example_04
23714 * @ingroup Calendar
23716 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23719 * Get a value whether day selection is enabled or not.
23721 * @see elm_calendar_day_selection_enable_set() for details.
23723 * @param obj The calendar object.
23724 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23725 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23727 * @ref calendar_example_05
23729 * @ingroup Calendar
23731 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23735 * Set selected date to be highlighted on calendar.
23737 * @param obj The calendar object.
23738 * @param selected_time A @b tm struct to represent the selected date.
23740 * Set the selected date, changing the displayed month if needed.
23741 * Selected date changes when the user goes to next/previous month or
23742 * select a day pressing over it on calendar.
23744 * @see elm_calendar_selected_time_get()
23746 * @ref calendar_example_04
23748 * @ingroup Calendar
23750 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23753 * Get selected date.
23755 * @param obj The calendar object
23756 * @param selected_time A @b tm struct to point to selected date
23757 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23760 * Get date selected by the user or set by function
23761 * elm_calendar_selected_time_set().
23762 * Selected date changes when the user goes to next/previous month or
23763 * select a day pressing over it on calendar.
23765 * @see elm_calendar_selected_time_get()
23767 * @ref calendar_example_05
23769 * @ingroup Calendar
23771 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23774 * Set a function to format the string that will be used to display
23777 * @param obj The calendar object
23778 * @param format_function Function to set the month-year string given
23779 * the selected date
23781 * By default it uses strftime with "%B %Y" format string.
23782 * It should allocate the memory that will be used by the string,
23783 * that will be freed by the widget after usage.
23784 * A pointer to the string and a pointer to the time struct will be provided.
23789 * _format_month_year(struct tm *selected_time)
23792 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23793 * return strdup(buf);
23796 * elm_calendar_format_function_set(calendar, _format_month_year);
23799 * @ref calendar_example_02
23801 * @ingroup Calendar
23803 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23806 * Add a new mark to the calendar
23808 * @param obj The calendar object
23809 * @param mark_type A string used to define the type of mark. It will be
23810 * emitted to the theme, that should display a related modification on these
23811 * days representation.
23812 * @param mark_time A time struct to represent the date of inclusion of the
23813 * mark. For marks that repeats it will just be displayed after the inclusion
23814 * date in the calendar.
23815 * @param repeat Repeat the event following this periodicity. Can be a unique
23816 * mark (that don't repeat), daily, weekly, monthly or annually.
23817 * @return The created mark or @p NULL upon failure.
23819 * Add a mark that will be drawn in the calendar respecting the insertion
23820 * time and periodicity. It will emit the type as signal to the widget theme.
23821 * Default theme supports "holiday" and "checked", but it can be extended.
23823 * It won't immediately update the calendar, drawing the marks.
23824 * For this, call elm_calendar_marks_draw(). However, when user selects
23825 * next or previous month calendar forces marks drawn.
23827 * Marks created with this method can be deleted with
23828 * elm_calendar_mark_del().
23832 * struct tm selected_time;
23833 * time_t current_time;
23835 * current_time = time(NULL) + 5 * 84600;
23836 * localtime_r(¤t_time, &selected_time);
23837 * elm_calendar_mark_add(cal, "holiday", selected_time,
23838 * ELM_CALENDAR_ANNUALLY);
23840 * current_time = time(NULL) + 1 * 84600;
23841 * localtime_r(¤t_time, &selected_time);
23842 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23844 * elm_calendar_marks_draw(cal);
23847 * @see elm_calendar_marks_draw()
23848 * @see elm_calendar_mark_del()
23850 * @ref calendar_example_06
23852 * @ingroup Calendar
23854 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);
23857 * Delete mark from the calendar.
23859 * @param mark The mark to be deleted.
23861 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23862 * should be used instead of getting marks list and deleting each one.
23864 * @see elm_calendar_mark_add()
23866 * @ref calendar_example_06
23868 * @ingroup Calendar
23870 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23873 * Remove all calendar's marks
23875 * @param obj The calendar object.
23877 * @see elm_calendar_mark_add()
23878 * @see elm_calendar_mark_del()
23880 * @ingroup Calendar
23882 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23886 * Get a list of all the calendar marks.
23888 * @param obj The calendar object.
23889 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23891 * @see elm_calendar_mark_add()
23892 * @see elm_calendar_mark_del()
23893 * @see elm_calendar_marks_clear()
23895 * @ingroup Calendar
23897 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23900 * Draw calendar marks.
23902 * @param obj The calendar object.
23904 * Should be used after adding, removing or clearing marks.
23905 * It will go through the entire marks list updating the calendar.
23906 * If lots of marks will be added, add all the marks and then call
23909 * When the month is changed, i.e. user selects next or previous month,
23910 * marks will be drawed.
23912 * @see elm_calendar_mark_add()
23913 * @see elm_calendar_mark_del()
23914 * @see elm_calendar_marks_clear()
23916 * @ref calendar_example_06
23918 * @ingroup Calendar
23920 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23923 * Set a day text color to the same that represents Saturdays.
23925 * @param obj The calendar object.
23926 * @param pos The text position. Position is the cell counter, from left
23927 * to right, up to down. It starts on 0 and ends on 41.
23929 * @deprecated use elm_calendar_mark_add() instead like:
23932 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23933 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23936 * @see elm_calendar_mark_add()
23938 * @ingroup Calendar
23940 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23943 * Set a day text color to the same that represents Sundays.
23945 * @param obj The calendar object.
23946 * @param pos The text position. Position is the cell counter, from left
23947 * to right, up to down. It starts on 0 and ends on 41.
23949 * @deprecated use elm_calendar_mark_add() instead like:
23952 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23953 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23956 * @see elm_calendar_mark_add()
23958 * @ingroup Calendar
23960 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23963 * Set a day text color to the same that represents Weekdays.
23965 * @param obj The calendar object
23966 * @param pos The text position. Position is the cell counter, from left
23967 * to right, up to down. It starts on 0 and ends on 41.
23969 * @deprecated use elm_calendar_mark_add() instead like:
23972 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23974 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23975 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23976 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23977 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23978 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23979 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23980 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23981 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23982 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23985 * @see elm_calendar_mark_add()
23987 * @ingroup Calendar
23989 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23992 * Set the interval on time updates for an user mouse button hold
23993 * on calendar widgets' month selection.
23995 * @param obj The calendar object
23996 * @param interval The (first) interval value in seconds
23998 * This interval value is @b decreased while the user holds the
23999 * mouse pointer either selecting next or previous month.
24001 * This helps the user to get to a given month distant from the
24002 * current one easier/faster, as it will start to change quicker and
24003 * quicker on mouse button holds.
24005 * The calculation for the next change interval value, starting from
24006 * the one set with this call, is the previous interval divided by
24007 * 1.05, so it decreases a little bit.
24009 * The default starting interval value for automatic changes is
24012 * @see elm_calendar_interval_get()
24014 * @ingroup Calendar
24016 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24019 * Get the interval on time updates for an user mouse button hold
24020 * on calendar widgets' month selection.
24022 * @param obj The calendar object
24023 * @return The (first) interval value, in seconds, set on it
24025 * @see elm_calendar_interval_set() for more details
24027 * @ingroup Calendar
24029 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24036 * @defgroup Diskselector Diskselector
24037 * @ingroup Elementary
24039 * @image html img/widget/diskselector/preview-00.png
24040 * @image latex img/widget/diskselector/preview-00.eps
24042 * A diskselector is a kind of list widget. It scrolls horizontally,
24043 * and can contain label and icon objects. Three items are displayed
24044 * with the selected one in the middle.
24046 * It can act like a circular list with round mode and labels can be
24047 * reduced for a defined length for side items.
24049 * Smart callbacks one can listen to:
24050 * - "selected" - when item is selected, i.e. scroller stops.
24052 * Available styles for it:
24055 * List of examples:
24056 * @li @ref diskselector_example_01
24057 * @li @ref diskselector_example_02
24061 * @addtogroup Diskselector
24065 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(). */
24068 * Add a new diskselector widget to the given parent Elementary
24069 * (container) object.
24071 * @param parent The parent object.
24072 * @return a new diskselector widget handle or @c NULL, on errors.
24074 * This function inserts a new diskselector widget on the canvas.
24076 * @ingroup Diskselector
24078 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24081 * Enable or disable round mode.
24083 * @param obj The diskselector object.
24084 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24087 * Disabled by default. If round mode is enabled the items list will
24088 * work like a circle list, so when the user reaches the last item,
24089 * the first one will popup.
24091 * @see elm_diskselector_round_get()
24093 * @ingroup Diskselector
24095 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24098 * Get a value whether round mode is enabled or not.
24100 * @see elm_diskselector_round_set() for details.
24102 * @param obj The diskselector object.
24103 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24104 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24106 * @ingroup Diskselector
24108 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24111 * Get the side labels max length.
24113 * @deprecated use elm_diskselector_side_label_length_get() instead:
24115 * @param obj The diskselector object.
24116 * @return The max length defined for side labels, or 0 if not a valid
24119 * @ingroup Diskselector
24121 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24124 * Set the side labels max length.
24126 * @deprecated use elm_diskselector_side_label_length_set() instead:
24128 * @param obj The diskselector object.
24129 * @param len The max length defined for side labels.
24131 * @ingroup Diskselector
24133 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24136 * Get the side labels max length.
24138 * @see elm_diskselector_side_label_length_set() for details.
24140 * @param obj The diskselector object.
24141 * @return The max length defined for side labels, or 0 if not a valid
24144 * @ingroup Diskselector
24146 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24149 * Set the side labels max length.
24151 * @param obj The diskselector object.
24152 * @param len The max length defined for side labels.
24154 * Length is the number of characters of items' label that will be
24155 * visible when it's set on side positions. It will just crop
24156 * the string after defined size. E.g.:
24158 * An item with label "January" would be displayed on side position as
24159 * "Jan" if max length is set to 3, or "Janu", if this property
24162 * When it's selected, the entire label will be displayed, except for
24163 * width restrictions. In this case label will be cropped and "..."
24164 * will be concatenated.
24166 * Default side label max length is 3.
24168 * This property will be applyed over all items, included before or
24169 * later this function call.
24171 * @ingroup Diskselector
24173 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24176 * Set the number of items to be displayed.
24178 * @param obj The diskselector object.
24179 * @param num The number of items the diskselector will display.
24181 * Default value is 3, and also it's the minimun. If @p num is less
24182 * than 3, it will be set to 3.
24184 * Also, it can be set on theme, using data item @c display_item_num
24185 * on group "elm/diskselector/item/X", where X is style set.
24188 * group { name: "elm/diskselector/item/X";
24190 * item: "display_item_num" "5";
24193 * @ingroup Diskselector
24195 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24198 * Get the number of items in the diskselector object.
24200 * @param obj The diskselector object.
24202 * @ingroup Diskselector
24204 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24207 * Set bouncing behaviour when the scrolled content reaches an edge.
24209 * Tell the internal scroller object whether it should bounce or not
24210 * when it reaches the respective edges for each axis.
24212 * @param obj The diskselector object.
24213 * @param h_bounce Whether to bounce or not in the horizontal axis.
24214 * @param v_bounce Whether to bounce or not in the vertical axis.
24216 * @see elm_scroller_bounce_set()
24218 * @ingroup Diskselector
24220 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24223 * Get the bouncing behaviour of the internal scroller.
24225 * Get whether the internal scroller should bounce when the edge of each
24226 * axis is reached scrolling.
24228 * @param obj The diskselector object.
24229 * @param h_bounce Pointer where to store the bounce state of the horizontal
24231 * @param v_bounce Pointer where to store the bounce state of the vertical
24234 * @see elm_scroller_bounce_get()
24235 * @see elm_diskselector_bounce_set()
24237 * @ingroup Diskselector
24239 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24242 * Get the scrollbar policy.
24244 * @see elm_diskselector_scroller_policy_get() for details.
24246 * @param obj The diskselector object.
24247 * @param policy_h Pointer where to store horizontal scrollbar policy.
24248 * @param policy_v Pointer where to store vertical scrollbar policy.
24250 * @ingroup Diskselector
24252 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);
24255 * Set the scrollbar policy.
24257 * @param obj The diskselector object.
24258 * @param policy_h Horizontal scrollbar policy.
24259 * @param policy_v Vertical scrollbar policy.
24261 * This sets the scrollbar visibility policy for the given scroller.
24262 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24263 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24264 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24265 * This applies respectively for the horizontal and vertical scrollbars.
24267 * The both are disabled by default, i.e., are set to
24268 * #ELM_SCROLLER_POLICY_OFF.
24270 * @ingroup Diskselector
24272 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24275 * Remove all diskselector's items.
24277 * @param obj The diskselector object.
24279 * @see elm_diskselector_item_del()
24280 * @see elm_diskselector_item_append()
24282 * @ingroup Diskselector
24284 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24287 * Get a list of all the diskselector items.
24289 * @param obj The diskselector object.
24290 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24291 * or @c NULL on failure.
24293 * @see elm_diskselector_item_append()
24294 * @see elm_diskselector_item_del()
24295 * @see elm_diskselector_clear()
24297 * @ingroup Diskselector
24299 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24302 * Appends a new item to the diskselector object.
24304 * @param obj The diskselector object.
24305 * @param label The label of the diskselector item.
24306 * @param icon The icon object to use at left side of the item. An
24307 * icon can be any Evas object, but usually it is an icon created
24308 * with elm_icon_add().
24309 * @param func The function to call when the item is selected.
24310 * @param data The data to associate with the item for related callbacks.
24312 * @return The created item or @c NULL upon failure.
24314 * A new item will be created and appended to the diskselector, i.e., will
24315 * be set as last item. Also, if there is no selected item, it will
24316 * be selected. This will always happens for the first appended item.
24318 * If no icon is set, label will be centered on item position, otherwise
24319 * the icon will be placed at left of the label, that will be shifted
24322 * Items created with this method can be deleted with
24323 * elm_diskselector_item_del().
24325 * Associated @p data can be properly freed when item is deleted if a
24326 * callback function is set with elm_diskselector_item_del_cb_set().
24328 * If a function is passed as argument, it will be called everytime this item
24329 * is selected, i.e., the user stops the diskselector with this
24330 * item on center position. If such function isn't needed, just passing
24331 * @c NULL as @p func is enough. The same should be done for @p data.
24333 * Simple example (with no function callback or data associated):
24335 * disk = elm_diskselector_add(win);
24336 * ic = elm_icon_add(win);
24337 * elm_icon_file_set(ic, "path/to/image", NULL);
24338 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24339 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24342 * @see elm_diskselector_item_del()
24343 * @see elm_diskselector_item_del_cb_set()
24344 * @see elm_diskselector_clear()
24345 * @see elm_icon_add()
24347 * @ingroup Diskselector
24349 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);
24353 * Delete them item from the diskselector.
24355 * @param it The item of diskselector to be deleted.
24357 * If deleting all diskselector items is required, elm_diskselector_clear()
24358 * should be used instead of getting items list and deleting each one.
24360 * @see elm_diskselector_clear()
24361 * @see elm_diskselector_item_append()
24362 * @see elm_diskselector_item_del_cb_set()
24364 * @ingroup Diskselector
24366 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24369 * Set the function called when a diskselector item is freed.
24371 * @param it The item to set the callback on
24372 * @param func The function called
24374 * If there is a @p func, then it will be called prior item's memory release.
24375 * That will be called with the following arguments:
24377 * @li item's Evas object;
24380 * This way, a data associated to a diskselector item could be properly
24383 * @ingroup Diskselector
24385 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24388 * Get the data associated to the item.
24390 * @param it The diskselector item
24391 * @return The data associated to @p it
24393 * The return value is a pointer to data associated to @p item when it was
24394 * created, with function elm_diskselector_item_append(). If no data
24395 * was passed as argument, it will return @c NULL.
24397 * @see elm_diskselector_item_append()
24399 * @ingroup Diskselector
24401 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24404 * Set the icon associated to the item.
24406 * @param it The diskselector item
24407 * @param icon The icon object to associate with @p it
24409 * The icon object to use at left side of the item. An
24410 * icon can be any Evas object, but usually it is an icon created
24411 * with elm_icon_add().
24413 * Once the icon object is set, a previously set one will be deleted.
24414 * @warning Setting the same icon for two items will cause the icon to
24415 * dissapear from the first item.
24417 * If an icon was passed as argument on item creation, with function
24418 * elm_diskselector_item_append(), it will be already
24419 * associated to the item.
24421 * @see elm_diskselector_item_append()
24422 * @see elm_diskselector_item_icon_get()
24424 * @ingroup Diskselector
24426 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24429 * Get the icon associated to the item.
24431 * @param it The diskselector item
24432 * @return The icon associated to @p it
24434 * The return value is a pointer to the icon associated to @p item when it was
24435 * created, with function elm_diskselector_item_append(), or later
24436 * with function elm_diskselector_item_icon_set. If no icon
24437 * was passed as argument, it will return @c NULL.
24439 * @see elm_diskselector_item_append()
24440 * @see elm_diskselector_item_icon_set()
24442 * @ingroup Diskselector
24444 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24447 * Set the label of item.
24449 * @param it The item of diskselector.
24450 * @param label The label of item.
24452 * The label to be displayed by the item.
24454 * If no icon is set, label will be centered on item position, otherwise
24455 * the icon will be placed at left of the label, that will be shifted
24458 * An item with label "January" would be displayed on side position as
24459 * "Jan" if max length is set to 3 with function
24460 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24463 * When this @p item is selected, the entire label will be displayed,
24464 * except for width restrictions.
24465 * In this case label will be cropped and "..." will be concatenated,
24466 * but only for display purposes. It will keep the entire string, so
24467 * if diskselector is resized the remaining characters will be displayed.
24469 * If a label was passed as argument on item creation, with function
24470 * elm_diskselector_item_append(), it will be already
24471 * displayed by the item.
24473 * @see elm_diskselector_side_label_lenght_set()
24474 * @see elm_diskselector_item_label_get()
24475 * @see elm_diskselector_item_append()
24477 * @ingroup Diskselector
24479 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24482 * Get the label of item.
24484 * @param it The item of diskselector.
24485 * @return The label of item.
24487 * The return value is a pointer to the label associated to @p item when it was
24488 * created, with function elm_diskselector_item_append(), or later
24489 * with function elm_diskselector_item_label_set. If no label
24490 * was passed as argument, it will return @c NULL.
24492 * @see elm_diskselector_item_label_set() for more details.
24493 * @see elm_diskselector_item_append()
24495 * @ingroup Diskselector
24497 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24500 * Get the selected item.
24502 * @param obj The diskselector object.
24503 * @return The selected diskselector item.
24505 * The selected item can be unselected with function
24506 * elm_diskselector_item_selected_set(), and the first item of
24507 * diskselector will be selected.
24509 * The selected item always will be centered on diskselector, with
24510 * full label displayed, i.e., max lenght set to side labels won't
24511 * apply on the selected item. More details on
24512 * elm_diskselector_side_label_length_set().
24514 * @ingroup Diskselector
24516 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24519 * Set the selected state of an item.
24521 * @param it The diskselector item
24522 * @param selected The selected state
24524 * This sets the selected state of the given item @p it.
24525 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24527 * If a new item is selected the previosly selected will be unselected.
24528 * Previoulsy selected item can be get with function
24529 * elm_diskselector_selected_item_get().
24531 * If the item @p it is unselected, the first item of diskselector will
24534 * Selected items will be visible on center position of diskselector.
24535 * So if it was on another position before selected, or was invisible,
24536 * diskselector will animate items until the selected item reaches center
24539 * @see elm_diskselector_item_selected_get()
24540 * @see elm_diskselector_selected_item_get()
24542 * @ingroup Diskselector
24544 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24547 * Get whether the @p item is selected or not.
24549 * @param it The diskselector item.
24550 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24551 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24553 * @see elm_diskselector_selected_item_set() for details.
24554 * @see elm_diskselector_item_selected_get()
24556 * @ingroup Diskselector
24558 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24561 * Get the first item of the diskselector.
24563 * @param obj The diskselector object.
24564 * @return The first item, or @c NULL if none.
24566 * The list of items follows append order. So it will return the first
24567 * item appended to the widget that wasn't deleted.
24569 * @see elm_diskselector_item_append()
24570 * @see elm_diskselector_items_get()
24572 * @ingroup Diskselector
24574 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24577 * Get the last item of the diskselector.
24579 * @param obj The diskselector object.
24580 * @return The last item, or @c NULL if none.
24582 * The list of items follows append order. So it will return last first
24583 * item appended to the widget that wasn't deleted.
24585 * @see elm_diskselector_item_append()
24586 * @see elm_diskselector_items_get()
24588 * @ingroup Diskselector
24590 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24593 * Get the item before @p item in diskselector.
24595 * @param it The diskselector item.
24596 * @return The item before @p item, or @c NULL if none or on failure.
24598 * The list of items follows append order. So it will return item appended
24599 * just before @p item and that wasn't deleted.
24601 * If it is the first item, @c NULL will be returned.
24602 * First item can be get by elm_diskselector_first_item_get().
24604 * @see elm_diskselector_item_append()
24605 * @see elm_diskselector_items_get()
24607 * @ingroup Diskselector
24609 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24612 * Get the item after @p item in diskselector.
24614 * @param it The diskselector item.
24615 * @return The item after @p item, or @c NULL if none or on failure.
24617 * The list of items follows append order. So it will return item appended
24618 * just after @p item and that wasn't deleted.
24620 * If it is the last item, @c NULL will be returned.
24621 * Last item can be get by elm_diskselector_last_item_get().
24623 * @see elm_diskselector_item_append()
24624 * @see elm_diskselector_items_get()
24626 * @ingroup Diskselector
24628 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24631 * Set the text to be shown in the diskselector item.
24633 * @param item Target item
24634 * @param text The text to set in the content
24636 * Setup the text as tooltip to object. The item can have only one tooltip,
24637 * so any previous tooltip data is removed.
24639 * @see elm_object_tooltip_text_set() for more details.
24641 * @ingroup Diskselector
24643 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24646 * Set the content to be shown in the tooltip item.
24648 * Setup the tooltip to item. The item can have only one tooltip,
24649 * so any previous tooltip data is removed. @p func(with @p data) will
24650 * be called every time that need show the tooltip and it should
24651 * return a valid Evas_Object. This object is then managed fully by
24652 * tooltip system and is deleted when the tooltip is gone.
24654 * @param item the diskselector item being attached a tooltip.
24655 * @param func the function used to create the tooltip contents.
24656 * @param data what to provide to @a func as callback data/context.
24657 * @param del_cb called when data is not needed anymore, either when
24658 * another callback replaces @p func, the tooltip is unset with
24659 * elm_diskselector_item_tooltip_unset() or the owner @a item
24660 * dies. This callback receives as the first parameter the
24661 * given @a data, and @c event_info is the item.
24663 * @see elm_object_tooltip_content_cb_set() for more details.
24665 * @ingroup Diskselector
24667 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);
24670 * Unset tooltip from item.
24672 * @param item diskselector item to remove previously set tooltip.
24674 * Remove tooltip from item. The callback provided as del_cb to
24675 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24676 * it is not used anymore.
24678 * @see elm_object_tooltip_unset() for more details.
24679 * @see elm_diskselector_item_tooltip_content_cb_set()
24681 * @ingroup Diskselector
24683 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24687 * Sets a different style for this item tooltip.
24689 * @note before you set a style you should define a tooltip with
24690 * elm_diskselector_item_tooltip_content_cb_set() or
24691 * elm_diskselector_item_tooltip_text_set()
24693 * @param item diskselector item with tooltip already set.
24694 * @param style the theme style to use (default, transparent, ...)
24696 * @see elm_object_tooltip_style_set() for more details.
24698 * @ingroup Diskselector
24700 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24703 * Get the style for this item tooltip.
24705 * @param item diskselector item with tooltip already set.
24706 * @return style the theme style in use, defaults to "default". If the
24707 * object does not have a tooltip set, then NULL is returned.
24709 * @see elm_object_tooltip_style_get() for more details.
24710 * @see elm_diskselector_item_tooltip_style_set()
24712 * @ingroup Diskselector
24714 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24717 * Set the cursor to be shown when mouse is over the diskselector item
24719 * @param item Target item
24720 * @param cursor the cursor name to be used.
24722 * @see elm_object_cursor_set() for more details.
24724 * @ingroup Diskselector
24726 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24729 * Get the cursor to be shown when mouse is over the diskselector item
24731 * @param item diskselector item with cursor already set.
24732 * @return the cursor name.
24734 * @see elm_object_cursor_get() for more details.
24735 * @see elm_diskselector_cursor_set()
24737 * @ingroup Diskselector
24739 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24743 * Unset the cursor to be shown when mouse is over the diskselector item
24745 * @param item Target item
24747 * @see elm_object_cursor_unset() for more details.
24748 * @see elm_diskselector_cursor_set()
24750 * @ingroup Diskselector
24752 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24755 * Sets a different style for this item cursor.
24757 * @note before you set a style you should define a cursor with
24758 * elm_diskselector_item_cursor_set()
24760 * @param item diskselector item with cursor already set.
24761 * @param style the theme style to use (default, transparent, ...)
24763 * @see elm_object_cursor_style_set() for more details.
24765 * @ingroup Diskselector
24767 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24771 * Get the style for this item cursor.
24773 * @param item diskselector item with cursor already set.
24774 * @return style the theme style in use, defaults to "default". If the
24775 * object does not have a cursor set, then @c NULL is returned.
24777 * @see elm_object_cursor_style_get() for more details.
24778 * @see elm_diskselector_item_cursor_style_set()
24780 * @ingroup Diskselector
24782 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24786 * Set if the cursor set should be searched on the theme or should use
24787 * the provided by the engine, only.
24789 * @note before you set if should look on theme you should define a cursor
24790 * with elm_diskselector_item_cursor_set().
24791 * By default it will only look for cursors provided by the engine.
24793 * @param item widget item with cursor already set.
24794 * @param engine_only boolean to define if cursors set with
24795 * elm_diskselector_item_cursor_set() should be searched only
24796 * between cursors provided by the engine or searched on widget's
24799 * @see elm_object_cursor_engine_only_set() for more details.
24801 * @ingroup Diskselector
24803 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24806 * Get the cursor engine only usage for this item cursor.
24808 * @param item widget item with cursor already set.
24809 * @return engine_only boolean to define it cursors should be looked only
24810 * between the provided by the engine or searched on widget's theme as well.
24811 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24813 * @see elm_object_cursor_engine_only_get() for more details.
24814 * @see elm_diskselector_item_cursor_engine_only_set()
24816 * @ingroup Diskselector
24818 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24825 * @defgroup Colorselector Colorselector
24829 * @image html img/widget/colorselector/preview-00.png
24830 * @image latex img/widget/colorselector/preview-00.eps
24832 * @brief Widget for user to select a color.
24834 * Signals that you can add callbacks for are:
24835 * "changed" - When the color value changes(event_info is NULL).
24837 * See @ref tutorial_colorselector.
24840 * @brief Add a new colorselector to the parent
24842 * @param parent The parent object
24843 * @return The new object or NULL if it cannot be created
24845 * @ingroup Colorselector
24847 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24849 * Set a color for the colorselector
24851 * @param obj Colorselector object
24852 * @param r r-value of color
24853 * @param g g-value of color
24854 * @param b b-value of color
24855 * @param a a-value of color
24857 * @ingroup Colorselector
24859 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24861 * Get a color from the colorselector
24863 * @param obj Colorselector object
24864 * @param r integer pointer for r-value of color
24865 * @param g integer pointer for g-value of color
24866 * @param b integer pointer for b-value of color
24867 * @param a integer pointer for a-value of color
24869 * @ingroup Colorselector
24871 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24877 * @defgroup Ctxpopup Ctxpopup
24879 * @image html img/widget/ctxpopup/preview-00.png
24880 * @image latex img/widget/ctxpopup/preview-00.eps
24882 * @brief Context popup widet.
24884 * A ctxpopup is a widget that, when shown, pops up a list of items.
24885 * It automatically chooses an area inside its parent object's view
24886 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24887 * optimally fit into it. In the default theme, it will also point an
24888 * arrow to it's top left position at the time one shows it. Ctxpopup
24889 * items have a label and/or an icon. It is intended for a small
24890 * number of items (hence the use of list, not genlist).
24892 * @note Ctxpopup is a especialization of @ref Hover.
24894 * Signals that you can add callbacks for are:
24895 * "dismissed" - the ctxpopup was dismissed
24897 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24900 typedef enum _Elm_Ctxpopup_Direction
24902 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24904 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24905 the clicked area */
24906 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24907 the clicked area */
24908 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24910 ELM_CTXPOPUP_DIRECTION_DONT_KNOW, /**< ctxpopup does not determine it's direction yet*/
24911 } Elm_Ctxpopup_Direction;
24914 * @brief Add a new Ctxpopup object to the parent.
24916 * @param parent Parent object
24917 * @return New object or @c NULL, if it cannot be created
24919 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24921 * @brief Set the Ctxpopup's parent
24923 * @param obj The ctxpopup object
24924 * @param area The parent to use
24926 * Set the parent object.
24928 * @note elm_ctxpopup_add() will automatically call this function
24929 * with its @c parent argument.
24931 * @see elm_ctxpopup_add()
24932 * @see elm_hover_parent_set()
24934 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24936 * @brief Get the Ctxpopup's parent
24938 * @param obj The ctxpopup object
24940 * @see elm_ctxpopup_hover_parent_set() for more information
24942 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24944 * @brief Clear all items in the given ctxpopup object.
24946 * @param obj Ctxpopup object
24948 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24950 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24952 * @param obj Ctxpopup object
24953 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24955 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24957 * @brief Get the value of current ctxpopup object's orientation.
24959 * @param obj Ctxpopup object
24960 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24962 * @see elm_ctxpopup_horizontal_set()
24964 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24966 * @brief Add a new item to a ctxpopup object.
24968 * @param obj Ctxpopup object
24969 * @param icon Icon to be set on new item
24970 * @param label The Label of the new item
24971 * @param func Convenience function called when item selected
24972 * @param data Data passed to @p func
24973 * @return A handle to the item added or @c NULL, on errors
24975 * @warning Ctxpopup can't hold both an item list and a content at the same
24976 * time. When an item is added, any previous content will be removed.
24978 * @see elm_ctxpopup_content_set()
24980 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);
24982 * @brief Delete the given item in a ctxpopup object.
24984 * @param it Ctxpopup item to be deleted
24986 * @see elm_ctxpopup_item_append()
24988 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24990 * @brief Set the ctxpopup item's state as disabled or enabled.
24992 * @param it Ctxpopup item to be enabled/disabled
24993 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24995 * When disabled the item is greyed out to indicate it's state.
24997 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24999 * @brief Get the ctxpopup item's disabled/enabled state.
25001 * @param it Ctxpopup item to be enabled/disabled
25002 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25004 * @see elm_ctxpopup_item_disabled_set()
25006 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25008 * @brief Get the icon object for the given ctxpopup item.
25010 * @param it Ctxpopup item
25011 * @return icon object or @c NULL, if the item does not have icon or an error
25014 * @see elm_ctxpopup_item_append()
25015 * @see elm_ctxpopup_item_icon_set()
25017 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25019 * @brief Sets the side icon associated with the ctxpopup item
25021 * @param it Ctxpopup item
25022 * @param icon Icon object to be set
25024 * Once the icon object is set, a previously set one will be deleted.
25025 * @warning Setting the same icon for two items will cause the icon to
25026 * dissapear from the first item.
25028 * @see elm_ctxpopup_item_append()
25030 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25032 * @brief Get the label for the given ctxpopup item.
25034 * @param it Ctxpopup item
25035 * @return label string or @c NULL, if the item does not have label or an
25038 * @see elm_ctxpopup_item_append()
25039 * @see elm_ctxpopup_item_label_set()
25041 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25043 * @brief (Re)set the label on the given ctxpopup item.
25045 * @param it Ctxpopup item
25046 * @param label String to set as label
25048 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25050 * @brief Set an elm widget as the content of the ctxpopup.
25052 * @param obj Ctxpopup object
25053 * @param content Content to be swallowed
25055 * If the content object is already set, a previous one will bedeleted. If
25056 * you want to keep that old content object, use the
25057 * elm_ctxpopup_content_unset() function.
25059 * @deprecated use elm_object_content_set()
25061 * @warning Ctxpopup can't hold both a item list and a content at the same
25062 * time. When a content is set, any previous items will be removed.
25064 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25066 * @brief Unset the ctxpopup content
25068 * @param obj Ctxpopup object
25069 * @return The content that was being used
25071 * Unparent and return the content object which was set for this widget.
25073 * @deprecated use elm_object_content_unset()
25075 * @see elm_ctxpopup_content_set()
25077 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25079 * @brief Set the direction priority of a ctxpopup.
25081 * @param obj Ctxpopup object
25082 * @param first 1st priority of direction
25083 * @param second 2nd priority of direction
25084 * @param third 3th priority of direction
25085 * @param fourth 4th priority of direction
25087 * This functions gives a chance to user to set the priority of ctxpopup
25088 * showing direction. This doesn't guarantee the ctxpopup will appear in the
25089 * requested direction.
25091 * @see Elm_Ctxpopup_Direction
25093 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);
25095 * @brief Get the direction priority of a ctxpopup.
25097 * @param obj Ctxpopup object
25098 * @param first 1st priority of direction to be returned
25099 * @param second 2nd priority of direction to be returned
25100 * @param third 3th priority of direction to be returned
25101 * @param fourth 4th priority of direction to be returned
25103 * @see elm_ctxpopup_direction_priority_set() for more information.
25105 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);
25108 * @brief Get the current direction of a ctxpopup.
25110 * @param obj Ctxpopup object
25111 * @return current direction of a ctxpopup
25113 * @warning Once the ctxpopup showed up, the direction would be determined
25115 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25124 * @defgroup Transit Transit
25125 * @ingroup Elementary
25127 * Transit is designed to apply various animated transition effects to @c
25128 * Evas_Object, such like translation, rotation, etc. For using these
25129 * effects, create an @ref Elm_Transit and add the desired transition effects.
25131 * Once the effects are added into transit, they will be automatically
25132 * managed (their callback will be called until the duration is ended, and
25133 * they will be deleted on completion).
25137 * Elm_Transit *trans = elm_transit_add();
25138 * elm_transit_object_add(trans, obj);
25139 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25140 * elm_transit_duration_set(transit, 1);
25141 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25142 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25143 * elm_transit_repeat_times_set(transit, 3);
25146 * Some transition effects are used to change the properties of objects. They
25148 * @li @ref elm_transit_effect_translation_add
25149 * @li @ref elm_transit_effect_color_add
25150 * @li @ref elm_transit_effect_rotation_add
25151 * @li @ref elm_transit_effect_wipe_add
25152 * @li @ref elm_transit_effect_zoom_add
25153 * @li @ref elm_transit_effect_resizing_add
25155 * Other transition effects are used to make one object disappear and another
25156 * object appear on its old place. These effects are:
25158 * @li @ref elm_transit_effect_flip_add
25159 * @li @ref elm_transit_effect_resizable_flip_add
25160 * @li @ref elm_transit_effect_fade_add
25161 * @li @ref elm_transit_effect_blend_add
25163 * It's also possible to make a transition chain with @ref
25164 * elm_transit_chain_transit_add.
25166 * @warning We strongly recommend to use elm_transit just when edje can not do
25167 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25168 * animations can be manipulated inside the theme.
25170 * List of examples:
25171 * @li @ref transit_example_01_explained
25172 * @li @ref transit_example_02_explained
25173 * @li @ref transit_example_03_c
25174 * @li @ref transit_example_04_c
25180 * @enum Elm_Transit_Tween_Mode
25182 * The type of acceleration used in the transition.
25186 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25187 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25188 over time, then decrease again
25190 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25192 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25194 } Elm_Transit_Tween_Mode;
25197 * @enum Elm_Transit_Effect_Flip_Axis
25199 * The axis where flip effect should be applied.
25203 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25204 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25205 } Elm_Transit_Effect_Flip_Axis;
25207 * @enum Elm_Transit_Effect_Wipe_Dir
25209 * The direction where the wipe effect should occur.
25213 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25214 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25215 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25216 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25217 } Elm_Transit_Effect_Wipe_Dir;
25218 /** @enum Elm_Transit_Effect_Wipe_Type
25220 * Whether the wipe effect should show or hide the object.
25224 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25226 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25228 } Elm_Transit_Effect_Wipe_Type;
25231 * @typedef Elm_Transit
25233 * The Transit created with elm_transit_add(). This type has the information
25234 * about the objects which the transition will be applied, and the
25235 * transition effects that will be used. It also contains info about
25236 * duration, number of repetitions, auto-reverse, etc.
25238 typedef struct _Elm_Transit Elm_Transit;
25239 typedef void Elm_Transit_Effect;
25241 * @typedef Elm_Transit_Effect_Transition_Cb
25243 * Transition callback called for this effect on each transition iteration.
25245 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25247 * Elm_Transit_Effect_End_Cb
25249 * Transition callback called for this effect when the transition is over.
25251 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25254 * Elm_Transit_Del_Cb
25256 * A callback called when the transit is deleted.
25258 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25263 * @note Is not necessary to delete the transit object, it will be deleted at
25264 * the end of its operation.
25265 * @note The transit will start playing when the program enter in the main loop, is not
25266 * necessary to give a start to the transit.
25268 * @return The transit object.
25272 EAPI Elm_Transit *elm_transit_add(void);
25275 * Stops the animation and delete the @p transit object.
25277 * Call this function if you wants to stop the animation before the duration
25278 * time. Make sure the @p transit object is still alive with
25279 * elm_transit_del_cb_set() function.
25280 * All added effects will be deleted, calling its repective data_free_cb
25281 * functions. The function setted by elm_transit_del_cb_set() will be called.
25283 * @see elm_transit_del_cb_set()
25285 * @param transit The transit object to be deleted.
25288 * @warning Just call this function if you are sure the transit is alive.
25290 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25293 * Add a new effect to the transit.
25295 * @note The cb function and the data are the key to the effect. If you try to
25296 * add an already added effect, nothing is done.
25297 * @note After the first addition of an effect in @p transit, if its
25298 * effect list become empty again, the @p transit will be killed by
25299 * elm_transit_del(transit) function.
25303 * Elm_Transit *transit = elm_transit_add();
25304 * elm_transit_effect_add(transit,
25305 * elm_transit_effect_blend_op,
25306 * elm_transit_effect_blend_context_new(),
25307 * elm_transit_effect_blend_context_free);
25310 * @param transit The transit object.
25311 * @param transition_cb The operation function. It is called when the
25312 * animation begins, it is the function that actually performs the animation.
25313 * It is called with the @p data, @p transit and the time progression of the
25314 * animation (a double value between 0.0 and 1.0).
25315 * @param effect The context data of the effect.
25316 * @param end_cb The function to free the context data, it will be called
25317 * at the end of the effect, it must finalize the animation and free the
25321 * @warning The transit free the context data at the and of the transition with
25322 * the data_free_cb function, do not use the context data in another transit.
25324 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);
25327 * Delete an added effect.
25329 * This function will remove the effect from the @p transit, calling the
25330 * data_free_cb to free the @p data.
25332 * @see elm_transit_effect_add()
25334 * @note If the effect is not found, nothing is done.
25335 * @note If the effect list become empty, this function will call
25336 * elm_transit_del(transit), that is, it will kill the @p transit.
25338 * @param transit The transit object.
25339 * @param transition_cb The operation function.
25340 * @param effect The context data of the effect.
25344 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);
25347 * Add new object to apply the effects.
25349 * @note After the first addition of an object in @p transit, if its
25350 * object list become empty again, the @p transit will be killed by
25351 * elm_transit_del(transit) function.
25352 * @note If the @p obj belongs to another transit, the @p obj will be
25353 * removed from it and it will only belong to the @p transit. If the old
25354 * transit stays without objects, it will die.
25355 * @note When you add an object into the @p transit, its state from
25356 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25357 * transit ends, if you change this state whith evas_object_pass_events_set()
25358 * after add the object, this state will change again when @p transit stops to
25361 * @param transit The transit object.
25362 * @param obj Object to be animated.
25365 * @warning It is not allowed to add a new object after transit begins to go.
25367 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25370 * Removes an added object from the transit.
25372 * @note If the @p obj is not in the @p transit, nothing is done.
25373 * @note If the list become empty, this function will call
25374 * elm_transit_del(transit), that is, it will kill the @p transit.
25376 * @param transit The transit object.
25377 * @param obj Object to be removed from @p transit.
25380 * @warning It is not allowed to remove objects after transit begins to go.
25382 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25385 * Get the objects of the transit.
25387 * @param transit The transit object.
25388 * @return a Eina_List with the objects from the transit.
25392 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25395 * Enable/disable keeping up the objects states.
25396 * If it is not kept, the objects states will be reset when transition ends.
25398 * @note @p transit can not be NULL.
25399 * @note One state includes geometry, color, map data.
25401 * @param transit The transit object.
25402 * @param state_keep Keeping or Non Keeping.
25406 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25409 * Get a value whether the objects states will be reset or not.
25411 * @note @p transit can not be NULL
25413 * @see elm_transit_objects_final_state_keep_set()
25415 * @param transit The transit object.
25416 * @return EINA_TRUE means the states of the objects will be reset.
25417 * If @p transit is NULL, EINA_FALSE is returned
25421 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25424 * Set the event enabled when transit is operating.
25426 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25427 * events from mouse and keyboard during the animation.
25428 * @note When you add an object with elm_transit_object_add(), its state from
25429 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25430 * transit ends, if you change this state with evas_object_pass_events_set()
25431 * after adding the object, this state will change again when @p transit stops
25434 * @param transit The transit object.
25435 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25436 * ignored otherwise.
25440 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25443 * Get the value of event enabled status.
25445 * @see elm_transit_event_enabled_set()
25447 * @param transit The Transit object
25448 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25449 * EINA_FALSE is returned
25453 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25456 * Set the user-callback function when the transit is deleted.
25458 * @note Using this function twice will overwrite the first function setted.
25459 * @note the @p transit object will be deleted after call @p cb function.
25461 * @param transit The transit object.
25462 * @param cb Callback function pointer. This function will be called before
25463 * the deletion of the transit.
25464 * @param data Callback funtion user data. It is the @p op parameter.
25468 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25471 * Set reverse effect automatically.
25473 * If auto reverse is setted, after running the effects with the progress
25474 * parameter from 0 to 1, it will call the effecs again with the progress
25475 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25476 * where the duration was setted with the function elm_transit_add and
25477 * the repeat with the function elm_transit_repeat_times_set().
25479 * @param transit The transit object.
25480 * @param reverse EINA_TRUE means the auto_reverse is on.
25484 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25487 * Get if the auto reverse is on.
25489 * @see elm_transit_auto_reverse_set()
25491 * @param transit The transit object.
25492 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25493 * EINA_FALSE is returned
25497 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25500 * Set the transit repeat count. Effect will be repeated by repeat count.
25502 * This function sets the number of repetition the transit will run after
25503 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25504 * If the @p repeat is a negative number, it will repeat infinite times.
25506 * @note If this function is called during the transit execution, the transit
25507 * will run @p repeat times, ignoring the times it already performed.
25509 * @param transit The transit object
25510 * @param repeat Repeat count
25514 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25517 * Get the transit repeat count.
25519 * @see elm_transit_repeat_times_set()
25521 * @param transit The Transit object.
25522 * @return The repeat count. If @p transit is NULL
25527 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25530 * Set the transit animation acceleration type.
25532 * This function sets the tween mode of the transit that can be:
25533 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25534 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25535 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25536 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25538 * @param transit The transit object.
25539 * @param tween_mode The tween type.
25543 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25546 * Get the transit animation acceleration type.
25548 * @note @p transit can not be NULL
25550 * @param transit The transit object.
25551 * @return The tween type. If @p transit is NULL
25552 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25556 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25559 * Set the transit animation time
25561 * @note @p transit can not be NULL
25563 * @param transit The transit object.
25564 * @param duration The animation time.
25568 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25571 * Get the transit animation time
25573 * @note @p transit can not be NULL
25575 * @param transit The transit object.
25577 * @return The transit animation time.
25581 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25584 * Starts the transition.
25585 * Once this API is called, the transit begins to measure the time.
25587 * @note @p transit can not be NULL
25589 * @param transit The transit object.
25593 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25596 * Pause/Resume the transition.
25598 * If you call elm_transit_go again, the transit will be started from the
25599 * beginning, and will be unpaused.
25601 * @note @p transit can not be NULL
25603 * @param transit The transit object.
25604 * @param paused Whether the transition should be paused or not.
25608 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25611 * Get the value of paused status.
25613 * @see elm_transit_paused_set()
25615 * @note @p transit can not be NULL
25617 * @param transit The transit object.
25618 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25619 * EINA_FALSE is returned
25623 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25626 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25628 * The value returned is a fraction (current time / total time). It
25629 * represents the progression position relative to the total.
25631 * @note @p transit can not be NULL
25633 * @param transit The transit object.
25635 * @return The time progression value. If @p transit is NULL
25640 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25643 * Makes the chain relationship between two transits.
25645 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25646 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25648 * @param transit The transit object.
25649 * @param chain_transit The chain transit object. This transit will be operated
25650 * after transit is done.
25652 * This function adds @p chain_transit transition to a chain after the @p
25653 * transit, and will be started as soon as @p transit ends. See @ref
25654 * transit_example_02_explained for a full example.
25658 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25661 * Cut off the chain relationship between two transits.
25663 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25664 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25666 * @param transit The transit object.
25667 * @param chain_transit The chain transit object.
25669 * This function remove the @p chain_transit transition from the @p transit.
25673 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25676 * Get the current chain transit list.
25678 * @note @p transit can not be NULL.
25680 * @param transit The transit object.
25681 * @return chain transit list.
25685 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25688 * Add the Resizing Effect to Elm_Transit.
25690 * @note This API is one of the facades. It creates resizing effect context
25691 * and add it's required APIs to elm_transit_effect_add.
25693 * @see elm_transit_effect_add()
25695 * @param transit Transit object.
25696 * @param from_w Object width size when effect begins.
25697 * @param from_h Object height size when effect begins.
25698 * @param to_w Object width size when effect ends.
25699 * @param to_h Object height size when effect ends.
25700 * @return Resizing effect context data.
25704 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);
25707 * Add the Translation Effect to Elm_Transit.
25709 * @note This API is one of the facades. It creates translation effect context
25710 * and add it's required APIs to elm_transit_effect_add.
25712 * @see elm_transit_effect_add()
25714 * @param transit Transit object.
25715 * @param from_dx X Position variation when effect begins.
25716 * @param from_dy Y Position variation when effect begins.
25717 * @param to_dx X Position variation when effect ends.
25718 * @param to_dy Y Position variation when effect ends.
25719 * @return Translation effect context data.
25722 * @warning It is highly recommended just create a transit with this effect when
25723 * the window that the objects of the transit belongs has already been created.
25724 * This is because this effect needs the geometry information about the objects,
25725 * and if the window was not created yet, it can get a wrong information.
25727 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);
25730 * Add the Zoom Effect to Elm_Transit.
25732 * @note This API is one of the facades. It creates zoom effect context
25733 * and add it's required APIs to elm_transit_effect_add.
25735 * @see elm_transit_effect_add()
25737 * @param transit Transit object.
25738 * @param from_rate Scale rate when effect begins (1 is current rate).
25739 * @param to_rate Scale rate when effect ends.
25740 * @return Zoom effect context data.
25743 * @warning It is highly recommended just create a transit with this effect when
25744 * the window that the objects of the transit belongs has already been created.
25745 * This is because this effect needs the geometry information about the objects,
25746 * and if the window was not created yet, it can get a wrong information.
25748 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25751 * Add the Flip Effect to Elm_Transit.
25753 * @note This API is one of the facades. It creates flip effect context
25754 * and add it's required APIs to elm_transit_effect_add.
25755 * @note This effect is applied to each pair of objects in the order they are listed
25756 * in the transit list of objects. The first object in the pair will be the
25757 * "front" object and the second will be the "back" object.
25759 * @see elm_transit_effect_add()
25761 * @param transit Transit object.
25762 * @param axis Flipping Axis(X or Y).
25763 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25764 * @return Flip effect context data.
25767 * @warning It is highly recommended just create a transit with this effect when
25768 * the window that the objects of the transit belongs has already been created.
25769 * This is because this effect needs the geometry information about the objects,
25770 * and if the window was not created yet, it can get a wrong information.
25772 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25775 * Add the Resizable Flip Effect to Elm_Transit.
25777 * @note This API is one of the facades. It creates resizable flip effect context
25778 * and add it's required APIs to elm_transit_effect_add.
25779 * @note This effect is applied to each pair of objects in the order they are listed
25780 * in the transit list of objects. The first object in the pair will be the
25781 * "front" object and the second will be the "back" object.
25783 * @see elm_transit_effect_add()
25785 * @param transit Transit object.
25786 * @param axis Flipping Axis(X or Y).
25787 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25788 * @return Resizable flip effect context data.
25791 * @warning It is highly recommended just create a transit with this effect when
25792 * the window that the objects of the transit belongs has already been created.
25793 * This is because this effect needs the geometry information about the objects,
25794 * and if the window was not created yet, it can get a wrong information.
25796 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25799 * Add the Wipe Effect to Elm_Transit.
25801 * @note This API is one of the facades. It creates wipe effect context
25802 * and add it's required APIs to elm_transit_effect_add.
25804 * @see elm_transit_effect_add()
25806 * @param transit Transit object.
25807 * @param type Wipe type. Hide or show.
25808 * @param dir Wipe Direction.
25809 * @return Wipe effect context data.
25812 * @warning It is highly recommended just create a transit with this effect when
25813 * the window that the objects of the transit belongs has already been created.
25814 * This is because this effect needs the geometry information about the objects,
25815 * and if the window was not created yet, it can get a wrong information.
25817 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25820 * Add the Color Effect to Elm_Transit.
25822 * @note This API is one of the facades. It creates color effect context
25823 * and add it's required APIs to elm_transit_effect_add.
25825 * @see elm_transit_effect_add()
25827 * @param transit Transit object.
25828 * @param from_r RGB R when effect begins.
25829 * @param from_g RGB G when effect begins.
25830 * @param from_b RGB B when effect begins.
25831 * @param from_a RGB A when effect begins.
25832 * @param to_r RGB R when effect ends.
25833 * @param to_g RGB G when effect ends.
25834 * @param to_b RGB B when effect ends.
25835 * @param to_a RGB A when effect ends.
25836 * @return Color effect context data.
25840 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);
25843 * Add the Fade Effect to Elm_Transit.
25845 * @note This API is one of the facades. It creates fade effect context
25846 * and add it's required APIs to elm_transit_effect_add.
25847 * @note This effect is applied to each pair of objects in the order they are listed
25848 * in the transit list of objects. The first object in the pair will be the
25849 * "before" object and the second will be the "after" object.
25851 * @see elm_transit_effect_add()
25853 * @param transit Transit object.
25854 * @return Fade effect context data.
25857 * @warning It is highly recommended just create a transit with this effect when
25858 * the window that the objects of the transit belongs has already been created.
25859 * This is because this effect needs the color information about the objects,
25860 * and if the window was not created yet, it can get a wrong information.
25862 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25865 * Add the Blend Effect to Elm_Transit.
25867 * @note This API is one of the facades. It creates blend effect context
25868 * and add it's required APIs to elm_transit_effect_add.
25869 * @note This effect is applied to each pair of objects in the order they are listed
25870 * in the transit list of objects. The first object in the pair will be the
25871 * "before" object and the second will be the "after" object.
25873 * @see elm_transit_effect_add()
25875 * @param transit Transit object.
25876 * @return Blend effect context data.
25879 * @warning It is highly recommended just create a transit with this effect when
25880 * the window that the objects of the transit belongs has already been created.
25881 * This is because this effect needs the color information about the objects,
25882 * and if the window was not created yet, it can get a wrong information.
25884 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25887 * Add the Rotation Effect to Elm_Transit.
25889 * @note This API is one of the facades. It creates rotation effect context
25890 * and add it's required APIs to elm_transit_effect_add.
25892 * @see elm_transit_effect_add()
25894 * @param transit Transit object.
25895 * @param from_degree Degree when effect begins.
25896 * @param to_degree Degree when effect is ends.
25897 * @return Rotation effect context data.
25900 * @warning It is highly recommended just create a transit with this effect when
25901 * the window that the objects of the transit belongs has already been created.
25902 * This is because this effect needs the geometry information about the objects,
25903 * and if the window was not created yet, it can get a wrong information.
25905 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25908 * Add the ImageAnimation Effect to Elm_Transit.
25910 * @note This API is one of the facades. It creates image animation effect context
25911 * and add it's required APIs to elm_transit_effect_add.
25912 * The @p images parameter is a list images paths. This list and
25913 * its contents will be deleted at the end of the effect by
25914 * elm_transit_effect_image_animation_context_free() function.
25918 * char buf[PATH_MAX];
25919 * Eina_List *images = NULL;
25920 * Elm_Transit *transi = elm_transit_add();
25922 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25923 * images = eina_list_append(images, eina_stringshare_add(buf));
25925 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25926 * images = eina_list_append(images, eina_stringshare_add(buf));
25927 * elm_transit_effect_image_animation_add(transi, images);
25931 * @see elm_transit_effect_add()
25933 * @param transit Transit object.
25934 * @param images Eina_List of images file paths. This list and
25935 * its contents will be deleted at the end of the effect by
25936 * elm_transit_effect_image_animation_context_free() function.
25937 * @return Image Animation effect context data.
25941 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25946 typedef struct _Elm_Store Elm_Store;
25947 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25948 typedef struct _Elm_Store_Item Elm_Store_Item;
25949 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25950 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25951 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25952 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25953 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25954 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25955 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25956 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25958 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25959 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25960 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25961 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25965 ELM_STORE_ITEM_MAPPING_NONE = 0,
25966 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25967 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25968 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25969 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25970 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25971 // can add more here as needed by common apps
25972 ELM_STORE_ITEM_MAPPING_LAST
25973 } Elm_Store_Item_Mapping_Type;
25975 struct _Elm_Store_Item_Mapping_Icon
25977 // FIXME: allow edje file icons
25979 Elm_Icon_Lookup_Order lookup_order;
25980 Eina_Bool standard_name : 1;
25981 Eina_Bool no_scale : 1;
25982 Eina_Bool smooth : 1;
25983 Eina_Bool scale_up : 1;
25984 Eina_Bool scale_down : 1;
25987 struct _Elm_Store_Item_Mapping_Empty
25992 struct _Elm_Store_Item_Mapping_Photo
25997 struct _Elm_Store_Item_Mapping_Custom
25999 Elm_Store_Item_Mapping_Cb func;
26002 struct _Elm_Store_Item_Mapping
26004 Elm_Store_Item_Mapping_Type type;
26009 Elm_Store_Item_Mapping_Empty empty;
26010 Elm_Store_Item_Mapping_Icon icon;
26011 Elm_Store_Item_Mapping_Photo photo;
26012 Elm_Store_Item_Mapping_Custom custom;
26013 // add more types here
26017 struct _Elm_Store_Item_Info
26019 Elm_Genlist_Item_Class *item_class;
26020 const Elm_Store_Item_Mapping *mapping;
26025 struct _Elm_Store_Item_Info_Filesystem
26027 Elm_Store_Item_Info base;
26031 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26032 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26034 EAPI void elm_store_free(Elm_Store *st);
26036 EAPI Elm_Store *elm_store_filesystem_new(void);
26037 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26038 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26039 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26041 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26043 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26044 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26045 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26046 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26047 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26048 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26050 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26051 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26052 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26053 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26054 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26055 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26056 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26059 * @defgroup SegmentControl SegmentControl
26060 * @ingroup Elementary
26062 * @image html img/widget/segment_control/preview-00.png
26063 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26065 * @image html img/segment_control.png
26066 * @image latex img/segment_control.eps width=\textwidth
26068 * Segment control widget is a horizontal control made of multiple segment
26069 * items, each segment item functioning similar to discrete two state button.
26070 * A segment control groups the items together and provides compact
26071 * single button with multiple equal size segments.
26073 * Segment item size is determined by base widget
26074 * size and the number of items added.
26075 * Only one segment item can be at selected state. A segment item can display
26076 * combination of Text and any Evas_Object like Images or other widget.
26078 * Smart callbacks one can listen to:
26079 * - "changed" - When the user clicks on a segment item which is not
26080 * previously selected and get selected. The event_info parameter is the
26081 * segment item index.
26083 * Available styles for it:
26086 * Here is an example on its usage:
26087 * @li @ref segment_control_example
26091 * @addtogroup SegmentControl
26095 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26098 * Add a new segment control widget to the given parent Elementary
26099 * (container) object.
26101 * @param parent The parent object.
26102 * @return a new segment control widget handle or @c NULL, on errors.
26104 * This function inserts a new segment control widget on the canvas.
26106 * @ingroup SegmentControl
26108 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26111 * Append a new item to the segment control object.
26113 * @param obj The segment control object.
26114 * @param icon The icon object to use for the left side of the item. An
26115 * icon can be any Evas object, but usually it is an icon created
26116 * with elm_icon_add().
26117 * @param label The label of the item.
26118 * Note that, NULL is different from empty string "".
26119 * @return The created item or @c NULL upon failure.
26121 * A new item will be created and appended to the segment control, i.e., will
26122 * be set as @b last item.
26124 * If it should be inserted at another position,
26125 * elm_segment_control_item_insert_at() should be used instead.
26127 * Items created with this function can be deleted with function
26128 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26130 * @note @p label set to @c NULL is different from empty string "".
26132 * only has icon, it will be displayed bigger and centered. If it has
26133 * icon and label, even that an empty string, icon will be smaller and
26134 * positioned at left.
26138 * sc = elm_segment_control_add(win);
26139 * ic = elm_icon_add(win);
26140 * elm_icon_file_set(ic, "path/to/image", NULL);
26141 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26142 * elm_segment_control_item_add(sc, ic, "label");
26143 * evas_object_show(sc);
26146 * @see elm_segment_control_item_insert_at()
26147 * @see elm_segment_control_item_del()
26149 * @ingroup SegmentControl
26151 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26154 * Insert a new item to the segment control object at specified position.
26156 * @param obj The segment control object.
26157 * @param icon The icon object to use for the left side of the item. An
26158 * icon can be any Evas object, but usually it is an icon created
26159 * with elm_icon_add().
26160 * @param label The label of the item.
26161 * @param index Item position. Value should be between 0 and items count.
26162 * @return The created item or @c NULL upon failure.
26164 * Index values must be between @c 0, when item will be prepended to
26165 * segment control, and items count, that can be get with
26166 * elm_segment_control_item_count_get(), case when item will be appended
26167 * to segment control, just like elm_segment_control_item_add().
26169 * Items created with this function can be deleted with function
26170 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26172 * @note @p label set to @c NULL is different from empty string "".
26174 * only has icon, it will be displayed bigger and centered. If it has
26175 * icon and label, even that an empty string, icon will be smaller and
26176 * positioned at left.
26178 * @see elm_segment_control_item_add()
26179 * @see elm_segment_control_item_count_get()
26180 * @see elm_segment_control_item_del()
26182 * @ingroup SegmentControl
26184 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);
26187 * Remove a segment control item from its parent, deleting it.
26189 * @param it The item to be removed.
26191 * Items can be added with elm_segment_control_item_add() or
26192 * elm_segment_control_item_insert_at().
26194 * @ingroup SegmentControl
26196 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26199 * Remove a segment control item at given index from its parent,
26202 * @param obj The segment control object.
26203 * @param index The position of the segment control item to be deleted.
26205 * Items can be added with elm_segment_control_item_add() or
26206 * elm_segment_control_item_insert_at().
26208 * @ingroup SegmentControl
26210 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26213 * Get the Segment items count from segment control.
26215 * @param obj The segment control object.
26216 * @return Segment items count.
26218 * It will just return the number of items added to segment control @p obj.
26220 * @ingroup SegmentControl
26222 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26225 * Get the item placed at specified index.
26227 * @param obj The segment control object.
26228 * @param index The index of the segment item.
26229 * @return The segment control item or @c NULL on failure.
26231 * Index is the position of an item in segment control widget. Its
26232 * range is from @c 0 to <tt> count - 1 </tt>.
26233 * Count is the number of items, that can be get with
26234 * elm_segment_control_item_count_get().
26236 * @ingroup SegmentControl
26238 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26241 * Get the label of item.
26243 * @param obj The segment control object.
26244 * @param index The index of the segment item.
26245 * @return The label of the item at @p index.
26247 * The return value is a pointer to the label associated to the item when
26248 * it was created, with function elm_segment_control_item_add(), or later
26249 * with function elm_segment_control_item_label_set. If no label
26250 * was passed as argument, it will return @c NULL.
26252 * @see elm_segment_control_item_label_set() for more details.
26253 * @see elm_segment_control_item_add()
26255 * @ingroup SegmentControl
26257 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26260 * Set the label of item.
26262 * @param it The item of segment control.
26263 * @param text The label of item.
26265 * The label to be displayed by the item.
26266 * Label will be at right of the icon (if set).
26268 * If a label was passed as argument on item creation, with function
26269 * elm_control_segment_item_add(), it will be already
26270 * displayed by the item.
26272 * @see elm_segment_control_item_label_get()
26273 * @see elm_segment_control_item_add()
26275 * @ingroup SegmentControl
26277 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26280 * Get the icon associated to the item.
26282 * @param obj The segment control object.
26283 * @param index The index of the segment item.
26284 * @return The left side icon associated to the item at @p index.
26286 * The return value is a pointer to the icon associated to the item when
26287 * it was created, with function elm_segment_control_item_add(), or later
26288 * with function elm_segment_control_item_icon_set(). If no icon
26289 * was passed as argument, it will return @c NULL.
26291 * @see elm_segment_control_item_add()
26292 * @see elm_segment_control_item_icon_set()
26294 * @ingroup SegmentControl
26296 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26299 * Set the icon associated to the item.
26301 * @param it The segment control item.
26302 * @param icon The icon object to associate with @p it.
26304 * The icon object to use at left side of the item. An
26305 * icon can be any Evas object, but usually it is an icon created
26306 * with elm_icon_add().
26308 * Once the icon object is set, a previously set one will be deleted.
26309 * @warning Setting the same icon for two items will cause the icon to
26310 * dissapear from the first item.
26312 * If an icon was passed as argument on item creation, with function
26313 * elm_segment_control_item_add(), it will be already
26314 * associated to the item.
26316 * @see elm_segment_control_item_add()
26317 * @see elm_segment_control_item_icon_get()
26319 * @ingroup SegmentControl
26321 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26324 * Get the index of an item.
26326 * @param it The segment control item.
26327 * @return The position of item in segment control widget.
26329 * Index is the position of an item in segment control widget. Its
26330 * range is from @c 0 to <tt> count - 1 </tt>.
26331 * Count is the number of items, that can be get with
26332 * elm_segment_control_item_count_get().
26334 * @ingroup SegmentControl
26336 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26339 * Get the base object of the item.
26341 * @param it The segment control item.
26342 * @return The base object associated with @p it.
26344 * Base object is the @c Evas_Object that represents that item.
26346 * @ingroup SegmentControl
26348 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26351 * Get the selected item.
26353 * @param obj The segment control object.
26354 * @return The selected item or @c NULL if none of segment items is
26357 * The selected item can be unselected with function
26358 * elm_segment_control_item_selected_set().
26360 * The selected item always will be highlighted on segment control.
26362 * @ingroup SegmentControl
26364 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26367 * Set the selected state of an item.
26369 * @param it The segment control item
26370 * @param select The selected state
26372 * This sets the selected state of the given item @p it.
26373 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26375 * If a new item is selected the previosly selected will be unselected.
26376 * Previoulsy selected item can be get with function
26377 * elm_segment_control_item_selected_get().
26379 * The selected item always will be highlighted on segment control.
26381 * @see elm_segment_control_item_selected_get()
26383 * @ingroup SegmentControl
26385 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26392 * @defgroup Grid Grid
26394 * The grid is a grid layout widget that lays out a series of children as a
26395 * fixed "grid" of widgets using a given percentage of the grid width and
26396 * height each using the child object.
26398 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26399 * widgets size itself. The default is 100 x 100, so that means the
26400 * position and sizes of children will effectively be percentages (0 to 100)
26401 * of the width or height of the grid widget
26407 * Add a new grid to the parent
26409 * @param parent The parent object
26410 * @return The new object or NULL if it cannot be created
26414 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26417 * Set the virtual size of the grid
26419 * @param obj The grid object
26420 * @param w The virtual width of the grid
26421 * @param h The virtual height of the grid
26425 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26428 * Get the virtual size of the grid
26430 * @param obj The grid object
26431 * @param w Pointer to integer to store the virtual width of the grid
26432 * @param h Pointer to integer to store the virtual height of the grid
26436 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26439 * Pack child at given position and size
26441 * @param obj The grid object
26442 * @param subobj The child to pack
26443 * @param x The virtual x coord at which to pack it
26444 * @param y The virtual y coord at which to pack it
26445 * @param w The virtual width at which to pack it
26446 * @param h The virtual height at which to pack it
26450 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26453 * Unpack a child from a grid object
26455 * @param obj The grid object
26456 * @param subobj The child to unpack
26460 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26463 * Faster way to remove all child objects from a grid object.
26465 * @param obj The grid object
26466 * @param clear If true, it will delete just removed children
26470 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26473 * Set packing of an existing child at to position and size
26475 * @param subobj The child to set packing of
26476 * @param x The virtual x coord at which to pack it
26477 * @param y The virtual y coord at which to pack it
26478 * @param w The virtual width at which to pack it
26479 * @param h The virtual height at which to pack it
26483 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26486 * get packing of a child
26488 * @param subobj The child to query
26489 * @param x Pointer to integer to store the virtual x coord
26490 * @param y Pointer to integer to store the virtual y coord
26491 * @param w Pointer to integer to store the virtual width
26492 * @param h Pointer to integer to store the virtual height
26496 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26502 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26503 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26504 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26505 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26506 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
26507 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
26510 * @defgroup Video Video
26512 * This object display an player that let you control an Elm_Video
26513 * object. It take care of updating it's content according to what is
26514 * going on inside the Emotion object. It does activate the remember
26515 * function on the linked Elm_Video object.
26517 * Signals that you cann add callback for are :
26519 * "forward,clicked" - the user clicked the forward button.
26520 * "info,clicked" - the user clicked the info button.
26521 * "next,clicked" - the user clicked the next button.
26522 * "pause,clicked" - the user clicked the pause button.
26523 * "play,clicked" - the user clicked the play button.
26524 * "prev,clicked" - the user clicked the prev button.
26525 * "rewind,clicked" - the user clicked the rewind button.
26526 * "stop,clicked" - the user clicked the stop button.
26528 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26529 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26530 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26531 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26532 EAPI void elm_video_play(Evas_Object *video);
26533 EAPI void elm_video_pause(Evas_Object *video);
26534 EAPI void elm_video_stop(Evas_Object *video);
26535 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26536 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26537 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26538 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26539 EAPI double elm_video_audio_level_get(Evas_Object *video);
26540 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26541 EAPI double elm_video_play_position_get(Evas_Object *video);
26542 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26543 EAPI double elm_video_play_length_get(Evas_Object *video);
26544 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26545 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26546 EAPI const char *elm_video_title_get(Evas_Object *video);
26548 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26549 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26552 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26553 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);
26554 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26555 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26556 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26557 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26558 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26559 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26560 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26561 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26562 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26563 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26564 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26565 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26566 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);