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)
1112 * @defgroup Caches Caches
1114 * These are functions which let one fine-tune some cache values for
1115 * Elementary applications, thus allowing for performance adjustments.
1121 * @brief Flush all caches.
1123 * Frees all data that was in cache and is not currently being used to reduce
1124 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1125 * to calling all of the following functions:
1126 * @li edje_file_cache_flush()
1127 * @li edje_collection_cache_flush()
1128 * @li eet_clearcache()
1129 * @li evas_image_cache_flush()
1130 * @li evas_font_cache_flush()
1131 * @li evas_render_dump()
1132 * @note Evas caches are flushed for every canvas associated with a window.
1136 EAPI void elm_all_flush(void);
1139 * Get the configured cache flush interval time
1141 * This gets the globally configured cache flush interval time, in
1144 * @return The cache flush interval time
1147 * @see elm_all_flush()
1149 EAPI int elm_cache_flush_interval_get(void);
1152 * Set the configured cache flush interval time
1154 * This sets the globally configured cache flush interval time, in ticks
1156 * @param size The cache flush interval time
1159 * @see elm_all_flush()
1161 EAPI void elm_cache_flush_interval_set(int size);
1164 * Set the configured cache flush interval time for all applications on the
1167 * This sets the globally configured cache flush interval time -- in ticks
1168 * -- for all applications on the display.
1170 * @param size The cache flush interval time
1173 EAPI void elm_cache_flush_interval_all_set(int size);
1176 * Get the configured cache flush enabled state
1178 * This gets the globally configured cache flush state - if it is enabled
1179 * or not. When cache flushing is enabled, elementary will regularly
1180 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1181 * memory and allow usage to re-seed caches and data in memory where it
1182 * can do so. An idle application will thus minimise its memory usage as
1183 * data will be freed from memory and not be re-loaded as it is idle and
1184 * not rendering or doing anything graphically right now.
1186 * @return The cache flush state
1189 * @see elm_all_flush()
1191 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1194 * Set the configured cache flush enabled state
1196 * This sets the globally configured cache flush enabled state
1198 * @param size The cache flush enabled state
1201 * @see elm_all_flush()
1203 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1206 * Set the configured cache flush enabled state for all applications on the
1209 * This sets the globally configured cache flush enabled state for all
1210 * applications on the display.
1212 * @param size The cache flush enabled state
1215 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1218 * Get the configured font cache size
1220 * This gets the globally configured font cache size, in bytes
1222 * @return The font cache size
1225 EAPI int elm_font_cache_get(void);
1228 * Set the configured font cache size
1230 * This sets the globally configured font cache size, in bytes
1232 * @param size The font cache size
1235 EAPI void elm_font_cache_set(int size);
1238 * Set the configured font cache size for all applications on the
1241 * This sets the globally configured font cache size -- in bytes
1242 * -- for all applications on the display.
1244 * @param size The font cache size
1247 EAPI void elm_font_cache_all_set(int size);
1250 * Get the configured image cache size
1252 * This gets the globally configured image cache size, in bytes
1254 * @return The image cache size
1257 EAPI int elm_image_cache_get(void);
1260 * Set the configured image cache size
1262 * This sets the globally configured image cache size, in bytes
1264 * @param size The image cache size
1267 EAPI void elm_image_cache_set(int size);
1270 * Set the configured image cache size for all applications on the
1273 * This sets the globally configured image cache size -- in bytes
1274 * -- for all applications on the display.
1276 * @param size The image cache size
1279 EAPI void elm_image_cache_all_set(int size);
1282 * Get the configured edje file cache size.
1284 * This gets the globally configured edje file cache size, in number
1287 * @return The edje file cache size
1290 EAPI int elm_edje_file_cache_get(void);
1293 * Set the configured edje file cache size
1295 * This sets the globally configured edje file cache size, in number
1298 * @param size The edje file cache size
1301 EAPI void elm_edje_file_cache_set(int size);
1304 * Set the configured edje file cache size for all applications on the
1307 * This sets the globally configured edje file cache size -- in number
1308 * of files -- for all applications on the display.
1310 * @param size The edje file cache size
1313 EAPI void elm_edje_file_cache_all_set(int size);
1316 * Get the configured edje collections (groups) cache size.
1318 * This gets the globally configured edje collections cache size, in
1319 * number of collections.
1321 * @return The edje collections cache size
1324 EAPI int elm_edje_collection_cache_get(void);
1327 * Set the configured edje collections (groups) cache size
1329 * This sets the globally configured edje collections cache size, in
1330 * number of collections.
1332 * @param size The edje collections cache size
1335 EAPI void elm_edje_collection_cache_set(int size);
1338 * Set the configured edje collections (groups) cache size for all
1339 * applications on the display
1341 * This sets the globally configured edje collections cache size -- in
1342 * number of collections -- for all applications on the display.
1344 * @param size The edje collections cache size
1347 EAPI void elm_edje_collection_cache_all_set(int size);
1354 * @defgroup Scaling Widget Scaling
1356 * Different widgets can be scaled independently. These functions
1357 * allow you to manipulate this scaling on a per-widget basis. The
1358 * object and all its children get their scaling factors multiplied
1359 * by the scale factor set. This is multiplicative, in that if a
1360 * child also has a scale size set it is in turn multiplied by its
1361 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1362 * double size, @c 0.5 is half, etc.
1364 * @ref general_functions_example_page "This" example contemplates
1365 * some of these functions.
1369 * Get the global scaling factor
1371 * This gets the globally configured scaling factor that is applied to all
1374 * @return The scaling factor
1377 EAPI double elm_scale_get(void);
1380 * Set the global scaling factor
1382 * This sets the globally configured scaling factor that is applied to all
1385 * @param scale The scaling factor to set
1388 EAPI void elm_scale_set(double scale);
1391 * Set the global scaling factor for all applications on the display
1393 * This sets the globally configured scaling factor that is applied to all
1394 * objects for all applications.
1395 * @param scale The scaling factor to set
1398 EAPI void elm_scale_all_set(double scale);
1401 * Set the scaling factor for a given Elementary object
1403 * @param obj The Elementary to operate on
1404 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1409 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1412 * Get the scaling factor for a given Elementary object
1414 * @param obj The object
1415 * @return The scaling factor set by elm_object_scale_set()
1419 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1422 * @defgroup Password_last_show Password last input show
1424 * Last show feature of password mode enables user to view
1425 * the last input entered for few seconds before masking it.
1426 * These functions allow to set this feature in password mode
1427 * of entry widget and also allow to manipulate the duration
1428 * for which the input has to be visible.
1434 * Get show last setting of password mode.
1436 * This gets the show last input setting of password mode which might be
1437 * enabled or disabled.
1439 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1441 * @ingroup Password_last_show
1443 EAPI Eina_Bool elm_password_show_last_get(void);
1446 * Set show last setting in password mode.
1448 * This enables or disables show last setting of password mode.
1450 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1451 * @see elm_password_show_last_timeout_set()
1452 * @ingroup Password_last_show
1454 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1457 * Get's the timeout value in last show password mode.
1459 * This gets the time out value for which the last input entered in password
1460 * mode will be visible.
1462 * @return The timeout value of last show password mode.
1463 * @ingroup Password_last_show
1465 EAPI double elm_password_show_last_timeout_get(void);
1468 * Set's the timeout value in last show password mode.
1470 * This sets the time out value for which the last input entered in password
1471 * mode will be visible.
1473 * @param password_show_last_timeout The timeout value.
1474 * @see elm_password_show_last_set()
1475 * @ingroup Password_last_show
1477 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1484 * @defgroup UI-Mirroring Selective Widget mirroring
1486 * These functions allow you to set ui-mirroring on specific
1487 * widgets or the whole interface. Widgets can be in one of two
1488 * modes, automatic and manual. Automatic means they'll be changed
1489 * according to the system mirroring mode and manual means only
1490 * explicit changes will matter. You are not supposed to change
1491 * mirroring state of a widget set to automatic, will mostly work,
1492 * but the behavior is not really defined.
1497 EAPI Eina_Bool elm_mirrored_get(void);
1498 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1501 * Get the system mirrored mode. This determines the default mirrored mode
1504 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1506 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1509 * Set the system mirrored mode. This determines the default mirrored mode
1512 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1514 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1517 * Returns the widget's mirrored mode setting.
1519 * @param obj The widget.
1520 * @return mirrored mode setting of the object.
1523 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1526 * Sets the widget's mirrored mode setting.
1527 * When widget in automatic mode, it follows the system mirrored mode set by
1528 * elm_mirrored_set().
1529 * @param obj The widget.
1530 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1532 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1539 * Set the style to use by a widget
1541 * Sets the style name that will define the appearance of a widget. Styles
1542 * vary from widget to widget and may also be defined by other themes
1543 * by means of extensions and overlays.
1545 * @param obj The Elementary widget to style
1546 * @param style The style name to use
1548 * @see elm_theme_extension_add()
1549 * @see elm_theme_extension_del()
1550 * @see elm_theme_overlay_add()
1551 * @see elm_theme_overlay_del()
1555 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1557 * Get the style used by the widget
1559 * This gets the style being used for that widget. Note that the string
1560 * pointer is only valid as longas the object is valid and the style doesn't
1563 * @param obj The Elementary widget to query for its style
1564 * @return The style name used
1566 * @see elm_object_style_set()
1570 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1573 * @defgroup Styles Styles
1575 * Widgets can have different styles of look. These generic API's
1576 * set styles of widgets, if they support them (and if the theme(s)
1579 * @ref general_functions_example_page "This" example contemplates
1580 * some of these functions.
1584 * Set the disabled state of an Elementary object.
1586 * @param obj The Elementary object to operate on
1587 * @param disabled The state to put in in: @c EINA_TRUE for
1588 * disabled, @c EINA_FALSE for enabled
1590 * Elementary objects can be @b disabled, in which state they won't
1591 * receive input and, in general, will be themed differently from
1592 * their normal state, usually greyed out. Useful for contexts
1593 * where you don't want your users to interact with some of the
1594 * parts of you interface.
1596 * This sets the state for the widget, either disabling it or
1601 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1604 * Get the disabled state of an Elementary object.
1606 * @param obj The Elementary object to operate on
1607 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1608 * if it's enabled (or on errors)
1610 * This gets the state of the widget, which might be enabled or disabled.
1614 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1617 * @defgroup WidgetNavigation Widget Tree Navigation.
1619 * How to check if an Evas Object is an Elementary widget? How to
1620 * get the first elementary widget that is parent of the given
1621 * object? These are all covered in widget tree navigation.
1623 * @ref general_functions_example_page "This" example contemplates
1624 * some of these functions.
1628 * Check if the given Evas Object is an Elementary widget.
1630 * @param obj the object to query.
1631 * @return @c EINA_TRUE if it is an elementary widget variant,
1632 * @c EINA_FALSE otherwise
1633 * @ingroup WidgetNavigation
1635 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1638 * Get the first parent of the given object that is an Elementary
1641 * @param obj the Elementary object to query parent from.
1642 * @return the parent object that is an Elementary widget, or @c
1643 * NULL, if it was not found.
1645 * Use this to query for an object's parent widget.
1647 * @note Most of Elementary users wouldn't be mixing non-Elementary
1648 * smart objects in the objects tree of an application, as this is
1649 * an advanced usage of Elementary with Evas. So, except for the
1650 * application's window, which is the root of that tree, all other
1651 * objects would have valid Elementary widget parents.
1653 * @ingroup WidgetNavigation
1655 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1658 * Get the top level parent of an Elementary widget.
1660 * @param obj The object to query.
1661 * @return The top level Elementary widget, or @c NULL if parent cannot be
1663 * @ingroup WidgetNavigation
1665 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1668 * Get the string that represents this Elementary widget.
1670 * @note Elementary is weird and exposes itself as a single
1671 * Evas_Object_Smart_Class of type "elm_widget", so
1672 * evas_object_type_get() always return that, making debug and
1673 * language bindings hard. This function tries to mitigate this
1674 * problem, but the solution is to change Elementary to use
1675 * proper inheritance.
1677 * @param obj the object to query.
1678 * @return Elementary widget name, or @c NULL if not a valid widget.
1679 * @ingroup WidgetNavigation
1681 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1684 * @defgroup Config Elementary Config
1686 * Elementary configuration is formed by a set options bounded to a
1687 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1688 * "finger size", etc. These are functions with which one syncronizes
1689 * changes made to those values to the configuration storing files, de
1690 * facto. You most probably don't want to use the functions in this
1691 * group unlees you're writing an elementary configuration manager.
1697 * Save back Elementary's configuration, so that it will persist on
1700 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1703 * This function will take effect -- thus, do I/O -- immediately. Use
1704 * it when you want to apply all configuration changes at once. The
1705 * current configuration set will get saved onto the current profile
1706 * configuration file.
1709 EAPI Eina_Bool elm_config_save(void);
1712 * Reload Elementary's configuration, bounded to current selected
1715 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1718 * Useful when you want to force reloading of configuration values for
1719 * a profile. If one removes user custom configuration directories,
1720 * for example, it will force a reload with system values insted.
1723 EAPI void elm_config_reload(void);
1730 * @defgroup Profile Elementary Profile
1732 * Profiles are pre-set options that affect the whole look-and-feel of
1733 * Elementary-based applications. There are, for example, profiles
1734 * aimed at desktop computer applications and others aimed at mobile,
1735 * touchscreen-based ones. You most probably don't want to use the
1736 * functions in this group unlees you're writing an elementary
1737 * configuration manager.
1743 * Get Elementary's profile in use.
1745 * This gets the global profile that is applied to all Elementary
1748 * @return The profile's name
1751 EAPI const char *elm_profile_current_get(void);
1754 * Get an Elementary's profile directory path in the filesystem. One
1755 * may want to fetch a system profile's dir or an user one (fetched
1758 * @param profile The profile's name
1759 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1760 * or a system one (@c EINA_FALSE)
1761 * @return The profile's directory path.
1764 * @note You must free it with elm_profile_dir_free().
1766 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1769 * Free an Elementary's profile directory path, as returned by
1770 * elm_profile_dir_get().
1772 * @param p_dir The profile's path
1776 EAPI void elm_profile_dir_free(const char *p_dir);
1779 * Get Elementary's list of available profiles.
1781 * @return The profiles list. List node data are the profile name
1785 * @note One must free this list, after usage, with the function
1786 * elm_profile_list_free().
1788 EAPI Eina_List *elm_profile_list_get(void);
1791 * Free Elementary's list of available profiles.
1793 * @param l The profiles list, as returned by elm_profile_list_get().
1797 EAPI void elm_profile_list_free(Eina_List *l);
1800 * Set Elementary's profile.
1802 * This sets the global profile that is applied to Elementary
1803 * applications. Just the process the call comes from will be
1806 * @param profile The profile's name
1810 EAPI void elm_profile_set(const char *profile);
1813 * Set Elementary's profile.
1815 * This sets the global profile that is applied to all Elementary
1816 * applications. All running Elementary windows will be affected.
1818 * @param profile The profile's name
1822 EAPI void elm_profile_all_set(const char *profile);
1829 * @defgroup Engine Elementary Engine
1831 * These are functions setting and querying which rendering engine
1832 * Elementary will use for drawing its windows' pixels.
1834 * The following are the available engines:
1835 * @li "software_x11"
1838 * @li "software_16_x11"
1839 * @li "software_8_x11"
1842 * @li "software_gdi"
1843 * @li "software_16_wince_gdi"
1845 * @li "software_16_sdl"
1853 * @brief Get Elementary's rendering engine in use.
1855 * @return The rendering engine's name
1856 * @note there's no need to free the returned string, here.
1858 * This gets the global rendering engine that is applied to all Elementary
1861 * @see elm_engine_set()
1863 EAPI const char *elm_engine_current_get(void);
1866 * @brief Set Elementary's rendering engine for use.
1868 * @param engine The rendering engine's name
1870 * This sets global rendering engine that is applied to all Elementary
1871 * applications. Note that it will take effect only to Elementary windows
1872 * created after this is called.
1874 * @see elm_win_add()
1876 EAPI void elm_engine_set(const char *engine);
1883 * @defgroup Fonts Elementary Fonts
1885 * These are functions dealing with font rendering, selection and the
1886 * like for Elementary applications. One might fetch which system
1887 * fonts are there to use and set custom fonts for individual classes
1888 * of UI items containing text (text classes).
1893 typedef struct _Elm_Text_Class
1899 typedef struct _Elm_Font_Overlay
1901 const char *text_class;
1903 Evas_Font_Size size;
1906 typedef struct _Elm_Font_Properties
1910 } Elm_Font_Properties;
1913 * Get Elementary's list of supported text classes.
1915 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1918 * Release the list with elm_text_classes_list_free().
1920 EAPI const Eina_List *elm_text_classes_list_get(void);
1923 * Free Elementary's list of supported text classes.
1927 * @see elm_text_classes_list_get().
1929 EAPI void elm_text_classes_list_free(const Eina_List *list);
1932 * Get Elementary's list of font overlays, set with
1933 * elm_font_overlay_set().
1935 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1940 * For each text class, one can set a <b>font overlay</b> for it,
1941 * overriding the default font properties for that class coming from
1942 * the theme in use. There is no need to free this list.
1944 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1946 EAPI const Eina_List *elm_font_overlay_list_get(void);
1949 * Set a font overlay for a given Elementary text class.
1951 * @param text_class Text class name
1952 * @param font Font name and style string
1953 * @param size Font size
1957 * @p font has to be in the format returned by
1958 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1959 * and elm_font_overlay_unset().
1961 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1964 * Unset a font overlay for a given Elementary text class.
1966 * @param text_class Text class name
1970 * This will bring back text elements belonging to text class
1971 * @p text_class back to their default font settings.
1973 EAPI void elm_font_overlay_unset(const char *text_class);
1976 * Apply the changes made with elm_font_overlay_set() and
1977 * elm_font_overlay_unset() on the current Elementary window.
1981 * This applies all font overlays set to all objects in the UI.
1983 EAPI void elm_font_overlay_apply(void);
1986 * Apply the changes made with elm_font_overlay_set() and
1987 * elm_font_overlay_unset() on all Elementary application windows.
1991 * This applies all font overlays set to all objects in the UI.
1993 EAPI void elm_font_overlay_all_apply(void);
1996 * Translate a font (family) name string in fontconfig's font names
1997 * syntax into an @c Elm_Font_Properties struct.
1999 * @param font The font name and styles string
2000 * @return the font properties struct
2004 * @note The reverse translation can be achived with
2005 * elm_font_fontconfig_name_get(), for one style only (single font
2006 * instance, not family).
2008 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2011 * Free font properties return by elm_font_properties_get().
2013 * @param efp the font properties struct
2017 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2020 * Translate a font name, bound to a style, into fontconfig's font names
2023 * @param name The font (family) name
2024 * @param style The given style (may be @c NULL)
2026 * @return the font name and style string
2030 * @note The reverse translation can be achived with
2031 * elm_font_properties_get(), for one style only (single font
2032 * instance, not family).
2034 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2037 * Free the font string return by elm_font_fontconfig_name_get().
2039 * @param efp the font properties struct
2043 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2046 * Create a font hash table of available system fonts.
2048 * One must call it with @p list being the return value of
2049 * evas_font_available_list(). The hash will be indexed by font
2050 * (family) names, being its values @c Elm_Font_Properties blobs.
2052 * @param list The list of available system fonts, as returned by
2053 * evas_font_available_list().
2054 * @return the font hash.
2058 * @note The user is supposed to get it populated at least with 3
2059 * default font families (Sans, Serif, Monospace), which should be
2060 * present on most systems.
2062 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2065 * Free the hash return by elm_font_available_hash_add().
2067 * @param hash the hash to be freed.
2071 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2078 * @defgroup Fingers Fingers
2080 * Elementary is designed to be finger-friendly for touchscreens,
2081 * and so in addition to scaling for display resolution, it can
2082 * also scale based on finger "resolution" (or size). You can then
2083 * customize the granularity of the areas meant to receive clicks
2086 * Different profiles may have pre-set values for finger sizes.
2088 * @ref general_functions_example_page "This" example contemplates
2089 * some of these functions.
2095 * Get the configured "finger size"
2097 * @return The finger size
2099 * This gets the globally configured finger size, <b>in pixels</b>
2103 EAPI Evas_Coord elm_finger_size_get(void);
2106 * Set the configured finger size
2108 * This sets the globally configured finger size in pixels
2110 * @param size The finger size
2113 EAPI void elm_finger_size_set(Evas_Coord size);
2116 * Set the configured finger size for all applications on the display
2118 * This sets the globally configured finger size in pixels for all
2119 * applications on the display
2121 * @param size The finger size
2124 EAPI void elm_finger_size_all_set(Evas_Coord size);
2131 * @defgroup Focus Focus
2133 * An Elementary application has, at all times, one (and only one)
2134 * @b focused object. This is what determines where the input
2135 * events go to within the application's window. Also, focused
2136 * objects can be decorated differently, in order to signal to the
2137 * user where the input is, at a given moment.
2139 * Elementary applications also have the concept of <b>focus
2140 * chain</b>: one can cycle through all the windows' focusable
2141 * objects by input (tab key) or programmatically. The default
2142 * focus chain for an application is the one define by the order in
2143 * which the widgets where added in code. One will cycle through
2144 * top level widgets, and, for each one containg sub-objects, cycle
2145 * through them all, before returning to the level
2146 * above. Elementary also allows one to set @b custom focus chains
2147 * for their applications.
2149 * Besides the focused decoration a widget may exhibit, when it
2150 * gets focus, Elementary has a @b global focus highlight object
2151 * that can be enabled for a window. If one chooses to do so, this
2152 * extra highlight effect will surround the current focused object,
2155 * @note Some Elementary widgets are @b unfocusable, after
2156 * creation, by their very nature: they are not meant to be
2157 * interacted with input events, but are there just for visual
2160 * @ref general_functions_example_page "This" example contemplates
2161 * some of these functions.
2165 * Get the enable status of the focus highlight
2167 * This gets whether the highlight on focused objects is enabled or not
2170 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2173 * Set the enable status of the focus highlight
2175 * Set whether to show or not the highlight on focused objects
2176 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2179 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2182 * Get the enable status of the highlight animation
2184 * Get whether the focus highlight, if enabled, will animate its switch from
2185 * one object to the next
2188 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2191 * Set the enable status of the highlight animation
2193 * Set whether the focus highlight, if enabled, will animate its switch from
2194 * one object to the next
2195 * @param animate Enable animation if EINA_TRUE, disable otherwise
2198 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2201 * Get the whether an Elementary object has the focus or not.
2203 * @param obj The Elementary object to get the information from
2204 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2205 * not (and on errors).
2207 * @see elm_object_focus_set()
2211 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2214 * Set/unset focus to a given Elementary object.
2216 * @param obj The Elementary object to operate on.
2217 * @param enable @c EINA_TRUE Set focus to a given object,
2218 * @c EINA_FALSE Unset focus to a given object.
2220 * @note When you set focus to this object, if it can handle focus, will
2221 * take the focus away from the one who had it previously and will, for
2222 * now on, be the one receiving input events. Unsetting focus will remove
2223 * the focus from @p obj, passing it back to the previous element in the
2226 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2230 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2233 * Make a given Elementary object the focused one.
2235 * @param obj The Elementary object to make focused.
2237 * @note This object, if it can handle focus, will take the focus
2238 * away from the one who had it previously and will, for now on, be
2239 * the one receiving input events.
2241 * @see elm_object_focus_get()
2242 * @deprecated use elm_object_focus_set() instead.
2246 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2249 * Remove the focus from an Elementary object
2251 * @param obj The Elementary to take focus from
2253 * This removes the focus from @p obj, passing it back to the
2254 * previous element in the focus chain list.
2256 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2257 * @deprecated use elm_object_focus_set() instead.
2261 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2264 * Set the ability for an Element object to be focused
2266 * @param obj The Elementary object to operate on
2267 * @param enable @c EINA_TRUE if the object can be focused, @c
2268 * EINA_FALSE if not (and on errors)
2270 * This sets whether the object @p obj is able to take focus or
2271 * not. Unfocusable objects do nothing when programmatically
2272 * focused, being the nearest focusable parent object the one
2273 * really getting focus. Also, when they receive mouse input, they
2274 * will get the event, but not take away the focus from where it
2279 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2282 * Get whether an Elementary object is focusable or not
2284 * @param obj The Elementary object to operate on
2285 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2286 * EINA_FALSE if not (and on errors)
2288 * @note Objects which are meant to be interacted with by input
2289 * events are created able to be focused, by default. All the
2294 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2297 * Set custom focus chain.
2299 * This function overwrites any previous custom focus chain within
2300 * the list of objects. The previous list will be deleted and this list
2301 * will be managed by elementary. After it is set, don't modify it.
2303 * @note On focus cycle, only will be evaluated children of this container.
2305 * @param obj The container object
2306 * @param objs Chain of objects to pass focus
2309 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2312 * Unset a custom focus chain on a given Elementary widget
2314 * @param obj The container object to remove focus chain from
2316 * Any focus chain previously set on @p obj (for its child objects)
2317 * is removed entirely after this call.
2321 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2324 * Get custom focus chain
2326 * @param obj The container object
2329 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2332 * Append object to custom focus chain.
2334 * @note If relative_child equal to NULL or not in custom chain, the object
2335 * will be added in end.
2337 * @note On focus cycle, only will be evaluated children of this container.
2339 * @param obj The container object
2340 * @param child The child to be added in custom chain
2341 * @param relative_child The relative object to position the child
2344 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2347 * Prepend object to custom focus chain.
2349 * @note If relative_child equal to NULL or not in custom chain, the object
2350 * will be added in begin.
2352 * @note On focus cycle, only will be evaluated children of this container.
2354 * @param obj The container object
2355 * @param child The child to be added in custom chain
2356 * @param relative_child The relative object to position the child
2359 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2362 * Give focus to next object in object tree.
2364 * Give focus to next object in focus chain of one object sub-tree.
2365 * If the last object of chain already have focus, the focus will go to the
2366 * first object of chain.
2368 * @param obj The object root of sub-tree
2369 * @param dir Direction to cycle the focus
2373 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2376 * Give focus to near object in one direction.
2378 * Give focus to near object in direction of one object.
2379 * If none focusable object in given direction, the focus will not change.
2381 * @param obj The reference object
2382 * @param x Horizontal component of direction to focus
2383 * @param y Vertical component of direction to focus
2387 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2390 * Make the elementary object and its children to be unfocusable
2393 * @param obj The Elementary object to operate on
2394 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2395 * @c EINA_FALSE for focusable.
2397 * This sets whether the object @p obj and its children objects
2398 * are able to take focus or not. If the tree is set as unfocusable,
2399 * newest focused object which is not in this tree will get focus.
2400 * This API can be helpful for an object to be deleted.
2401 * When an object will be deleted soon, it and its children may not
2402 * want to get focus (by focus reverting or by other focus controls).
2403 * Then, just use this API before deleting.
2405 * @see elm_object_tree_unfocusable_get()
2409 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2412 * Get whether an Elementary object and its children are unfocusable or not.
2414 * @param obj The Elementary object to get the information from
2415 * @return @c EINA_TRUE, if the tree is unfocussable,
2416 * @c EINA_FALSE if not (and on errors).
2418 * @see elm_object_tree_unfocusable_set()
2422 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2425 * @defgroup Scrolling Scrolling
2427 * These are functions setting how scrollable views in Elementary
2428 * widgets should behave on user interaction.
2434 * Get whether scrollers should bounce when they reach their
2435 * viewport's edge during a scroll.
2437 * @return the thumb scroll bouncing state
2439 * This is the default behavior for touch screens, in general.
2440 * @ingroup Scrolling
2442 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2445 * Set whether scrollers should bounce when they reach their
2446 * viewport's edge during a scroll.
2448 * @param enabled the thumb scroll bouncing state
2450 * @see elm_thumbscroll_bounce_enabled_get()
2451 * @ingroup Scrolling
2453 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2456 * Set whether scrollers should bounce when they reach their
2457 * viewport's edge during a scroll, for all Elementary application
2460 * @param enabled the thumb scroll bouncing state
2462 * @see elm_thumbscroll_bounce_enabled_get()
2463 * @ingroup Scrolling
2465 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2468 * Get the amount of inertia a scroller will impose at bounce
2471 * @return the thumb scroll bounce friction
2473 * @ingroup Scrolling
2475 EAPI double elm_scroll_bounce_friction_get(void);
2478 * Set the amount of inertia a scroller will impose at bounce
2481 * @param friction the thumb scroll bounce friction
2483 * @see elm_thumbscroll_bounce_friction_get()
2484 * @ingroup Scrolling
2486 EAPI void elm_scroll_bounce_friction_set(double friction);
2489 * Set the amount of inertia a scroller will impose at bounce
2490 * animations, for all Elementary application windows.
2492 * @param friction the thumb scroll bounce friction
2494 * @see elm_thumbscroll_bounce_friction_get()
2495 * @ingroup Scrolling
2497 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2500 * Get the amount of inertia a <b>paged</b> scroller will impose at
2501 * page fitting animations.
2503 * @return the page scroll friction
2505 * @ingroup Scrolling
2507 EAPI double elm_scroll_page_scroll_friction_get(void);
2510 * Set the amount of inertia a <b>paged</b> scroller will impose at
2511 * page fitting animations.
2513 * @param friction the page scroll friction
2515 * @see elm_thumbscroll_page_scroll_friction_get()
2516 * @ingroup Scrolling
2518 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2521 * Set the amount of inertia a <b>paged</b> scroller will impose at
2522 * page fitting animations, for all Elementary application windows.
2524 * @param friction the page scroll friction
2526 * @see elm_thumbscroll_page_scroll_friction_get()
2527 * @ingroup Scrolling
2529 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2532 * Get the amount of inertia a scroller will impose at region bring
2535 * @return the bring in scroll friction
2537 * @ingroup Scrolling
2539 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2542 * Set the amount of inertia a scroller will impose at region bring
2545 * @param friction the bring in scroll friction
2547 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2548 * @ingroup Scrolling
2550 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2553 * Set the amount of inertia a scroller will impose at region bring
2554 * animations, for all Elementary application windows.
2556 * @param friction the bring in scroll friction
2558 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2559 * @ingroup Scrolling
2561 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2564 * Get the amount of inertia scrollers will impose at animations
2565 * triggered by Elementary widgets' zooming API.
2567 * @return the zoom friction
2569 * @ingroup Scrolling
2571 EAPI double elm_scroll_zoom_friction_get(void);
2574 * Set the amount of inertia scrollers will impose at animations
2575 * triggered by Elementary widgets' zooming API.
2577 * @param friction the zoom friction
2579 * @see elm_thumbscroll_zoom_friction_get()
2580 * @ingroup Scrolling
2582 EAPI void elm_scroll_zoom_friction_set(double friction);
2585 * Set the amount of inertia scrollers will impose at animations
2586 * triggered by Elementary widgets' zooming API, for all Elementary
2587 * application windows.
2589 * @param friction the zoom friction
2591 * @see elm_thumbscroll_zoom_friction_get()
2592 * @ingroup Scrolling
2594 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2597 * Get whether scrollers should be draggable from any point in their
2600 * @return the thumb scroll state
2602 * @note This is the default behavior for touch screens, in general.
2603 * @note All other functions namespaced with "thumbscroll" will only
2604 * have effect if this mode is enabled.
2606 * @ingroup Scrolling
2608 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2611 * Set whether scrollers should be draggable from any point in their
2614 * @param enabled the thumb scroll state
2616 * @see elm_thumbscroll_enabled_get()
2617 * @ingroup Scrolling
2619 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2622 * Set whether scrollers should be draggable from any point in their
2623 * views, for all Elementary application windows.
2625 * @param enabled the thumb scroll state
2627 * @see elm_thumbscroll_enabled_get()
2628 * @ingroup Scrolling
2630 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2633 * Get the number of pixels one should travel while dragging a
2634 * scroller's view to actually trigger scrolling.
2636 * @return the thumb scroll threshould
2638 * One would use higher values for touch screens, in general, because
2639 * of their inherent imprecision.
2640 * @ingroup Scrolling
2642 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2645 * Set the number of pixels one should travel while dragging a
2646 * scroller's view to actually trigger scrolling.
2648 * @param threshold the thumb scroll threshould
2650 * @see elm_thumbscroll_threshould_get()
2651 * @ingroup Scrolling
2653 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2656 * Set the number of pixels one should travel while dragging a
2657 * scroller's view to actually trigger scrolling, for all Elementary
2658 * application windows.
2660 * @param threshold the thumb scroll threshould
2662 * @see elm_thumbscroll_threshould_get()
2663 * @ingroup Scrolling
2665 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2668 * Get the minimum speed of mouse cursor movement which will trigger
2669 * list self scrolling animation after a mouse up event
2672 * @return the thumb scroll momentum threshould
2674 * @ingroup Scrolling
2676 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2679 * Set the minimum speed of mouse cursor movement which will trigger
2680 * list self scrolling animation after a mouse up event
2683 * @param threshold the thumb scroll momentum threshould
2685 * @see elm_thumbscroll_momentum_threshould_get()
2686 * @ingroup Scrolling
2688 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2691 * Set the minimum speed of mouse cursor movement which will trigger
2692 * list self scrolling animation after a mouse up event
2693 * (pixels/second), for all Elementary application windows.
2695 * @param threshold the thumb scroll momentum threshould
2697 * @see elm_thumbscroll_momentum_threshould_get()
2698 * @ingroup Scrolling
2700 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2703 * Get the amount of inertia a scroller will impose at self scrolling
2706 * @return the thumb scroll friction
2708 * @ingroup Scrolling
2710 EAPI double elm_scroll_thumbscroll_friction_get(void);
2713 * Set the amount of inertia a scroller will impose at self scrolling
2716 * @param friction the thumb scroll friction
2718 * @see elm_thumbscroll_friction_get()
2719 * @ingroup Scrolling
2721 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2724 * Set the amount of inertia a scroller will impose at self scrolling
2725 * animations, for all Elementary application windows.
2727 * @param friction the thumb scroll friction
2729 * @see elm_thumbscroll_friction_get()
2730 * @ingroup Scrolling
2732 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2735 * Get the amount of lag between your actual mouse cursor dragging
2736 * movement and a scroller's view movement itself, while pushing it
2737 * into bounce state manually.
2739 * @return the thumb scroll border friction
2741 * @ingroup Scrolling
2743 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2746 * Set the amount of lag between your actual mouse cursor dragging
2747 * movement and a scroller's view movement itself, while pushing it
2748 * into bounce state manually.
2750 * @param friction the thumb scroll border friction. @c 0.0 for
2751 * perfect synchrony between two movements, @c 1.0 for maximum
2754 * @see elm_thumbscroll_border_friction_get()
2755 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2757 * @ingroup Scrolling
2759 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2762 * Set the amount of lag between your actual mouse cursor dragging
2763 * movement and a scroller's view movement itself, while pushing it
2764 * into bounce state manually, for all Elementary application windows.
2766 * @param friction the thumb scroll border friction. @c 0.0 for
2767 * perfect synchrony between two movements, @c 1.0 for maximum
2770 * @see elm_thumbscroll_border_friction_get()
2771 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2773 * @ingroup Scrolling
2775 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2782 * @defgroup Scrollhints Scrollhints
2784 * Objects when inside a scroller can scroll, but this may not always be
2785 * desirable in certain situations. This allows an object to hint to itself
2786 * and parents to "not scroll" in one of 2 ways. If any child object of a
2787 * scroller has pushed a scroll freeze or hold then it affects all parent
2788 * scrollers until all children have released them.
2790 * 1. To hold on scrolling. This means just flicking and dragging may no
2791 * longer scroll, but pressing/dragging near an edge of the scroller will
2792 * still scroll. This is automatically used by the entry object when
2795 * 2. To totally freeze scrolling. This means it stops. until
2802 * Push the scroll hold by 1
2804 * This increments the scroll hold count by one. If it is more than 0 it will
2805 * take effect on the parents of the indicated object.
2807 * @param obj The object
2808 * @ingroup Scrollhints
2810 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2813 * Pop the scroll hold by 1
2815 * This decrements the scroll hold count by one. If it is more than 0 it will
2816 * take effect on the parents of the indicated object.
2818 * @param obj The object
2819 * @ingroup Scrollhints
2821 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2824 * Push the scroll freeze by 1
2826 * This increments the scroll freeze count by one. If it is more
2827 * than 0 it will take effect on the parents of the indicated
2830 * @param obj The object
2831 * @ingroup Scrollhints
2833 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2836 * Pop the scroll freeze by 1
2838 * This decrements the scroll freeze count by one. If it is more
2839 * than 0 it will take effect on the parents of the indicated
2842 * @param obj The object
2843 * @ingroup Scrollhints
2845 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2848 * Lock the scrolling of the given widget (and thus all parents)
2850 * This locks the given object from scrolling in the X axis (and implicitly
2851 * also locks all parent scrollers too from doing the same).
2853 * @param obj The object
2854 * @param lock The lock state (1 == locked, 0 == unlocked)
2855 * @ingroup Scrollhints
2857 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2860 * Lock the scrolling of the given widget (and thus all parents)
2862 * This locks the given object from scrolling in the Y axis (and implicitly
2863 * also locks all parent scrollers too from doing the same).
2865 * @param obj The object
2866 * @param lock The lock state (1 == locked, 0 == unlocked)
2867 * @ingroup Scrollhints
2869 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2872 * Get the scrolling lock of the given widget
2874 * This gets the lock for X axis scrolling.
2876 * @param obj The object
2877 * @ingroup Scrollhints
2879 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2882 * Get the scrolling lock of the given widget
2884 * This gets the lock for X axis scrolling.
2886 * @param obj The object
2887 * @ingroup Scrollhints
2889 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2896 * Send a signal to the widget edje object.
2898 * This function sends a signal to the edje object of the obj. An
2899 * edje program can respond to a signal by specifying matching
2900 * 'signal' and 'source' fields.
2902 * @param obj The object
2903 * @param emission The signal's name.
2904 * @param source The signal's source.
2907 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2910 * Add a callback for a signal emitted by widget edje object.
2912 * This function connects a callback function to a signal emitted by the
2913 * edje object of the obj.
2914 * Globs can occur in either the emission or source name.
2916 * @param obj The object
2917 * @param emission The signal's name.
2918 * @param source The signal's source.
2919 * @param func The callback function to be executed when the signal is
2921 * @param data A pointer to data to pass in to the callback function.
2924 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);
2927 * Remove a signal-triggered callback from a widget edje object.
2929 * This function removes a callback, previoulsy attached to a
2930 * signal emitted by the edje object of the obj. The parameters
2931 * emission, source and func must match exactly those passed to a
2932 * previous call to elm_object_signal_callback_add(). The data
2933 * pointer that was passed to this call will be returned.
2935 * @param obj The object
2936 * @param emission The signal's name.
2937 * @param source The signal's source.
2938 * @param func The callback function to be executed when the signal is
2940 * @return The data pointer
2943 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);
2946 * Add a callback for input events (key up, key down, mouse wheel)
2947 * on a given Elementary widget
2949 * @param obj The widget to add an event callback on
2950 * @param func The callback function to be executed when the event
2952 * @param data Data to pass in to @p func
2954 * Every widget in an Elementary interface set to receive focus,
2955 * with elm_object_focus_allow_set(), will propagate @b all of its
2956 * key up, key down and mouse wheel input events up to its parent
2957 * object, and so on. All of the focusable ones in this chain which
2958 * had an event callback set, with this call, will be able to treat
2959 * those events. There are two ways of making the propagation of
2960 * these event upwards in the tree of widgets to @b cease:
2961 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2962 * the event was @b not processed, so the propagation will go on.
2963 * - The @c event_info pointer passed to @p func will contain the
2964 * event's structure and, if you OR its @c event_flags inner
2965 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2966 * one has already handled it, thus killing the event's
2969 * @note Your event callback will be issued on those events taking
2970 * place only if no other child widget of @obj has consumed the
2973 * @note Not to be confused with @c
2974 * evas_object_event_callback_add(), which will add event callbacks
2975 * per type on general Evas objects (no event propagation
2976 * infrastructure taken in account).
2978 * @note Not to be confused with @c
2979 * elm_object_signal_callback_add(), which will add callbacks to @b
2980 * signals coming from a widget's theme, not input events.
2982 * @note Not to be confused with @c
2983 * edje_object_signal_callback_add(), which does the same as
2984 * elm_object_signal_callback_add(), but directly on an Edje
2987 * @note Not to be confused with @c
2988 * evas_object_smart_callback_add(), which adds callbacks to smart
2989 * objects' <b>smart events</b>, and not input events.
2991 * @see elm_object_event_callback_del()
2995 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2998 * Remove an event callback from a widget.
3000 * This function removes a callback, previoulsy attached to event emission
3002 * The parameters func and data must match exactly those passed to
3003 * a previous call to elm_object_event_callback_add(). The data pointer that
3004 * was passed to this call will be returned.
3006 * @param obj The object
3007 * @param func The callback function to be executed when the event is
3009 * @param data Data to pass in to the callback function.
3010 * @return The data pointer
3013 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3016 * Adjust size of an element for finger usage.
3018 * @param times_w How many fingers should fit horizontally
3019 * @param w Pointer to the width size to adjust
3020 * @param times_h How many fingers should fit vertically
3021 * @param h Pointer to the height size to adjust
3023 * This takes width and height sizes (in pixels) as input and a
3024 * size multiple (which is how many fingers you want to place
3025 * within the area, being "finger" the size set by
3026 * elm_finger_size_set()), and adjusts the size to be large enough
3027 * to accommodate the resulting size -- if it doesn't already
3028 * accommodate it. On return the @p w and @p h sizes pointed to by
3029 * these parameters will be modified, on those conditions.
3031 * @note This is kind of a low level Elementary call, most useful
3032 * on size evaluation times for widgets. An external user wouldn't
3033 * be calling, most of the time.
3037 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3040 * Get the duration for occuring long press event.
3042 * @return Timeout for long press event
3043 * @ingroup Longpress
3045 EAPI double elm_longpress_timeout_get(void);
3048 * Set the duration for occuring long press event.
3050 * @param lonpress_timeout Timeout for long press event
3051 * @ingroup Longpress
3053 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3056 * @defgroup Debug Debug
3057 * don't use it unless you are sure
3063 * Print Tree object hierarchy in stdout
3065 * @param obj The root object
3068 EAPI void elm_object_tree_dump(const Evas_Object *top);
3071 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3073 * @param obj The root object
3074 * @param file The path of output file
3077 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3084 * @defgroup Theme Theme
3086 * Elementary uses Edje to theme its widgets, naturally. But for the most
3087 * part this is hidden behind a simpler interface that lets the user set
3088 * extensions and choose the style of widgets in a much easier way.
3090 * Instead of thinking in terms of paths to Edje files and their groups
3091 * each time you want to change the appearance of a widget, Elementary
3092 * works so you can add any theme file with extensions or replace the
3093 * main theme at one point in the application, and then just set the style
3094 * of widgets with elm_object_style_set() and related functions. Elementary
3095 * will then look in its list of themes for a matching group and apply it,
3096 * and when the theme changes midway through the application, all widgets
3097 * will be updated accordingly.
3099 * There are three concepts you need to know to understand how Elementary
3100 * theming works: default theme, extensions and overlays.
3102 * Default theme, obviously enough, is the one that provides the default
3103 * look of all widgets. End users can change the theme used by Elementary
3104 * by setting the @c ELM_THEME environment variable before running an
3105 * application, or globally for all programs using the @c elementary_config
3106 * utility. Applications can change the default theme using elm_theme_set(),
3107 * but this can go against the user wishes, so it's not an adviced practice.
3109 * Ideally, applications should find everything they need in the already
3110 * provided theme, but there may be occasions when that's not enough and
3111 * custom styles are required to correctly express the idea. For this
3112 * cases, Elementary has extensions.
3114 * Extensions allow the application developer to write styles of its own
3115 * to apply to some widgets. This requires knowledge of how each widget
3116 * is themed, as extensions will always replace the entire group used by
3117 * the widget, so important signals and parts need to be there for the
3118 * object to behave properly (see documentation of Edje for details).
3119 * Once the theme for the extension is done, the application needs to add
3120 * it to the list of themes Elementary will look into, using
3121 * elm_theme_extension_add(), and set the style of the desired widgets as
3122 * he would normally with elm_object_style_set().
3124 * Overlays, on the other hand, can replace the look of all widgets by
3125 * overriding the default style. Like extensions, it's up to the application
3126 * developer to write the theme for the widgets it wants, the difference
3127 * being that when looking for the theme, Elementary will check first the
3128 * list of overlays, then the set theme and lastly the list of extensions,
3129 * so with overlays it's possible to replace the default view and every
3130 * widget will be affected. This is very much alike to setting the whole
3131 * theme for the application and will probably clash with the end user
3132 * options, not to mention the risk of ending up with not matching styles
3133 * across the program. Unless there's a very special reason to use them,
3134 * overlays should be avoided for the resons exposed before.
3136 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3137 * keeps one default internally and every function that receives one of
3138 * these can be called with NULL to refer to this default (except for
3139 * elm_theme_free()). It's possible to create a new instance of a
3140 * ::Elm_Theme to set other theme for a specific widget (and all of its
3141 * children), but this is as discouraged, if not even more so, than using
3142 * overlays. Don't use this unless you really know what you are doing.
3144 * But to be less negative about things, you can look at the following
3146 * @li @ref theme_example_01 "Using extensions"
3147 * @li @ref theme_example_02 "Using overlays"
3152 * @typedef Elm_Theme
3154 * Opaque handler for the list of themes Elementary looks for when
3155 * rendering widgets.
3157 * Stay out of this unless you really know what you are doing. For most
3158 * cases, sticking to the default is all a developer needs.
3160 typedef struct _Elm_Theme Elm_Theme;
3163 * Create a new specific theme
3165 * This creates an empty specific theme that only uses the default theme. A
3166 * specific theme has its own private set of extensions and overlays too
3167 * (which are empty by default). Specific themes do not fall back to themes
3168 * of parent objects. They are not intended for this use. Use styles, overlays
3169 * and extensions when needed, but avoid specific themes unless there is no
3170 * other way (example: you want to have a preview of a new theme you are
3171 * selecting in a "theme selector" window. The preview is inside a scroller
3172 * and should display what the theme you selected will look like, but not
3173 * actually apply it yet. The child of the scroller will have a specific
3174 * theme set to show this preview before the user decides to apply it to all
3177 EAPI Elm_Theme *elm_theme_new(void);
3179 * Free a specific theme
3181 * @param th The theme to free
3183 * This frees a theme created with elm_theme_new().
3185 EAPI void elm_theme_free(Elm_Theme *th);
3187 * Copy the theme fom the source to the destination theme
3189 * @param th The source theme to copy from
3190 * @param thdst The destination theme to copy data to
3192 * This makes a one-time static copy of all the theme config, extensions
3193 * and overlays from @p th to @p thdst. If @p th references a theme, then
3194 * @p thdst is also set to reference it, with all the theme settings,
3195 * overlays and extensions that @p th had.
3197 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3199 * Tell the source theme to reference the ref theme
3201 * @param th The theme that will do the referencing
3202 * @param thref The theme that is the reference source
3204 * This clears @p th to be empty and then sets it to refer to @p thref
3205 * so @p th acts as an override to @p thref, but where its overrides
3206 * don't apply, it will fall through to @p thref for configuration.
3208 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3210 * Return the theme referred to
3212 * @param th The theme to get the reference from
3213 * @return The referenced theme handle
3215 * This gets the theme set as the reference theme by elm_theme_ref_set().
3216 * If no theme is set as a reference, NULL is returned.
3218 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3220 * Return the default theme
3222 * @return The default theme handle
3224 * This returns the internal default theme setup handle that all widgets
3225 * use implicitly unless a specific theme is set. This is also often use
3226 * as a shorthand of NULL.
3228 EAPI Elm_Theme *elm_theme_default_get(void);
3230 * Prepends a theme overlay to the list of overlays
3232 * @param th The theme to add to, or if NULL, the default theme
3233 * @param item The Edje file path to be used
3235 * Use this if your application needs to provide some custom overlay theme
3236 * (An Edje file that replaces some default styles of widgets) where adding
3237 * new styles, or changing system theme configuration is not possible. Do
3238 * NOT use this instead of a proper system theme configuration. Use proper
3239 * configuration files, profiles, environment variables etc. to set a theme
3240 * so that the theme can be altered by simple confiugration by a user. Using
3241 * this call to achieve that effect is abusing the API and will create lots
3244 * @see elm_theme_extension_add()
3246 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3248 * Delete a theme overlay from the list of overlays
3250 * @param th The theme to delete from, or if NULL, the default theme
3251 * @param item The name of the theme overlay
3253 * @see elm_theme_overlay_add()
3255 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3257 * Appends a theme extension to the list of extensions.
3259 * @param th The theme to add to, or if NULL, the default theme
3260 * @param item The Edje file path to be used
3262 * This is intended when an application needs more styles of widgets or new
3263 * widget themes that the default does not provide (or may not provide). The
3264 * application has "extended" usage by coming up with new custom style names
3265 * for widgets for specific uses, but as these are not "standard", they are
3266 * not guaranteed to be provided by a default theme. This means the
3267 * application is required to provide these extra elements itself in specific
3268 * Edje files. This call adds one of those Edje files to the theme search
3269 * path to be search after the default theme. The use of this call is
3270 * encouraged when default styles do not meet the needs of the application.
3271 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3273 * @see elm_object_style_set()
3275 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3277 * Deletes a theme extension from the list of extensions.
3279 * @param th The theme to delete from, or if NULL, the default theme
3280 * @param item The name of the theme extension
3282 * @see elm_theme_extension_add()
3284 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3286 * Set the theme search order for the given theme
3288 * @param th The theme to set the search order, or if NULL, the default theme
3289 * @param theme Theme search string
3291 * This sets the search string for the theme in path-notation from first
3292 * theme to search, to last, delimited by the : character. Example:
3294 * "shiny:/path/to/file.edj:default"
3296 * See the ELM_THEME environment variable for more information.
3298 * @see elm_theme_get()
3299 * @see elm_theme_list_get()
3301 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3303 * Return the theme search order
3305 * @param th The theme to get the search order, or if NULL, the default theme
3306 * @return The internal search order path
3308 * This function returns a colon separated string of theme elements as
3309 * returned by elm_theme_list_get().
3311 * @see elm_theme_set()
3312 * @see elm_theme_list_get()
3314 EAPI const char *elm_theme_get(Elm_Theme *th);
3316 * Return a list of theme elements to be used in a theme.
3318 * @param th Theme to get the list of theme elements from.
3319 * @return The internal list of theme elements
3321 * This returns the internal list of theme elements (will only be valid as
3322 * long as the theme is not modified by elm_theme_set() or theme is not
3323 * freed by elm_theme_free(). This is a list of strings which must not be
3324 * altered as they are also internal. If @p th is NULL, then the default
3325 * theme element list is returned.
3327 * A theme element can consist of a full or relative path to a .edj file,
3328 * or a name, without extension, for a theme to be searched in the known
3329 * theme paths for Elemementary.
3331 * @see elm_theme_set()
3332 * @see elm_theme_get()
3334 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3336 * Return the full patrh for a theme element
3338 * @param f The theme element name
3339 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3340 * @return The full path to the file found.
3342 * This returns a string you should free with free() on success, NULL on
3343 * failure. This will search for the given theme element, and if it is a
3344 * full or relative path element or a simple searchable name. The returned
3345 * path is the full path to the file, if searched, and the file exists, or it
3346 * is simply the full path given in the element or a resolved path if
3347 * relative to home. The @p in_search_path boolean pointed to is set to
3348 * EINA_TRUE if the file was a searchable file andis in the search path,
3349 * and EINA_FALSE otherwise.
3351 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3353 * Flush the current theme.
3355 * @param th Theme to flush
3357 * This flushes caches that let elementary know where to find theme elements
3358 * in the given theme. If @p th is NULL, then the default theme is flushed.
3359 * Call this function if source theme data has changed in such a way as to
3360 * make any caches Elementary kept invalid.
3362 EAPI void elm_theme_flush(Elm_Theme *th);
3364 * This flushes all themes (default and specific ones).
3366 * This will flush all themes in the current application context, by calling
3367 * elm_theme_flush() on each of them.
3369 EAPI void elm_theme_full_flush(void);
3371 * Set the theme for all elementary using applications on the current display
3373 * @param theme The name of the theme to use. Format same as the ELM_THEME
3374 * environment variable.
3376 EAPI void elm_theme_all_set(const char *theme);
3378 * Return a list of theme elements in the theme search path
3380 * @return A list of strings that are the theme element names.
3382 * This lists all available theme files in the standard Elementary search path
3383 * for theme elements, and returns them in alphabetical order as theme
3384 * element names in a list of strings. Free this with
3385 * elm_theme_name_available_list_free() when you are done with the list.
3387 EAPI Eina_List *elm_theme_name_available_list_new(void);
3389 * Free the list returned by elm_theme_name_available_list_new()
3391 * This frees the list of themes returned by
3392 * elm_theme_name_available_list_new(). Once freed the list should no longer
3393 * be used. a new list mys be created.
3395 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3397 * Set a specific theme to be used for this object and its children
3399 * @param obj The object to set the theme on
3400 * @param th The theme to set
3402 * This sets a specific theme that will be used for the given object and any
3403 * child objects it has. If @p th is NULL then the theme to be used is
3404 * cleared and the object will inherit its theme from its parent (which
3405 * ultimately will use the default theme if no specific themes are set).
3407 * Use special themes with great care as this will annoy users and make
3408 * configuration difficult. Avoid any custom themes at all if it can be
3411 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3413 * Get the specific theme to be used
3415 * @param obj The object to get the specific theme from
3416 * @return The specifc theme set.
3418 * This will return a specific theme set, or NULL if no specific theme is
3419 * set on that object. It will not return inherited themes from parents, only
3420 * the specific theme set for that specific object. See elm_object_theme_set()
3421 * for more information.
3423 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3429 /** @defgroup Win Win
3431 * @image html img/widget/win/preview-00.png
3432 * @image latex img/widget/win/preview-00.eps
3434 * The window class of Elementary. Contains functions to manipulate
3435 * windows. The Evas engine used to render the window contents is specified
3436 * in the system or user elementary config files (whichever is found last),
3437 * and can be overridden with the ELM_ENGINE environment variable for
3438 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3439 * compilation setup and modules actually installed at runtime) are (listed
3440 * in order of best supported and most likely to be complete and work to
3443 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3444 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3446 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3448 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3450 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3452 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3453 * rendering using SDL as the buffer)
3454 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3455 * GDI with software)
3456 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3457 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3458 * grayscale using dedicated 8bit software engine in X11)
3459 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3460 * X11 using 16bit software engine)
3461 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3462 * (Windows CE rendering via GDI with 16bit software renderer)
3463 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3464 * buffer with 16bit software renderer)
3466 * All engines use a simple string to select the engine to render, EXCEPT
3467 * the "shot" engine. This actually encodes the output of the virtual
3468 * screenshot and how long to delay in the engine string. The engine string
3469 * is encoded in the following way:
3471 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3473 * Where options are separated by a ":" char if more than one option is
3474 * given, with delay, if provided being the first option and file the last
3475 * (order is important). The delay specifies how long to wait after the
3476 * window is shown before doing the virtual "in memory" rendering and then
3477 * save the output to the file specified by the file option (and then exit).
3478 * If no delay is given, the default is 0.5 seconds. If no file is given the
3479 * default output file is "out.png". Repeat option is for continous
3480 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3481 * fixed to "out001.png" Some examples of using the shot engine:
3483 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3484 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3485 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3486 * ELM_ENGINE="shot:delay=2.0" elementary_test
3487 * ELM_ENGINE="shot:" elementary_test
3489 * Signals that you can add callbacks for are:
3491 * @li "delete,request": the user requested to close the window. See
3492 * elm_win_autodel_set().
3493 * @li "focus,in": window got focus
3494 * @li "focus,out": window lost focus
3495 * @li "moved": window that holds the canvas was moved
3498 * @li @ref win_example_01
3503 * Defines the types of window that can be created
3505 * These are hints set on the window so that a running Window Manager knows
3506 * how the window should be handled and/or what kind of decorations it
3509 * Currently, only the X11 backed engines use them.
3511 typedef enum _Elm_Win_Type
3513 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3514 window. Almost every window will be created with this
3516 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3517 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3518 window holding desktop icons. */
3519 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3520 be kept on top of any other window by the Window
3522 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3524 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3525 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3527 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3528 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3529 entry in a menubar is clicked. Typically used
3530 with elm_win_override_set(). This hint exists
3531 for completion only, as the EFL way of
3532 implementing a menu would not normally use a
3533 separate window for its contents. */
3534 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3535 triggered by right-clicking an object. */
3536 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3537 explanatory text that typically appear after the
3538 mouse cursor hovers over an object for a while.
3539 Typically used with elm_win_override_set() and also
3540 not very commonly used in the EFL. */
3541 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3542 battery life or a new E-Mail received. */
3543 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3544 usually used in the EFL. */
3545 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3546 object being dragged across different windows, or even
3547 applications. Typically used with
3548 elm_win_override_set(). */
3549 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3550 buffer. No actual window is created for this
3551 type, instead the window and all of its
3552 contents will be rendered to an image buffer.
3553 This allows to have children window inside a
3554 parent one just like any other object would
3555 be, and do other things like applying @c
3556 Evas_Map effects to it. This is the only type
3557 of window that requires the @c parent
3558 parameter of elm_win_add() to be a valid @c
3563 * The differents layouts that can be requested for the virtual keyboard.
3565 * When the application window is being managed by Illume, it may request
3566 * any of the following layouts for the virtual keyboard.
3568 typedef enum _Elm_Win_Keyboard_Mode
3570 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3571 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3572 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3573 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3574 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3575 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3576 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3577 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3578 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3579 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3580 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3581 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3582 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3583 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3584 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3585 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3586 } Elm_Win_Keyboard_Mode;
3589 * Available commands that can be sent to the Illume manager.
3591 * When running under an Illume session, a window may send commands to the
3592 * Illume manager to perform different actions.
3594 typedef enum _Elm_Illume_Command
3596 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3598 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3600 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3602 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3603 } Elm_Illume_Command;
3606 * Adds a window object. If this is the first window created, pass NULL as
3609 * @param parent Parent object to add the window to, or NULL
3610 * @param name The name of the window
3611 * @param type The window type, one of #Elm_Win_Type.
3613 * The @p parent paramter can be @c NULL for every window @p type except
3614 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3615 * which the image object will be created.
3617 * @return The created object, or NULL on failure
3619 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3621 * Add @p subobj as a resize object of window @p obj.
3624 * Setting an object as a resize object of the window means that the
3625 * @p subobj child's size and position will be controlled by the window
3626 * directly. That is, the object will be resized to match the window size
3627 * and should never be moved or resized manually by the developer.
3629 * In addition, resize objects of the window control what the minimum size
3630 * of it will be, as well as whether it can or not be resized by the user.
3632 * For the end user to be able to resize a window by dragging the handles
3633 * or borders provided by the Window Manager, or using any other similar
3634 * mechanism, all of the resize objects in the window should have their
3635 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3637 * @param obj The window object
3638 * @param subobj The resize object to add
3640 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3642 * Delete @p subobj as a resize object of window @p obj.
3644 * This function removes the object @p subobj from the resize objects of
3645 * the window @p obj. It will not delete the object itself, which will be
3646 * left unmanaged and should be deleted by the developer, manually handled
3647 * or set as child of some other container.
3649 * @param obj The window object
3650 * @param subobj The resize object to add
3652 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3654 * Set the title of the window
3656 * @param obj The window object
3657 * @param title The title to set
3659 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3661 * Get the title of the window
3663 * The returned string is an internal one and should not be freed or
3664 * modified. It will also be rendered invalid if a new title is set or if
3665 * the window is destroyed.
3667 * @param obj The window object
3670 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3672 * Set the window's autodel state.
3674 * When closing the window in any way outside of the program control, like
3675 * pressing the X button in the titlebar or using a command from the
3676 * Window Manager, a "delete,request" signal is emitted to indicate that
3677 * this event occurred and the developer can take any action, which may
3678 * include, or not, destroying the window object.
3680 * When the @p autodel parameter is set, the window will be automatically
3681 * destroyed when this event occurs, after the signal is emitted.
3682 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3683 * and is up to the program to do so when it's required.
3685 * @param obj The window object
3686 * @param autodel If true, the window will automatically delete itself when
3689 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3691 * Get the window's autodel state.
3693 * @param obj The window object
3694 * @return If the window will automatically delete itself when closed
3696 * @see elm_win_autodel_set()
3698 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700 * Activate a window object.
3702 * This function sends a request to the Window Manager to activate the
3703 * window pointed by @p obj. If honored by the WM, the window will receive
3704 * the keyboard focus.
3706 * @note This is just a request that a Window Manager may ignore, so calling
3707 * this function does not ensure in any way that the window will be the
3708 * active one after it.
3710 * @param obj The window object
3712 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3714 * Lower a window object.
3716 * Places the window pointed by @p obj at the bottom of the stack, so that
3717 * no other window is covered by it.
3719 * If elm_win_override_set() is not set, the Window Manager may ignore this
3722 * @param obj The window object
3724 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3726 * Raise a window object.
3728 * Places the window pointed by @p obj at the top of the stack, so that it's
3729 * not covered by any other window.
3731 * If elm_win_override_set() is not set, the Window Manager may ignore this
3734 * @param obj The window object
3736 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3738 * Set the borderless state of a window.
3740 * This function requests the Window Manager to not draw any decoration
3741 * around the window.
3743 * @param obj The window object
3744 * @param borderless If true, the window is borderless
3746 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3748 * Get the borderless state of a window.
3750 * @param obj The window object
3751 * @return If true, the window is borderless
3753 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3755 * Set the shaped state of a window.
3757 * Shaped windows, when supported, will render the parts of the window that
3758 * has no content, transparent.
3760 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3761 * background object or cover the entire window in any other way, or the
3762 * parts of the canvas that have no data will show framebuffer artifacts.
3764 * @param obj The window object
3765 * @param shaped If true, the window is shaped
3767 * @see elm_win_alpha_set()
3769 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3771 * Get the shaped state of a window.
3773 * @param obj The window object
3774 * @return If true, the window is shaped
3776 * @see elm_win_shaped_set()
3778 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3780 * Set the alpha channel state of a window.
3782 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3783 * possibly making parts of the window completely or partially transparent.
3784 * This is also subject to the underlying system supporting it, like for
3785 * example, running under a compositing manager. If no compositing is
3786 * available, enabling this option will instead fallback to using shaped
3787 * windows, with elm_win_shaped_set().
3789 * @param obj The window object
3790 * @param alpha If true, the window has an alpha channel
3792 * @see elm_win_alpha_set()
3794 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3796 * Get the transparency state of a window.
3798 * @param obj The window object
3799 * @return If true, the window is transparent
3801 * @see elm_win_transparent_set()
3803 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3805 * Set the transparency state of a window.
3807 * Use elm_win_alpha_set() instead.
3809 * @param obj The window object
3810 * @param transparent If true, the window is transparent
3812 * @see elm_win_alpha_set()
3814 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3816 * Get the alpha channel state of a window.
3818 * @param obj The window object
3819 * @return If true, the window has an alpha channel
3821 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3823 * Set the override state of a window.
3825 * A window with @p override set to EINA_TRUE will not be managed by the
3826 * Window Manager. This means that no decorations of any kind will be shown
3827 * for it, moving and resizing must be handled by the application, as well
3828 * as the window visibility.
3830 * This should not be used for normal windows, and even for not so normal
3831 * ones, it should only be used when there's a good reason and with a lot
3832 * of care. Mishandling override windows may result situations that
3833 * disrupt the normal workflow of the end user.
3835 * @param obj The window object
3836 * @param override If true, the window is overridden
3838 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3840 * Get the override state of a window.
3842 * @param obj The window object
3843 * @return If true, the window is overridden
3845 * @see elm_win_override_set()
3847 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3849 * Set the fullscreen state of a window.
3851 * @param obj The window object
3852 * @param fullscreen If true, the window is fullscreen
3854 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3856 * Get the fullscreen state of a window.
3858 * @param obj The window object
3859 * @return If true, the window is fullscreen
3861 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3863 * Set the maximized state of a window.
3865 * @param obj The window object
3866 * @param maximized If true, the window is maximized
3868 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3870 * Get the maximized state of a window.
3872 * @param obj The window object
3873 * @return If true, the window is maximized
3875 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3877 * Set the iconified state of a window.
3879 * @param obj The window object
3880 * @param iconified If true, the window is iconified
3882 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3884 * Get the iconified state of a window.
3886 * @param obj The window object
3887 * @return If true, the window is iconified
3889 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3891 * Set the layer of the window.
3893 * What this means exactly will depend on the underlying engine used.
3895 * In the case of X11 backed engines, the value in @p layer has the
3896 * following meanings:
3897 * @li < 3: The window will be placed below all others.
3898 * @li > 5: The window will be placed above all others.
3899 * @li other: The window will be placed in the default layer.
3901 * @param obj The window object
3902 * @param layer The layer of the window
3904 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3906 * Get the layer of the window.
3908 * @param obj The window object
3909 * @return The layer of the window
3911 * @see elm_win_layer_set()
3913 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3915 * Set the rotation of the window.
3917 * Most engines only work with multiples of 90.
3919 * This function is used to set the orientation of the window @p obj to
3920 * match that of the screen. The window itself will be resized to adjust
3921 * to the new geometry of its contents. If you want to keep the window size,
3922 * see elm_win_rotation_with_resize_set().
3924 * @param obj The window object
3925 * @param rotation The rotation of the window, in degrees (0-360),
3926 * counter-clockwise.
3928 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3930 * Rotates the window and resizes it.
3932 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3933 * that they fit inside the current window geometry.
3935 * @param obj The window object
3936 * @param layer The rotation of the window in degrees (0-360),
3937 * counter-clockwise.
3939 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3941 * Get the rotation of the window.
3943 * @param obj The window object
3944 * @return The rotation of the window in degrees (0-360)
3946 * @see elm_win_rotation_set()
3947 * @see elm_win_rotation_with_resize_set()
3949 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3951 * Set the sticky state of the window.
3953 * Hints the Window Manager that the window in @p obj should be left fixed
3954 * at its position even when the virtual desktop it's on moves or changes.
3956 * @param obj The window object
3957 * @param sticky If true, the window's sticky state is enabled
3959 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3961 * Get the sticky state of the window.
3963 * @param obj The window object
3964 * @return If true, the window's sticky state is enabled
3966 * @see elm_win_sticky_set()
3968 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3970 * Set if this window is an illume conformant window
3972 * @param obj The window object
3973 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3975 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3977 * Get if this window is an illume conformant window
3979 * @param obj The window object
3980 * @return A boolean if this window is illume conformant or not
3982 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3984 * Set a window to be an illume quickpanel window
3986 * By default window objects are not quickpanel windows.
3988 * @param obj The window object
3989 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3991 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3993 * Get if this window is a quickpanel or not
3995 * @param obj The window object
3996 * @return A boolean if this window is a quickpanel or not
3998 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4000 * Set the major priority of a quickpanel window
4002 * @param obj The window object
4003 * @param priority The major priority for this quickpanel
4005 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4007 * Get the major priority of a quickpanel window
4009 * @param obj The window object
4010 * @return The major priority of this quickpanel
4012 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4014 * Set the minor priority of a quickpanel window
4016 * @param obj The window object
4017 * @param priority The minor priority for this quickpanel
4019 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4021 * Get the minor priority of a quickpanel window
4023 * @param obj The window object
4024 * @return The minor priority of this quickpanel
4026 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4028 * Set which zone this quickpanel should appear in
4030 * @param obj The window object
4031 * @param zone The requested zone for this quickpanel
4033 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4035 * Get which zone this quickpanel should appear in
4037 * @param obj The window object
4038 * @return The requested zone for this quickpanel
4040 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4042 * Set the window to be skipped by keyboard focus
4044 * This sets the window to be skipped by normal keyboard input. This means
4045 * a window manager will be asked to not focus this window as well as omit
4046 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4048 * Call this and enable it on a window BEFORE you show it for the first time,
4049 * otherwise it may have no effect.
4051 * Use this for windows that have only output information or might only be
4052 * interacted with by the mouse or fingers, and never for typing input.
4053 * Be careful that this may have side-effects like making the window
4054 * non-accessible in some cases unless the window is specially handled. Use
4057 * @param obj The window object
4058 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4060 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4062 * Send a command to the windowing environment
4064 * This is intended to work in touchscreen or small screen device
4065 * environments where there is a more simplistic window management policy in
4066 * place. This uses the window object indicated to select which part of the
4067 * environment to control (the part that this window lives in), and provides
4068 * a command and an optional parameter structure (use NULL for this if not
4071 * @param obj The window object that lives in the environment to control
4072 * @param command The command to send
4073 * @param params Optional parameters for the command
4075 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4077 * Get the inlined image object handle
4079 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4080 * then the window is in fact an evas image object inlined in the parent
4081 * canvas. You can get this object (be careful to not manipulate it as it
4082 * is under control of elementary), and use it to do things like get pixel
4083 * data, save the image to a file, etc.
4085 * @param obj The window object to get the inlined image from
4086 * @return The inlined image object, or NULL if none exists
4088 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4090 * Set the enabled status for the focus highlight in a window
4092 * This function will enable or disable the focus highlight only for the
4093 * given window, regardless of the global setting for it
4095 * @param obj The window where to enable the highlight
4096 * @param enabled The enabled value for the highlight
4098 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4100 * Get the enabled value of the focus highlight for this window
4102 * @param obj The window in which to check if the focus highlight is enabled
4104 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4106 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4108 * Set the style for the focus highlight on this window
4110 * Sets the style to use for theming the highlight of focused objects on
4111 * the given window. If @p style is NULL, the default will be used.
4113 * @param obj The window where to set the style
4114 * @param style The style to set
4116 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4118 * Get the style set for the focus highlight object
4120 * Gets the style set for this windows highilght object, or NULL if none
4123 * @param obj The window to retrieve the highlights style from
4125 * @return The style set or NULL if none was. Default is used in that case.
4127 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4129 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4130 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4131 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4132 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4133 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4134 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4135 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4137 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4138 * (blank mouse, private mouse obj, defaultmouse)
4142 * Sets the keyboard mode of the window.
4144 * @param obj The window object
4145 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4147 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4149 * Gets the keyboard mode of the window.
4151 * @param obj The window object
4152 * @return The mode, one of #Elm_Win_Keyboard_Mode
4154 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4156 * Sets whether the window is a keyboard.
4158 * @param obj The window object
4159 * @param is_keyboard If true, the window is a virtual keyboard
4161 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4163 * Gets whether the window is a keyboard.
4165 * @param obj The window object
4166 * @return If the window is a virtual keyboard
4168 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4171 * Get the screen position of a window.
4173 * @param obj The window object
4174 * @param x The int to store the x coordinate to
4175 * @param y The int to store the y coordinate to
4177 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4183 * @defgroup Inwin Inwin
4185 * @image html img/widget/inwin/preview-00.png
4186 * @image latex img/widget/inwin/preview-00.eps
4187 * @image html img/widget/inwin/preview-01.png
4188 * @image latex img/widget/inwin/preview-01.eps
4189 * @image html img/widget/inwin/preview-02.png
4190 * @image latex img/widget/inwin/preview-02.eps
4192 * An inwin is a window inside a window that is useful for a quick popup.
4193 * It does not hover.
4195 * It works by creating an object that will occupy the entire window, so it
4196 * must be created using an @ref Win "elm_win" as parent only. The inwin
4197 * object can be hidden or restacked below every other object if it's
4198 * needed to show what's behind it without destroying it. If this is done,
4199 * the elm_win_inwin_activate() function can be used to bring it back to
4200 * full visibility again.
4202 * There are three styles available in the default theme. These are:
4203 * @li default: The inwin is sized to take over most of the window it's
4205 * @li minimal: The size of the inwin will be the minimum necessary to show
4207 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4208 * possible, but it's sized vertically the most it needs to fit its\
4211 * Some examples of Inwin can be found in the following:
4212 * @li @ref inwin_example_01
4217 * Adds an inwin to the current window
4219 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4220 * Never call this function with anything other than the top-most window
4221 * as its parameter, unless you are fond of undefined behavior.
4223 * After creating the object, the widget will set itself as resize object
4224 * for the window with elm_win_resize_object_add(), so when shown it will
4225 * appear to cover almost the entire window (how much of it depends on its
4226 * content and the style used). It must not be added into other container
4227 * objects and it needs not be moved or resized manually.
4229 * @param parent The parent object
4230 * @return The new object or NULL if it cannot be created
4232 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4234 * Activates an inwin object, ensuring its visibility
4236 * This function will make sure that the inwin @p obj is completely visible
4237 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4238 * to the front. It also sets the keyboard focus to it, which will be passed
4241 * The object's theme will also receive the signal "elm,action,show" with
4244 * @param obj The inwin to activate
4246 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4248 * Set the content of an inwin object.
4250 * Once the content object is set, a previously set one will be deleted.
4251 * If you want to keep that old content object, use the
4252 * elm_win_inwin_content_unset() function.
4254 * @param obj The inwin object
4255 * @param content The object to set as content
4257 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4259 * Get the content of an inwin object.
4261 * Return the content object which is set for this widget.
4263 * The returned object is valid as long as the inwin is still alive and no
4264 * other content is set on it. Deleting the object will notify the inwin
4265 * about it and this one will be left empty.
4267 * If you need to remove an inwin's content to be reused somewhere else,
4268 * see elm_win_inwin_content_unset().
4270 * @param obj The inwin object
4271 * @return The content that is being used
4273 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 * Unset the content of an inwin object.
4277 * Unparent and return the content object which was set for this widget.
4279 * @param obj The inwin object
4280 * @return The content that was being used
4282 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4286 /* X specific calls - won't work on non-x engines (return 0) */
4289 * Get the Ecore_X_Window of an Evas_Object
4291 * @param obj The object
4293 * @return The Ecore_X_Window of @p obj
4297 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299 /* smart callbacks called:
4300 * "delete,request" - the user requested to delete the window
4301 * "focus,in" - window got focus
4302 * "focus,out" - window lost focus
4303 * "moved" - window that holds the canvas was moved
4309 * @image html img/widget/bg/preview-00.png
4310 * @image latex img/widget/bg/preview-00.eps
4312 * @brief Background object, used for setting a solid color, image or Edje
4313 * group as background to a window or any container object.
4315 * The bg object is used for setting a solid background to a window or
4316 * packing into any container object. It works just like an image, but has
4317 * some properties useful to a background, like setting it to tiled,
4318 * centered, scaled or stretched.
4320 * Here is some sample code using it:
4321 * @li @ref bg_01_example_page
4322 * @li @ref bg_02_example_page
4323 * @li @ref bg_03_example_page
4327 typedef enum _Elm_Bg_Option
4329 ELM_BG_OPTION_CENTER, /**< center the background */
4330 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4331 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4332 ELM_BG_OPTION_TILE /**< tile background at its original size */
4336 * Add a new background to the parent
4338 * @param parent The parent object
4339 * @return The new object or NULL if it cannot be created
4343 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4346 * Set the file (image or edje) used for the background
4348 * @param obj The bg object
4349 * @param file The file path
4350 * @param group Optional key (group in Edje) within the file
4352 * This sets the image file used in the background object. The image (or edje)
4353 * will be stretched (retaining aspect if its an image file) to completely fill
4354 * the bg object. This may mean some parts are not visible.
4356 * @note Once the image of @p obj is set, a previously set one will be deleted,
4357 * even if @p file is NULL.
4361 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4364 * Get 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
4372 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4375 * Set the option used for the background image
4377 * @param obj The bg object
4378 * @param option The desired background option (TILE, SCALE)
4380 * This sets the option used for manipulating the display of the background
4381 * image. The image can be tiled or scaled.
4385 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4388 * Get the option used for the background image
4390 * @param obj The bg object
4391 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4395 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4397 * Set the option used for the background color
4399 * @param obj The bg object
4404 * This sets the color used for the background rectangle. Its range goes
4409 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4411 * Get the option used for the background color
4413 * @param obj The bg object
4420 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4423 * Set the overlay object used for the background object.
4425 * @param obj The bg object
4426 * @param overlay The overlay object
4428 * This provides a way for elm_bg to have an 'overlay' that will be on top
4429 * of the bg. Once the over object is set, a previously set one will be
4430 * deleted, even if you set the new one to NULL. If you want to keep that
4431 * old content object, use the elm_bg_overlay_unset() function.
4436 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4439 * Get the overlay object used for the background object.
4441 * @param obj The bg object
4442 * @return The content that is being used
4444 * Return the content object which is set for this widget
4448 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4451 * Get the overlay object used for the background object.
4453 * @param obj The bg object
4454 * @return The content that was being used
4456 * Unparent and return the overlay object which was set for this widget
4460 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4463 * Set the size of the pixmap representation of the image.
4465 * This option just makes sense if an image is going to be set in the bg.
4467 * @param obj The bg object
4468 * @param w The new width of the image pixmap representation.
4469 * @param h The new height of the image pixmap representation.
4471 * This function sets a new size for pixmap representation of the given bg
4472 * image. It allows the image to be loaded already in the specified size,
4473 * reducing the memory usage and load time when loading a big image with load
4474 * size set to a smaller size.
4476 * NOTE: this is just a hint, the real size of the pixmap may differ
4477 * depending on the type of image being loaded, being bigger than requested.
4481 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4482 /* smart callbacks called:
4486 * @defgroup Icon Icon
4488 * @image html img/widget/icon/preview-00.png
4489 * @image latex img/widget/icon/preview-00.eps
4491 * An object that provides standard icon images (delete, edit, arrows, etc.)
4492 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4494 * The icon image requested can be in the elementary theme, or in the
4495 * freedesktop.org paths. It's possible to set the order of preference from
4496 * where the image will be used.
4498 * This API is very similar to @ref Image, but with ready to use images.
4500 * Default images provided by the theme are described below.
4502 * The first list contains icons that were first intended to be used in
4503 * toolbars, but can be used in many other places too:
4519 * Now some icons that were designed to be used in menus (but again, you can
4520 * use them anywhere else):
4525 * @li menu/arrow_down
4526 * @li menu/arrow_left
4527 * @li menu/arrow_right
4536 * And here we have some media player specific icons:
4537 * @li media_player/forward
4538 * @li media_player/info
4539 * @li media_player/next
4540 * @li media_player/pause
4541 * @li media_player/play
4542 * @li media_player/prev
4543 * @li media_player/rewind
4544 * @li media_player/stop
4546 * Signals that you can add callbacks for are:
4548 * "clicked" - This is called when a user has clicked the icon
4550 * An example of usage for this API follows:
4551 * @li @ref tutorial_icon
4559 typedef enum _Elm_Icon_Type
4566 * @enum _Elm_Icon_Lookup_Order
4567 * @typedef Elm_Icon_Lookup_Order
4569 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4570 * theme, FDO paths, or both?
4574 typedef enum _Elm_Icon_Lookup_Order
4576 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4577 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4578 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4579 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4580 } Elm_Icon_Lookup_Order;
4583 * Add a new icon object to the parent.
4585 * @param parent The parent object
4586 * @return The new object or NULL if it cannot be created
4588 * @see elm_icon_file_set()
4592 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4594 * Set the file that will be used as icon.
4596 * @param obj The icon object
4597 * @param file The path to file that will be used as icon image
4598 * @param group The group that the icon belongs to in edje file
4600 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4602 * @note The icon image set by this function can be changed by
4603 * elm_icon_standard_set().
4605 * @see elm_icon_file_get()
4609 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4611 * Set a location in memory to be used as an icon
4613 * @param obj The icon object
4614 * @param img The binary data that will be used as an image
4615 * @param size The size of binary data @p img
4616 * @param format Optional format of @p img to pass to the image loader
4617 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4619 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4621 * @note The icon image set by this function can be changed by
4622 * elm_icon_standard_set().
4626 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);
4628 * Get the file that will be used as icon.
4630 * @param obj The icon object
4631 * @param file The path to file that will be used as icon icon image
4632 * @param group The group that the icon belongs to in edje file
4634 * @see elm_icon_file_set()
4638 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4639 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4641 * Set the icon by icon standards names.
4643 * @param obj The icon object
4644 * @param name The icon name
4646 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4648 * For example, freedesktop.org defines standard icon names such as "home",
4649 * "network", etc. There can be different icon sets to match those icon
4650 * keys. The @p name given as parameter is one of these "keys", and will be
4651 * used to look in the freedesktop.org paths and elementary theme. One can
4652 * change the lookup order with elm_icon_order_lookup_set().
4654 * If name is not found in any of the expected locations and it is the
4655 * absolute path of an image file, this image will be used.
4657 * @note The icon image set by this function can be changed by
4658 * elm_icon_file_set().
4660 * @see elm_icon_standard_get()
4661 * @see elm_icon_file_set()
4665 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4667 * Get the icon name set by icon standard names.
4669 * @param obj The icon object
4670 * @return The icon name
4672 * If the icon image was set using elm_icon_file_set() instead of
4673 * elm_icon_standard_set(), then this function will return @c NULL.
4675 * @see elm_icon_standard_set()
4679 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4681 * Set the smooth effect for an icon object.
4683 * @param obj The icon object
4684 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4685 * otherwise. Default is @c EINA_TRUE.
4687 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4688 * scaling provides a better resulting image, but is slower.
4690 * The smooth scaling should be disabled when making animations that change
4691 * the icon size, since they will be faster. Animations that don't require
4692 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4693 * is already scaled, since the scaled icon image will be cached).
4695 * @see elm_icon_smooth_get()
4699 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4701 * Get the smooth effect for an icon object.
4703 * @param obj The icon object
4704 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4706 * @see elm_icon_smooth_set()
4710 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4712 * Disable scaling of this object.
4714 * @param obj The icon object.
4715 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4716 * otherwise. Default is @c EINA_FALSE.
4718 * This function disables scaling of the icon object through the function
4719 * elm_object_scale_set(). However, this does not affect the object
4720 * size/resize in any way. For that effect, take a look at
4721 * elm_icon_scale_set().
4723 * @see elm_icon_no_scale_get()
4724 * @see elm_icon_scale_set()
4725 * @see elm_object_scale_set()
4729 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4731 * Get whether scaling is disabled on the object.
4733 * @param obj The icon object
4734 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4736 * @see elm_icon_no_scale_set()
4740 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4742 * Set if the object is (up/down) resizable.
4744 * @param obj The icon object
4745 * @param scale_up A bool to set if the object is resizable up. Default is
4747 * @param scale_down A bool to set if the object is resizable down. Default
4750 * This function limits the icon object resize ability. If @p scale_up is set to
4751 * @c EINA_FALSE, the object can't have its height or width resized to a value
4752 * higher than the original icon size. Same is valid for @p scale_down.
4754 * @see elm_icon_scale_get()
4758 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4760 * Get 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
4764 * @param scale_down A bool to set if the object is resizable down
4766 * @see elm_icon_scale_set()
4770 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4772 * Get the object's image size
4774 * @param obj The icon object
4775 * @param w A pointer to store the width in
4776 * @param h A pointer to store the height in
4780 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4782 * Set if the icon fill the entire object area.
4784 * @param obj The icon object
4785 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4786 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4788 * When the icon object is resized to a different aspect ratio from the
4789 * original icon image, the icon image will still keep its aspect. This flag
4790 * tells how the image should fill the object's area. They are: keep the
4791 * entire icon inside the limits of height and width of the object (@p
4792 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4793 * of the object, and the icon will fill the entire object (@p fill_outside
4796 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4797 * retain property to false. Thus, the icon image will always keep its
4798 * original aspect ratio.
4800 * @see elm_icon_fill_outside_get()
4801 * @see elm_image_fill_outside_set()
4805 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4807 * Get if the object is filled outside.
4809 * @param obj The icon object
4810 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4812 * @see elm_icon_fill_outside_set()
4816 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4818 * Set the prescale size for the icon.
4820 * @param obj The icon object
4821 * @param size The prescale size. This value is used for both width and
4824 * This function sets a new size for pixmap representation of the given
4825 * icon. It allows the icon to be loaded already in the specified size,
4826 * reducing the memory usage and load time when loading a big icon with load
4827 * size set to a smaller size.
4829 * It's equivalent to the elm_bg_load_size_set() function for bg.
4831 * @note this is just a hint, the real size of the pixmap may differ
4832 * depending on the type of icon being loaded, being bigger than requested.
4834 * @see elm_icon_prescale_get()
4835 * @see elm_bg_load_size_set()
4839 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4841 * Get the prescale size for the icon.
4843 * @param obj The icon object
4844 * @return The prescale size
4846 * @see elm_icon_prescale_set()
4850 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4852 * Sets the icon lookup order used by elm_icon_standard_set().
4854 * @param obj The icon object
4855 * @param order The icon lookup order (can be one of
4856 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4857 * or ELM_ICON_LOOKUP_THEME)
4859 * @see elm_icon_order_lookup_get()
4860 * @see Elm_Icon_Lookup_Order
4864 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4866 * Gets the icon lookup order.
4868 * @param obj The icon object
4869 * @return The icon lookup order
4871 * @see elm_icon_order_lookup_set()
4872 * @see Elm_Icon_Lookup_Order
4876 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4878 * Get if the icon supports animation or not.
4880 * @param obj The icon object
4881 * @return @c EINA_TRUE if the icon supports animation,
4882 * @c EINA_FALSE otherwise.
4884 * Return if this elm icon's image can be animated. Currently Evas only
4885 * supports gif animation. If the return value is EINA_FALSE, other
4886 * elm_icon_animated_XXX APIs won't work.
4889 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4891 * Set animation mode of the icon.
4893 * @param obj The icon object
4894 * @param anim @c EINA_TRUE if the object do animation job,
4895 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4897 * Even though elm icon's file can be animated,
4898 * sometimes appication developer want to just first page of image.
4899 * In that time, don't call this function, because default value is EINA_FALSE
4900 * Only when you want icon support anition,
4901 * use this function and set animated to EINA_TURE
4904 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4906 * Get animation mode of the icon.
4908 * @param obj The icon object
4909 * @return The animation mode of the icon object
4910 * @see elm_icon_animated_set
4913 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4915 * Set animation play mode of the icon.
4917 * @param obj The icon object
4918 * @param play @c EINA_TRUE the object play animation images,
4919 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4921 * If you want to play elm icon's animation, you set play to EINA_TURE.
4922 * For example, you make gif player using this set/get API and click event.
4924 * 1. Click event occurs
4925 * 2. Check play flag using elm_icon_animaged_play_get
4926 * 3. If elm icon was playing, set play to EINA_FALSE.
4927 * Then animation will be stopped and vice versa
4930 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4932 * Get animation play mode of the icon.
4934 * @param obj The icon object
4935 * @return The play mode of the icon object
4937 * @see elm_icon_animated_lay_get
4940 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4947 * @defgroup Image Image
4949 * @image html img/widget/image/preview-00.png
4950 * @image latex img/widget/image/preview-00.eps
4953 * An object that allows one to load an image file to it. It can be used
4954 * anywhere like any other elementary widget.
4956 * This widget provides most of the functionality provided from @ref Bg or @ref
4957 * Icon, but with a slightly different API (use the one that fits better your
4960 * The features not provided by those two other image widgets are:
4961 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4962 * @li change the object orientation with elm_image_orient_set();
4963 * @li and turning the image editable with elm_image_editable_set().
4965 * Signals that you can add callbacks for are:
4967 * @li @c "clicked" - This is called when a user has clicked the image
4969 * An example of usage for this API follows:
4970 * @li @ref tutorial_image
4979 * @enum _Elm_Image_Orient
4980 * @typedef Elm_Image_Orient
4982 * Possible orientation options for elm_image_orient_set().
4984 * @image html elm_image_orient_set.png
4985 * @image latex elm_image_orient_set.eps width=\textwidth
4989 typedef enum _Elm_Image_Orient
4991 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4992 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4993 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4994 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4995 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4996 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4997 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4998 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5002 * Add a new image to the parent.
5004 * @param parent The parent object
5005 * @return The new object or NULL if it cannot be created
5007 * @see elm_image_file_set()
5011 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5013 * Set the file that will be used as image.
5015 * @param obj The image object
5016 * @param file The path to file that will be used as image
5017 * @param group The group that the image belongs in edje file (if it's an
5020 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5022 * @see elm_image_file_get()
5026 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5028 * Get the file that will be used as image.
5030 * @param obj The image object
5031 * @param file The path to file
5032 * @param group The group that the image belongs in edje file
5034 * @see elm_image_file_set()
5038 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5040 * Set the smooth effect for an image.
5042 * @param obj The image object
5043 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5044 * otherwise. Default is @c EINA_TRUE.
5046 * Set the scaling algorithm to be used when scaling the image. Smooth
5047 * scaling provides a better resulting image, but is slower.
5049 * The smooth scaling should be disabled when making animations that change
5050 * the image size, since it will be faster. Animations that don't require
5051 * resizing of the image can keep the smooth scaling enabled (even if the
5052 * image is already scaled, since the scaled image will be cached).
5054 * @see elm_image_smooth_get()
5058 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5060 * Get the smooth effect for an image.
5062 * @param obj The image object
5063 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5065 * @see elm_image_smooth_get()
5069 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5071 * Gets the current size of the image.
5073 * @param obj The image object.
5074 * @param w Pointer to store width, or NULL.
5075 * @param h Pointer to store height, or NULL.
5077 * This is the real size of the image, not the size of the object.
5079 * On error, neither w or h will be written.
5083 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5085 * Disable scaling of this object.
5087 * @param obj The image object.
5088 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5089 * otherwise. Default is @c EINA_FALSE.
5091 * This function disables scaling of the elm_image widget through the
5092 * function elm_object_scale_set(). However, this does not affect the widget
5093 * size/resize in any way. For that effect, take a look at
5094 * elm_image_scale_set().
5096 * @see elm_image_no_scale_get()
5097 * @see elm_image_scale_set()
5098 * @see elm_object_scale_set()
5102 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5104 * Get whether scaling is disabled on the object.
5106 * @param obj The image object
5107 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5109 * @see elm_image_no_scale_set()
5113 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5115 * Set if the object is (up/down) resizable.
5117 * @param obj The image object
5118 * @param scale_up A bool to set if the object is resizable up. Default is
5120 * @param scale_down A bool to set if the object is resizable down. Default
5123 * This function limits the image resize ability. If @p scale_up is set to
5124 * @c EINA_FALSE, the object can't have its height or width resized to a value
5125 * higher than the original image size. Same is valid for @p scale_down.
5127 * @see elm_image_scale_get()
5131 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5133 * Get 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
5137 * @param scale_down A bool to set if the object is resizable down
5139 * @see elm_image_scale_set()
5143 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5145 * Set if the image fill the entire object area when keeping the aspect ratio.
5147 * @param obj The image object
5148 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5149 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5151 * When the image should keep its aspect ratio even if resized to another
5152 * aspect ratio, there are two possibilities to resize it: keep the entire
5153 * image inside the limits of height and width of the object (@p fill_outside
5154 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5155 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5157 * @note This option will have no effect if
5158 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5160 * @see elm_image_fill_outside_get()
5161 * @see elm_image_aspect_ratio_retained_set()
5165 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5167 * Get if the object is filled outside
5169 * @param obj The image object
5170 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5172 * @see elm_image_fill_outside_set()
5176 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5178 * Set the prescale size for the image
5180 * @param obj The image object
5181 * @param size The prescale size. This value is used for both width and
5184 * This function sets a new size for pixmap representation of the given
5185 * image. It allows the image to be loaded already in the specified size,
5186 * reducing the memory usage and load time when loading a big image with load
5187 * size set to a smaller size.
5189 * It's equivalent to the elm_bg_load_size_set() function for bg.
5191 * @note this is just a hint, the real size of the pixmap may differ
5192 * depending on the type of image being loaded, being bigger than requested.
5194 * @see elm_image_prescale_get()
5195 * @see elm_bg_load_size_set()
5199 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5201 * Get the prescale size for the image
5203 * @param obj The image object
5204 * @return The prescale size
5206 * @see elm_image_prescale_set()
5210 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5212 * Set the image orientation.
5214 * @param obj The image object
5215 * @param orient The image orientation
5216 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5217 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5218 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5219 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5220 * Default is #ELM_IMAGE_ORIENT_NONE.
5222 * This function allows to rotate or flip the given image.
5224 * @see elm_image_orient_get()
5225 * @see @ref Elm_Image_Orient
5229 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5231 * Get the image orientation.
5233 * @param obj The image object
5234 * @return The image orientation
5235 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5236 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5237 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5238 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5240 * @see elm_image_orient_set()
5241 * @see @ref Elm_Image_Orient
5245 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5247 * Make the image 'editable'.
5249 * @param obj Image object.
5250 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5252 * This means the image is a valid drag target for drag and drop, and can be
5253 * cut or pasted too.
5257 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5259 * Make the image 'editable'.
5261 * @param obj Image object.
5262 * @return Editability.
5264 * This means the image is a valid drag target for drag and drop, and can be
5265 * cut or pasted too.
5269 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5271 * Get the basic Evas_Image object from this object (widget).
5273 * @param obj The image object to get the inlined image from
5274 * @return The inlined image object, or NULL if none exists
5276 * This function allows one to get the underlying @c Evas_Object of type
5277 * Image from this elementary widget. It can be useful to do things like get
5278 * the pixel data, save the image to a file, etc.
5280 * @note Be careful to not manipulate it, as it is under control of
5285 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5287 * Set whether the original aspect ratio of the image should be kept on resize.
5289 * @param obj The image object.
5290 * @param retained @c EINA_TRUE if the image should retain the aspect,
5291 * @c EINA_FALSE otherwise.
5293 * The original aspect ratio (width / height) of the image is usually
5294 * distorted to match the object's size. Enabling this option will retain
5295 * this original aspect, and the way that the image is fit into the object's
5296 * area depends on the option set by elm_image_fill_outside_set().
5298 * @see elm_image_aspect_ratio_retained_get()
5299 * @see elm_image_fill_outside_set()
5303 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5305 * Get if the object retains the original aspect ratio.
5307 * @param obj The image object.
5308 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5313 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5320 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5322 typedef enum _Elm_GLView_Mode
5324 ELM_GLVIEW_ALPHA = 1,
5325 ELM_GLVIEW_DEPTH = 2,
5326 ELM_GLVIEW_STENCIL = 4
5330 * Defines a policy for the glview resizing.
5332 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5334 typedef enum _Elm_GLView_Resize_Policy
5336 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5337 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5338 } Elm_GLView_Resize_Policy;
5340 typedef enum _Elm_GLView_Render_Policy
5342 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5343 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5344 } Elm_GLView_Render_Policy;
5349 * A simple GLView widget that allows GL rendering.
5351 * Signals that you can add callbacks for are:
5357 * Add a new glview to the parent
5359 * @param parent The parent object
5360 * @return The new object or NULL if it cannot be created
5364 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5367 * Sets the size of the glview
5369 * @param obj The glview object
5370 * @param width width of the glview object
5371 * @param height height of the glview object
5375 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5378 * Gets the size of the glview.
5380 * @param obj The glview object
5381 * @param width width of the glview object
5382 * @param height height of the glview object
5384 * Note that this function returns the actual image size of the
5385 * glview. This means that when the scale policy is set to
5386 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5391 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5394 * Gets the gl api struct for gl rendering
5396 * @param obj The glview object
5397 * @return The api object or NULL if it cannot be created
5401 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5404 * Set the mode of the GLView. Supports Three simple modes.
5406 * @param obj The glview object
5407 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5408 * @return True if set properly.
5412 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5415 * Set the resize policy for the glview object.
5417 * @param obj The glview object.
5418 * @param policy The scaling policy.
5420 * By default, the resize policy is set to
5421 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5422 * destroys the previous surface and recreates the newly specified
5423 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5424 * however, glview only scales the image object and not the underlying
5429 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5432 * Set the render policy for the glview object.
5434 * @param obj The glview object.
5435 * @param policy The render policy.
5437 * By default, the render policy is set to
5438 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5439 * that during the render loop, glview is only redrawn if it needs
5440 * to be redrawn. (i.e. When it is visible) If the policy is set to
5441 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5442 * whether it is visible/need redrawing or not.
5446 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5449 * Set the init function that runs once in the main loop.
5451 * @param obj The glview object.
5452 * @param func The init function to be registered.
5454 * The registered init function gets called once during the render loop.
5458 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5461 * Set the render function that runs in the main loop.
5463 * @param obj The glview object.
5464 * @param func The delete function to be registered.
5466 * The registered del function gets called when GLView object is deleted.
5470 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5473 * Set the resize function that gets called when resize happens.
5475 * @param obj The glview object.
5476 * @param func The resize function to be registered.
5480 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5483 * Set the render function that runs in the main loop.
5485 * @param obj The glview object.
5486 * @param func The render function to be registered.
5490 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5493 * Notifies that there has been changes in the GLView.
5495 * @param obj The glview object.
5499 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5509 * @image html img/widget/box/preview-00.png
5510 * @image latex img/widget/box/preview-00.eps width=\textwidth
5512 * @image html img/box.png
5513 * @image latex img/box.eps width=\textwidth
5515 * A box arranges objects in a linear fashion, governed by a layout function
5516 * that defines the details of this arrangement.
5518 * By default, the box will use an internal function to set the layout to
5519 * a single row, either vertical or horizontal. This layout is affected
5520 * by a number of parameters, such as the homogeneous flag set by
5521 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5522 * elm_box_align_set() and the hints set to each object in the box.
5524 * For this default layout, it's possible to change the orientation with
5525 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5526 * placing its elements ordered from top to bottom. When horizontal is set,
5527 * the order will go from left to right. If the box is set to be
5528 * homogeneous, every object in it will be assigned the same space, that
5529 * of the largest object. Padding can be used to set some spacing between
5530 * the cell given to each object. The alignment of the box, set with
5531 * elm_box_align_set(), determines how the bounding box of all the elements
5532 * will be placed within the space given to the box widget itself.
5534 * The size hints of each object also affect how they are placed and sized
5535 * within the box. evas_object_size_hint_min_set() will give the minimum
5536 * size the object can have, and the box will use it as the basis for all
5537 * latter calculations. Elementary widgets set their own minimum size as
5538 * needed, so there's rarely any need to use it manually.
5540 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5541 * used to tell whether the object will be allocated the minimum size it
5542 * needs or if the space given to it should be expanded. It's important
5543 * to realize that expanding the size given to the object is not the same
5544 * thing as resizing the object. It could very well end being a small
5545 * widget floating in a much larger empty space. If not set, the weight
5546 * for objects will normally be 0.0 for both axis, meaning the widget will
5547 * not be expanded. To take as much space possible, set the weight to
5548 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5550 * Besides how much space each object is allocated, it's possible to control
5551 * how the widget will be placed within that space using
5552 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5553 * for both axis, meaning the object will be centered, but any value from
5554 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5555 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5556 * is -1.0, means the object will be resized to fill the entire space it
5559 * In addition, customized functions to define the layout can be set, which
5560 * allow the application developer to organize the objects within the box
5561 * in any number of ways.
5563 * The special elm_box_layout_transition() function can be used
5564 * to switch from one layout to another, animating the motion of the
5565 * children of the box.
5567 * @note Objects should not be added to box objects using _add() calls.
5569 * Some examples on how to use boxes follow:
5570 * @li @ref box_example_01
5571 * @li @ref box_example_02
5576 * @typedef Elm_Box_Transition
5578 * Opaque handler containing the parameters to perform an animated
5579 * transition of the layout the box uses.
5581 * @see elm_box_transition_new()
5582 * @see elm_box_layout_set()
5583 * @see elm_box_layout_transition()
5585 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5588 * Add a new box to the parent
5590 * By default, the box will be in vertical mode and non-homogeneous.
5592 * @param parent The parent object
5593 * @return The new object or NULL if it cannot be created
5595 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5597 * Set the horizontal orientation
5599 * By default, box object arranges their contents vertically from top to
5601 * By calling this function with @p horizontal as EINA_TRUE, the box will
5602 * become horizontal, arranging contents from left to right.
5604 * @note This flag is ignored if a custom layout function is set.
5606 * @param obj The box object
5607 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5608 * EINA_FALSE = vertical)
5610 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5612 * Get the horizontal orientation
5614 * @param obj The box object
5615 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5617 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5619 * Set the box to arrange its children homogeneously
5621 * If enabled, homogeneous layout makes all items the same size, according
5622 * to the size of the largest of its children.
5624 * @note This flag is ignored if a custom layout function is set.
5626 * @param obj The box object
5627 * @param homogeneous The homogeneous flag
5629 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5631 * Get whether the box is using homogeneous mode or not
5633 * @param obj The box object
5634 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5636 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5637 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5638 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5640 * Add an object to the beginning of the pack list
5642 * Pack @p subobj into the box @p obj, placing it first in the list of
5643 * children objects. The actual position the object will get on screen
5644 * depends on the layout used. If no custom layout is set, it will be at
5645 * the top or left, depending if the box is vertical or horizontal,
5648 * @param obj The box object
5649 * @param subobj The object to add to the box
5651 * @see elm_box_pack_end()
5652 * @see elm_box_pack_before()
5653 * @see elm_box_pack_after()
5654 * @see elm_box_unpack()
5655 * @see elm_box_unpack_all()
5656 * @see elm_box_clear()
5658 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5660 * Add an object at the end of the pack list
5662 * Pack @p subobj into the box @p obj, placing it last in the list of
5663 * children objects. The actual position the object will get on screen
5664 * depends on the layout used. If no custom layout is set, it will be at
5665 * the bottom or right, depending if the box is vertical or horizontal,
5668 * @param obj The box object
5669 * @param subobj The object to add to the box
5671 * @see elm_box_pack_start()
5672 * @see elm_box_pack_before()
5673 * @see elm_box_pack_after()
5674 * @see elm_box_unpack()
5675 * @see elm_box_unpack_all()
5676 * @see elm_box_clear()
5678 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5680 * Adds an object to the box before the indicated object
5682 * This will add the @p subobj to the box indicated before the object
5683 * indicated with @p before. If @p before is not already in the box, results
5684 * are undefined. Before means either to the left of the indicated object or
5685 * above it depending on orientation.
5687 * @param obj The box object
5688 * @param subobj The object to add to the box
5689 * @param before The object before which to add it
5691 * @see elm_box_pack_start()
5692 * @see elm_box_pack_end()
5693 * @see elm_box_pack_after()
5694 * @see elm_box_unpack()
5695 * @see elm_box_unpack_all()
5696 * @see elm_box_clear()
5698 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5700 * Adds an object to the box after the indicated object
5702 * This will add the @p subobj to the box indicated after the object
5703 * indicated with @p after. If @p after is not already in the box, results
5704 * are undefined. After means either to the right of the indicated object or
5705 * below it depending on orientation.
5707 * @param obj The box object
5708 * @param subobj The object to add to the box
5709 * @param after The object after which to add it
5711 * @see elm_box_pack_start()
5712 * @see elm_box_pack_end()
5713 * @see elm_box_pack_before()
5714 * @see elm_box_unpack()
5715 * @see elm_box_unpack_all()
5716 * @see elm_box_clear()
5718 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5720 * Clear the box of all children
5722 * Remove all the elements contained by the box, deleting the respective
5725 * @param obj The box object
5727 * @see elm_box_unpack()
5728 * @see elm_box_unpack_all()
5730 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5734 * Remove the object given by @p subobj from the box @p obj without
5737 * @param obj The box object
5739 * @see elm_box_unpack_all()
5740 * @see elm_box_clear()
5742 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5744 * Remove all items from the box, without deleting them
5746 * Clear the box from all children, but don't delete the respective objects.
5747 * If no other references of the box children exist, the objects will never
5748 * be deleted, and thus the application will leak the memory. Make sure
5749 * when using this function that you hold a reference to all the objects
5750 * in the box @p obj.
5752 * @param obj The box object
5754 * @see elm_box_clear()
5755 * @see elm_box_unpack()
5757 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5759 * Retrieve a list of the objects packed into the box
5761 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5762 * The order of the list corresponds to the packing order the box uses.
5764 * You must free this list with eina_list_free() once you are done with it.
5766 * @param obj The box object
5768 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5770 * Set the space (padding) between the box's elements.
5772 * Extra space in pixels that will be added between a box child and its
5773 * neighbors after its containing cell has been calculated. This padding
5774 * is set for all elements in the box, besides any possible padding that
5775 * individual elements may have through their size hints.
5777 * @param obj The box object
5778 * @param horizontal The horizontal space between elements
5779 * @param vertical The vertical space between elements
5781 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5783 * Get the space (padding) between the box's elements.
5785 * @param obj The box object
5786 * @param horizontal The horizontal space between elements
5787 * @param vertical The vertical space between elements
5789 * @see elm_box_padding_set()
5791 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5793 * Set the alignment of the whole bouding box of contents.
5795 * Sets how the bounding box containing all the elements of the box, after
5796 * their sizes and position has been calculated, will be aligned within
5797 * the space given for the whole box widget.
5799 * @param obj The box object
5800 * @param horizontal The horizontal alignment of elements
5801 * @param vertical The vertical alignment of elements
5803 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5805 * Get the alignment of the whole bouding box of contents.
5807 * @param obj The box object
5808 * @param horizontal The horizontal alignment of elements
5809 * @param vertical The vertical alignment of elements
5811 * @see elm_box_align_set()
5813 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5816 * Set the layout defining function to be used by the box
5818 * Whenever anything changes that requires the box in @p obj to recalculate
5819 * the size and position of its elements, the function @p cb will be called
5820 * to determine what the layout of the children will be.
5822 * Once a custom function is set, everything about the children layout
5823 * is defined by it. The flags set by elm_box_horizontal_set() and
5824 * elm_box_homogeneous_set() no longer have any meaning, and the values
5825 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5826 * layout function to decide if they are used and how. These last two
5827 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5828 * passed to @p cb. The @c Evas_Object the function receives is not the
5829 * Elementary widget, but the internal Evas Box it uses, so none of the
5830 * functions described here can be used on it.
5832 * Any of the layout functions in @c Evas can be used here, as well as the
5833 * special elm_box_layout_transition().
5835 * The final @p data argument received by @p cb is the same @p data passed
5836 * here, and the @p free_data function will be called to free it
5837 * whenever the box is destroyed or another layout function is set.
5839 * Setting @p cb to NULL will revert back to the default layout function.
5841 * @param obj The box object
5842 * @param cb The callback function used for layout
5843 * @param data Data that will be passed to layout function
5844 * @param free_data Function called to free @p data
5846 * @see elm_box_layout_transition()
5848 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);
5850 * Special layout function that animates the transition from one layout to another
5852 * Normally, when switching the layout function for a box, this will be
5853 * reflected immediately on screen on the next render, but it's also
5854 * possible to do this through an animated transition.
5856 * This is done by creating an ::Elm_Box_Transition and setting the box
5857 * layout to this function.
5861 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5862 * evas_object_box_layout_vertical, // start
5863 * NULL, // data for initial layout
5864 * NULL, // free function for initial data
5865 * evas_object_box_layout_horizontal, // end
5866 * NULL, // data for final layout
5867 * NULL, // free function for final data
5868 * anim_end, // will be called when animation ends
5869 * NULL); // data for anim_end function\
5870 * elm_box_layout_set(box, elm_box_layout_transition, t,
5871 * elm_box_transition_free);
5874 * @note This function can only be used with elm_box_layout_set(). Calling
5875 * it directly will not have the expected results.
5877 * @see elm_box_transition_new
5878 * @see elm_box_transition_free
5879 * @see elm_box_layout_set
5881 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5883 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5885 * If you want to animate the change from one layout to another, you need
5886 * to set the layout function of the box to elm_box_layout_transition(),
5887 * passing as user data to it an instance of ::Elm_Box_Transition with the
5888 * necessary information to perform this animation. The free function to
5889 * set for the layout is elm_box_transition_free().
5891 * The parameters to create an ::Elm_Box_Transition sum up to how long
5892 * will it be, in seconds, a layout function to describe the initial point,
5893 * another for the final position of the children and one function to be
5894 * called when the whole animation ends. This last function is useful to
5895 * set the definitive layout for the box, usually the same as the end
5896 * layout for the animation, but could be used to start another transition.
5898 * @param start_layout The layout function that will be used to start the animation
5899 * @param start_layout_data The data to be passed the @p start_layout function
5900 * @param start_layout_free_data Function to free @p start_layout_data
5901 * @param end_layout The layout function that will be used to end the animation
5902 * @param end_layout_free_data The data to be passed the @p end_layout function
5903 * @param end_layout_free_data Function to free @p end_layout_data
5904 * @param transition_end_cb Callback function called when animation ends
5905 * @param transition_end_data Data to be passed to @p transition_end_cb
5906 * @return An instance of ::Elm_Box_Transition
5908 * @see elm_box_transition_new
5909 * @see elm_box_layout_transition
5911 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);
5913 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5915 * This function is mostly useful as the @c free_data parameter in
5916 * elm_box_layout_set() when elm_box_layout_transition().
5918 * @param data The Elm_Box_Transition instance to be freed.
5920 * @see elm_box_transition_new
5921 * @see elm_box_layout_transition
5923 EAPI void elm_box_transition_free(void *data);
5930 * @defgroup Button Button
5932 * @image html img/widget/button/preview-00.png
5933 * @image latex img/widget/button/preview-00.eps
5934 * @image html img/widget/button/preview-01.png
5935 * @image latex img/widget/button/preview-01.eps
5936 * @image html img/widget/button/preview-02.png
5937 * @image latex img/widget/button/preview-02.eps
5939 * This is a push-button. Press it and run some function. It can contain
5940 * a simple label and icon object and it also has an autorepeat feature.
5942 * This widgets emits the following signals:
5943 * @li "clicked": the user clicked the button (press/release).
5944 * @li "repeated": the user pressed the button without releasing it.
5945 * @li "pressed": button was pressed.
5946 * @li "unpressed": button was released after being pressed.
5947 * In all three cases, the @c event parameter of the callback will be
5950 * Also, defined in the default theme, the button has the following styles
5952 * @li default: a normal button.
5953 * @li anchor: Like default, but the button fades away when the mouse is not
5954 * over it, leaving only the text or icon.
5955 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5956 * continuous look across its options.
5957 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5959 * Follow through a complete example @ref button_example_01 "here".
5963 * Add a new button to the parent's canvas
5965 * @param parent The parent object
5966 * @return The new object or NULL if it cannot be created
5968 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5970 * Set the label used in the button
5972 * The passed @p label can be NULL to clean any existing text in it and
5973 * leave the button as an icon only object.
5975 * @param obj The button object
5976 * @param label The text will be written on the button
5977 * @deprecated use elm_object_text_set() instead.
5979 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5981 * Get the label set for the button
5983 * The string returned is an internal pointer and should not be freed or
5984 * altered. It will also become invalid when the button is destroyed.
5985 * The string returned, if not NULL, is a stringshare, so if you need to
5986 * keep it around even after the button is destroyed, you can use
5987 * eina_stringshare_ref().
5989 * @param obj The button object
5990 * @return The text set to the label, or NULL if nothing is set
5991 * @deprecated use elm_object_text_set() instead.
5993 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 * Set the icon used for the button
5997 * Setting a new icon will delete any other that was previously set, making
5998 * any reference to them invalid. If you need to maintain the previous
5999 * object alive, unset it first with elm_button_icon_unset().
6001 * @param obj The button object
6002 * @param icon The icon object for the button
6004 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6006 * Get the icon used for the button
6008 * Return the icon object which is set for this widget. If the button is
6009 * destroyed or another icon is set, the returned object will be deleted
6010 * and any reference to it will be invalid.
6012 * @param obj The button object
6013 * @return The icon object that is being used
6015 * @see elm_button_icon_unset()
6017 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6019 * Remove the icon set without deleting it and return the object
6021 * This function drops the reference the button holds of the icon object
6022 * and returns this last object. It is used in case you want to remove any
6023 * icon, or set another one, without deleting the actual object. The button
6024 * will be left without an icon set.
6026 * @param obj The button object
6027 * @return The icon object that was being used
6029 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6031 * Turn on/off the autorepeat event generated when the button is kept pressed
6033 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6034 * signal when they are clicked.
6036 * When on, keeping a button pressed will continuously emit a @c repeated
6037 * signal until the button is released. The time it takes until it starts
6038 * emitting the signal is given by
6039 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6040 * new emission by elm_button_autorepeat_gap_timeout_set().
6042 * @param obj The button object
6043 * @param on A bool to turn on/off the event
6045 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6047 * Get whether the autorepeat feature is enabled
6049 * @param obj The button object
6050 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6052 * @see elm_button_autorepeat_set()
6054 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6056 * Set the initial timeout before the autorepeat event is generated
6058 * Sets the timeout, in seconds, since the button is pressed until the
6059 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6060 * won't be any delay and the even will be fired the moment the button is
6063 * @param obj The button object
6064 * @param t Timeout in seconds
6066 * @see elm_button_autorepeat_set()
6067 * @see elm_button_autorepeat_gap_timeout_set()
6069 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6071 * Get the initial timeout before the autorepeat event is generated
6073 * @param obj The button object
6074 * @return Timeout in seconds
6076 * @see elm_button_autorepeat_initial_timeout_set()
6078 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6080 * Set the interval between each generated autorepeat event
6082 * After the first @c repeated event is fired, all subsequent ones will
6083 * follow after a delay of @p t seconds for each.
6085 * @param obj The button object
6086 * @param t Interval in seconds
6088 * @see elm_button_autorepeat_initial_timeout_set()
6090 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6092 * Get the interval between each generated autorepeat event
6094 * @param obj The button object
6095 * @return Interval in seconds
6097 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6103 * @defgroup File_Selector_Button File Selector Button
6105 * @image html img/widget/fileselector_button/preview-00.png
6106 * @image latex img/widget/fileselector_button/preview-00.eps
6107 * @image html img/widget/fileselector_button/preview-01.png
6108 * @image latex img/widget/fileselector_button/preview-01.eps
6109 * @image html img/widget/fileselector_button/preview-02.png
6110 * @image latex img/widget/fileselector_button/preview-02.eps
6112 * This is a button that, when clicked, creates an Elementary
6113 * window (or inner window) <b> with a @ref Fileselector "file
6114 * selector widget" within</b>. When a file is chosen, the (inner)
6115 * window is closed and the button emits a signal having the
6116 * selected file as it's @c event_info.
6118 * This widget encapsulates operations on its internal file
6119 * selector on its own API. There is less control over its file
6120 * selector than that one would have instatiating one directly.
6122 * The following styles are available for this button:
6125 * @li @c "hoversel_vertical"
6126 * @li @c "hoversel_vertical_entry"
6128 * Smart callbacks one can register to:
6129 * - @c "file,chosen" - the user has selected a path, whose string
6130 * pointer comes as the @c event_info data (a stringshared
6133 * Here is an example on its usage:
6134 * @li @ref fileselector_button_example
6136 * @see @ref File_Selector_Entry for a similar widget.
6141 * Add a new file selector button widget to the given parent
6142 * Elementary (container) object
6144 * @param parent The parent object
6145 * @return a new file selector button widget handle or @c NULL, on
6148 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6151 * Set the label for a given file selector button widget
6153 * @param obj The file selector button widget
6154 * @param label The text label to be displayed on @p obj
6156 * @deprecated use elm_object_text_set() instead.
6158 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6161 * Get the label set for a given file selector button widget
6163 * @param obj The file selector button widget
6164 * @return The button label
6166 * @deprecated use elm_object_text_set() instead.
6168 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6171 * Set the icon on a given file selector button widget
6173 * @param obj The file selector button widget
6174 * @param icon The icon object for the button
6176 * Once the icon object is set, a previously set one will be
6177 * deleted. If you want to keep the latter, use the
6178 * elm_fileselector_button_icon_unset() function.
6180 * @see elm_fileselector_button_icon_get()
6182 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6185 * Get the icon set for a given file selector button widget
6187 * @param obj The file selector button widget
6188 * @return The icon object currently set on @p obj or @c NULL, if
6191 * @see elm_fileselector_button_icon_set()
6193 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6196 * Unset the icon used in a given file selector button widget
6198 * @param obj The file selector button widget
6199 * @return The icon object that was being used on @p obj or @c
6202 * Unparent and return the icon object which was set for this
6205 * @see elm_fileselector_button_icon_set()
6207 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6210 * Set the title for a given file selector button widget's window
6212 * @param obj The file selector button widget
6213 * @param title The title string
6215 * This will change the window's title, when the file selector pops
6216 * out after a click on the button. Those windows have the default
6217 * (unlocalized) value of @c "Select a file" as titles.
6219 * @note It will only take any effect if the file selector
6220 * button widget is @b not under "inwin mode".
6222 * @see elm_fileselector_button_window_title_get()
6224 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6227 * Get the title set for a given file selector button widget's
6230 * @param obj The file selector button widget
6231 * @return Title of the file selector button's window
6233 * @see elm_fileselector_button_window_title_get() for more details
6235 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6238 * Set the size of a given file selector button widget's window,
6239 * holding the file selector itself.
6241 * @param obj The file selector button widget
6242 * @param width The window's width
6243 * @param height The window's height
6245 * @note it will only take any effect if the file selector button
6246 * widget is @b not under "inwin mode". The default size for the
6247 * window (when applicable) is 400x400 pixels.
6249 * @see elm_fileselector_button_window_size_get()
6251 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6254 * Get the size of a given file selector button widget's window,
6255 * holding the file selector itself.
6257 * @param obj The file selector button widget
6258 * @param width Pointer into which to store the width value
6259 * @param height Pointer into which to store the height value
6261 * @note Use @c NULL pointers on the size values you're not
6262 * interested in: they'll be ignored by the function.
6264 * @see elm_fileselector_button_window_size_set(), for more details
6266 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6269 * Set the initial file system path for a given file selector
6272 * @param obj The file selector button widget
6273 * @param path The path string
6275 * It must be a <b>directory</b> path, which will have the contents
6276 * displayed initially in the file selector's view, when invoked
6277 * from @p obj. The default initial path is the @c "HOME"
6278 * environment variable's value.
6280 * @see elm_fileselector_button_path_get()
6282 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6285 * Get the initial file system path set for a given file selector
6288 * @param obj The file selector button widget
6289 * @return path The path string
6291 * @see elm_fileselector_button_path_set() for more details
6293 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6296 * Enable/disable a tree view in the given file selector button
6297 * widget's internal file selector
6299 * @param obj The file selector button widget
6300 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6303 * This has the same effect as elm_fileselector_expandable_set(),
6304 * but now applied to a file selector button's internal file
6307 * @note There's no way to put a file selector button's internal
6308 * file selector in "grid mode", as one may do with "pure" file
6311 * @see elm_fileselector_expandable_get()
6313 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6316 * Get whether tree view is enabled for the given file selector
6317 * button widget's internal file selector
6319 * @param obj The file selector button widget
6320 * @return @c EINA_TRUE if @p obj widget's internal file selector
6321 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6323 * @see elm_fileselector_expandable_set() for more details
6325 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6328 * Set whether a given file selector button widget's internal file
6329 * selector is to display folders only or the directory contents,
6332 * @param obj The file selector button widget
6333 * @param only @c EINA_TRUE to make @p obj widget's internal file
6334 * selector only display directories, @c EINA_FALSE to make files
6335 * to be displayed in it too
6337 * This has the same effect as elm_fileselector_folder_only_set(),
6338 * but now applied to a file selector button's internal file
6341 * @see elm_fileselector_folder_only_get()
6343 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6346 * Get whether a given file selector button widget's internal file
6347 * selector is displaying folders only or the directory contents,
6350 * @param obj The file selector button widget
6351 * @return @c EINA_TRUE if @p obj widget's internal file
6352 * selector is only displaying directories, @c EINA_FALSE if files
6353 * are being displayed in it too (and on errors)
6355 * @see elm_fileselector_button_folder_only_set() for more details
6357 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6360 * Enable/disable the file name entry box where the user can type
6361 * in a name for a file, in a given file selector button widget's
6362 * internal file selector.
6364 * @param obj The file selector button widget
6365 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6366 * file selector a "saving dialog", @c EINA_FALSE otherwise
6368 * This has the same effect as elm_fileselector_is_save_set(),
6369 * but now applied to a file selector button's internal file
6372 * @see elm_fileselector_is_save_get()
6374 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6377 * Get whether the given file selector button widget's internal
6378 * file selector is in "saving dialog" mode
6380 * @param obj The file selector button widget
6381 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6382 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6385 * @see elm_fileselector_button_is_save_set() for more details
6387 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6390 * Set whether a given file selector button widget's internal file
6391 * selector will raise an Elementary "inner window", instead of a
6392 * dedicated Elementary window. By default, it won't.
6394 * @param obj The file selector button widget
6395 * @param value @c EINA_TRUE to make it use an inner window, @c
6396 * EINA_TRUE to make it use a dedicated window
6398 * @see elm_win_inwin_add() for more information on inner windows
6399 * @see elm_fileselector_button_inwin_mode_get()
6401 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6404 * Get whether a given file selector button widget's internal file
6405 * selector will raise an Elementary "inner window", instead of a
6406 * dedicated Elementary window.
6408 * @param obj The file selector button widget
6409 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6410 * if it will use a dedicated window
6412 * @see elm_fileselector_button_inwin_mode_set() for more details
6414 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6421 * @defgroup File_Selector_Entry File Selector Entry
6423 * @image html img/widget/fileselector_entry/preview-00.png
6424 * @image latex img/widget/fileselector_entry/preview-00.eps
6426 * This is an entry made to be filled with or display a <b>file
6427 * system path string</b>. Besides the entry itself, the widget has
6428 * a @ref File_Selector_Button "file selector button" on its side,
6429 * which will raise an internal @ref Fileselector "file selector widget",
6430 * when clicked, for path selection aided by file system
6433 * This file selector may appear in an Elementary window or in an
6434 * inner window. When a file is chosen from it, the (inner) window
6435 * is closed and the selected file's path string is exposed both as
6436 * an smart event and as the new text on the entry.
6438 * This widget encapsulates operations on its internal file
6439 * selector on its own API. There is less control over its file
6440 * selector than that one would have instatiating one directly.
6442 * Smart callbacks one can register to:
6443 * - @c "changed" - The text within the entry was changed
6444 * - @c "activated" - The entry has had editing finished and
6445 * changes are to be "committed"
6446 * - @c "press" - The entry has been clicked
6447 * - @c "longpressed" - The entry has been clicked (and held) for a
6449 * - @c "clicked" - The entry has been clicked
6450 * - @c "clicked,double" - The entry has been double clicked
6451 * - @c "focused" - The entry has received focus
6452 * - @c "unfocused" - The entry has lost focus
6453 * - @c "selection,paste" - A paste action has occurred on the
6455 * - @c "selection,copy" - A copy action has occurred on the entry
6456 * - @c "selection,cut" - A cut action has occurred on the entry
6457 * - @c "unpressed" - The file selector entry's button was released
6458 * after being pressed.
6459 * - @c "file,chosen" - The user has selected a path via the file
6460 * selector entry's internal file selector, whose string pointer
6461 * comes as the @c event_info data (a stringshared string)
6463 * Here is an example on its usage:
6464 * @li @ref fileselector_entry_example
6466 * @see @ref File_Selector_Button for a similar widget.
6471 * Add a new file selector entry widget to the given parent
6472 * Elementary (container) object
6474 * @param parent The parent object
6475 * @return a new file selector entry widget handle or @c NULL, on
6478 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6481 * Set the label for a given file selector entry widget's button
6483 * @param obj The file selector entry widget
6484 * @param label The text label to be displayed on @p obj widget's
6487 * @deprecated use elm_object_text_set() instead.
6489 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6492 * Get the label set for a given file selector entry widget's button
6494 * @param obj The file selector entry widget
6495 * @return The widget button's label
6497 * @deprecated use elm_object_text_set() instead.
6499 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6502 * Set the icon on a given file selector entry widget's button
6504 * @param obj The file selector entry widget
6505 * @param icon The icon object for the entry's button
6507 * Once the icon object is set, a previously set one will be
6508 * deleted. If you want to keep the latter, use the
6509 * elm_fileselector_entry_button_icon_unset() function.
6511 * @see elm_fileselector_entry_button_icon_get()
6513 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6516 * Get the icon set for a given file selector entry widget's button
6518 * @param obj The file selector entry widget
6519 * @return The icon object currently set on @p obj widget's button
6520 * or @c NULL, if none is
6522 * @see elm_fileselector_entry_button_icon_set()
6524 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6527 * Unset the icon used in a given file selector entry widget's
6530 * @param obj The file selector entry widget
6531 * @return The icon object that was being used on @p obj widget's
6532 * button or @c NULL, on errors
6534 * Unparent and return the icon object which was set for this
6537 * @see elm_fileselector_entry_button_icon_set()
6539 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6542 * Set the title for a given file selector entry widget's window
6544 * @param obj The file selector entry widget
6545 * @param title The title string
6547 * This will change the window's title, when the file selector pops
6548 * out after a click on the entry's button. Those windows have the
6549 * default (unlocalized) value of @c "Select a file" as titles.
6551 * @note It will only take any effect if the file selector
6552 * entry widget is @b not under "inwin mode".
6554 * @see elm_fileselector_entry_window_title_get()
6556 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6559 * Get the title set for a given file selector entry widget's
6562 * @param obj The file selector entry widget
6563 * @return Title of the file selector entry's window
6565 * @see elm_fileselector_entry_window_title_get() for more details
6567 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6570 * Set the size of a given file selector entry widget's window,
6571 * holding the file selector itself.
6573 * @param obj The file selector entry widget
6574 * @param width The window's width
6575 * @param height The window's height
6577 * @note it will only take any effect if the file selector entry
6578 * widget is @b not under "inwin mode". The default size for the
6579 * window (when applicable) is 400x400 pixels.
6581 * @see elm_fileselector_entry_window_size_get()
6583 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6586 * Get the size of a given file selector entry widget's window,
6587 * holding the file selector itself.
6589 * @param obj The file selector entry widget
6590 * @param width Pointer into which to store the width value
6591 * @param height Pointer into which to store the height value
6593 * @note Use @c NULL pointers on the size values you're not
6594 * interested in: they'll be ignored by the function.
6596 * @see elm_fileselector_entry_window_size_set(), for more details
6598 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6601 * Set the initial file system path and the entry's path string for
6602 * a given file selector entry widget
6604 * @param obj The file selector entry widget
6605 * @param path The path string
6607 * It must be a <b>directory</b> path, which will have the contents
6608 * displayed initially in the file selector's view, when invoked
6609 * from @p obj. The default initial path is the @c "HOME"
6610 * environment variable's value.
6612 * @see elm_fileselector_entry_path_get()
6614 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6617 * Get the entry's path string for a given file selector entry
6620 * @param obj The file selector entry widget
6621 * @return path The path string
6623 * @see elm_fileselector_entry_path_set() for more details
6625 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628 * Enable/disable a tree view in the given file selector entry
6629 * widget's internal file selector
6631 * @param obj The file selector entry widget
6632 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6635 * This has the same effect as elm_fileselector_expandable_set(),
6636 * but now applied to a file selector entry's internal file
6639 * @note There's no way to put a file selector entry's internal
6640 * file selector in "grid mode", as one may do with "pure" file
6643 * @see elm_fileselector_expandable_get()
6645 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6648 * Get whether tree view is enabled for the given file selector
6649 * entry widget's internal file selector
6651 * @param obj The file selector entry widget
6652 * @return @c EINA_TRUE if @p obj widget's internal file selector
6653 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6655 * @see elm_fileselector_expandable_set() for more details
6657 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6660 * Set whether a given file selector entry widget's internal file
6661 * selector is to display folders only or the directory contents,
6664 * @param obj The file selector entry widget
6665 * @param only @c EINA_TRUE to make @p obj widget's internal file
6666 * selector only display directories, @c EINA_FALSE to make files
6667 * to be displayed in it too
6669 * This has the same effect as elm_fileselector_folder_only_set(),
6670 * but now applied to a file selector entry's internal file
6673 * @see elm_fileselector_folder_only_get()
6675 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6678 * Get whether a given file selector entry widget's internal file
6679 * selector is displaying folders only or the directory contents,
6682 * @param obj The file selector entry widget
6683 * @return @c EINA_TRUE if @p obj widget's internal file
6684 * selector is only displaying directories, @c EINA_FALSE if files
6685 * are being displayed in it too (and on errors)
6687 * @see elm_fileselector_entry_folder_only_set() for more details
6689 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6692 * Enable/disable the file name entry box where the user can type
6693 * in a name for a file, in a given file selector entry widget's
6694 * internal file selector.
6696 * @param obj The file selector entry widget
6697 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6698 * file selector a "saving dialog", @c EINA_FALSE otherwise
6700 * This has the same effect as elm_fileselector_is_save_set(),
6701 * but now applied to a file selector entry's internal file
6704 * @see elm_fileselector_is_save_get()
6706 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6709 * Get whether the given file selector entry widget's internal
6710 * file selector is in "saving dialog" mode
6712 * @param obj The file selector entry widget
6713 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6714 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6717 * @see elm_fileselector_entry_is_save_set() for more details
6719 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6722 * Set whether a given file selector entry widget's internal file
6723 * selector will raise an Elementary "inner window", instead of a
6724 * dedicated Elementary window. By default, it won't.
6726 * @param obj The file selector entry widget
6727 * @param value @c EINA_TRUE to make it use an inner window, @c
6728 * EINA_TRUE to make it use a dedicated window
6730 * @see elm_win_inwin_add() for more information on inner windows
6731 * @see elm_fileselector_entry_inwin_mode_get()
6733 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6736 * Get whether a given file selector entry widget's internal file
6737 * selector will raise an Elementary "inner window", instead of a
6738 * dedicated Elementary window.
6740 * @param obj The file selector entry widget
6741 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6742 * if it will use a dedicated window
6744 * @see elm_fileselector_entry_inwin_mode_set() for more details
6746 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6749 * Set the initial file system path for a given file selector entry
6752 * @param obj The file selector entry widget
6753 * @param path The path string
6755 * It must be a <b>directory</b> path, which will have the contents
6756 * displayed initially in the file selector's view, when invoked
6757 * from @p obj. The default initial path is the @c "HOME"
6758 * environment variable's value.
6760 * @see elm_fileselector_entry_path_get()
6762 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6765 * Get the parent directory's path to the latest file selection on
6766 * a given filer selector entry widget
6768 * @param obj The file selector object
6769 * @return The (full) path of the directory of the last selection
6770 * on @p obj widget, a @b stringshared string
6772 * @see elm_fileselector_entry_path_set()
6774 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6781 * @defgroup Scroller Scroller
6783 * A scroller holds a single object and "scrolls it around". This means that
6784 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6785 * region around, allowing to move through a much larger object that is
6786 * contained in the scroller. The scroiller will always have a small minimum
6787 * size by default as it won't be limited by the contents of the scroller.
6789 * Signals that you can add callbacks for are:
6790 * @li "edge,left" - the left edge of the content has been reached
6791 * @li "edge,right" - the right edge of the content has been reached
6792 * @li "edge,top" - the top edge of the content has been reached
6793 * @li "edge,bottom" - the bottom edge of the content has been reached
6794 * @li "scroll" - the content has been scrolled (moved)
6795 * @li "scroll,anim,start" - scrolling animation has started
6796 * @li "scroll,anim,stop" - scrolling animation has stopped
6797 * @li "scroll,drag,start" - dragging the contents around has started
6798 * @li "scroll,drag,stop" - dragging the contents around has stopped
6799 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6802 * @note When Elemementary is in embedded mode the scrollbars will not be
6803 * dragable, they appear merely as indicators of how much has been scrolled.
6804 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6805 * fingerscroll) won't work.
6807 * In @ref tutorial_scroller you'll find an example of how to use most of
6812 * @brief Type that controls when scrollbars should appear.
6814 * @see elm_scroller_policy_set()
6816 typedef enum _Elm_Scroller_Policy
6818 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6819 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6820 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6821 ELM_SCROLLER_POLICY_LAST
6822 } Elm_Scroller_Policy;
6824 * @brief Add a new scroller to the parent
6826 * @param parent The parent object
6827 * @return The new object or NULL if it cannot be created
6829 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6831 * @brief Set the content of the scroller widget (the object to be scrolled around).
6833 * @param obj The scroller object
6834 * @param content The new content object
6836 * Once the content object is set, a previously set one will be deleted.
6837 * If you want to keep that old content object, use the
6838 * elm_scroller_content_unset() function.
6840 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6842 * @brief Get the content of the scroller widget
6844 * @param obj The slider object
6845 * @return The content that is being used
6847 * Return the content object which is set for this widget
6849 * @see elm_scroller_content_set()
6851 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6853 * @brief Unset the content of the scroller widget
6855 * @param obj The slider object
6856 * @return The content that was being used
6858 * Unparent and return the content object which was set for this widget
6860 * @see elm_scroller_content_set()
6862 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6864 * @brief Set custom theme elements for the scroller
6866 * @param obj The scroller object
6867 * @param widget The widget name to use (default is "scroller")
6868 * @param base The base name to use (default is "base")
6870 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6872 * @brief Make the scroller minimum size limited to the minimum size of the content
6874 * @param obj The scroller object
6875 * @param w Enable limiting minimum size horizontally
6876 * @param h Enable limiting minimum size vertically
6878 * By default the scroller will be as small as its design allows,
6879 * irrespective of its content. This will make the scroller minimum size the
6880 * right size horizontally and/or vertically to perfectly fit its content in
6883 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6885 * @brief Show a specific virtual region within the scroller content object
6887 * @param obj The scroller object
6888 * @param x X coordinate of the region
6889 * @param y Y coordinate of the region
6890 * @param w Width of the region
6891 * @param h Height of the region
6893 * This will ensure all (or part if it does not fit) of the designated
6894 * region in the virtual content object (0, 0 starting at the top-left of the
6895 * virtual content object) is shown within the scroller.
6897 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);
6899 * @brief Set the scrollbar visibility policy
6901 * @param obj The scroller object
6902 * @param policy_h Horizontal scrollbar policy
6903 * @param policy_v Vertical scrollbar policy
6905 * This sets the scrollbar visibility policy for the given scroller.
6906 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6907 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6908 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6909 * respectively for the horizontal and vertical scrollbars.
6911 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6913 * @brief Gets scrollbar visibility policy
6915 * @param obj The scroller object
6916 * @param policy_h Horizontal scrollbar policy
6917 * @param policy_v Vertical scrollbar policy
6919 * @see elm_scroller_policy_set()
6921 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6923 * @brief Get the currently visible content region
6925 * @param obj The scroller object
6926 * @param x X coordinate of the region
6927 * @param y Y coordinate of the region
6928 * @param w Width of the region
6929 * @param h Height of the region
6931 * This gets the current region in the content object that is visible through
6932 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6933 * w, @p h values pointed to.
6935 * @note All coordinates are relative to the content.
6937 * @see elm_scroller_region_show()
6939 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);
6941 * @brief Get the size of the content object
6943 * @param obj The scroller object
6944 * @param w Width return
6945 * @param h Height return
6947 * This gets the size of the content object of the scroller.
6949 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6951 * @brief Set bouncing behavior
6953 * @param obj The scroller object
6954 * @param h_bounce Will the scroller bounce horizontally or not
6955 * @param v_bounce Will the scroller bounce vertically or not
6957 * When scrolling, the scroller may "bounce" when reaching an edge of the
6958 * content object. This is a visual way to indicate the end has been reached.
6959 * This is enabled by default for both axis. This will set if it is enabled
6960 * for that axis with the boolean parameters for each axis.
6962 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6964 * @brief Get the bounce mode
6966 * @param obj The Scroller object
6967 * @param h_bounce Allow bounce horizontally
6968 * @param v_bounce Allow bounce vertically
6970 * @see elm_scroller_bounce_set()
6972 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6974 * @brief Set scroll page size relative to viewport size.
6976 * @param obj The scroller object
6977 * @param h_pagerel The horizontal page relative size
6978 * @param v_pagerel The vertical page relative size
6980 * The scroller is capable of limiting scrolling by the user to "pages". That
6981 * is to jump by and only show a "whole page" at a time as if the continuous
6982 * area of the scroller content is split into page sized pieces. This sets
6983 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6984 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6985 * axis. This is mutually exclusive with page size
6986 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6987 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6988 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6991 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6993 * @brief Set scroll page size.
6995 * @param obj The scroller object
6996 * @param h_pagesize The horizontal page size
6997 * @param v_pagesize The vertical page size
6999 * This sets the page size to an absolute fixed value, with 0 turning it off
7002 * @see elm_scroller_page_relative_set()
7004 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7006 * @brief Get scroll current page number.
7008 * @param obj The scroller object
7009 * @param h_pagenumber The horizoptal page number
7010 * @param v_pagenumber The vertical page number
7012 * The page number starts from 0. 0 is the first page.
7013 * Current page means the page which meet the top-left of the viewport.
7014 * If there are two or more pages in the viewport, it returns the number of page
7015 * which meet the top-left of the viewport.
7017 * @see elm_scroller_last_page_get()
7018 * @see elm_scroller_page_show()
7019 * @see elm_scroller_page_brint_in()
7021 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7023 * @brief Get scroll last page number.
7025 * @param obj The scroller object
7026 * @param h_pagenumber The horizoptal page number
7027 * @param v_pagenumber The vertical page number
7029 * The page number starts from 0. 0 is the first page.
7030 * This returns the last page number among the pages.
7032 * @see elm_scroller_current_page_get()
7033 * @see elm_scroller_page_show()
7034 * @see elm_scroller_page_brint_in()
7036 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7038 * Show a specific virtual region within the scroller content object by page number.
7040 * @param obj The scroller object
7041 * @param h_pagenumber The horizoptal page number
7042 * @param v_pagenumber The vertical page number
7044 * 0, 0 of the indicated page is located at the top-left of the viewport.
7045 * This will jump to the page directly without animation.
7050 * sc = elm_scroller_add(win);
7051 * elm_scroller_content_set(sc, content);
7052 * elm_scroller_page_relative_set(sc, 1, 0);
7053 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7054 * elm_scroller_page_show(sc, h_page + 1, v_page);
7057 * @see elm_scroller_page_bring_in()
7059 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7061 * Show a specific virtual region within the scroller content object by page number.
7063 * @param obj The scroller object
7064 * @param h_pagenumber The horizoptal page number
7065 * @param v_pagenumber The vertical page number
7067 * 0, 0 of the indicated page is located at the top-left of the viewport.
7068 * This will slide to the page with animation.
7073 * sc = elm_scroller_add(win);
7074 * elm_scroller_content_set(sc, content);
7075 * elm_scroller_page_relative_set(sc, 1, 0);
7076 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7077 * elm_scroller_page_bring_in(sc, h_page, v_page);
7080 * @see elm_scroller_page_show()
7082 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7084 * @brief Show a specific virtual region within the scroller content object.
7086 * @param obj The scroller object
7087 * @param x X coordinate of the region
7088 * @param y Y coordinate of the region
7089 * @param w Width of the region
7090 * @param h Height of the region
7092 * This will ensure all (or part if it does not fit) of the designated
7093 * region in the virtual content object (0, 0 starting at the top-left of the
7094 * virtual content object) is shown within the scroller. Unlike
7095 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7096 * to this location (if configuration in general calls for transitions). It
7097 * may not jump immediately to the new location and make take a while and
7098 * show other content along the way.
7100 * @see elm_scroller_region_show()
7102 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);
7104 * @brief Set event propagation on a scroller
7106 * @param obj The scroller object
7107 * @param propagation If propagation is enabled or not
7109 * This enables or disabled event propagation from the scroller content to
7110 * the scroller and its parent. By default event propagation is disabled.
7112 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7114 * @brief Get event propagation for a scroller
7116 * @param obj The scroller object
7117 * @return The propagation state
7119 * This gets the event propagation for a scroller.
7121 * @see elm_scroller_propagate_events_set()
7123 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
7129 * @defgroup Label Label
7131 * @image html img/widget/label/preview-00.png
7132 * @image latex img/widget/label/preview-00.eps
7134 * @brief Widget to display text, with simple html-like markup.
7136 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7137 * text doesn't fit the geometry of the label it will be ellipsized or be
7138 * cut. Elementary provides several themes for this widget:
7139 * @li default - No animation
7140 * @li marker - Centers the text in the label and make it bold by default
7141 * @li slide_long - The entire text appears from the right of the screen and
7142 * slides until it disappears in the left of the screen(reappering on the
7144 * @li slide_short - The text appears in the left of the label and slides to
7145 * the right to show the overflow. When all of the text has been shown the
7146 * position is reset.
7147 * @li slide_bounce - The text appears in the left of the label and slides to
7148 * the right to show the overflow. When all of the text has been shown the
7149 * animation reverses, moving the text to the left.
7151 * Custom themes can of course invent new markup tags and style them any way
7154 * See @ref tutorial_label for a demonstration of how to use a label widget.
7158 * @brief Add a new label to the parent
7160 * @param parent The parent object
7161 * @return The new object or NULL if it cannot be created
7163 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7165 * @brief Set the label on the label object
7167 * @param obj The label object
7168 * @param label The label will be used on the label object
7169 * @deprecated See elm_object_text_set()
7171 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 */
7173 * @brief Get the label used on the label object
7175 * @param obj The label object
7176 * @return The string inside the label
7177 * @deprecated See elm_object_text_get()
7179 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7181 * @brief Set the wrapping behavior of the label
7183 * @param obj The label object
7184 * @param wrap To wrap text or not
7186 * By default no wrapping is done. Possible values for @p wrap are:
7187 * @li ELM_WRAP_NONE - No wrapping
7188 * @li ELM_WRAP_CHAR - wrap between characters
7189 * @li ELM_WRAP_WORD - wrap between words
7190 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7192 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7194 * @brief Get the wrapping behavior of the label
7196 * @param obj The label object
7199 * @see elm_label_line_wrap_set()
7201 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7203 * @brief Set wrap width of the label
7205 * @param obj The label object
7206 * @param w The wrap width in pixels at a minimum where words need to wrap
7208 * This function sets the maximum width size hint of the label.
7210 * @warning This is only relevant if the label is inside a container.
7212 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7214 * @brief Get wrap width of the label
7216 * @param obj The label object
7217 * @return The wrap width in pixels at a minimum where words need to wrap
7219 * @see elm_label_wrap_width_set()
7221 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7223 * @brief Set wrap height of the label
7225 * @param obj The label object
7226 * @param h The wrap height in pixels at a minimum where words need to wrap
7228 * This function sets the maximum height size hint of the label.
7230 * @warning This is only relevant if the label is inside a container.
7232 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7234 * @brief get wrap width of the label
7236 * @param obj The label object
7237 * @return The wrap height in pixels at a minimum where words need to wrap
7239 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7241 * @brief Set the font size on the label object.
7243 * @param obj The label object
7244 * @param size font size
7246 * @warning NEVER use this. It is for hyper-special cases only. use styles
7247 * instead. e.g. "big", "medium", "small" - or better name them by use:
7248 * "title", "footnote", "quote" etc.
7250 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7252 * @brief Set the text color on the label object
7254 * @param obj The label object
7255 * @param r Red property background color of The label object
7256 * @param g Green property background color of The label object
7257 * @param b Blue property background color of The label object
7258 * @param a Alpha property background color of The label object
7260 * @warning NEVER use this. It is for hyper-special cases only. use styles
7261 * instead. e.g. "big", "medium", "small" - or better name them by use:
7262 * "title", "footnote", "quote" etc.
7264 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);
7266 * @brief Set the text align on the label object
7268 * @param obj The label object
7269 * @param align align mode ("left", "center", "right")
7271 * @warning NEVER use this. It is for hyper-special cases only. use styles
7272 * instead. e.g. "big", "medium", "small" - or better name them by use:
7273 * "title", "footnote", "quote" etc.
7275 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7277 * @brief Set background color of the label
7279 * @param obj The label object
7280 * @param r Red property background color of The label object
7281 * @param g Green property background color of The label object
7282 * @param b Blue property background color of The label object
7283 * @param a Alpha property background alpha of The label object
7285 * @warning NEVER use this. It is for hyper-special cases only. use styles
7286 * instead. e.g. "big", "medium", "small" - or better name them by use:
7287 * "title", "footnote", "quote" etc.
7289 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);
7291 * @brief Set the ellipsis behavior of the label
7293 * @param obj The label object
7294 * @param ellipsis To ellipsis text or not
7296 * If set to true and the text doesn't fit in the label an ellipsis("...")
7297 * will be shown at the end of the widget.
7299 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7300 * choosen wrap method was ELM_WRAP_WORD.
7302 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7304 * @brief Set the text slide of the label
7306 * @param obj The label object
7307 * @param slide To start slide or stop
7309 * If set to true the text of the label will slide throught the length of
7312 * @warning This only work with the themes "slide_short", "slide_long" and
7315 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7317 * @brief Get the text slide mode of the label
7319 * @param obj The label object
7320 * @return slide slide mode value
7322 * @see elm_label_slide_set()
7324 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7326 * @brief Set the slide duration(speed) of the label
7328 * @param obj The label object
7329 * @return The duration in seconds in moving text from slide begin position
7330 * to slide end position
7332 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7334 * @brief Get the slide duration(speed) of the label
7336 * @param obj The label object
7337 * @return The duration time in moving text from slide begin position to slide end position
7339 * @see elm_label_slide_duration_set()
7341 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7347 * @defgroup Toggle Toggle
7349 * @image html img/widget/toggle/preview-00.png
7350 * @image latex img/widget/toggle/preview-00.eps
7352 * @brief A toggle is a slider which can be used to toggle between
7353 * two values. It has two states: on and off.
7355 * Signals that you can add callbacks for are:
7356 * @li "changed" - Whenever the toggle value has been changed. Is not called
7357 * until the toggle is released by the cursor (assuming it
7358 * has been triggered by the cursor in the first place).
7360 * @ref tutorial_toggle show how to use a toggle.
7364 * @brief Add a toggle to @p parent.
7366 * @param parent The parent object
7368 * @return The toggle object
7370 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7372 * @brief Sets the label to be displayed with the toggle.
7374 * @param obj The toggle object
7375 * @param label The label to be displayed
7377 * @deprecated use elm_object_text_set() instead.
7379 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7381 * @brief Gets the label of the toggle
7383 * @param obj toggle object
7384 * @return The label of the toggle
7386 * @deprecated use elm_object_text_get() instead.
7388 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7390 * @brief Set the icon used for the toggle
7392 * @param obj The toggle object
7393 * @param icon The icon object for the button
7395 * Once the icon object is set, a previously set one will be deleted
7396 * If you want to keep that old content object, use the
7397 * elm_toggle_icon_unset() function.
7399 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7401 * @brief Get the icon used for the toggle
7403 * @param obj The toggle object
7404 * @return The icon object that is being used
7406 * Return the icon object which is set for this widget.
7408 * @see elm_toggle_icon_set()
7410 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7412 * @brief Unset the icon used for the toggle
7414 * @param obj The toggle object
7415 * @return The icon object that was being used
7417 * Unparent and return the icon object which was set for this widget.
7419 * @see elm_toggle_icon_set()
7421 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7423 * @brief Sets the labels to be associated with the on and off states of the toggle.
7425 * @param obj The toggle object
7426 * @param onlabel The label displayed when the toggle is in the "on" state
7427 * @param offlabel The label displayed when the toggle is in the "off" state
7429 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7431 * @brief Gets the labels associated with the on and off states of the toggle.
7433 * @param obj The toggle object
7434 * @param onlabel A char** to place the onlabel of @p obj into
7435 * @param offlabel A char** to place the offlabel of @p obj into
7437 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7439 * @brief Sets the state of the toggle to @p state.
7441 * @param obj The toggle object
7442 * @param state The state of @p obj
7444 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7446 * @brief Gets the state of the toggle to @p state.
7448 * @param obj The toggle object
7449 * @return The state of @p obj
7451 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7453 * @brief Sets the state pointer of the toggle to @p statep.
7455 * @param obj The toggle object
7456 * @param statep The state pointer of @p obj
7458 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7464 * @defgroup Frame Frame
7466 * @image html img/widget/frame/preview-00.png
7467 * @image latex img/widget/frame/preview-00.eps
7469 * @brief Frame is a widget that holds some content and has a title.
7471 * The default look is a frame with a title, but Frame supports multple
7479 * @li outdent_bottom
7481 * Of all this styles only default shows the title. Frame emits no signals.
7483 * For a detailed example see the @ref tutorial_frame.
7488 * @brief Add a new frame to the parent
7490 * @param parent The parent object
7491 * @return The new object or NULL if it cannot be created
7493 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7495 * @brief Set the frame label
7497 * @param obj The frame object
7498 * @param label The label of this frame object
7500 * @deprecated use elm_object_text_set() instead.
7502 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7504 * @brief Get the frame label
7506 * @param obj The frame object
7508 * @return The label of this frame objet or NULL if unable to get frame
7510 * @deprecated use elm_object_text_get() instead.
7512 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7514 * @brief Set the content of the frame widget
7516 * Once the content object is set, a previously set one will be deleted.
7517 * If you want to keep that old content object, use the
7518 * elm_frame_content_unset() function.
7520 * @param obj The frame object
7521 * @param content The content will be filled in this frame object
7523 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7525 * @brief Get the content of the frame widget
7527 * Return the content object which is set for this widget
7529 * @param obj The frame object
7530 * @return The content that is being used
7532 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7534 * @brief Unset the content of the frame widget
7536 * Unparent and return the content object which was set for this widget
7538 * @param obj The frame object
7539 * @return The content that was being used
7541 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7547 * @defgroup Table Table
7549 * A container widget to arrange other widgets in a table where items can
7550 * also span multiple columns or rows - even overlap (and then be raised or
7551 * lowered accordingly to adjust stacking if they do overlap).
7553 * The followin are examples of how to use a table:
7554 * @li @ref tutorial_table_01
7555 * @li @ref tutorial_table_02
7560 * @brief Add a new table to the parent
7562 * @param parent The parent object
7563 * @return The new object or NULL if it cannot be created
7565 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7567 * @brief Set the homogeneous layout in the table
7569 * @param obj The layout object
7570 * @param homogeneous A boolean to set if the layout is homogeneous in the
7571 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7573 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7575 * @brief Get the current table homogeneous mode.
7577 * @param obj The table object
7578 * @return A boolean to indicating if the layout is homogeneous in the table
7579 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7581 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7583 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7585 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7587 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7589 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7591 * @brief Set padding between cells.
7593 * @param obj The layout object.
7594 * @param horizontal set the horizontal padding.
7595 * @param vertical set the vertical padding.
7597 * Default value is 0.
7599 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7601 * @brief Get padding between cells.
7603 * @param obj The layout object.
7604 * @param horizontal set the horizontal padding.
7605 * @param vertical set the vertical padding.
7607 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7609 * @brief Add a subobject on the table with the coordinates passed
7611 * @param obj The table object
7612 * @param subobj The subobject to be added to the table
7613 * @param x Row number
7614 * @param y Column number
7618 * @note All positioning inside the table is relative to rows and columns, so
7619 * a value of 0 for x and y, means the top left cell of the table, and a
7620 * value of 1 for w and h means @p subobj only takes that 1 cell.
7622 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7624 * @brief Remove child from table.
7626 * @param obj The table object
7627 * @param subobj The subobject
7629 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7631 * @brief Faster way to remove all child objects from a table object.
7633 * @param obj The table object
7634 * @param clear If true, will delete children, else just remove from table.
7636 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7638 * @brief Set the packing location of an existing child of the table
7640 * @param subobj The subobject to be modified in the table
7641 * @param x Row number
7642 * @param y Column number
7646 * Modifies the position of an object already in the table.
7648 * @note All positioning inside the table is relative to rows and columns, so
7649 * a value of 0 for x and y, means the top left cell of the table, and a
7650 * value of 1 for w and h means @p subobj only takes that 1 cell.
7652 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7654 * @brief Get the packing location of an existing child of the table
7656 * @param subobj The subobject to be modified in the table
7657 * @param x Row number
7658 * @param y Column number
7662 * @see elm_table_pack_set()
7664 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7670 * @defgroup Gengrid Gengrid (Generic grid)
7672 * This widget aims to position objects in a grid layout while
7673 * actually creating and rendering only the visible ones, using the
7674 * same idea as the @ref Genlist "genlist": the user defines a @b
7675 * class for each item, specifying functions that will be called at
7676 * object creation, deletion, etc. When those items are selected by
7677 * the user, a callback function is issued. Users may interact with
7678 * a gengrid via the mouse (by clicking on items to select them and
7679 * clicking on the grid's viewport and swiping to pan the whole
7680 * view) or via the keyboard, navigating through item with the
7683 * @section Gengrid_Layouts Gengrid layouts
7685 * Gengrids may layout its items in one of two possible layouts:
7689 * When in "horizontal mode", items will be placed in @b columns,
7690 * from top to bottom and, when the space for a column is filled,
7691 * another one is started on the right, thus expanding the grid
7692 * horizontally, making for horizontal scrolling. When in "vertical
7693 * mode" , though, items will be placed in @b rows, from left to
7694 * right and, when the space for a row is filled, another one is
7695 * started below, thus expanding the grid vertically (and making
7696 * for vertical scrolling).
7698 * @section Gengrid_Items Gengrid items
7700 * An item in a gengrid can have 0 or more text labels (they can be
7701 * regular text or textblock Evas objects - that's up to the style
7702 * to determine), 0 or more icons (which are simply objects
7703 * swallowed into the gengrid item's theming Edje object) and 0 or
7704 * more <b>boolean states</b>, which have the behavior left to the
7705 * user to define. The Edje part names for each of these properties
7706 * will be looked up, in the theme file for the gengrid, under the
7707 * Edje (string) data items named @c "labels", @c "icons" and @c
7708 * "states", respectively. For each of those properties, if more
7709 * than one part is provided, they must have names listed separated
7710 * by spaces in the data fields. For the default gengrid item
7711 * theme, we have @b one label part (@c "elm.text"), @b two icon
7712 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7715 * A gengrid item may be at one of several styles. Elementary
7716 * provides one by default - "default", but this can be extended by
7717 * system or application custom themes/overlays/extensions (see
7718 * @ref Theme "themes" for more details).
7720 * @section Gengrid_Item_Class Gengrid item classes
7722 * In order to have the ability to add and delete items on the fly,
7723 * gengrid implements a class (callback) system where the
7724 * application provides a structure with information about that
7725 * type of item (gengrid may contain multiple different items with
7726 * different classes, states and styles). Gengrid will call the
7727 * functions in this struct (methods) when an item is "realized"
7728 * (i.e., created dynamically, while the user is scrolling the
7729 * grid). All objects will simply be deleted when no longer needed
7730 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7731 * contains the following members:
7732 * - @c item_style - This is a constant string and simply defines
7733 * the name of the item style. It @b must be specified and the
7734 * default should be @c "default".
7735 * - @c func.label_get - This function is called when an item
7736 * object is actually created. The @c data parameter will point to
7737 * the same data passed to elm_gengrid_item_append() and related
7738 * item creation functions. The @c obj parameter is the gengrid
7739 * object itself, while the @c part one is the name string of one
7740 * of the existing text parts in the Edje group implementing the
7741 * item's theme. This function @b must return a strdup'()ed string,
7742 * as the caller will free() it when done. See
7743 * #Elm_Gengrid_Item_Label_Get_Cb.
7744 * - @c func.icon_get - This function is called when an item object
7745 * is actually created. The @c data parameter will point to the
7746 * same data passed to elm_gengrid_item_append() and related item
7747 * creation functions. The @c obj parameter is the gengrid object
7748 * itself, while the @c part one is the name string of one of the
7749 * existing (icon) swallow parts in the Edje group implementing the
7750 * item's theme. It must return @c NULL, when no icon is desired,
7751 * or a valid object handle, otherwise. The object will be deleted
7752 * by the gengrid on its deletion or when the item is "unrealized".
7753 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7754 * - @c func.state_get - This function is called when an item
7755 * object is actually created. The @c data parameter will point to
7756 * the same data passed to elm_gengrid_item_append() and related
7757 * item creation functions. The @c obj parameter is the gengrid
7758 * object itself, while the @c part one is the name string of one
7759 * of the state parts in the Edje group implementing the item's
7760 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7761 * true/on. Gengrids will emit a signal to its theming Edje object
7762 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7763 * "source" arguments, respectively, when the state is true (the
7764 * default is false), where @c XXX is the name of the (state) part.
7765 * See #Elm_Gengrid_Item_State_Get_Cb.
7766 * - @c func.del - This is called when elm_gengrid_item_del() is
7767 * called on an item or elm_gengrid_clear() is called on the
7768 * gengrid. This is intended for use when gengrid items are
7769 * deleted, so any data attached to the item (e.g. its data
7770 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7772 * @section Gengrid_Usage_Hints Usage hints
7774 * If the user wants to have multiple items selected at the same
7775 * time, elm_gengrid_multi_select_set() will permit it. If the
7776 * gengrid is single-selection only (the default), then
7777 * elm_gengrid_select_item_get() will return the selected item or
7778 * @c NULL, if none is selected. If the gengrid is under
7779 * multi-selection, then elm_gengrid_selected_items_get() will
7780 * return a list (that is only valid as long as no items are
7781 * modified (added, deleted, selected or unselected) of child items
7784 * If an item changes (internal (boolean) state, label or icon
7785 * changes), then use elm_gengrid_item_update() to have gengrid
7786 * update the item with the new state. A gengrid will re-"realize"
7787 * the item, thus calling the functions in the
7788 * #Elm_Gengrid_Item_Class set for that item.
7790 * To programmatically (un)select an item, use
7791 * elm_gengrid_item_selected_set(). To get its selected state use
7792 * elm_gengrid_item_selected_get(). To make an item disabled
7793 * (unable to be selected and appear differently) use
7794 * elm_gengrid_item_disabled_set() to set this and
7795 * elm_gengrid_item_disabled_get() to get the disabled state.
7797 * Grid cells will only have their selection smart callbacks called
7798 * when firstly getting selected. Any further clicks will do
7799 * nothing, unless you enable the "always select mode", with
7800 * elm_gengrid_always_select_mode_set(), thus making every click to
7801 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7802 * turn off the ability to select items entirely in the widget and
7803 * they will neither appear selected nor call the selection smart
7806 * Remember that you can create new styles and add your own theme
7807 * augmentation per application with elm_theme_extension_add(). If
7808 * you absolutely must have a specific style that overrides any
7809 * theme the user or system sets up you can use
7810 * elm_theme_overlay_add() to add such a file.
7812 * @section Gengrid_Smart_Events Gengrid smart events
7814 * Smart events that you can add callbacks for are:
7815 * - @c "activated" - The user has double-clicked or pressed
7816 * (enter|return|spacebar) on an item. The @c event_info parameter
7817 * is the gengrid item that was activated.
7818 * - @c "clicked,double" - The user has double-clicked an item.
7819 * The @c event_info parameter is the gengrid item that was double-clicked.
7820 * - @c "selected" - The user has made an item selected. The
7821 * @c event_info parameter is the gengrid item that was selected.
7822 * - @c "unselected" - The user has made an item unselected. The
7823 * @c event_info parameter is the gengrid item that was unselected.
7824 * - @c "realized" - This is called when the item in the gengrid
7825 * has its implementing Evas object instantiated, de facto. @c
7826 * event_info is the gengrid item that was created. The object
7827 * may be deleted at any time, so it is highly advised to the
7828 * caller @b not to use the object pointer returned from
7829 * elm_gengrid_item_object_get(), because it may point to freed
7831 * - @c "unrealized" - This is called when the implementing Evas
7832 * object for this item is deleted. @c event_info is the gengrid
7833 * item that was deleted.
7834 * - @c "changed" - Called when an item is added, removed, resized
7835 * or moved and when the gengrid is resized or gets "horizontal"
7837 * - @c "scroll,anim,start" - This is called when scrolling animation has
7839 * - @c "scroll,anim,stop" - This is called when scrolling animation has
7841 * - @c "drag,start,up" - Called when the item in the gengrid has
7842 * been dragged (not scrolled) up.
7843 * - @c "drag,start,down" - Called when the item in the gengrid has
7844 * been dragged (not scrolled) down.
7845 * - @c "drag,start,left" - Called when the item in the gengrid has
7846 * been dragged (not scrolled) left.
7847 * - @c "drag,start,right" - Called when the item in the gengrid has
7848 * been dragged (not scrolled) right.
7849 * - @c "drag,stop" - Called when the item in the gengrid has
7850 * stopped being dragged.
7851 * - @c "drag" - Called when the item in the gengrid is being
7853 * - @c "scroll" - called when the content has been scrolled
7855 * - @c "scroll,drag,start" - called when dragging the content has
7857 * - @c "scroll,drag,stop" - called when dragging the content has
7860 * List of gendrid examples:
7861 * @li @ref gengrid_example
7865 * @addtogroup Gengrid
7869 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7870 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7871 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7872 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7873 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. */
7874 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. */
7875 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7877 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7878 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7879 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7880 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7883 * @struct _Elm_Gengrid_Item_Class
7885 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7888 struct _Elm_Gengrid_Item_Class
7890 const char *item_style;
7891 struct _Elm_Gengrid_Item_Class_Func
7893 Elm_Gengrid_Item_Label_Get_Cb label_get;
7894 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7895 Elm_Gengrid_Item_State_Get_Cb state_get;
7896 Elm_Gengrid_Item_Del_Cb del;
7898 }; /**< #Elm_Gengrid_Item_Class member definitions */
7901 * Add a new gengrid widget to the given parent Elementary
7902 * (container) object
7904 * @param parent The parent object
7905 * @return a new gengrid widget handle or @c NULL, on errors
7907 * This function inserts a new gengrid widget on the canvas.
7909 * @see elm_gengrid_item_size_set()
7910 * @see elm_gengrid_horizontal_set()
7911 * @see elm_gengrid_item_append()
7912 * @see elm_gengrid_item_del()
7913 * @see elm_gengrid_clear()
7917 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7920 * Set the size for the items of a given gengrid widget
7922 * @param obj The gengrid object.
7923 * @param w The items' width.
7924 * @param h The items' height;
7926 * A gengrid, after creation, has still no information on the size
7927 * to give to each of its cells. So, you most probably will end up
7928 * with squares one @ref Fingers "finger" wide, the default
7929 * size. Use this function to force a custom size for you items,
7930 * making them as big as you wish.
7932 * @see elm_gengrid_item_size_get()
7936 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7939 * Get the size set for the items of a given gengrid widget
7941 * @param obj The gengrid object.
7942 * @param w Pointer to a variable where to store the items' width.
7943 * @param h Pointer to a variable where to store the items' height.
7945 * @note Use @c NULL pointers on the size values you're not
7946 * interested in: they'll be ignored by the function.
7948 * @see elm_gengrid_item_size_get() for more details
7952 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7955 * Set the items grid's alignment within a given gengrid widget
7957 * @param obj The gengrid object.
7958 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7959 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7961 * This sets the alignment of the whole grid of items of a gengrid
7962 * within its given viewport. By default, those values are both
7963 * 0.5, meaning that the gengrid will have its items grid placed
7964 * exactly in the middle of its viewport.
7966 * @note If given alignment values are out of the cited ranges,
7967 * they'll be changed to the nearest boundary values on the valid
7970 * @see elm_gengrid_align_get()
7974 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7977 * Get the items grid's alignment values within a given gengrid
7980 * @param obj The gengrid object.
7981 * @param align_x Pointer to a variable where to store the
7982 * horizontal alignment.
7983 * @param align_y Pointer to a variable where to store the vertical
7986 * @note Use @c NULL pointers on the alignment values you're not
7987 * interested in: they'll be ignored by the function.
7989 * @see elm_gengrid_align_set() for more details
7993 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7996 * Set whether a given gengrid widget is or not able have items
7999 * @param obj The gengrid object
8000 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8001 * @c EINA_FALSE to turn it off
8003 * If a gengrid is set to allow reordering, a click held for more
8004 * than 0.5 over a given item will highlight it specially,
8005 * signalling the gengrid has entered the reordering state. From
8006 * that time on, the user will be able to, while still holding the
8007 * mouse button down, move the item freely in the gengrid's
8008 * viewport, replacing to said item to the locations it goes to.
8009 * The replacements will be animated and, whenever the user
8010 * releases the mouse button, the item being replaced gets a new
8011 * definitive place in the grid.
8013 * @see elm_gengrid_reorder_mode_get()
8017 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8020 * Get whether a given gengrid widget is or not able have items
8023 * @param obj The gengrid object
8024 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8027 * @see elm_gengrid_reorder_mode_set() for more details
8031 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8034 * Append a new item in a given gengrid widget.
8036 * @param obj The gengrid object.
8037 * @param gic The item class for the item.
8038 * @param data The item data.
8039 * @param func Convenience function called when the item is
8041 * @param func_data Data to be passed to @p func.
8042 * @return A handle to the item added or @c NULL, on errors.
8044 * This adds an item to the beginning of the gengrid.
8046 * @see elm_gengrid_item_prepend()
8047 * @see elm_gengrid_item_insert_before()
8048 * @see elm_gengrid_item_insert_after()
8049 * @see elm_gengrid_item_del()
8053 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);
8056 * Prepend a new item in a given gengrid widget.
8058 * @param obj The gengrid object.
8059 * @param gic The item class for the item.
8060 * @param data The item data.
8061 * @param func Convenience function called when the item is
8063 * @param func_data Data to be passed to @p func.
8064 * @return A handle to the item added or @c NULL, on errors.
8066 * This adds an item to the end of the gengrid.
8068 * @see elm_gengrid_item_append()
8069 * @see elm_gengrid_item_insert_before()
8070 * @see elm_gengrid_item_insert_after()
8071 * @see elm_gengrid_item_del()
8075 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);
8078 * Insert an item before another in a gengrid widget
8080 * @param obj The gengrid object.
8081 * @param gic The item class for the item.
8082 * @param data The item data.
8083 * @param relative The item to place this new one before.
8084 * @param func Convenience function called when the item is
8086 * @param func_data Data to be passed to @p func.
8087 * @return A handle to the item added or @c NULL, on errors.
8089 * This inserts an item before another in the gengrid.
8091 * @see elm_gengrid_item_append()
8092 * @see elm_gengrid_item_prepend()
8093 * @see elm_gengrid_item_insert_after()
8094 * @see elm_gengrid_item_del()
8098 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);
8101 * Insert an item after another in a gengrid widget
8103 * @param obj The gengrid object.
8104 * @param gic The item class for the item.
8105 * @param data The item data.
8106 * @param relative The item to place this new one after.
8107 * @param func Convenience function called when the item is
8109 * @param func_data Data to be passed to @p func.
8110 * @return A handle to the item added or @c NULL, on errors.
8112 * This inserts an item after another in the gengrid.
8114 * @see elm_gengrid_item_append()
8115 * @see elm_gengrid_item_prepend()
8116 * @see elm_gengrid_item_insert_after()
8117 * @see elm_gengrid_item_del()
8121 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);
8123 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);
8125 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);
8128 * Set whether items on a given gengrid widget are to get their
8129 * selection callbacks issued for @b every subsequent selection
8130 * click on them or just for the first click.
8132 * @param obj The gengrid object
8133 * @param always_select @c EINA_TRUE to make items "always
8134 * selected", @c EINA_FALSE, otherwise
8136 * By default, grid items will only call their selection callback
8137 * function when firstly getting selected, any subsequent further
8138 * clicks will do nothing. With this call, you make those
8139 * subsequent clicks also to issue the selection callbacks.
8141 * @note <b>Double clicks</b> will @b always be reported on items.
8143 * @see elm_gengrid_always_select_mode_get()
8147 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8150 * Get whether items on a given gengrid widget have their selection
8151 * callbacks issued for @b every subsequent selection click on them
8152 * or just for the first click.
8154 * @param obj The gengrid object.
8155 * @return @c EINA_TRUE if the gengrid items are "always selected",
8156 * @c EINA_FALSE, otherwise
8158 * @see elm_gengrid_always_select_mode_set() for more details
8162 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8165 * Set whether items on a given gengrid widget can be selected or not.
8167 * @param obj The gengrid object
8168 * @param no_select @c EINA_TRUE to make items selectable,
8169 * @c EINA_FALSE otherwise
8171 * This will make items in @p obj selectable or not. In the latter
8172 * case, any user interacion on the gendrid items will neither make
8173 * them appear selected nor them call their selection callback
8176 * @see elm_gengrid_no_select_mode_get()
8180 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8183 * Get whether items on a given gengrid widget can be selected or
8186 * @param obj The gengrid object
8187 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8190 * @see elm_gengrid_no_select_mode_set() for more details
8194 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8197 * Enable or disable multi-selection in a given gengrid widget
8199 * @param obj The gengrid object.
8200 * @param multi @c EINA_TRUE, to enable multi-selection,
8201 * @c EINA_FALSE to disable it.
8203 * Multi-selection is the ability for one to have @b more than one
8204 * item selected, on a given gengrid, simultaneously. When it is
8205 * enabled, a sequence of clicks on different items will make them
8206 * all selected, progressively. A click on an already selected item
8207 * will unselect it. If interecting via the keyboard,
8208 * multi-selection is enabled while holding the "Shift" key.
8210 * @note By default, multi-selection is @b disabled on gengrids
8212 * @see elm_gengrid_multi_select_get()
8216 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8219 * Get whether multi-selection is enabled or disabled for a given
8222 * @param obj The gengrid object.
8223 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8224 * EINA_FALSE otherwise
8226 * @see elm_gengrid_multi_select_set() for more details
8230 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8233 * Enable or disable bouncing effect for a given gengrid widget
8235 * @param obj The gengrid object
8236 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8237 * @c EINA_FALSE to disable it
8238 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8239 * @c EINA_FALSE to disable it
8241 * The bouncing effect occurs whenever one reaches the gengrid's
8242 * edge's while panning it -- it will scroll past its limits a
8243 * little bit and return to the edge again, in a animated for,
8246 * @note By default, gengrids have bouncing enabled on both axis
8248 * @see elm_gengrid_bounce_get()
8252 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8255 * Get whether bouncing effects are enabled or disabled, for a
8256 * given gengrid widget, on each axis
8258 * @param obj The gengrid object
8259 * @param h_bounce Pointer to a variable where to store the
8260 * horizontal bouncing flag.
8261 * @param v_bounce Pointer to a variable where to store the
8262 * vertical bouncing flag.
8264 * @see elm_gengrid_bounce_set() for more details
8268 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8271 * Set a given gengrid widget's scrolling page size, relative to
8272 * its viewport size.
8274 * @param obj The gengrid object
8275 * @param h_pagerel The horizontal page (relative) size
8276 * @param v_pagerel The vertical page (relative) size
8278 * The gengrid's scroller is capable of binding scrolling by the
8279 * user to "pages". It means that, while scrolling and, specially
8280 * after releasing the mouse button, the grid will @b snap to the
8281 * nearest displaying page's area. When page sizes are set, the
8282 * grid's continuous content area is split into (equal) page sized
8285 * This function sets the size of a page <b>relatively to the
8286 * viewport dimensions</b> of the gengrid, for each axis. A value
8287 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8288 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8289 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8290 * 1.0. Values beyond those will make it behave behave
8291 * inconsistently. If you only want one axis to snap to pages, use
8292 * the value @c 0.0 for the other one.
8294 * There is a function setting page size values in @b absolute
8295 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8296 * is mutually exclusive to this one.
8298 * @see elm_gengrid_page_relative_get()
8302 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8305 * Get a given gengrid widget's scrolling page size, relative to
8306 * its viewport size.
8308 * @param obj The gengrid object
8309 * @param h_pagerel Pointer to a variable where to store the
8310 * horizontal page (relative) size
8311 * @param v_pagerel Pointer to a variable where to store the
8312 * vertical page (relative) size
8314 * @see elm_gengrid_page_relative_set() for more details
8318 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8321 * Set a given gengrid widget's scrolling page size
8323 * @param obj The gengrid object
8324 * @param h_pagerel The horizontal page size, in pixels
8325 * @param v_pagerel The vertical page size, in pixels
8327 * The gengrid's scroller is capable of binding scrolling by the
8328 * user to "pages". It means that, while scrolling and, specially
8329 * after releasing the mouse button, the grid will @b snap to the
8330 * nearest displaying page's area. When page sizes are set, the
8331 * grid's continuous content area is split into (equal) page sized
8334 * This function sets the size of a page of the gengrid, in pixels,
8335 * for each axis. Sane usable values are, between @c 0 and the
8336 * dimensions of @p obj, for each axis. Values beyond those will
8337 * make it behave behave inconsistently. If you only want one axis
8338 * to snap to pages, use the value @c 0 for the other one.
8340 * There is a function setting page size values in @b relative
8341 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8342 * use is mutually exclusive to this one.
8346 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8349 * Set for what direction a given gengrid widget will expand while
8350 * placing its items.
8352 * @param obj The gengrid object.
8353 * @param setting @c EINA_TRUE to make the gengrid expand
8354 * horizontally, @c EINA_FALSE to expand vertically.
8356 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8357 * in @b columns, from top to bottom and, when the space for a
8358 * column is filled, another one is started on the right, thus
8359 * expanding the grid horizontally. When in "vertical mode"
8360 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8361 * to right and, when the space for a row is filled, another one is
8362 * started below, thus expanding the grid vertically.
8364 * @see elm_gengrid_horizontal_get()
8368 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8371 * Get for what direction a given gengrid widget will expand while
8372 * placing its items.
8374 * @param obj The gengrid object.
8375 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8376 * @c EINA_FALSE if it's set to expand vertically.
8378 * @see elm_gengrid_horizontal_set() for more detais
8382 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8385 * Get the first item in a given gengrid widget
8387 * @param obj The gengrid object
8388 * @return The first item's handle or @c NULL, if there are no
8389 * items in @p obj (and on errors)
8391 * This returns the first item in the @p obj's internal list of
8394 * @see elm_gengrid_last_item_get()
8398 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8401 * Get the last item in a given gengrid widget
8403 * @param obj The gengrid object
8404 * @return The last item's handle or @c NULL, if there are no
8405 * items in @p obj (and on errors)
8407 * This returns the last item in the @p obj's internal list of
8410 * @see elm_gengrid_first_item_get()
8414 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8417 * Get the @b next item in a gengrid widget's internal list of items,
8418 * given a handle to one of those items.
8420 * @param item The gengrid item to fetch next from
8421 * @return The item after @p item, or @c NULL if there's none (and
8424 * This returns the item placed after the @p item, on the container
8427 * @see elm_gengrid_item_prev_get()
8431 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8434 * Get the @b previous item in a gengrid widget's internal list of items,
8435 * given a handle to one of those items.
8437 * @param item The gengrid item to fetch previous from
8438 * @return The item before @p item, or @c NULL if there's none (and
8441 * This returns the item placed before the @p item, on the container
8444 * @see elm_gengrid_item_next_get()
8448 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8451 * Get the gengrid object's handle which contains a given gengrid
8454 * @param item The item to fetch the container from
8455 * @return The gengrid (parent) object
8457 * This returns the gengrid object itself that an item belongs to.
8461 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8464 * Remove a gengrid item from the its parent, deleting it.
8466 * @param item The item to be removed.
8467 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8469 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8474 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8477 * Update the contents of a given gengrid item
8479 * @param item The gengrid item
8481 * This updates an item by calling all the item class functions
8482 * again to get the icons, labels and states. Use this when the
8483 * original item data has changed and you want thta changes to be
8488 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8489 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8490 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8493 * Return the data associated to a given gengrid item
8495 * @param item The gengrid item.
8496 * @return the data associated to this item.
8498 * This returns the @c data value passed on the
8499 * elm_gengrid_item_append() and related item addition calls.
8501 * @see elm_gengrid_item_append()
8502 * @see elm_gengrid_item_data_set()
8506 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8509 * Set the data associated to a given gengrid item
8511 * @param item The gengrid item
8512 * @param data The new data pointer to set on it
8514 * This @b overrides the @c data value passed on the
8515 * elm_gengrid_item_append() and related item addition calls. This
8516 * function @b won't call elm_gengrid_item_update() automatically,
8517 * so you'd issue it afterwards if you want to hove the item
8518 * updated to reflect the that new data.
8520 * @see elm_gengrid_item_data_get()
8524 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8527 * Get a given gengrid item's position, relative to the whole
8528 * gengrid's grid area.
8530 * @param item The Gengrid item.
8531 * @param x Pointer to variable where to store the item's <b>row
8533 * @param y Pointer to variable where to store the item's <b>column
8536 * This returns the "logical" position of the item whithin the
8537 * gengrid. For example, @c (0, 1) would stand for first row,
8542 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8545 * Set whether a given gengrid item is selected or not
8547 * @param item The gengrid item
8548 * @param selected Use @c EINA_TRUE, to make it selected, @c
8549 * EINA_FALSE to make it unselected
8551 * This sets the selected state of an item. If multi selection is
8552 * not enabled on the containing gengrid and @p selected is @c
8553 * EINA_TRUE, any other previously selected items will get
8554 * unselected in favor of this new one.
8556 * @see elm_gengrid_item_selected_get()
8560 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8563 * Get whether a given gengrid item is selected or not
8565 * @param item The gengrid item
8566 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8568 * @see elm_gengrid_item_selected_set() for more details
8572 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8575 * Get the real Evas object created to implement the view of a
8576 * given gengrid item
8578 * @param item The gengrid item.
8579 * @return the Evas object implementing this item's view.
8581 * This returns the actual Evas object used to implement the
8582 * specified gengrid item's view. This may be @c NULL, as it may
8583 * not have been created or may have been deleted, at any time, by
8584 * the gengrid. <b>Do not modify this object</b> (move, resize,
8585 * show, hide, etc.), as the gengrid is controlling it. This
8586 * function is for querying, emitting custom signals or hooking
8587 * lower level callbacks for events on that object. Do not delete
8588 * this object under any circumstances.
8590 * @see elm_gengrid_item_data_get()
8594 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8597 * Show the portion of a gengrid's internal grid containing a given
8598 * item, @b immediately.
8600 * @param item The item to display
8602 * This causes gengrid to @b redraw its viewport's contents to the
8603 * region contining the given @p item item, if it is not fully
8606 * @see elm_gengrid_item_bring_in()
8610 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8613 * Animatedly bring in, to the visible are of a gengrid, a given
8616 * @param item The gengrid item to display
8618 * This causes gengrig to jump to the given @p item item and show
8619 * it (by scrolling), if it is not fully visible. This will use
8620 * animation to do so and take a period of time to complete.
8622 * @see elm_gengrid_item_show()
8626 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8629 * Set whether a given gengrid item is disabled or not.
8631 * @param item The gengrid item
8632 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8633 * to enable it back.
8635 * A disabled item cannot be selected or unselected. It will also
8636 * change its appearance, to signal the user it's disabled.
8638 * @see elm_gengrid_item_disabled_get()
8642 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8645 * Get whether a given gengrid item is disabled or not.
8647 * @param item The gengrid item
8648 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8651 * @see elm_gengrid_item_disabled_set() for more details
8655 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8658 * Set the text to be shown in a given gengrid item's tooltips.
8660 * @param item The gengrid item
8661 * @param text The text to set in the content
8663 * This call will setup the text to be used as tooltip to that item
8664 * (analogous to elm_object_tooltip_text_set(), but being item
8665 * tooltips with higher precedence than object tooltips). It can
8666 * have only one tooltip at a time, so any previous tooltip data
8671 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8674 * Set the content to be shown in a given gengrid item's tooltips
8676 * @param item The gengrid item.
8677 * @param func The function returning the tooltip contents.
8678 * @param data What to provide to @a func as callback data/context.
8679 * @param del_cb Called when data is not needed anymore, either when
8680 * another callback replaces @p func, the tooltip is unset with
8681 * elm_gengrid_item_tooltip_unset() or the owner @p item
8682 * dies. This callback receives as its first parameter the
8683 * given @p data, being @c event_info the item handle.
8685 * This call will setup the tooltip's contents to @p item
8686 * (analogous to elm_object_tooltip_content_cb_set(), but being
8687 * item tooltips with higher precedence than object tooltips). It
8688 * can have only one tooltip at a time, so any previous tooltip
8689 * content will get removed. @p func (with @p data) will be called
8690 * every time Elementary needs to show the tooltip and it should
8691 * return a valid Evas object, which will be fully managed by the
8692 * tooltip system, getting deleted when the tooltip is gone.
8696 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);
8699 * Unset a tooltip from a given gengrid item
8701 * @param item gengrid item to remove a previously set tooltip from.
8703 * This call removes any tooltip set on @p item. The callback
8704 * provided as @c del_cb to
8705 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8706 * notify it is not used anymore (and have resources cleaned, if
8709 * @see elm_gengrid_item_tooltip_content_cb_set()
8713 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8716 * Set a different @b style for a given gengrid item's tooltip.
8718 * @param item gengrid item with tooltip set
8719 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8720 * "default", @c "transparent", etc)
8722 * Tooltips can have <b>alternate styles</b> to be displayed on,
8723 * which are defined by the theme set on Elementary. This function
8724 * works analogously as elm_object_tooltip_style_set(), but here
8725 * applied only to gengrid item objects. The default style for
8726 * tooltips is @c "default".
8728 * @note before you set a style you should define a tooltip with
8729 * elm_gengrid_item_tooltip_content_cb_set() or
8730 * elm_gengrid_item_tooltip_text_set()
8732 * @see elm_gengrid_item_tooltip_style_get()
8736 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8739 * Get the style set a given gengrid item's tooltip.
8741 * @param item gengrid item with tooltip already set on.
8742 * @return style the theme style in use, which defaults to
8743 * "default". If the object does not have a tooltip set,
8744 * then @c NULL is returned.
8746 * @see elm_gengrid_item_tooltip_style_set() for more details
8750 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8752 * @brief Disable size restrictions on an object's tooltip
8753 * @param item The tooltip's anchor object
8754 * @param disable If EINA_TRUE, size restrictions are disabled
8755 * @return EINA_FALSE on failure, EINA_TRUE on success
8757 * This function allows a tooltip to expand beyond its parant window's canvas.
8758 * It will instead be limited only by the size of the display.
8760 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8762 * @brief Retrieve size restriction state of an object's tooltip
8763 * @param item The tooltip's anchor object
8764 * @return If EINA_TRUE, size restrictions are disabled
8766 * This function returns whether a tooltip is allowed to expand beyond
8767 * its parant window's canvas.
8768 * It will instead be limited only by the size of the display.
8770 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8772 * Set the type of mouse pointer/cursor decoration to be shown,
8773 * when the mouse pointer is over the given gengrid widget item
8775 * @param item gengrid item to customize cursor on
8776 * @param cursor the cursor type's name
8778 * This function works analogously as elm_object_cursor_set(), but
8779 * here the cursor's changing area is restricted to the item's
8780 * area, and not the whole widget's. Note that that item cursors
8781 * have precedence over widget cursors, so that a mouse over @p
8782 * item will always show cursor @p type.
8784 * If this function is called twice for an object, a previously set
8785 * cursor will be unset on the second call.
8787 * @see elm_object_cursor_set()
8788 * @see elm_gengrid_item_cursor_get()
8789 * @see elm_gengrid_item_cursor_unset()
8793 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8796 * Get the type of mouse pointer/cursor decoration set to be shown,
8797 * when the mouse pointer is over the given gengrid widget item
8799 * @param item gengrid item with custom cursor set
8800 * @return the cursor type's name or @c NULL, if no custom cursors
8801 * were set to @p item (and on errors)
8803 * @see elm_object_cursor_get()
8804 * @see elm_gengrid_item_cursor_set() for more details
8805 * @see elm_gengrid_item_cursor_unset()
8809 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8812 * Unset any custom mouse pointer/cursor decoration set to be
8813 * shown, when the mouse pointer is over the given gengrid widget
8814 * item, thus making it show the @b default cursor again.
8816 * @param item a gengrid item
8818 * Use this call to undo any custom settings on this item's cursor
8819 * decoration, bringing it back to defaults (no custom style set).
8821 * @see elm_object_cursor_unset()
8822 * @see elm_gengrid_item_cursor_set() for more details
8826 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8829 * Set a different @b style for a given custom cursor set for a
8832 * @param item gengrid item with custom cursor set
8833 * @param style the <b>theme style</b> to use (e.g. @c "default",
8834 * @c "transparent", etc)
8836 * This function only makes sense when one is using custom mouse
8837 * cursor decorations <b>defined in a theme file</b> , which can
8838 * have, given a cursor name/type, <b>alternate styles</b> on
8839 * it. It works analogously as elm_object_cursor_style_set(), but
8840 * here applied only to gengrid item objects.
8842 * @warning Before you set a cursor style you should have defined a
8843 * custom cursor previously on the item, with
8844 * elm_gengrid_item_cursor_set()
8846 * @see elm_gengrid_item_cursor_engine_only_set()
8847 * @see elm_gengrid_item_cursor_style_get()
8851 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8854 * Get the current @b style set for a given gengrid item's custom
8857 * @param item gengrid item with custom cursor set.
8858 * @return style the cursor style in use. If the object does not
8859 * have a cursor set, then @c NULL is returned.
8861 * @see elm_gengrid_item_cursor_style_set() for more details
8865 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8868 * Set if the (custom) cursor for a given gengrid item should be
8869 * searched in its theme, also, or should only rely on the
8872 * @param item item with custom (custom) cursor already set on
8873 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8874 * only on those provided by the rendering engine, @c EINA_FALSE to
8875 * have them searched on the widget's theme, as well.
8877 * @note This call is of use only if you've set a custom cursor
8878 * for gengrid items, with elm_gengrid_item_cursor_set().
8880 * @note By default, cursors will only be looked for between those
8881 * provided by the rendering engine.
8885 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8888 * Get if the (custom) cursor for a given gengrid item is being
8889 * searched in its theme, also, or is only relying on the rendering
8892 * @param item a gengrid item
8893 * @return @c EINA_TRUE, if cursors are being looked for only on
8894 * those provided by the rendering engine, @c EINA_FALSE if they
8895 * are being searched on the widget's theme, as well.
8897 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8901 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8904 * Remove all items from a given gengrid widget
8906 * @param obj The gengrid object.
8908 * This removes (and deletes) all items in @p obj, leaving it
8911 * @see elm_gengrid_item_del(), to remove just one item.
8915 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8918 * Get the selected item in a given gengrid widget
8920 * @param obj The gengrid object.
8921 * @return The selected item's handleor @c NULL, if none is
8922 * selected at the moment (and on errors)
8924 * This returns the selected item in @p obj. If multi selection is
8925 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8926 * the first item in the list is selected, which might not be very
8927 * useful. For that case, see elm_gengrid_selected_items_get().
8931 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8934 * Get <b>a list</b> of selected items in a given gengrid
8936 * @param obj The gengrid object.
8937 * @return The list of selected items or @c NULL, if none is
8938 * selected at the moment (and on errors)
8940 * This returns a list of the selected items, in the order that
8941 * they appear in the grid. This list is only valid as long as no
8942 * more items are selected or unselected (or unselected implictly
8943 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8946 * @see elm_gengrid_selected_item_get()
8950 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8957 * @defgroup Clock Clock
8959 * @image html img/widget/clock/preview-00.png
8960 * @image latex img/widget/clock/preview-00.eps
8962 * This is a @b digital clock widget. In its default theme, it has a
8963 * vintage "flipping numbers clock" appearance, which will animate
8964 * sheets of individual algarisms individually as time goes by.
8966 * A newly created clock will fetch system's time (already
8967 * considering local time adjustments) to start with, and will tick
8968 * accondingly. It may or may not show seconds.
8970 * Clocks have an @b edition mode. When in it, the sheets will
8971 * display extra arrow indications on the top and bottom and the
8972 * user may click on them to raise or lower the time values. After
8973 * it's told to exit edition mode, it will keep ticking with that
8974 * new time set (it keeps the difference from local time).
8976 * Also, when under edition mode, user clicks on the cited arrows
8977 * which are @b held for some time will make the clock to flip the
8978 * sheet, thus editing the time, continuosly and automatically for
8979 * the user. The interval between sheet flips will keep growing in
8980 * time, so that it helps the user to reach a time which is distant
8983 * The time display is, by default, in military mode (24h), but an
8984 * am/pm indicator may be optionally shown, too, when it will
8987 * Smart callbacks one can register to:
8988 * - "changed" - the clock's user changed the time
8990 * Here is an example on its usage:
8991 * @li @ref clock_example
9000 * Identifiers for which clock digits should be editable, when a
9001 * clock widget is in edition mode. Values may be ORed together to
9002 * make a mask, naturally.
9004 * @see elm_clock_edit_set()
9005 * @see elm_clock_digit_edit_set()
9007 typedef enum _Elm_Clock_Digedit
9009 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9010 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9011 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9012 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9013 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9014 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9015 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9016 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9017 } Elm_Clock_Digedit;
9020 * Add a new clock widget to the given parent Elementary
9021 * (container) object
9023 * @param parent The parent object
9024 * @return a new clock widget handle or @c NULL, on errors
9026 * This function inserts a new clock widget on the canvas.
9030 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9033 * Set a clock widget's time, programmatically
9035 * @param obj The clock widget object
9036 * @param hrs The hours to set
9037 * @param min The minutes to set
9038 * @param sec The secondes to set
9040 * This function updates the time that is showed by the clock
9043 * Values @b must be set within the following ranges:
9044 * - 0 - 23, for hours
9045 * - 0 - 59, for minutes
9046 * - 0 - 59, for seconds,
9048 * even if the clock is not in "military" mode.
9050 * @warning The behavior for values set out of those ranges is @b
9055 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9058 * Get a clock widget's time values
9060 * @param obj The clock object
9061 * @param[out] hrs Pointer to the variable to get the hours value
9062 * @param[out] min Pointer to the variable to get the minutes value
9063 * @param[out] sec Pointer to the variable to get the seconds value
9065 * This function gets the time set for @p obj, returning
9066 * it on the variables passed as the arguments to function
9068 * @note Use @c NULL pointers on the time values you're not
9069 * interested in: they'll be ignored by the function.
9073 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9076 * Set whether a given clock widget is under <b>edition mode</b> or
9077 * under (default) displaying-only mode.
9079 * @param obj The clock object
9080 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9081 * put it back to "displaying only" mode
9083 * This function makes a clock's time to be editable or not <b>by
9084 * user interaction</b>. When in edition mode, clocks @b stop
9085 * ticking, until one brings them back to canonical mode. The
9086 * elm_clock_digit_edit_set() function will influence which digits
9087 * of the clock will be editable. By default, all of them will be
9088 * (#ELM_CLOCK_NONE).
9090 * @note am/pm sheets, if being shown, will @b always be editable
9091 * under edition mode.
9093 * @see elm_clock_edit_get()
9097 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9100 * Retrieve whether a given clock widget is under <b>edition
9101 * mode</b> or under (default) displaying-only mode.
9103 * @param obj The clock object
9104 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9107 * This function retrieves whether the clock's time can be edited
9108 * or not by user interaction.
9110 * @see elm_clock_edit_set() for more details
9114 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9117 * Set what digits of the given clock widget should be editable
9118 * when in edition mode.
9120 * @param obj The clock object
9121 * @param digedit Bit mask indicating the digits to be editable
9122 * (values in #Elm_Clock_Digedit).
9124 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9125 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9128 * @see elm_clock_digit_edit_get()
9132 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9135 * Retrieve what digits of the given clock widget should be
9136 * editable when in edition mode.
9138 * @param obj The clock object
9139 * @return Bit mask indicating the digits to be editable
9140 * (values in #Elm_Clock_Digedit).
9142 * @see elm_clock_digit_edit_set() for more details
9146 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9149 * Set if the given clock widget must show hours in military or
9152 * @param obj The clock object
9153 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9156 * This function sets if the clock must show hours in military or
9157 * am/pm mode. In some countries like Brazil the military mode
9158 * (00-24h-format) is used, in opposition to the USA, where the
9159 * am/pm mode is more commonly used.
9161 * @see elm_clock_show_am_pm_get()
9165 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9168 * Get if the given clock widget shows hours in military or am/pm
9171 * @param obj The clock object
9172 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9175 * This function gets if the clock shows hours in military or am/pm
9178 * @see elm_clock_show_am_pm_set() for more details
9182 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9185 * Set if the given clock widget must show time with seconds or not
9187 * @param obj The clock object
9188 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9190 * This function sets if the given clock must show or not elapsed
9191 * seconds. By default, they are @b not shown.
9193 * @see elm_clock_show_seconds_get()
9197 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9200 * Get whether the given clock widget is showing time with seconds
9203 * @param obj The clock object
9204 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9206 * This function gets whether @p obj is showing or not the elapsed
9209 * @see elm_clock_show_seconds_set()
9213 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9216 * Set the interval on time updates for an user mouse button hold
9217 * on clock widgets' time edition.
9219 * @param obj The clock object
9220 * @param interval The (first) interval value in seconds
9222 * This interval value is @b decreased while the user holds the
9223 * mouse pointer either incrementing or decrementing a given the
9224 * clock digit's value.
9226 * This helps the user to get to a given time distant from the
9227 * current one easier/faster, as it will start to flip quicker and
9228 * quicker on mouse button holds.
9230 * The calculation for the next flip interval value, starting from
9231 * the one set with this call, is the previous interval divided by
9232 * 1.05, so it decreases a little bit.
9234 * The default starting interval value for automatic flips is
9237 * @see elm_clock_interval_get()
9241 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9244 * Get the interval on time updates for an user mouse button hold
9245 * on clock widgets' time edition.
9247 * @param obj The clock object
9248 * @return The (first) interval value, in seconds, set on it
9250 * @see elm_clock_interval_set() for more details
9254 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9261 * @defgroup Layout Layout
9263 * @image html img/widget/layout/preview-00.png
9264 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9266 * @image html img/layout-predefined.png
9267 * @image latex img/layout-predefined.eps width=\textwidth
9269 * This is a container widget that takes a standard Edje design file and
9270 * wraps it very thinly in a widget.
9272 * An Edje design (theme) file has a very wide range of possibilities to
9273 * describe the behavior of elements added to the Layout. Check out the Edje
9274 * documentation and the EDC reference to get more information about what can
9275 * be done with Edje.
9277 * Just like @ref List, @ref Box, and other container widgets, any
9278 * object added to the Layout will become its child, meaning that it will be
9279 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9281 * The Layout widget can contain as many Contents, Boxes or Tables as
9282 * described in its theme file. For instance, objects can be added to
9283 * different Tables by specifying the respective Table part names. The same
9284 * is valid for Content and Box.
9286 * The objects added as child of the Layout will behave as described in the
9287 * part description where they were added. There are 3 possible types of
9288 * parts where a child can be added:
9290 * @section secContent Content (SWALLOW part)
9292 * Only one object can be added to the @c SWALLOW part (but you still can
9293 * have many @c SWALLOW parts and one object on each of them). Use the @c
9294 * elm_layout_content_* set of functions to set, retrieve and unset objects
9295 * as content of the @c SWALLOW. After being set to this part, the object
9296 * size, position, visibility, clipping and other description properties
9297 * will be totally controled by the description of the given part (inside
9298 * the Edje theme file).
9300 * One can use @c evas_object_size_hint_* functions on the child to have some
9301 * kind of control over its behavior, but the resulting behavior will still
9302 * depend heavily on the @c SWALLOW part description.
9304 * The Edje theme also can change the part description, based on signals or
9305 * scripts running inside the theme. This change can also be animated. All of
9306 * this will affect the child object set as content accordingly. The object
9307 * size will be changed if the part size is changed, it will animate move if
9308 * the part is moving, and so on.
9310 * The following picture demonstrates a Layout widget with a child object
9311 * added to its @c SWALLOW:
9313 * @image html layout_swallow.png
9314 * @image latex layout_swallow.eps width=\textwidth
9316 * @section secBox Box (BOX part)
9318 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9319 * allows one to add objects to the box and have them distributed along its
9320 * area, accordingly to the specified @a layout property (now by @a layout we
9321 * mean the chosen layouting design of the Box, not the Layout widget
9324 * A similar effect for having a box with its position, size and other things
9325 * controled by the Layout theme would be to create an Elementary @ref Box
9326 * widget and add it as a Content in the @c SWALLOW part.
9328 * The main difference of using the Layout Box is that its behavior, the box
9329 * properties like layouting format, padding, align, etc. will be all
9330 * controled by the theme. This means, for example, that a signal could be
9331 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9332 * handled the signal by changing the box padding, or align, or both. Using
9333 * the Elementary @ref Box widget is not necessarily harder or easier, it
9334 * just depends on the circunstances and requirements.
9336 * The Layout Box can be used through the @c elm_layout_box_* set of
9339 * The following picture demonstrates a Layout widget with many child objects
9340 * added to its @c BOX part:
9342 * @image html layout_box.png
9343 * @image latex layout_box.eps width=\textwidth
9345 * @section secTable Table (TABLE part)
9347 * Just like the @ref secBox, the Layout Table is very similar to the
9348 * Elementary @ref Table widget. It allows one to add objects to the Table
9349 * specifying the row and column where the object should be added, and any
9350 * column or row span if necessary.
9352 * Again, we could have this design by adding a @ref Table widget to the @c
9353 * SWALLOW part using elm_layout_content_set(). The same difference happens
9354 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9355 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9357 * The Layout Table can be used through the @c elm_layout_table_* set of
9360 * The following picture demonstrates a Layout widget with many child objects
9361 * added to its @c TABLE part:
9363 * @image html layout_table.png
9364 * @image latex layout_table.eps width=\textwidth
9366 * @section secPredef Predefined Layouts
9368 * Another interesting thing about the Layout widget is that it offers some
9369 * predefined themes that come with the default Elementary theme. These
9370 * themes can be set by the call elm_layout_theme_set(), and provide some
9371 * basic functionality depending on the theme used.
9373 * Most of them already send some signals, some already provide a toolbar or
9374 * back and next buttons.
9376 * These are available predefined theme layouts. All of them have class = @c
9377 * layout, group = @c application, and style = one of the following options:
9379 * @li @c toolbar-content - application with toolbar and main content area
9380 * @li @c toolbar-content-back - application with toolbar and main content
9381 * area with a back button and title area
9382 * @li @c toolbar-content-back-next - application with toolbar and main
9383 * content area with a back and next buttons and title area
9384 * @li @c content-back - application with a main content area with a back
9385 * button and title area
9386 * @li @c content-back-next - application with a main content area with a
9387 * back and next buttons and title area
9388 * @li @c toolbar-vbox - application with toolbar and main content area as a
9390 * @li @c toolbar-table - application with toolbar and main content area as a
9393 * @section secExamples Examples
9395 * Some examples of the Layout widget can be found here:
9396 * @li @ref layout_example_01
9397 * @li @ref layout_example_02
9398 * @li @ref layout_example_03
9399 * @li @ref layout_example_edc
9404 * Add a new layout to the parent
9406 * @param parent The parent object
9407 * @return The new object or NULL if it cannot be created
9409 * @see elm_layout_file_set()
9410 * @see elm_layout_theme_set()
9414 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9416 * Set the file that will be used as layout
9418 * @param obj The layout object
9419 * @param file The path to file (edj) that will be used as layout
9420 * @param group The group that the layout belongs in edje file
9422 * @return (1 = success, 0 = error)
9426 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9428 * Set the edje group from the elementary theme that will be used as layout
9430 * @param obj The layout object
9431 * @param clas the clas of the group
9432 * @param group the group
9433 * @param style the style to used
9435 * @return (1 = success, 0 = error)
9439 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9441 * Set the layout content.
9443 * @param obj The layout object
9444 * @param swallow The swallow part name in the edje file
9445 * @param content The child that will be added in this layout object
9447 * Once the content object is set, a previously set one will be deleted.
9448 * If you want to keep that old content object, use the
9449 * elm_layout_content_unset() function.
9451 * @note In an Edje theme, the part used as a content container is called @c
9452 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9453 * expected to be a part name just like the second parameter of
9454 * elm_layout_box_append().
9456 * @see elm_layout_box_append()
9457 * @see elm_layout_content_get()
9458 * @see elm_layout_content_unset()
9463 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9465 * Get the child object in the given content part.
9467 * @param obj The layout object
9468 * @param swallow The SWALLOW part to get its content
9470 * @return The swallowed object or NULL if none or an error occurred
9472 * @see elm_layout_content_set()
9476 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9478 * Unset the layout content.
9480 * @param obj The layout object
9481 * @param swallow The swallow part name in the edje file
9482 * @return The content that was being used
9484 * Unparent and return the content object which was set for this part.
9486 * @see elm_layout_content_set()
9490 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9492 * Set the text of the given part
9494 * @param obj The layout object
9495 * @param part The TEXT part where to set the text
9496 * @param text The text to set
9499 * @deprecated use elm_object_text_* instead.
9501 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9503 * Get the text set in the given part
9505 * @param obj The layout object
9506 * @param part The TEXT part to retrieve the text off
9508 * @return The text set in @p part
9511 * @deprecated use elm_object_text_* instead.
9513 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9515 * Append child to layout box part.
9517 * @param obj the layout object
9518 * @param part the box part to which the object will be appended.
9519 * @param child the child object to append to box.
9521 * Once the object is appended, it will become child of the layout. Its
9522 * lifetime will be bound to the layout, whenever the layout dies the child
9523 * will be deleted automatically. One should use elm_layout_box_remove() to
9524 * make this layout forget about the object.
9526 * @see elm_layout_box_prepend()
9527 * @see elm_layout_box_insert_before()
9528 * @see elm_layout_box_insert_at()
9529 * @see elm_layout_box_remove()
9533 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9535 * Prepend child to layout box part.
9537 * @param obj the layout object
9538 * @param part the box part to prepend.
9539 * @param child the child object to prepend to box.
9541 * Once the object is prepended, it will become child of the layout. Its
9542 * lifetime will be bound to the layout, whenever the layout dies the child
9543 * will be deleted automatically. One should use elm_layout_box_remove() to
9544 * make this layout forget about the object.
9546 * @see elm_layout_box_append()
9547 * @see elm_layout_box_insert_before()
9548 * @see elm_layout_box_insert_at()
9549 * @see elm_layout_box_remove()
9553 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9555 * Insert child to layout box part before a reference object.
9557 * @param obj the layout object
9558 * @param part the box part to insert.
9559 * @param child the child object to insert into box.
9560 * @param reference another reference object to insert before in box.
9562 * Once the object is inserted, it will become child of the layout. Its
9563 * lifetime will be bound to the layout, whenever the layout dies the child
9564 * will be deleted automatically. One should use elm_layout_box_remove() to
9565 * make this layout forget about the object.
9567 * @see elm_layout_box_append()
9568 * @see elm_layout_box_prepend()
9569 * @see elm_layout_box_insert_before()
9570 * @see elm_layout_box_remove()
9574 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9576 * Insert child to layout box part at a given position.
9578 * @param obj the layout object
9579 * @param part the box part to insert.
9580 * @param child the child object to insert into box.
9581 * @param pos the numeric position >=0 to insert the child.
9583 * Once the object is inserted, it will become child of the layout. Its
9584 * lifetime will be bound to the layout, whenever the layout dies the child
9585 * will be deleted automatically. One should use elm_layout_box_remove() to
9586 * make this layout forget about the object.
9588 * @see elm_layout_box_append()
9589 * @see elm_layout_box_prepend()
9590 * @see elm_layout_box_insert_before()
9591 * @see elm_layout_box_remove()
9595 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9597 * Remove a child of the given part box.
9599 * @param obj The layout object
9600 * @param part The box part name to remove child.
9601 * @param child The object to remove from box.
9602 * @return The object that was being used, or NULL if not found.
9604 * The object will be removed from the box part and its lifetime will
9605 * not be handled by the layout anymore. This is equivalent to
9606 * elm_layout_content_unset() for box.
9608 * @see elm_layout_box_append()
9609 * @see elm_layout_box_remove_all()
9613 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9615 * Remove all child of the given part box.
9617 * @param obj The layout object
9618 * @param part The box part name to remove child.
9619 * @param clear If EINA_TRUE, then all objects will be deleted as
9620 * well, otherwise they will just be removed and will be
9621 * dangling on the canvas.
9623 * The objects will be removed from the box part and their lifetime will
9624 * not be handled by the layout anymore. This is equivalent to
9625 * elm_layout_box_remove() for all box children.
9627 * @see elm_layout_box_append()
9628 * @see elm_layout_box_remove()
9632 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9634 * Insert child to layout table part.
9636 * @param obj the layout object
9637 * @param part the box part to pack child.
9638 * @param child_obj the child object to pack into table.
9639 * @param col the column to which the child should be added. (>= 0)
9640 * @param row the row to which the child should be added. (>= 0)
9641 * @param colspan how many columns should be used to store this object. (>=
9643 * @param rowspan how many rows should be used to store this object. (>= 1)
9645 * Once the object is inserted, it will become child of the table. Its
9646 * lifetime will be bound to the layout, and whenever the layout dies the
9647 * child will be deleted automatically. One should use
9648 * elm_layout_table_remove() to make this layout forget about the object.
9650 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9651 * more space than a single cell. For instance, the following code:
9653 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9656 * Would result in an object being added like the following picture:
9658 * @image html layout_colspan.png
9659 * @image latex layout_colspan.eps width=\textwidth
9661 * @see elm_layout_table_unpack()
9662 * @see elm_layout_table_clear()
9666 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);
9668 * Unpack (remove) a child of the given part table.
9670 * @param obj The layout object
9671 * @param part The table part name to remove child.
9672 * @param child_obj The object to remove from table.
9673 * @return The object that was being used, or NULL if not found.
9675 * The object will be unpacked from the table part and its lifetime
9676 * will not be handled by the layout anymore. This is equivalent to
9677 * elm_layout_content_unset() for table.
9679 * @see elm_layout_table_pack()
9680 * @see elm_layout_table_clear()
9684 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9686 * Remove all child of the given part table.
9688 * @param obj The layout object
9689 * @param part The table part name to remove child.
9690 * @param clear If EINA_TRUE, then all objects will be deleted as
9691 * well, otherwise they will just be removed and will be
9692 * dangling on the canvas.
9694 * The objects will be removed from the table part and their lifetime will
9695 * not be handled by the layout anymore. This is equivalent to
9696 * elm_layout_table_unpack() for all table children.
9698 * @see elm_layout_table_pack()
9699 * @see elm_layout_table_unpack()
9703 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9705 * Get the edje layout
9707 * @param obj The layout object
9709 * @return A Evas_Object with the edje layout settings loaded
9710 * with function elm_layout_file_set
9712 * This returns the edje object. It is not expected to be used to then
9713 * swallow objects via edje_object_part_swallow() for example. Use
9714 * elm_layout_content_set() instead so child object handling and sizing is
9717 * @note This function should only be used if you really need to call some
9718 * low level Edje function on this edje object. All the common stuff (setting
9719 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9720 * with proper elementary functions.
9722 * @see elm_object_signal_callback_add()
9723 * @see elm_object_signal_emit()
9724 * @see elm_object_text_part_set()
9725 * @see elm_layout_content_set()
9726 * @see elm_layout_box_append()
9727 * @see elm_layout_table_pack()
9728 * @see elm_layout_data_get()
9732 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9734 * Get the edje data from the given layout
9736 * @param obj The layout object
9737 * @param key The data key
9739 * @return The edje data string
9741 * This function fetches data specified inside the edje theme of this layout.
9742 * This function return NULL if data is not found.
9744 * In EDC this comes from a data block within the group block that @p
9745 * obj was loaded from. E.g.
9752 * item: "key1" "value1";
9753 * item: "key2" "value2";
9761 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9765 * @param obj The layout object
9767 * Manually forces a sizing re-evaluation. This is useful when the minimum
9768 * size required by the edje theme of this layout has changed. The change on
9769 * the minimum size required by the edje theme is not immediately reported to
9770 * the elementary layout, so one needs to call this function in order to tell
9771 * the widget (layout) that it needs to reevaluate its own size.
9773 * The minimum size of the theme is calculated based on minimum size of
9774 * parts, the size of elements inside containers like box and table, etc. All
9775 * of this can change due to state changes, and that's when this function
9778 * Also note that a standard signal of "size,eval" "elm" emitted from the
9779 * edje object will cause this to happen too.
9783 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9786 * Sets a specific cursor for an edje part.
9788 * @param obj The layout object.
9789 * @param part_name a part from loaded edje group.
9790 * @param cursor cursor name to use, see Elementary_Cursor.h
9792 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9793 * part not exists or it has "mouse_events: 0".
9797 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9800 * Get the cursor to be shown when mouse is over an edje part
9802 * @param obj The layout object.
9803 * @param part_name a part from loaded edje group.
9804 * @return the cursor name.
9808 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9811 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9813 * @param obj The layout object.
9814 * @param part_name a part from loaded edje group, that had a cursor set
9815 * with elm_layout_part_cursor_set().
9819 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9822 * Sets a specific cursor style for an edje part.
9824 * @param obj The layout object.
9825 * @param part_name a part from loaded edje group.
9826 * @param style the theme style to use (default, transparent, ...)
9828 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9829 * part not exists or it did not had a cursor set.
9833 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9836 * Gets a specific cursor style for an edje part.
9838 * @param obj The layout object.
9839 * @param part_name a part from loaded edje group.
9841 * @return the theme style in use, defaults to "default". If the
9842 * object does not have a cursor set, then NULL is returned.
9846 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9849 * Sets if the cursor set should be searched on the theme or should use
9850 * the provided by the engine, only.
9852 * @note before you set if should look on theme you should define a
9853 * cursor with elm_layout_part_cursor_set(). By default it will only
9854 * look for cursors provided by the engine.
9856 * @param obj The layout object.
9857 * @param part_name a part from loaded edje group.
9858 * @param engine_only if cursors should be just provided by the engine
9859 * or should also search on widget's theme as well
9861 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9862 * part not exists or it did not had a cursor set.
9866 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);
9869 * Gets a specific cursor engine_only for an edje part.
9871 * @param obj The layout object.
9872 * @param part_name a part from loaded edje group.
9874 * @return whenever the cursor is just provided by engine or also from theme.
9878 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9881 * @def elm_layout_icon_set
9882 * Convienience macro to set the icon object in a layout that follows the
9883 * Elementary naming convention for its parts.
9887 #define elm_layout_icon_set(_ly, _obj) \
9890 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9891 if ((_obj)) sig = "elm,state,icon,visible"; \
9892 else sig = "elm,state,icon,hidden"; \
9893 elm_object_signal_emit((_ly), sig, "elm"); \
9897 * @def elm_layout_icon_get
9898 * Convienience macro to get the icon object from a layout that follows the
9899 * Elementary naming convention for its parts.
9903 #define elm_layout_icon_get(_ly) \
9904 elm_layout_content_get((_ly), "elm.swallow.icon")
9907 * @def elm_layout_end_set
9908 * Convienience macro to set the end object in a layout that follows the
9909 * Elementary naming convention for its parts.
9913 #define elm_layout_end_set(_ly, _obj) \
9916 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9917 if ((_obj)) sig = "elm,state,end,visible"; \
9918 else sig = "elm,state,end,hidden"; \
9919 elm_object_signal_emit((_ly), sig, "elm"); \
9923 * @def elm_layout_end_get
9924 * Convienience macro to get the end object in a layout that follows the
9925 * Elementary naming convention for its parts.
9929 #define elm_layout_end_get(_ly) \
9930 elm_layout_content_get((_ly), "elm.swallow.end")
9933 * @def elm_layout_label_set
9934 * Convienience macro to set the label in a layout that follows the
9935 * Elementary naming convention for its parts.
9938 * @deprecated use elm_object_text_* instead.
9940 #define elm_layout_label_set(_ly, _txt) \
9941 elm_layout_text_set((_ly), "elm.text", (_txt))
9944 * @def elm_layout_label_get
9945 * Convienience macro to get the label in a layout that follows the
9946 * Elementary naming convention for its parts.
9949 * @deprecated use elm_object_text_* instead.
9951 #define elm_layout_label_get(_ly) \
9952 elm_layout_text_get((_ly), "elm.text")
9954 /* smart callbacks called:
9955 * "theme,changed" - when elm theme is changed.
9959 * @defgroup Notify Notify
9961 * @image html img/widget/notify/preview-00.png
9962 * @image latex img/widget/notify/preview-00.eps
9964 * Display a container in a particular region of the parent(top, bottom,
9965 * etc. A timeout can be set to automatically hide the notify. This is so
9966 * that, after an evas_object_show() on a notify object, if a timeout was set
9967 * on it, it will @b automatically get hidden after that time.
9969 * Signals that you can add callbacks for are:
9970 * @li "timeout" - when timeout happens on notify and it's hidden
9971 * @li "block,clicked" - when a click outside of the notify happens
9973 * @ref tutorial_notify show usage of the API.
9978 * @brief Possible orient values for notify.
9980 * This values should be used in conjunction to elm_notify_orient_set() to
9981 * set the position in which the notify should appear(relative to its parent)
9982 * and in conjunction with elm_notify_orient_get() to know where the notify
9985 typedef enum _Elm_Notify_Orient
9987 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9988 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9989 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9990 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9991 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9992 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9993 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9994 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9995 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9996 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9997 } Elm_Notify_Orient;
9999 * @brief Add a new notify to the parent
10001 * @param parent The parent object
10002 * @return The new object or NULL if it cannot be created
10004 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10006 * @brief Set the content of the notify widget
10008 * @param obj The notify object
10009 * @param content The content will be filled in this notify object
10011 * Once the content object is set, a previously set one will be deleted. If
10012 * you want to keep that old content object, use the
10013 * elm_notify_content_unset() function.
10015 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10017 * @brief Unset the content of the notify widget
10019 * @param obj The notify object
10020 * @return The content that was being used
10022 * Unparent and return the content object which was set for this widget
10024 * @see elm_notify_content_set()
10026 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10028 * @brief Return the content of the notify widget
10030 * @param obj The notify object
10031 * @return The content that is being used
10033 * @see elm_notify_content_set()
10035 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10037 * @brief Set the notify parent
10039 * @param obj The notify object
10040 * @param content The new parent
10042 * Once the parent object is set, a previously set one will be disconnected
10045 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10047 * @brief Get the notify parent
10049 * @param obj The notify object
10050 * @return The parent
10052 * @see elm_notify_parent_set()
10054 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10056 * @brief Set the orientation
10058 * @param obj The notify object
10059 * @param orient The new orientation
10061 * Sets the position in which the notify will appear in its parent.
10063 * @see @ref Elm_Notify_Orient for possible values.
10065 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10067 * @brief Return the orientation
10068 * @param obj The notify object
10069 * @return The orientation of the notification
10071 * @see elm_notify_orient_set()
10072 * @see Elm_Notify_Orient
10074 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10076 * @brief Set the time interval after which the notify window is going to be
10079 * @param obj The notify object
10080 * @param time The timeout in seconds
10082 * This function sets a timeout and starts the timer controlling when the
10083 * notify is hidden. Since calling evas_object_show() on a notify restarts
10084 * the timer controlling when the notify is hidden, setting this before the
10085 * notify is shown will in effect mean starting the timer when the notify is
10088 * @note Set a value <= 0.0 to disable a running timer.
10090 * @note If the value > 0.0 and the notify is previously visible, the
10091 * timer will be started with this value, canceling any running timer.
10093 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10095 * @brief Return the timeout value (in seconds)
10096 * @param obj the notify object
10098 * @see elm_notify_timeout_set()
10100 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10102 * @brief Sets whether events should be passed to by a click outside
10105 * @param obj The notify object
10106 * @param repeats EINA_TRUE Events are repeats, else no
10108 * When true if the user clicks outside the window the events will be caught
10109 * by the others widgets, else the events are blocked.
10111 * @note The default value is EINA_TRUE.
10113 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10115 * @brief Return true if events are repeat below the notify object
10116 * @param obj the notify object
10118 * @see elm_notify_repeat_events_set()
10120 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10126 * @defgroup Hover Hover
10128 * @image html img/widget/hover/preview-00.png
10129 * @image latex img/widget/hover/preview-00.eps
10131 * A Hover object will hover over its @p parent object at the @p target
10132 * location. Anything in the background will be given a darker coloring to
10133 * indicate that the hover object is on top (at the default theme). When the
10134 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10135 * clicked that @b doesn't cause the hover to be dismissed.
10137 * @note The hover object will take up the entire space of @p target
10140 * Elementary has the following styles for the hover widget:
10144 * @li hoversel_vertical
10146 * The following are the available position for content:
10158 * Signals that you can add callbacks for are:
10159 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10160 * @li "smart,changed" - a content object placed under the "smart"
10161 * policy was replaced to a new slot direction.
10163 * See @ref tutorial_hover for more information.
10167 typedef enum _Elm_Hover_Axis
10169 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10170 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10171 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10172 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10175 * @brief Adds a hover object to @p parent
10177 * @param parent The parent object
10178 * @return The hover object or NULL if one could not be created
10180 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10182 * @brief Sets the target object for the hover.
10184 * @param obj The hover object
10185 * @param target The object to center the hover onto. The hover
10187 * This function will cause the hover to be centered on the target object.
10189 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10191 * @brief Gets the target object for the hover.
10193 * @param obj The hover object
10194 * @param parent The object to locate the hover over.
10196 * @see elm_hover_target_set()
10198 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10200 * @brief Sets the parent object for the hover.
10202 * @param obj The hover object
10203 * @param parent The object to locate the hover over.
10205 * This function will cause the hover to take up the entire space that the
10206 * parent object fills.
10208 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10210 * @brief Gets the parent object for the hover.
10212 * @param obj The hover object
10213 * @return The parent object to locate the hover over.
10215 * @see elm_hover_parent_set()
10217 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10219 * @brief Sets the content of the hover object and the direction in which it
10222 * @param obj The hover object
10223 * @param swallow The direction that the object will be displayed
10224 * at. Accepted values are "left", "top-left", "top", "top-right",
10225 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10227 * @param content The content to place at @p swallow
10229 * Once the content object is set for a given direction, a previously
10230 * set one (on the same direction) will be deleted. If you want to
10231 * keep that old content object, use the elm_hover_content_unset()
10234 * All directions may have contents at the same time, except for
10235 * "smart". This is a special placement hint and its use case
10236 * independs of the calculations coming from
10237 * elm_hover_best_content_location_get(). Its use is for cases when
10238 * one desires only one hover content, but with a dinamic special
10239 * placement within the hover area. The content's geometry, whenever
10240 * it changes, will be used to decide on a best location not
10241 * extrapolating the hover's parent object view to show it in (still
10242 * being the hover's target determinant of its medium part -- move and
10243 * resize it to simulate finger sizes, for example). If one of the
10244 * directions other than "smart" are used, a previously content set
10245 * using it will be deleted, and vice-versa.
10247 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10249 * @brief Get the content of the hover object, in a given direction.
10251 * Return the content object which was set for this widget in the
10252 * @p swallow direction.
10254 * @param obj The hover object
10255 * @param swallow The direction that the object was display at.
10256 * @return The content that was being used
10258 * @see elm_hover_content_set()
10260 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10262 * @brief Unset the content of the hover object, in a given direction.
10264 * Unparent and return the content object set at @p swallow direction.
10266 * @param obj The hover object
10267 * @param swallow The direction that the object was display at.
10268 * @return The content that was being used.
10270 * @see elm_hover_content_set()
10272 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10274 * @brief Returns the best swallow location for content in the hover.
10276 * @param obj The hover object
10277 * @param pref_axis The preferred orientation axis for the hover object to use
10278 * @return The edje location to place content into the hover or @c
10281 * Best is defined here as the location at which there is the most available
10284 * @p pref_axis may be one of
10285 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10286 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10287 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10288 * - @c ELM_HOVER_AXIS_BOTH -- both
10290 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10291 * nescessarily be along the horizontal axis("left" or "right"). If
10292 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10293 * be along the vertical axis("top" or "bottom"). Chossing
10294 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10295 * returned position may be in either axis.
10297 * @see elm_hover_content_set()
10299 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10306 * @defgroup Entry Entry
10308 * @image html img/widget/entry/preview-00.png
10309 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10310 * @image html img/widget/entry/preview-01.png
10311 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10312 * @image html img/widget/entry/preview-02.png
10313 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10314 * @image html img/widget/entry/preview-03.png
10315 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10317 * An entry is a convenience widget which shows a box that the user can
10318 * enter text into. Entries by default don't scroll, so they grow to
10319 * accomodate the entire text, resizing the parent window as needed. This
10320 * can be changed with the elm_entry_scrollable_set() function.
10322 * They can also be single line or multi line (the default) and when set
10323 * to multi line mode they support text wrapping in any of the modes
10324 * indicated by #Elm_Wrap_Type.
10326 * Other features include password mode, filtering of inserted text with
10327 * elm_entry_text_filter_append() and related functions, inline "items" and
10328 * formatted markup text.
10330 * @section entry-markup Formatted text
10332 * The markup tags supported by the Entry are defined by the theme, but
10333 * even when writing new themes or extensions it's a good idea to stick to
10334 * a sane default, to maintain coherency and avoid application breakages.
10335 * Currently defined by the default theme are the following tags:
10336 * @li \<br\>: Inserts a line break.
10337 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10339 * @li \<tab\>: Inserts a tab.
10340 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10342 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10343 * @li \<link\>...\</link\>: Underlines the enclosed text.
10344 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10346 * @section entry-special Special markups
10348 * Besides those used to format text, entries support two special markup
10349 * tags used to insert clickable portions of text or items inlined within
10352 * @subsection entry-anchors Anchors
10354 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10355 * \</a\> tags and an event will be generated when this text is clicked,
10359 * This text is outside <a href=anc-01>but this one is an anchor</a>
10362 * The @c href attribute in the opening tag gives the name that will be
10363 * used to identify the anchor and it can be any valid utf8 string.
10365 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10366 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10367 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10368 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10371 * @subsection entry-items Items
10373 * Inlined in the text, any other @c Evas_Object can be inserted by using
10374 * \<item\> tags this way:
10377 * <item size=16x16 vsize=full href=emoticon/haha></item>
10380 * Just like with anchors, the @c href identifies each item, but these need,
10381 * in addition, to indicate their size, which is done using any one of
10382 * @c size, @c absize or @c relsize attributes. These attributes take their
10383 * value in the WxH format, where W is the width and H the height of the
10386 * @li absize: Absolute pixel size for the item. Whatever value is set will
10387 * be the item's size regardless of any scale value the object may have
10388 * been set to. The final line height will be adjusted to fit larger items.
10389 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10391 * @li relsize: Size is adjusted for the item to fit within the current
10394 * Besides their size, items are specificed a @c vsize value that affects
10395 * how their final size and position are calculated. The possible values
10397 * @li ascent: Item will be placed within the line's baseline and its
10398 * ascent. That is, the height between the line where all characters are
10399 * positioned and the highest point in the line. For @c size and @c absize
10400 * items, the descent value will be added to the total line height to make
10401 * them fit. @c relsize items will be adjusted to fit within this space.
10402 * @li full: Items will be placed between the descent and ascent, or the
10403 * lowest point in the line and its highest.
10405 * The next image shows different configurations of items and how they
10406 * are the previously mentioned options affect their sizes. In all cases,
10407 * the green line indicates the ascent, blue for the baseline and red for
10410 * @image html entry_item.png
10411 * @image latex entry_item.eps width=\textwidth
10413 * And another one to show how size differs from absize. In the first one,
10414 * the scale value is set to 1.0, while the second one is using one of 2.0.
10416 * @image html entry_item_scale.png
10417 * @image latex entry_item_scale.eps width=\textwidth
10419 * After the size for an item is calculated, the entry will request an
10420 * object to place in its space. For this, the functions set with
10421 * elm_entry_item_provider_append() and related functions will be called
10422 * in order until one of them returns a @c non-NULL value. If no providers
10423 * are available, or all of them return @c NULL, then the entry falls back
10424 * to one of the internal defaults, provided the name matches with one of
10427 * All of the following are currently supported:
10430 * - emoticon/angry-shout
10431 * - emoticon/crazy-laugh
10432 * - emoticon/evil-laugh
10434 * - emoticon/goggle-smile
10435 * - emoticon/grumpy
10436 * - emoticon/grumpy-smile
10437 * - emoticon/guilty
10438 * - emoticon/guilty-smile
10440 * - emoticon/half-smile
10441 * - emoticon/happy-panting
10443 * - emoticon/indifferent
10445 * - emoticon/knowing-grin
10447 * - emoticon/little-bit-sorry
10448 * - emoticon/love-lots
10450 * - emoticon/minimal-smile
10451 * - emoticon/not-happy
10452 * - emoticon/not-impressed
10454 * - emoticon/opensmile
10457 * - emoticon/squint-laugh
10458 * - emoticon/surprised
10459 * - emoticon/suspicious
10460 * - emoticon/tongue-dangling
10461 * - emoticon/tongue-poke
10463 * - emoticon/unhappy
10464 * - emoticon/very-sorry
10467 * - emoticon/worried
10470 * Alternatively, an item may reference an image by its path, using
10471 * the URI form @c file:///path/to/an/image.png and the entry will then
10472 * use that image for the item.
10474 * @section entry-files Loading and saving files
10476 * Entries have convinience functions to load text from a file and save
10477 * changes back to it after a short delay. The automatic saving is enabled
10478 * by default, but can be disabled with elm_entry_autosave_set() and files
10479 * can be loaded directly as plain text or have any markup in them
10480 * recognized. See elm_entry_file_set() for more details.
10482 * @section entry-signals Emitted signals
10484 * This widget emits the following signals:
10486 * @li "changed": The text within the entry was changed.
10487 * @li "changed,user": The text within the entry was changed because of user interaction.
10488 * @li "activated": The enter key was pressed on a single line entry.
10489 * @li "press": A mouse button has been pressed on the entry.
10490 * @li "longpressed": A mouse button has been pressed and held for a couple
10492 * @li "clicked": The entry has been clicked (mouse press and release).
10493 * @li "clicked,double": The entry has been double clicked.
10494 * @li "clicked,triple": The entry has been triple clicked.
10495 * @li "focused": The entry has received focus.
10496 * @li "unfocused": The entry has lost focus.
10497 * @li "selection,paste": A paste of the clipboard contents was requested.
10498 * @li "selection,copy": A copy of the selected text into the clipboard was
10500 * @li "selection,cut": A cut of the selected text into the clipboard was
10502 * @li "selection,start": A selection has begun and no previous selection
10504 * @li "selection,changed": The current selection has changed.
10505 * @li "selection,cleared": The current selection has been cleared.
10506 * @li "cursor,changed": The cursor has changed position.
10507 * @li "anchor,clicked": An anchor has been clicked. The event_info
10508 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10509 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10510 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10511 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10512 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10513 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10514 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10515 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10516 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10517 * @li "preedit,changed": The preedit string has changed.
10519 * @section entry-examples
10521 * An overview of the Entry API can be seen in @ref entry_example_01
10526 * @typedef Elm_Entry_Anchor_Info
10528 * The info sent in the callback for the "anchor,clicked" signals emitted
10531 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10533 * @struct _Elm_Entry_Anchor_Info
10535 * The info sent in the callback for the "anchor,clicked" signals emitted
10538 struct _Elm_Entry_Anchor_Info
10540 const char *name; /**< The name of the anchor, as stated in its href */
10541 int button; /**< The mouse button used to click on it */
10542 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10543 y, /**< Anchor geometry, relative to canvas */
10544 w, /**< Anchor geometry, relative to canvas */
10545 h; /**< Anchor geometry, relative to canvas */
10548 * @typedef Elm_Entry_Filter_Cb
10549 * This callback type is used by entry filters to modify text.
10550 * @param data The data specified as the last param when adding the filter
10551 * @param entry The entry object
10552 * @param text A pointer to the location of the text being filtered. This data can be modified,
10553 * but any additional allocations must be managed by the user.
10554 * @see elm_entry_text_filter_append
10555 * @see elm_entry_text_filter_prepend
10557 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10560 * This adds an entry to @p parent object.
10562 * By default, entries are:
10566 * @li autosave is enabled
10568 * @param parent The parent object
10569 * @return The new object or NULL if it cannot be created
10571 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10573 * Sets the entry to single line mode.
10575 * In single line mode, entries don't ever wrap when the text reaches the
10576 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10577 * key will generate an @c "activate" event instead of adding a new line.
10579 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10580 * and pressing enter will break the text into a different line
10581 * without generating any events.
10583 * @param obj The entry object
10584 * @param single_line If true, the text in the entry
10585 * will be on a single line.
10587 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10589 * Gets whether the entry is set to be single line.
10591 * @param obj The entry object
10592 * @return single_line If true, the text in the entry is set to display
10593 * on a single line.
10595 * @see elm_entry_single_line_set()
10597 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10599 * Sets the entry to password mode.
10601 * In password mode, entries are implicitly single line and the display of
10602 * any text in them is replaced with asterisks (*).
10604 * @param obj The entry object
10605 * @param password If true, password mode is enabled.
10607 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10609 * Gets whether the entry is set to password mode.
10611 * @param obj The entry object
10612 * @return If true, the entry is set to display all characters
10613 * as asterisks (*).
10615 * @see elm_entry_password_set()
10617 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10619 * This sets the text displayed within the entry to @p entry.
10621 * @param obj The entry object
10622 * @param entry The text to be displayed
10624 * @deprecated Use elm_object_text_set() instead.
10626 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10628 * This returns the text currently shown in object @p entry.
10629 * See also elm_entry_entry_set().
10631 * @param obj The entry object
10632 * @return The currently displayed text or NULL on failure
10634 * @deprecated Use elm_object_text_get() instead.
10636 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10638 * Appends @p entry to the text of the entry.
10640 * Adds the text in @p entry to the end of any text already present in the
10643 * The appended text is subject to any filters set for the widget.
10645 * @param obj The entry object
10646 * @param entry The text to be displayed
10648 * @see elm_entry_text_filter_append()
10650 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10652 * Gets whether the entry is empty.
10654 * Empty means no text at all. If there are any markup tags, like an item
10655 * tag for which no provider finds anything, and no text is displayed, this
10656 * function still returns EINA_FALSE.
10658 * @param obj The entry object
10659 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10661 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10663 * Gets any selected text within the entry.
10665 * If there's any selected text in the entry, this function returns it as
10666 * a string in markup format. NULL is returned if no selection exists or
10667 * if an error occurred.
10669 * The returned value points to an internal string and should not be freed
10670 * or modified in any way. If the @p entry object is deleted or its
10671 * contents are changed, the returned pointer should be considered invalid.
10673 * @param obj The entry object
10674 * @return The selected text within the entry or NULL on failure
10676 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10678 * Inserts the given text into the entry at the current cursor position.
10680 * This inserts text at the cursor position as if it was typed
10681 * by the user (note that this also allows markup which a user
10682 * can't just "type" as it would be converted to escaped text, so this
10683 * call can be used to insert things like emoticon items or bold push/pop
10684 * tags, other font and color change tags etc.)
10686 * If any selection exists, it will be replaced by the inserted text.
10688 * The inserted text is subject to any filters set for the widget.
10690 * @param obj The entry object
10691 * @param entry The text to insert
10693 * @see elm_entry_text_filter_append()
10695 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10697 * Set the line wrap type to use on multi-line entries.
10699 * Sets the wrap type used by the entry to any of the specified in
10700 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10701 * line (without inserting a line break or paragraph separator) when it
10702 * reaches the far edge of the widget.
10704 * Note that this only makes sense for multi-line entries. A widget set
10705 * to be single line will never wrap.
10707 * @param obj The entry object
10708 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10710 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10712 * Gets the wrap mode the entry was set to use.
10714 * @param obj The entry object
10715 * @return Wrap type
10717 * @see also elm_entry_line_wrap_set()
10719 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10721 * Sets if the entry is to be editable or not.
10723 * By default, entries are editable and when focused, any text input by the
10724 * user will be inserted at the current cursor position. But calling this
10725 * function with @p editable as EINA_FALSE will prevent the user from
10726 * inputting text into the entry.
10728 * The only way to change the text of a non-editable entry is to use
10729 * elm_object_text_set(), elm_entry_entry_insert() and other related
10732 * @param obj The entry object
10733 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10734 * if not, the entry is read-only and no user input is allowed.
10736 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10738 * Gets whether the entry is editable or not.
10740 * @param obj The entry object
10741 * @return If true, the entry is editable by the user.
10742 * If false, it is not editable by the user
10744 * @see elm_entry_editable_set()
10746 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10748 * This drops any existing text selection within the entry.
10750 * @param obj The entry object
10752 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10754 * This selects all text within the entry.
10756 * @param obj The entry object
10758 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10760 * This moves the cursor one place to the right within the entry.
10762 * @param obj The entry object
10763 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10765 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10767 * This moves the cursor one place to the left within the entry.
10769 * @param obj The entry object
10770 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10772 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10774 * This moves the cursor one line up within the entry.
10776 * @param obj The entry object
10777 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10779 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10781 * This moves the cursor one line down within the entry.
10783 * @param obj The entry object
10784 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10786 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10788 * This moves the cursor to the beginning of the entry.
10790 * @param obj The entry object
10792 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10794 * This moves the cursor to the end of the entry.
10796 * @param obj The entry object
10798 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10800 * This moves the cursor to the beginning of the current line.
10802 * @param obj The entry object
10804 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10806 * This moves the cursor to the end of the current line.
10808 * @param obj The entry object
10810 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10812 * This begins a selection within the entry as though
10813 * the user were holding down the mouse button to make a selection.
10815 * @param obj The entry object
10817 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10819 * This ends a selection within the entry as though
10820 * the user had just released the mouse button while making a selection.
10822 * @param obj The entry object
10824 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10826 * Gets whether a format node exists at the current cursor position.
10828 * A format node is anything that defines how the text is rendered. It can
10829 * be a visible format node, such as a line break or a paragraph separator,
10830 * or an invisible one, such as bold begin or end tag.
10831 * This function returns whether any format node exists at the current
10834 * @param obj The entry object
10835 * @return EINA_TRUE if the current cursor position contains a format node,
10836 * EINA_FALSE otherwise.
10838 * @see elm_entry_cursor_is_visible_format_get()
10840 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10842 * Gets if the current cursor position holds a visible format node.
10844 * @param obj The entry object
10845 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10846 * if it's an invisible one or no format exists.
10848 * @see elm_entry_cursor_is_format_get()
10850 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10852 * Gets the character pointed by the cursor at its current position.
10854 * This function returns a string with the utf8 character stored at the
10855 * current cursor position.
10856 * Only the text is returned, any format that may exist will not be part
10857 * of the return value.
10859 * @param obj The entry object
10860 * @return The text pointed by the cursors.
10862 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10864 * This function returns the geometry of the cursor.
10866 * It's useful if you want to draw something on the cursor (or where it is),
10867 * or for example in the case of scrolled entry where you want to show the
10870 * @param obj The entry object
10871 * @param x returned geometry
10872 * @param y returned geometry
10873 * @param w returned geometry
10874 * @param h returned geometry
10875 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10877 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);
10879 * Sets the cursor position in the entry to the given value
10881 * The value in @p pos is the index of the character position within the
10882 * contents of the string as returned by elm_entry_cursor_pos_get().
10884 * @param obj The entry object
10885 * @param pos The position of the cursor
10887 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10889 * Retrieves the current position of the cursor in the entry
10891 * @param obj The entry object
10892 * @return The cursor position
10894 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10896 * This executes a "cut" action on the selected text in the entry.
10898 * @param obj The entry object
10900 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10902 * This executes a "copy" action on the selected text in the entry.
10904 * @param obj The entry object
10906 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10908 * This executes a "paste" action in the entry.
10910 * @param obj The entry object
10912 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10914 * This clears and frees the items in a entry's contextual (longpress)
10917 * @param obj The entry object
10919 * @see elm_entry_context_menu_item_add()
10921 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10923 * This adds an item to the entry's contextual menu.
10925 * A longpress on an entry will make the contextual menu show up, if this
10926 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10927 * By default, this menu provides a few options like enabling selection mode,
10928 * which is useful on embedded devices that need to be explicit about it,
10929 * and when a selection exists it also shows the copy and cut actions.
10931 * With this function, developers can add other options to this menu to
10932 * perform any action they deem necessary.
10934 * @param obj The entry object
10935 * @param label The item's text label
10936 * @param icon_file The item's icon file
10937 * @param icon_type The item's icon type
10938 * @param func The callback to execute when the item is clicked
10939 * @param data The data to associate with the item for related functions
10941 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);
10943 * This disables the entry's contextual (longpress) menu.
10945 * @param obj The entry object
10946 * @param disabled If true, the menu is disabled
10948 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10950 * This returns whether the entry's contextual (longpress) menu is
10953 * @param obj The entry object
10954 * @return If true, the menu is disabled
10956 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10958 * This appends a custom item provider to the list for that entry
10960 * This appends the given callback. The list is walked from beginning to end
10961 * with each function called given the item href string in the text. If the
10962 * function returns an object handle other than NULL (it should create an
10963 * object to do this), then this object is used to replace that item. If
10964 * not the next provider is called until one provides an item object, or the
10965 * default provider in entry does.
10967 * @param obj The entry object
10968 * @param func The function called to provide the item object
10969 * @param data The data passed to @p func
10971 * @see @ref entry-items
10973 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);
10975 * This prepends a custom item provider to the list for that entry
10977 * This prepends the given callback. See elm_entry_item_provider_append() for
10980 * @param obj The entry object
10981 * @param func The function called to provide the item object
10982 * @param data The data passed to @p func
10984 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);
10986 * This removes a custom item provider to the list for that entry
10988 * This removes the given callback. See elm_entry_item_provider_append() for
10991 * @param obj The entry object
10992 * @param func The function called to provide the item object
10993 * @param data The data passed to @p func
10995 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);
10997 * Append a filter function for text inserted in the entry
10999 * Append the given callback to the list. This functions will be called
11000 * whenever any text is inserted into the entry, with the text to be inserted
11001 * as a parameter. The callback function is free to alter the text in any way
11002 * it wants, but it must remember to free the given pointer and update it.
11003 * If the new text is to be discarded, the function can free it and set its
11004 * text parameter to NULL. This will also prevent any following filters from
11007 * @param obj The entry object
11008 * @param func The function to use as text filter
11009 * @param data User data to pass to @p func
11011 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11013 * Prepend a filter function for text insdrted in the entry
11015 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11016 * for more information
11018 * @param obj The entry object
11019 * @param func The function to use as text filter
11020 * @param data User data to pass to @p func
11022 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11024 * Remove a filter from the list
11026 * Removes the given callback from the filter list. See
11027 * elm_entry_text_filter_append() for more information.
11029 * @param obj The entry object
11030 * @param func The filter function to remove
11031 * @param data The user data passed when adding the function
11033 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11035 * This converts a markup (HTML-like) string into UTF-8.
11037 * The returned string is a malloc'ed buffer and it should be freed when
11038 * not needed anymore.
11040 * @param s The string (in markup) to be converted
11041 * @return The converted string (in UTF-8). It should be freed.
11043 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11045 * This converts a UTF-8 string into markup (HTML-like).
11047 * The returned string is a malloc'ed buffer and it should be freed when
11048 * not needed anymore.
11050 * @param s The string (in UTF-8) to be converted
11051 * @return The converted string (in markup). It should be freed.
11053 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11055 * This sets the file (and implicitly loads it) for the text to display and
11056 * then edit. All changes are written back to the file after a short delay if
11057 * the entry object is set to autosave (which is the default).
11059 * If the entry had any other file set previously, any changes made to it
11060 * will be saved if the autosave feature is enabled, otherwise, the file
11061 * will be silently discarded and any non-saved changes will be lost.
11063 * @param obj The entry object
11064 * @param file The path to the file to load and save
11065 * @param format The file format
11067 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11069 * Gets the file being edited by the entry.
11071 * This function can be used to retrieve any file set on the entry for
11072 * edition, along with the format used to load and save it.
11074 * @param obj The entry object
11075 * @param file The path to the file to load and save
11076 * @param format The file format
11078 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11080 * This function writes any changes made to the file set with
11081 * elm_entry_file_set()
11083 * @param obj The entry object
11085 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11087 * This sets the entry object to 'autosave' the loaded text file or not.
11089 * @param obj The entry object
11090 * @param autosave Autosave the loaded file or not
11092 * @see elm_entry_file_set()
11094 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11096 * This gets the entry object's 'autosave' status.
11098 * @param obj The entry object
11099 * @return Autosave the loaded file or not
11101 * @see elm_entry_file_set()
11103 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11105 * Control pasting of text and images for the widget.
11107 * Normally the entry allows both text and images to be pasted. By setting
11108 * textonly to be true, this prevents images from being pasted.
11110 * Note this only changes the behaviour of text.
11112 * @param obj The entry object
11113 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11114 * text+image+other.
11116 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11118 * Getting elm_entry text paste/drop mode.
11120 * In textonly mode, only text may be pasted or dropped into the widget.
11122 * @param obj The entry object
11123 * @return If the widget only accepts text from pastes.
11125 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11127 * Enable or disable scrolling in entry
11129 * Normally the entry is not scrollable unless you enable it with this call.
11131 * @param obj The entry object
11132 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11134 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11136 * Get the scrollable state of the entry
11138 * Normally the entry is not scrollable. This gets the scrollable state
11139 * of the entry. See elm_entry_scrollable_set() for more information.
11141 * @param obj The entry object
11142 * @return The scrollable state
11144 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11146 * This sets a widget to be displayed to the left of a scrolled entry.
11148 * @param obj The scrolled entry object
11149 * @param icon The widget to display on the left side of the scrolled
11152 * @note A previously set widget will be destroyed.
11153 * @note If the object being set does not have minimum size hints set,
11154 * it won't get properly displayed.
11156 * @see elm_entry_end_set()
11158 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11160 * Gets the leftmost widget of the scrolled entry. This object is
11161 * owned by the scrolled entry and should not be modified.
11163 * @param obj The scrolled entry object
11164 * @return the left widget inside the scroller
11166 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11168 * Unset the leftmost widget of the scrolled entry, unparenting and
11171 * @param obj The scrolled entry object
11172 * @return the previously set icon sub-object of this entry, on
11175 * @see elm_entry_icon_set()
11177 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11179 * Sets the visibility of the left-side widget of the scrolled entry,
11180 * set by elm_entry_icon_set().
11182 * @param obj The scrolled entry object
11183 * @param setting EINA_TRUE if the object should be displayed,
11184 * EINA_FALSE if not.
11186 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11188 * This sets a widget to be displayed to the end of a scrolled entry.
11190 * @param obj The scrolled entry object
11191 * @param end The widget to display on the right side of the scrolled
11194 * @note A previously set widget will be destroyed.
11195 * @note If the object being set does not have minimum size hints set,
11196 * it won't get properly displayed.
11198 * @see elm_entry_icon_set
11200 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11202 * Gets the endmost widget of the scrolled entry. This object is owned
11203 * by the scrolled entry and should not be modified.
11205 * @param obj The scrolled entry object
11206 * @return the right widget inside the scroller
11208 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11210 * Unset the endmost widget of the scrolled entry, unparenting and
11213 * @param obj The scrolled entry object
11214 * @return the previously set icon sub-object of this entry, on
11217 * @see elm_entry_icon_set()
11219 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11221 * Sets the visibility of the end widget of the scrolled entry, set by
11222 * elm_entry_end_set().
11224 * @param obj The scrolled entry object
11225 * @param setting EINA_TRUE if the object should be displayed,
11226 * EINA_FALSE if not.
11228 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11230 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11233 * Setting an entry to single-line mode with elm_entry_single_line_set()
11234 * will automatically disable the display of scrollbars when the entry
11235 * moves inside its scroller.
11237 * @param obj The scrolled entry object
11238 * @param h The horizontal scrollbar policy to apply
11239 * @param v The vertical scrollbar policy to apply
11241 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11243 * This enables/disables bouncing within the entry.
11245 * This function sets whether the entry will bounce when scrolling reaches
11246 * the end of the contained entry.
11248 * @param obj The scrolled entry object
11249 * @param h The horizontal bounce state
11250 * @param v The vertical bounce state
11252 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11254 * Get the bounce mode
11256 * @param obj The Entry object
11257 * @param h_bounce Allow bounce horizontally
11258 * @param v_bounce Allow bounce vertically
11260 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11262 /* pre-made filters for entries */
11264 * @typedef Elm_Entry_Filter_Limit_Size
11266 * Data for the elm_entry_filter_limit_size() entry filter.
11268 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11270 * @struct _Elm_Entry_Filter_Limit_Size
11272 * Data for the elm_entry_filter_limit_size() entry filter.
11274 struct _Elm_Entry_Filter_Limit_Size
11276 int max_char_count; /**< The maximum number of characters allowed. */
11277 int max_byte_count; /**< The maximum number of bytes allowed*/
11280 * Filter inserted text based on user defined character and byte limits
11282 * Add this filter to an entry to limit the characters that it will accept
11283 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11284 * The funtion works on the UTF-8 representation of the string, converting
11285 * it from the set markup, thus not accounting for any format in it.
11287 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11288 * it as data when setting the filter. In it, it's possible to set limits
11289 * by character count or bytes (any of them is disabled if 0), and both can
11290 * be set at the same time. In that case, it first checks for characters,
11293 * The function will cut the inserted text in order to allow only the first
11294 * number of characters that are still allowed. The cut is made in
11295 * characters, even when limiting by bytes, in order to always contain
11296 * valid ones and avoid half unicode characters making it in.
11298 * This filter, like any others, does not apply when setting the entry text
11299 * directly with elm_object_text_set() (or the deprecated
11300 * elm_entry_entry_set()).
11302 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11304 * @typedef Elm_Entry_Filter_Accept_Set
11306 * Data for the elm_entry_filter_accept_set() entry filter.
11308 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11310 * @struct _Elm_Entry_Filter_Accept_Set
11312 * Data for the elm_entry_filter_accept_set() entry filter.
11314 struct _Elm_Entry_Filter_Accept_Set
11316 const char *accepted; /**< Set of characters accepted in the entry. */
11317 const char *rejected; /**< Set of characters rejected from the entry. */
11320 * Filter inserted text based on accepted or rejected sets of characters
11322 * Add this filter to an entry to restrict the set of accepted characters
11323 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11324 * This structure contains both accepted and rejected sets, but they are
11325 * mutually exclusive.
11327 * The @c accepted set takes preference, so if it is set, the filter will
11328 * only work based on the accepted characters, ignoring anything in the
11329 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11331 * In both cases, the function filters by matching utf8 characters to the
11332 * raw markup text, so it can be used to remove formatting tags.
11334 * This filter, like any others, does not apply when setting the entry text
11335 * directly with elm_object_text_set() (or the deprecated
11336 * elm_entry_entry_set()).
11338 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11340 * Set the input panel layout of the entry
11342 * @param obj The entry object
11343 * @param layout layout type
11345 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11347 * Get the input panel layout of the entry
11349 * @param obj The entry object
11350 * @return layout type
11352 * @see elm_entry_input_panel_layout_set
11354 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11359 /* composite widgets - these basically put together basic widgets above
11360 * in convenient packages that do more than basic stuff */
11364 * @defgroup Anchorview Anchorview
11366 * @image html img/widget/anchorview/preview-00.png
11367 * @image latex img/widget/anchorview/preview-00.eps
11369 * Anchorview is for displaying text that contains markup with anchors
11370 * like <c>\<a href=1234\>something\</\></c> in it.
11372 * Besides being styled differently, the anchorview widget provides the
11373 * necessary functionality so that clicking on these anchors brings up a
11374 * popup with user defined content such as "call", "add to contacts" or
11375 * "open web page". This popup is provided using the @ref Hover widget.
11377 * This widget is very similar to @ref Anchorblock, so refer to that
11378 * widget for an example. The only difference Anchorview has is that the
11379 * widget is already provided with scrolling functionality, so if the
11380 * text set to it is too large to fit in the given space, it will scroll,
11381 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11382 * text can be displayed.
11384 * This widget emits the following signals:
11385 * @li "anchor,clicked": will be called when an anchor is clicked. The
11386 * @p event_info parameter on the callback will be a pointer of type
11387 * ::Elm_Entry_Anchorview_Info.
11389 * See @ref Anchorblock for an example on how to use both of them.
11398 * @typedef Elm_Entry_Anchorview_Info
11400 * The info sent in the callback for "anchor,clicked" signals emitted by
11401 * the Anchorview widget.
11403 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11405 * @struct _Elm_Entry_Anchorview_Info
11407 * The info sent in the callback for "anchor,clicked" signals emitted by
11408 * the Anchorview widget.
11410 struct _Elm_Entry_Anchorview_Info
11412 const char *name; /**< Name of the anchor, as indicated in its href
11414 int button; /**< The mouse button used to click on it */
11415 Evas_Object *hover; /**< The hover object to use for the popup */
11417 Evas_Coord x, y, w, h;
11418 } anchor, /**< Geometry selection of text used as anchor */
11419 hover_parent; /**< Geometry of the object used as parent by the
11421 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11422 for content on the left side of
11423 the hover. Before calling the
11424 callback, the widget will make the
11425 necessary calculations to check
11426 which sides are fit to be set with
11427 content, based on the position the
11428 hover is activated and its distance
11429 to the edges of its parent object
11431 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11432 the right side of the hover.
11433 See @ref hover_left */
11434 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11435 of the hover. See @ref hover_left */
11436 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11437 below the hover. See @ref
11441 * Add a new Anchorview object
11443 * @param parent The parent object
11444 * @return The new object or NULL if it cannot be created
11446 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11448 * Set the text to show in the anchorview
11450 * Sets the text of the anchorview to @p text. This text can include markup
11451 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11452 * text that will be specially styled and react to click events, ended with
11453 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11454 * "anchor,clicked" signal that you can attach a callback to with
11455 * evas_object_smart_callback_add(). The name of the anchor given in the
11456 * event info struct will be the one set in the href attribute, in this
11457 * case, anchorname.
11459 * Other markup can be used to style the text in different ways, but it's
11460 * up to the style defined in the theme which tags do what.
11461 * @deprecated use elm_object_text_set() instead.
11463 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11465 * Get the markup text set for the anchorview
11467 * Retrieves the text set on the anchorview, with markup tags included.
11469 * @param obj The anchorview object
11470 * @return The markup text set or @c NULL if nothing was set or an error
11472 * @deprecated use elm_object_text_set() instead.
11474 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11476 * Set the parent of the hover popup
11478 * Sets the parent object to use by the hover created by the anchorview
11479 * when an anchor is clicked. See @ref Hover for more details on this.
11480 * If no parent is set, the same anchorview object will be used.
11482 * @param obj The anchorview object
11483 * @param parent The object to use as parent for the hover
11485 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11487 * Get the parent of the hover popup
11489 * Get the object used as parent for the hover created by the anchorview
11490 * widget. See @ref Hover for more details on this.
11492 * @param obj The anchorview object
11493 * @return The object used as parent for the hover, NULL if none is set.
11495 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11497 * Set the style that the hover should use
11499 * When creating the popup hover, anchorview will request that it's
11500 * themed according to @p style.
11502 * @param obj The anchorview object
11503 * @param style The style to use for the underlying hover
11505 * @see elm_object_style_set()
11507 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11509 * Get the style that the hover should use
11511 * Get the style the hover created by anchorview will use.
11513 * @param obj The anchorview object
11514 * @return The style to use by the hover. NULL means the default is used.
11516 * @see elm_object_style_set()
11518 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11520 * Ends the hover popup in the anchorview
11522 * When an anchor is clicked, the anchorview widget will create a hover
11523 * object to use as a popup with user provided content. This function
11524 * terminates this popup, returning the anchorview to its normal state.
11526 * @param obj The anchorview object
11528 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11530 * Set bouncing behaviour when the scrolled content reaches an edge
11532 * Tell the internal scroller object whether it should bounce or not
11533 * when it reaches the respective edges for each axis.
11535 * @param obj The anchorview object
11536 * @param h_bounce Whether to bounce or not in the horizontal axis
11537 * @param v_bounce Whether to bounce or not in the vertical axis
11539 * @see elm_scroller_bounce_set()
11541 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11543 * Get the set bouncing behaviour of the internal scroller
11545 * Get whether the internal scroller should bounce when the edge of each
11546 * axis is reached scrolling.
11548 * @param obj The anchorview object
11549 * @param h_bounce Pointer where to store the bounce state of the horizontal
11551 * @param v_bounce Pointer where to store the bounce state of the vertical
11554 * @see elm_scroller_bounce_get()
11556 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11558 * Appends a custom item provider to the given anchorview
11560 * Appends the given function to the list of items providers. This list is
11561 * called, one function at a time, with the given @p data pointer, the
11562 * anchorview object and, in the @p item parameter, the item name as
11563 * referenced in its href string. Following functions in the list will be
11564 * called in order until one of them returns something different to NULL,
11565 * which should be an Evas_Object which will be used in place of the item
11568 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11569 * href=item/name\>\</item\>
11571 * @param obj The anchorview object
11572 * @param func The function to add to the list of providers
11573 * @param data User data that will be passed to the callback function
11575 * @see elm_entry_item_provider_append()
11577 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);
11579 * Prepend a custom item provider to the given anchorview
11581 * Like elm_anchorview_item_provider_append(), but it adds the function
11582 * @p func to the beginning of the list, instead of the end.
11584 * @param obj The anchorview object
11585 * @param func The function to add to the list of providers
11586 * @param data User data that will be passed to the callback function
11588 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);
11590 * Remove a custom item provider from the list of the given anchorview
11592 * Removes the function and data pairing that matches @p func and @p data.
11593 * That is, unless the same function and same user data are given, the
11594 * function will not be removed from the list. This allows us to add the
11595 * same callback several times, with different @p data pointers and be
11596 * able to remove them later without conflicts.
11598 * @param obj The anchorview object
11599 * @param func The function to remove from the list
11600 * @param data The data matching the function to remove from the list
11602 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);
11609 * @defgroup Anchorblock Anchorblock
11611 * @image html img/widget/anchorblock/preview-00.png
11612 * @image latex img/widget/anchorblock/preview-00.eps
11614 * Anchorblock is for displaying text that contains markup with anchors
11615 * like <c>\<a href=1234\>something\</\></c> in it.
11617 * Besides being styled differently, the anchorblock widget provides the
11618 * necessary functionality so that clicking on these anchors brings up a
11619 * popup with user defined content such as "call", "add to contacts" or
11620 * "open web page". This popup is provided using the @ref Hover widget.
11622 * This widget emits the following signals:
11623 * @li "anchor,clicked": will be called when an anchor is clicked. The
11624 * @p event_info parameter on the callback will be a pointer of type
11625 * ::Elm_Entry_Anchorblock_Info.
11631 * Since examples are usually better than plain words, we might as well
11632 * try @ref tutorial_anchorblock_example "one".
11635 * @addtogroup Anchorblock
11639 * @typedef Elm_Entry_Anchorblock_Info
11641 * The info sent in the callback for "anchor,clicked" signals emitted by
11642 * the Anchorblock widget.
11644 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11646 * @struct _Elm_Entry_Anchorblock_Info
11648 * The info sent in the callback for "anchor,clicked" signals emitted by
11649 * the Anchorblock widget.
11651 struct _Elm_Entry_Anchorblock_Info
11653 const char *name; /**< Name of the anchor, as indicated in its href
11655 int button; /**< The mouse button used to click on it */
11656 Evas_Object *hover; /**< The hover object to use for the popup */
11658 Evas_Coord x, y, w, h;
11659 } anchor, /**< Geometry selection of text used as anchor */
11660 hover_parent; /**< Geometry of the object used as parent by the
11662 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11663 for content on the left side of
11664 the hover. Before calling the
11665 callback, the widget will make the
11666 necessary calculations to check
11667 which sides are fit to be set with
11668 content, based on the position the
11669 hover is activated and its distance
11670 to the edges of its parent object
11672 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11673 the right side of the hover.
11674 See @ref hover_left */
11675 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11676 of the hover. See @ref hover_left */
11677 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11678 below the hover. See @ref
11682 * Add a new Anchorblock object
11684 * @param parent The parent object
11685 * @return The new object or NULL if it cannot be created
11687 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11689 * Set the text to show in the anchorblock
11691 * Sets the text of the anchorblock to @p text. This text can include markup
11692 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11693 * of text that will be specially styled and react to click events, ended
11694 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11695 * "anchor,clicked" signal that you can attach a callback to with
11696 * evas_object_smart_callback_add(). The name of the anchor given in the
11697 * event info struct will be the one set in the href attribute, in this
11698 * case, anchorname.
11700 * Other markup can be used to style the text in different ways, but it's
11701 * up to the style defined in the theme which tags do what.
11702 * @deprecated use elm_object_text_set() instead.
11704 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11706 * Get the markup text set for the anchorblock
11708 * Retrieves the text set on the anchorblock, with markup tags included.
11710 * @param obj The anchorblock object
11711 * @return The markup text set or @c NULL if nothing was set or an error
11713 * @deprecated use elm_object_text_set() instead.
11715 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11717 * Set the parent of the hover popup
11719 * Sets the parent object to use by the hover created by the anchorblock
11720 * when an anchor is clicked. See @ref Hover for more details on this.
11722 * @param obj The anchorblock object
11723 * @param parent The object to use as parent for the hover
11725 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11727 * Get the parent of the hover popup
11729 * Get the object used as parent for the hover created by the anchorblock
11730 * widget. See @ref Hover for more details on this.
11731 * If no parent is set, the same anchorblock object will be used.
11733 * @param obj The anchorblock object
11734 * @return The object used as parent for the hover, NULL if none is set.
11736 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11738 * Set the style that the hover should use
11740 * When creating the popup hover, anchorblock will request that it's
11741 * themed according to @p style.
11743 * @param obj The anchorblock object
11744 * @param style The style to use for the underlying hover
11746 * @see elm_object_style_set()
11748 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11750 * Get the style that the hover should use
11752 * Get the style the hover created by anchorblock will use.
11754 * @param obj The anchorblock object
11755 * @return The style to use by the hover. NULL means the default is used.
11757 * @see elm_object_style_set()
11759 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11761 * Ends the hover popup in the anchorblock
11763 * When an anchor is clicked, the anchorblock widget will create a hover
11764 * object to use as a popup with user provided content. This function
11765 * terminates this popup, returning the anchorblock to its normal state.
11767 * @param obj The anchorblock object
11769 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11771 * Appends a custom item provider to the given anchorblock
11773 * Appends the given function to the list of items providers. This list is
11774 * called, one function at a time, with the given @p data pointer, the
11775 * anchorblock object and, in the @p item parameter, the item name as
11776 * referenced in its href string. Following functions in the list will be
11777 * called in order until one of them returns something different to NULL,
11778 * which should be an Evas_Object which will be used in place of the item
11781 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11782 * href=item/name\>\</item\>
11784 * @param obj The anchorblock object
11785 * @param func The function to add to the list of providers
11786 * @param data User data that will be passed to the callback function
11788 * @see elm_entry_item_provider_append()
11790 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);
11792 * Prepend a custom item provider to the given anchorblock
11794 * Like elm_anchorblock_item_provider_append(), but it adds the function
11795 * @p func to the beginning of the list, instead of the end.
11797 * @param obj The anchorblock object
11798 * @param func The function to add to the list of providers
11799 * @param data User data that will be passed to the callback function
11801 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);
11803 * Remove a custom item provider from the list of the given anchorblock
11805 * Removes the function and data pairing that matches @p func and @p data.
11806 * That is, unless the same function and same user data are given, the
11807 * function will not be removed from the list. This allows us to add the
11808 * same callback several times, with different @p data pointers and be
11809 * able to remove them later without conflicts.
11811 * @param obj The anchorblock object
11812 * @param func The function to remove from the list
11813 * @param data The data matching the function to remove from the list
11815 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);
11821 * @defgroup Bubble Bubble
11823 * @image html img/widget/bubble/preview-00.png
11824 * @image latex img/widget/bubble/preview-00.eps
11825 * @image html img/widget/bubble/preview-01.png
11826 * @image latex img/widget/bubble/preview-01.eps
11827 * @image html img/widget/bubble/preview-02.png
11828 * @image latex img/widget/bubble/preview-02.eps
11830 * @brief The Bubble is a widget to show text similarly to how speech is
11831 * represented in comics.
11833 * The bubble widget contains 5 important visual elements:
11834 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11835 * @li The @p icon is an image to which the frame's arrow points to.
11836 * @li The @p label is a text which appears to the right of the icon if the
11837 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11839 * @li The @p info is a text which appears to the right of the label. Info's
11840 * font is of a ligther color than label.
11841 * @li The @p content is an evas object that is shown inside the frame.
11843 * The position of the arrow, icon, label and info depends on which corner is
11844 * selected. The four available corners are:
11845 * @li "top_left" - Default
11847 * @li "bottom_left"
11848 * @li "bottom_right"
11850 * Signals that you can add callbacks for are:
11851 * @li "clicked" - This is called when a user has clicked the bubble.
11853 * For an example of using a buble see @ref bubble_01_example_page "this".
11858 * Add a new bubble to the parent
11860 * @param parent The parent object
11861 * @return The new object or NULL if it cannot be created
11863 * This function adds a text bubble to the given parent evas object.
11865 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11867 * Set the label of the bubble
11869 * @param obj The bubble object
11870 * @param label The string to set in the label
11872 * This function sets the title of the bubble. Where this appears depends on
11873 * the selected corner.
11874 * @deprecated use elm_object_text_set() instead.
11876 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11878 * Get the label of the bubble
11880 * @param obj The bubble object
11881 * @return The string of set in the label
11883 * This function gets the title of the bubble.
11884 * @deprecated use elm_object_text_get() instead.
11886 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11888 * Set the info of the bubble
11890 * @param obj The bubble object
11891 * @param info The given info about the bubble
11893 * This function sets the info of the bubble. Where this appears depends on
11894 * the selected corner.
11895 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11897 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11899 * Get the info of the bubble
11901 * @param obj The bubble object
11903 * @return The "info" string of the bubble
11905 * This function gets the info text.
11906 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11908 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11910 * Set the content to be shown in the bubble
11912 * Once the content object is set, a previously set one will be deleted.
11913 * If you want to keep the old content object, use the
11914 * elm_bubble_content_unset() function.
11916 * @param obj The bubble object
11917 * @param content The given content of the bubble
11919 * This function sets the content shown on the middle of the bubble.
11921 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11923 * Get the content shown in the bubble
11925 * Return the content object which is set for this widget.
11927 * @param obj The bubble object
11928 * @return The content that is being used
11930 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11932 * Unset the content shown in the bubble
11934 * Unparent and return the content object which was set for this widget.
11936 * @param obj The bubble object
11937 * @return The content that was being used
11939 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11941 * Set the icon of the bubble
11943 * Once the icon object is set, a previously set one will be deleted.
11944 * If you want to keep the old content object, use the
11945 * elm_icon_content_unset() function.
11947 * @param obj The bubble object
11948 * @param icon The given icon for the bubble
11950 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11952 * Get the icon of the bubble
11954 * @param obj The bubble object
11955 * @return The icon for the bubble
11957 * This function gets the icon shown on the top left of bubble.
11959 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11961 * Unset the icon of the bubble
11963 * Unparent and return the icon object which was set for this widget.
11965 * @param obj The bubble object
11966 * @return The icon that was being used
11968 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11970 * Set the corner of the bubble
11972 * @param obj The bubble object.
11973 * @param corner The given corner for the bubble.
11975 * This function sets the corner of the bubble. The corner will be used to
11976 * determine where the arrow in the frame points to and where label, icon and
11979 * Possible values for corner are:
11980 * @li "top_left" - Default
11982 * @li "bottom_left"
11983 * @li "bottom_right"
11985 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11987 * Get the corner of the bubble
11989 * @param obj The bubble object.
11990 * @return The given corner for the bubble.
11992 * This function gets the selected corner of the bubble.
11994 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12000 * @defgroup Photo Photo
12002 * For displaying the photo of a person (contact). Simple yet
12003 * with a very specific purpose.
12005 * Signals that you can add callbacks for are:
12007 * "clicked" - This is called when a user has clicked the photo
12008 * "drag,start" - Someone started dragging the image out of the object
12009 * "drag,end" - Dragged item was dropped (somewhere)
12015 * Add a new photo to the parent
12017 * @param parent The parent object
12018 * @return The new object or NULL if it cannot be created
12022 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12025 * Set the file that will be used as photo
12027 * @param obj The photo object
12028 * @param file The path to file that will be used as photo
12030 * @return (1 = success, 0 = error)
12034 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12037 * Set the file that will be used as thumbnail in the photo.
12039 * @param obj The photo object.
12040 * @param file The path to file that will be used as thumb.
12041 * @param group The key used in case of an EET file.
12045 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12048 * Set the size that will be used on the photo
12050 * @param obj The photo object
12051 * @param size The size that the photo will be
12055 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12058 * Set if the photo should be completely visible or not.
12060 * @param obj The photo object
12061 * @param fill if true the photo will be completely visible
12065 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12068 * Set editability of the photo.
12070 * An editable photo can be dragged to or from, and can be cut or
12071 * pasted too. Note that pasting an image or dropping an item on
12072 * the image will delete the existing content.
12074 * @param obj The photo object.
12075 * @param set To set of clear editablity.
12077 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12083 /* gesture layer */
12085 * @defgroup Elm_Gesture_Layer Gesture Layer
12086 * Gesture Layer Usage:
12088 * Use Gesture Layer to detect gestures.
12089 * The advantage is that you don't have to implement
12090 * gesture detection, just set callbacks of gesture state.
12091 * By using gesture layer we make standard interface.
12093 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12094 * with a parent object parameter.
12095 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12096 * call. Usually with same object as target (2nd parameter).
12098 * Now you need to tell gesture layer what gestures you follow.
12099 * This is done with @ref elm_gesture_layer_cb_set call.
12100 * By setting the callback you actually saying to gesture layer:
12101 * I would like to know when the gesture @ref Elm_Gesture_Types
12102 * switches to state @ref Elm_Gesture_State.
12104 * Next, you need to implement the actual action that follows the input
12105 * in your callback.
12107 * Note that if you like to stop being reported about a gesture, just set
12108 * all callbacks referring this gesture to NULL.
12109 * (again with @ref elm_gesture_layer_cb_set)
12111 * The information reported by gesture layer to your callback is depending
12112 * on @ref Elm_Gesture_Types:
12113 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12114 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12115 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12117 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12118 * @ref ELM_GESTURE_MOMENTUM.
12120 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12121 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12122 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12123 * Note that we consider a flick as a line-gesture that should be completed
12124 * in flick-time-limit as defined in @ref Config.
12126 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12128 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12132 * @enum _Elm_Gesture_Types
12133 * Enum of supported gesture types.
12134 * @ingroup Elm_Gesture_Layer
12136 enum _Elm_Gesture_Types
12138 ELM_GESTURE_FIRST = 0,
12140 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12141 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12142 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12143 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12145 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12147 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12148 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12150 ELM_GESTURE_ZOOM, /**< Zoom */
12151 ELM_GESTURE_ROTATE, /**< Rotate */
12157 * @typedef Elm_Gesture_Types
12158 * gesture types enum
12159 * @ingroup Elm_Gesture_Layer
12161 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12164 * @enum _Elm_Gesture_State
12165 * Enum of gesture states.
12166 * @ingroup Elm_Gesture_Layer
12168 enum _Elm_Gesture_State
12170 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12171 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12172 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12173 ELM_GESTURE_STATE_END, /**< Gesture completed */
12174 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12178 * @typedef Elm_Gesture_State
12179 * gesture states enum
12180 * @ingroup Elm_Gesture_Layer
12182 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12185 * @struct _Elm_Gesture_Taps_Info
12186 * Struct holds taps info for user
12187 * @ingroup Elm_Gesture_Layer
12189 struct _Elm_Gesture_Taps_Info
12191 Evas_Coord x, y; /**< Holds center point between fingers */
12192 unsigned int n; /**< Number of fingers tapped */
12193 unsigned int timestamp; /**< event timestamp */
12197 * @typedef Elm_Gesture_Taps_Info
12198 * holds taps info for user
12199 * @ingroup Elm_Gesture_Layer
12201 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12204 * @struct _Elm_Gesture_Momentum_Info
12205 * Struct holds momentum info for user
12206 * x1 and y1 are not necessarily in sync
12207 * x1 holds x value of x direction starting point
12208 * and same holds for y1.
12209 * This is noticeable when doing V-shape movement
12210 * @ingroup Elm_Gesture_Layer
12212 struct _Elm_Gesture_Momentum_Info
12213 { /* Report line ends, timestamps, and momentum computed */
12214 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12215 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12216 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12217 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12219 unsigned int tx; /**< Timestamp of start of final x-swipe */
12220 unsigned int ty; /**< Timestamp of start of final y-swipe */
12222 Evas_Coord mx; /**< Momentum on X */
12223 Evas_Coord my; /**< Momentum on Y */
12227 * @typedef Elm_Gesture_Momentum_Info
12228 * holds momentum info for user
12229 * @ingroup Elm_Gesture_Layer
12231 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12234 * @struct _Elm_Gesture_Line_Info
12235 * Struct holds line info for user
12236 * @ingroup Elm_Gesture_Layer
12238 struct _Elm_Gesture_Line_Info
12239 { /* Report line ends, timestamps, and momentum computed */
12240 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12241 unsigned int n; /**< Number of fingers (lines) */
12242 /* FIXME should be radians, bot degrees */
12243 double angle; /**< Angle (direction) of lines */
12247 * @typedef Elm_Gesture_Line_Info
12248 * Holds line info for user
12249 * @ingroup Elm_Gesture_Layer
12251 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12254 * @struct _Elm_Gesture_Zoom_Info
12255 * Struct holds zoom info for user
12256 * @ingroup Elm_Gesture_Layer
12258 struct _Elm_Gesture_Zoom_Info
12260 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12261 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12262 double zoom; /**< Zoom value: 1.0 means no zoom */
12263 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12267 * @typedef Elm_Gesture_Zoom_Info
12268 * Holds zoom info for user
12269 * @ingroup Elm_Gesture_Layer
12271 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12274 * @struct _Elm_Gesture_Rotate_Info
12275 * Struct holds rotation info for user
12276 * @ingroup Elm_Gesture_Layer
12278 struct _Elm_Gesture_Rotate_Info
12280 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12281 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12282 double base_angle; /**< Holds start-angle */
12283 double angle; /**< Rotation value: 0.0 means no rotation */
12284 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12288 * @typedef Elm_Gesture_Rotate_Info
12289 * Holds rotation info for user
12290 * @ingroup Elm_Gesture_Layer
12292 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12295 * @typedef Elm_Gesture_Event_Cb
12296 * User callback used to stream gesture info from gesture layer
12297 * @param data user data
12298 * @param event_info gesture report info
12299 * Returns a flag field to be applied on the causing event.
12300 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12301 * upon the event, in an irreversible way.
12303 * @ingroup Elm_Gesture_Layer
12305 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12308 * Use function to set callbacks to be notified about
12309 * change of state of gesture.
12310 * When a user registers a callback with this function
12311 * this means this gesture has to be tested.
12313 * When ALL callbacks for a gesture are set to NULL
12314 * it means user isn't interested in gesture-state
12315 * and it will not be tested.
12317 * @param obj Pointer to gesture-layer.
12318 * @param idx The gesture you would like to track its state.
12319 * @param cb callback function pointer.
12320 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12321 * @param data user info to be sent to callback (usually, Smart Data)
12323 * @ingroup Elm_Gesture_Layer
12325 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);
12328 * Call this function to get repeat-events settings.
12330 * @param obj Pointer to gesture-layer.
12332 * @return repeat events settings.
12333 * @see elm_gesture_layer_hold_events_set()
12334 * @ingroup Elm_Gesture_Layer
12336 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12339 * This function called in order to make gesture-layer repeat events.
12340 * Set this of you like to get the raw events only if gestures were not detected.
12341 * Clear this if you like gesture layer to fwd events as testing gestures.
12343 * @param obj Pointer to gesture-layer.
12344 * @param r Repeat: TRUE/FALSE
12346 * @ingroup Elm_Gesture_Layer
12348 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12351 * This function sets step-value for zoom action.
12352 * Set step to any positive value.
12353 * Cancel step setting by setting to 0.0
12355 * @param obj Pointer to gesture-layer.
12356 * @param s new zoom step value.
12358 * @ingroup Elm_Gesture_Layer
12360 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12363 * This function sets step-value for rotate action.
12364 * Set step to any positive value.
12365 * Cancel step setting by setting to 0.0
12367 * @param obj Pointer to gesture-layer.
12368 * @param s new roatate step value.
12370 * @ingroup Elm_Gesture_Layer
12372 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12375 * This function called to attach gesture-layer to an Evas_Object.
12376 * @param obj Pointer to gesture-layer.
12377 * @param t Pointer to underlying object (AKA Target)
12379 * @return TRUE, FALSE on success, failure.
12381 * @ingroup Elm_Gesture_Layer
12383 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12386 * Call this function to construct a new gesture-layer object.
12387 * This does not activate the gesture layer. You have to
12388 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12390 * @param parent the parent object.
12392 * @return Pointer to new gesture-layer object.
12394 * @ingroup Elm_Gesture_Layer
12396 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12399 * @defgroup Thumb Thumb
12401 * @image html img/widget/thumb/preview-00.png
12402 * @image latex img/widget/thumb/preview-00.eps
12404 * A thumb object is used for displaying the thumbnail of an image or video.
12405 * You must have compiled Elementary with Ethumb_Client support and the DBus
12406 * service must be present and auto-activated in order to have thumbnails to
12409 * Once the thumbnail object becomes visible, it will check if there is a
12410 * previously generated thumbnail image for the file set on it. If not, it
12411 * will start generating this thumbnail.
12413 * Different config settings will cause different thumbnails to be generated
12414 * even on the same file.
12416 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12417 * Ethumb documentation to change this path, and to see other configuration
12420 * Signals that you can add callbacks for are:
12422 * - "clicked" - This is called when a user has clicked the thumb without dragging
12424 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12425 * - "press" - This is called when a user has pressed down the thumb.
12426 * - "generate,start" - The thumbnail generation started.
12427 * - "generate,stop" - The generation process stopped.
12428 * - "generate,error" - The generation failed.
12429 * - "load,error" - The thumbnail image loading failed.
12431 * available styles:
12435 * An example of use of thumbnail:
12437 * - @ref thumb_example_01
12441 * @addtogroup Thumb
12446 * @enum _Elm_Thumb_Animation_Setting
12447 * @typedef Elm_Thumb_Animation_Setting
12449 * Used to set if a video thumbnail is animating or not.
12453 typedef enum _Elm_Thumb_Animation_Setting
12455 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12456 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12457 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12458 ELM_THUMB_ANIMATION_LAST
12459 } Elm_Thumb_Animation_Setting;
12462 * Add a new thumb object to the parent.
12464 * @param parent The parent object.
12465 * @return The new object or NULL if it cannot be created.
12467 * @see elm_thumb_file_set()
12468 * @see elm_thumb_ethumb_client_get()
12472 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12474 * Reload thumbnail if it was generated before.
12476 * @param obj The thumb object to reload
12478 * This is useful if the ethumb client configuration changed, like its
12479 * size, aspect or any other property one set in the handle returned
12480 * by elm_thumb_ethumb_client_get().
12482 * If the options didn't change, the thumbnail won't be generated again, but
12483 * the old one will still be used.
12485 * @see elm_thumb_file_set()
12489 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12491 * Set the file that will be used as thumbnail.
12493 * @param obj The thumb object.
12494 * @param file The path to file that will be used as thumb.
12495 * @param key The key used in case of an EET file.
12497 * The file can be an image or a video (in that case, acceptable extensions are:
12498 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12499 * function elm_thumb_animate().
12501 * @see elm_thumb_file_get()
12502 * @see elm_thumb_reload()
12503 * @see elm_thumb_animate()
12507 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12509 * Get the image or video path and key used to generate the thumbnail.
12511 * @param obj The thumb object.
12512 * @param file Pointer to filename.
12513 * @param key Pointer to key.
12515 * @see elm_thumb_file_set()
12516 * @see elm_thumb_path_get()
12520 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12522 * Get the path and key to the image or video generated by ethumb.
12524 * One just need to make sure that the thumbnail was generated before getting
12525 * its path; otherwise, the path will be NULL. One way to do that is by asking
12526 * for the path when/after the "generate,stop" smart callback is called.
12528 * @param obj The thumb object.
12529 * @param file Pointer to thumb path.
12530 * @param key Pointer to thumb key.
12532 * @see elm_thumb_file_get()
12536 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12538 * Set the animation state for the thumb object. If its content is an animated
12539 * video, you may start/stop the animation or tell it to play continuously and
12542 * @param obj The thumb object.
12543 * @param setting The animation setting.
12545 * @see elm_thumb_file_set()
12549 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12551 * Get the animation state for the thumb object.
12553 * @param obj The thumb object.
12554 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12557 * @see elm_thumb_animate_set()
12561 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12563 * Get the ethumb_client handle so custom configuration can be made.
12565 * @return Ethumb_Client instance or NULL.
12567 * This must be called before the objects are created to be sure no object is
12568 * visible and no generation started.
12570 * Example of usage:
12573 * #include <Elementary.h>
12574 * #ifndef ELM_LIB_QUICKLAUNCH
12576 * elm_main(int argc, char **argv)
12578 * Ethumb_Client *client;
12580 * elm_need_ethumb();
12584 * client = elm_thumb_ethumb_client_get();
12587 * ERR("could not get ethumb_client");
12590 * ethumb_client_size_set(client, 100, 100);
12591 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12594 * // Create elm_thumb objects here
12604 * @note There's only one client handle for Ethumb, so once a configuration
12605 * change is done to it, any other request for thumbnails (for any thumbnail
12606 * object) will use that configuration. Thus, this configuration is global.
12610 EAPI void *elm_thumb_ethumb_client_get(void);
12612 * Get the ethumb_client connection state.
12614 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12617 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12619 * Make the thumbnail 'editable'.
12621 * @param obj Thumb object.
12622 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12624 * This means the thumbnail is a valid drag target for drag and drop, and can be
12625 * cut or pasted too.
12627 * @see elm_thumb_editable_get()
12631 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12633 * Make the thumbnail 'editable'.
12635 * @param obj Thumb object.
12636 * @return Editability.
12638 * This means the thumbnail is a valid drag target for drag and drop, and can be
12639 * cut or pasted too.
12641 * @see elm_thumb_editable_set()
12645 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12652 * @defgroup Hoversel Hoversel
12654 * @image html img/widget/hoversel/preview-00.png
12655 * @image latex img/widget/hoversel/preview-00.eps
12657 * A hoversel is a button that pops up a list of items (automatically
12658 * choosing the direction to display) that have a label and, optionally, an
12659 * icon to select from. It is a convenience widget to avoid the need to do
12660 * all the piecing together yourself. It is intended for a small number of
12661 * items in the hoversel menu (no more than 8), though is capable of many
12664 * Signals that you can add callbacks for are:
12665 * "clicked" - the user clicked the hoversel button and popped up the sel
12666 * "selected" - an item in the hoversel list is selected. event_info is the item
12667 * "dismissed" - the hover is dismissed
12669 * See @ref tutorial_hoversel for an example.
12672 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12674 * @brief Add a new Hoversel object
12676 * @param parent The parent object
12677 * @return The new object or NULL if it cannot be created
12679 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12681 * @brief This sets the hoversel to expand horizontally.
12683 * @param obj The hoversel object
12684 * @param horizontal If true, the hover will expand horizontally to the
12687 * @note The initial button will display horizontally regardless of this
12690 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12692 * @brief This returns whether the hoversel is set to expand horizontally.
12694 * @param obj The hoversel object
12695 * @return If true, the hover will expand horizontally to the right.
12697 * @see elm_hoversel_horizontal_set()
12699 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12701 * @brief Set the Hover parent
12703 * @param obj The hoversel object
12704 * @param parent The parent to use
12706 * Sets the hover parent object, the area that will be darkened when the
12707 * hoversel is clicked. Should probably be the window that the hoversel is
12708 * in. See @ref Hover objects for more information.
12710 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12712 * @brief Get the Hover parent
12714 * @param obj The hoversel object
12715 * @return The used parent
12717 * Gets the hover parent object.
12719 * @see elm_hoversel_hover_parent_set()
12721 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12723 * @brief Set the hoversel button label
12725 * @param obj The hoversel object
12726 * @param label The label text.
12728 * This sets the label of the button that is always visible (before it is
12729 * clicked and expanded).
12731 * @deprecated elm_object_text_set()
12733 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12735 * @brief Get the hoversel button label
12737 * @param obj The hoversel object
12738 * @return The label text.
12740 * @deprecated elm_object_text_get()
12742 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12744 * @brief Set the icon of the hoversel button
12746 * @param obj The hoversel object
12747 * @param icon The icon object
12749 * Sets the icon of the button that is always visible (before it is clicked
12750 * and expanded). Once the icon object is set, a previously set one will be
12751 * deleted, if you want to keep that old content object, use the
12752 * elm_hoversel_icon_unset() function.
12754 * @see elm_button_icon_set()
12756 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12758 * @brief Get the icon of the hoversel button
12760 * @param obj The hoversel object
12761 * @return The icon object
12763 * Get the icon of the button that is always visible (before it is clicked
12764 * and expanded). Also see elm_button_icon_get().
12766 * @see elm_hoversel_icon_set()
12768 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12770 * @brief Get and unparent the icon of the hoversel button
12772 * @param obj The hoversel object
12773 * @return The icon object that was being used
12775 * Unparent and return the icon of the button that is always visible
12776 * (before it is clicked and expanded).
12778 * @see elm_hoversel_icon_set()
12779 * @see elm_button_icon_unset()
12781 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12783 * @brief This triggers the hoversel popup from code, the same as if the user
12784 * had clicked the button.
12786 * @param obj The hoversel object
12788 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12790 * @brief This dismisses the hoversel popup as if the user had clicked
12791 * outside the hover.
12793 * @param obj The hoversel object
12795 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12797 * @brief Returns whether the hoversel is expanded.
12799 * @param obj The hoversel object
12800 * @return This will return EINA_TRUE if the hoversel is expanded or
12801 * EINA_FALSE if it is not expanded.
12803 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12805 * @brief This will remove all the children items from the hoversel.
12807 * @param obj The hoversel object
12809 * @warning Should @b not be called while the hoversel is active; use
12810 * elm_hoversel_expanded_get() to check first.
12812 * @see elm_hoversel_item_del_cb_set()
12813 * @see elm_hoversel_item_del()
12815 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12817 * @brief Get the list of items within the given hoversel.
12819 * @param obj The hoversel object
12820 * @return Returns a list of Elm_Hoversel_Item*
12822 * @see elm_hoversel_item_add()
12824 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12826 * @brief Add an item to the hoversel button
12828 * @param obj The hoversel object
12829 * @param label The text label to use for the item (NULL if not desired)
12830 * @param icon_file An image file path on disk to use for the icon or standard
12831 * icon name (NULL if not desired)
12832 * @param icon_type The icon type if relevant
12833 * @param func Convenience function to call when this item is selected
12834 * @param data Data to pass to item-related functions
12835 * @return A handle to the item added.
12837 * This adds an item to the hoversel to show when it is clicked. Note: if you
12838 * need to use an icon from an edje file then use
12839 * elm_hoversel_item_icon_set() right after the this function, and set
12840 * icon_file to NULL here.
12842 * For more information on what @p icon_file and @p icon_type are see the
12843 * @ref Icon "icon documentation".
12845 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);
12847 * @brief Delete an item from the hoversel
12849 * @param item The item to delete
12851 * This deletes the item from the hoversel (should not be called while the
12852 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12854 * @see elm_hoversel_item_add()
12855 * @see elm_hoversel_item_del_cb_set()
12857 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12859 * @brief Set the function to be called when an item from the hoversel is
12862 * @param item The item to set the callback on
12863 * @param func The function called
12865 * That function will receive these parameters:
12866 * @li void *item_data
12867 * @li Evas_Object *the_item_object
12868 * @li Elm_Hoversel_Item *the_object_struct
12870 * @see elm_hoversel_item_add()
12872 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12874 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12875 * that will be passed to associated function callbacks.
12877 * @param item The item to get the data from
12878 * @return The data pointer set with elm_hoversel_item_add()
12880 * @see elm_hoversel_item_add()
12882 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12884 * @brief This returns the label text of the given hoversel item.
12886 * @param item The item to get the label
12887 * @return The label text of the hoversel item
12889 * @see elm_hoversel_item_add()
12891 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12893 * @brief This sets the icon for the given hoversel item.
12895 * @param item The item to set the icon
12896 * @param icon_file An image file path on disk to use for the icon or standard
12898 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12899 * to NULL if the icon is not an edje file
12900 * @param icon_type The icon type
12902 * The icon can be loaded from the standard set, from an image file, or from
12905 * @see elm_hoversel_item_add()
12907 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);
12909 * @brief Get the icon object of the hoversel item
12911 * @param item The item to get the icon from
12912 * @param icon_file The image file path on disk used for the icon or standard
12914 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12915 * if the icon is not an edje file
12916 * @param icon_type The icon type
12918 * @see elm_hoversel_item_icon_set()
12919 * @see elm_hoversel_item_add()
12921 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);
12927 * @defgroup Toolbar Toolbar
12928 * @ingroup Elementary
12930 * @image html img/widget/toolbar/preview-00.png
12931 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12933 * @image html img/toolbar.png
12934 * @image latex img/toolbar.eps width=\textwidth
12936 * A toolbar is a widget that displays a list of items inside
12937 * a box. It can be scrollable, show a menu with items that don't fit
12938 * to toolbar size or even crop them.
12940 * Only one item can be selected at a time.
12942 * Items can have multiple states, or show menus when selected by the user.
12944 * Smart callbacks one can listen to:
12945 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12947 * Available styles for it:
12949 * - @c "transparent" - no background or shadow, just show the content
12951 * List of examples:
12952 * @li @ref toolbar_example_01
12953 * @li @ref toolbar_example_02
12954 * @li @ref toolbar_example_03
12958 * @addtogroup Toolbar
12963 * @enum _Elm_Toolbar_Shrink_Mode
12964 * @typedef Elm_Toolbar_Shrink_Mode
12966 * Set toolbar's items display behavior, it can be scrollabel,
12967 * show a menu with exceeding items, or simply hide them.
12969 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12972 * Values <b> don't </b> work as bitmask, only one can be choosen.
12974 * @see elm_toolbar_mode_shrink_set()
12975 * @see elm_toolbar_mode_shrink_get()
12979 typedef enum _Elm_Toolbar_Shrink_Mode
12981 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12982 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12983 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12984 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12985 } Elm_Toolbar_Shrink_Mode;
12987 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(). */
12989 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(). */
12992 * Add a new toolbar widget to the given parent Elementary
12993 * (container) object.
12995 * @param parent The parent object.
12996 * @return a new toolbar widget handle or @c NULL, on errors.
12998 * This function inserts a new toolbar widget on the canvas.
13002 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13005 * Set the icon size, in pixels, to be used by toolbar items.
13007 * @param obj The toolbar object
13008 * @param icon_size The icon size in pixels
13010 * @note Default value is @c 32. It reads value from elm config.
13012 * @see elm_toolbar_icon_size_get()
13016 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13019 * Get the icon size, in pixels, to be used by toolbar items.
13021 * @param obj The toolbar object.
13022 * @return The icon size in pixels.
13024 * @see elm_toolbar_icon_size_set() for details.
13028 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13031 * Sets icon lookup order, for toolbar items' icons.
13033 * @param obj The toolbar object.
13034 * @param order The icon lookup order.
13036 * Icons added before calling this function will not be affected.
13037 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13039 * @see elm_toolbar_icon_order_lookup_get()
13043 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13046 * Gets the icon lookup order.
13048 * @param obj The toolbar object.
13049 * @return The icon lookup order.
13051 * @see elm_toolbar_icon_order_lookup_set() for details.
13055 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13058 * Set whether the toolbar items' should be selected by the user or not.
13060 * @param obj The toolbar object.
13061 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13064 * This will turn off the ability to select items entirely and they will
13065 * neither appear selected nor emit selected signals. The clicked
13066 * callback function will still be called.
13068 * Selection is enabled by default.
13070 * @see elm_toolbar_no_select_mode_get().
13074 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13077 * Set whether the toolbar items' should be selected by the user or not.
13079 * @param obj The toolbar object.
13080 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13081 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13083 * @see elm_toolbar_no_select_mode_set() for details.
13087 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13090 * Append item to the toolbar.
13092 * @param obj The toolbar object.
13093 * @param icon A string with icon name or the absolute path of an image file.
13094 * @param label The label of the item.
13095 * @param func The function to call when the item is clicked.
13096 * @param data The data to associate with the item for related callbacks.
13097 * @return The created item or @c NULL upon failure.
13099 * A new item will be created and appended to the toolbar, i.e., will
13100 * be set as @b last item.
13102 * Items created with this method can be deleted with
13103 * elm_toolbar_item_del().
13105 * Associated @p data can be properly freed when item is deleted if a
13106 * callback function is set with elm_toolbar_item_del_cb_set().
13108 * If a function is passed as argument, it will be called everytime this item
13109 * is selected, i.e., the user clicks over an unselected item.
13110 * If such function isn't needed, just passing
13111 * @c NULL as @p func is enough. The same should be done for @p data.
13113 * Toolbar will load icon image from fdo or current theme.
13114 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13115 * If an absolute path is provided it will load it direct from a file.
13117 * @see elm_toolbar_item_icon_set()
13118 * @see elm_toolbar_item_del()
13119 * @see elm_toolbar_item_del_cb_set()
13123 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);
13126 * Prepend item to the toolbar.
13128 * @param obj The toolbar object.
13129 * @param icon A string with icon name or the absolute path of an image file.
13130 * @param label The label of the item.
13131 * @param func The function to call when the item is clicked.
13132 * @param data The data to associate with the item for related callbacks.
13133 * @return The created item or @c NULL upon failure.
13135 * A new item will be created and prepended to the toolbar, i.e., will
13136 * be set as @b first item.
13138 * Items created with this method can be deleted with
13139 * elm_toolbar_item_del().
13141 * Associated @p data can be properly freed when item is deleted if a
13142 * callback function is set with elm_toolbar_item_del_cb_set().
13144 * If a function is passed as argument, it will be called everytime this item
13145 * is selected, i.e., the user clicks over an unselected item.
13146 * If such function isn't needed, just passing
13147 * @c NULL as @p func is enough. The same should be done for @p data.
13149 * Toolbar will load icon image from fdo or current theme.
13150 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13151 * If an absolute path is provided it will load it direct from a file.
13153 * @see elm_toolbar_item_icon_set()
13154 * @see elm_toolbar_item_del()
13155 * @see elm_toolbar_item_del_cb_set()
13159 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);
13162 * Insert a new item into the toolbar object before item @p before.
13164 * @param obj The toolbar object.
13165 * @param before The toolbar item to insert before.
13166 * @param icon A string with icon name or the absolute path of an image file.
13167 * @param label The label of the item.
13168 * @param func The function to call when the item is clicked.
13169 * @param data The data to associate with the item for related callbacks.
13170 * @return The created item or @c NULL upon failure.
13172 * A new item will be created and added to the toolbar. Its position in
13173 * this toolbar will be just before item @p before.
13175 * Items created with this method can be deleted with
13176 * elm_toolbar_item_del().
13178 * Associated @p data can be properly freed when item is deleted if a
13179 * callback function is set with elm_toolbar_item_del_cb_set().
13181 * If a function is passed as argument, it will be called everytime this item
13182 * is selected, i.e., the user clicks over an unselected item.
13183 * If such function isn't needed, just passing
13184 * @c NULL as @p func is enough. The same should be done for @p data.
13186 * Toolbar will load icon image from fdo or current theme.
13187 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13188 * If an absolute path is provided it will load it direct from a file.
13190 * @see elm_toolbar_item_icon_set()
13191 * @see elm_toolbar_item_del()
13192 * @see elm_toolbar_item_del_cb_set()
13196 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);
13199 * Insert a new item into the toolbar object after item @p after.
13201 * @param obj The toolbar object.
13202 * @param before The toolbar item to insert before.
13203 * @param icon A string with icon name or the absolute path of an image file.
13204 * @param label The label of the item.
13205 * @param func The function to call when the item is clicked.
13206 * @param data The data to associate with the item for related callbacks.
13207 * @return The created item or @c NULL upon failure.
13209 * A new item will be created and added to the toolbar. Its position in
13210 * this toolbar will be just after item @p after.
13212 * Items created with this method can be deleted with
13213 * elm_toolbar_item_del().
13215 * Associated @p data can be properly freed when item is deleted if a
13216 * callback function is set with elm_toolbar_item_del_cb_set().
13218 * If a function is passed as argument, it will be called everytime this item
13219 * is selected, i.e., the user clicks over an unselected item.
13220 * If such function isn't needed, just passing
13221 * @c NULL as @p func is enough. The same should be done for @p data.
13223 * Toolbar will load icon image from fdo or current theme.
13224 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13225 * If an absolute path is provided it will load it direct from a file.
13227 * @see elm_toolbar_item_icon_set()
13228 * @see elm_toolbar_item_del()
13229 * @see elm_toolbar_item_del_cb_set()
13233 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);
13236 * Get the first item in the given toolbar widget's list of
13239 * @param obj The toolbar object
13240 * @return The first item or @c NULL, if it has no items (and on
13243 * @see elm_toolbar_item_append()
13244 * @see elm_toolbar_last_item_get()
13248 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13251 * Get the last item in the given toolbar widget's list of
13254 * @param obj The toolbar object
13255 * @return The last item or @c NULL, if it has no items (and on
13258 * @see elm_toolbar_item_prepend()
13259 * @see elm_toolbar_first_item_get()
13263 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13266 * Get the item after @p item in toolbar.
13268 * @param item The toolbar item.
13269 * @return The item after @p item, or @c NULL if none or on failure.
13271 * @note If it is the last item, @c NULL will be returned.
13273 * @see elm_toolbar_item_append()
13277 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13280 * Get the item before @p item in toolbar.
13282 * @param item The toolbar item.
13283 * @return The item before @p item, or @c NULL if none or on failure.
13285 * @note If it is the first item, @c NULL will be returned.
13287 * @see elm_toolbar_item_prepend()
13291 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13294 * Get the toolbar object from an item.
13296 * @param item The item.
13297 * @return The toolbar object.
13299 * This returns the toolbar object itself that an item belongs to.
13303 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13306 * Set the priority of a toolbar item.
13308 * @param item The toolbar item.
13309 * @param priority The item priority. The default is zero.
13311 * This is used only when the toolbar shrink mode is set to
13312 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13313 * When space is less than required, items with low priority
13314 * will be removed from the toolbar and added to a dynamically-created menu,
13315 * while items with higher priority will remain on the toolbar,
13316 * with the same order they were added.
13318 * @see elm_toolbar_item_priority_get()
13322 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13325 * Get the priority of a toolbar item.
13327 * @param item The toolbar item.
13328 * @return The @p item priority, or @c 0 on failure.
13330 * @see elm_toolbar_item_priority_set() for details.
13334 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13337 * Get the label of item.
13339 * @param item The item of toolbar.
13340 * @return The label of item.
13342 * The return value is a pointer to the label associated to @p item when
13343 * it was created, with function elm_toolbar_item_append() or similar,
13345 * with function elm_toolbar_item_label_set. If no label
13346 * was passed as argument, it will return @c NULL.
13348 * @see elm_toolbar_item_label_set() for more details.
13349 * @see elm_toolbar_item_append()
13353 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13356 * Set the label of item.
13358 * @param item The item of toolbar.
13359 * @param text The label of item.
13361 * The label to be displayed by the item.
13362 * Label will be placed at icons bottom (if set).
13364 * If a label was passed as argument on item creation, with function
13365 * elm_toolbar_item_append() or similar, it will be already
13366 * displayed by the item.
13368 * @see elm_toolbar_item_label_get()
13369 * @see elm_toolbar_item_append()
13373 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13376 * Return the data associated with a given toolbar widget item.
13378 * @param item The toolbar widget item handle.
13379 * @return The data associated with @p item.
13381 * @see elm_toolbar_item_data_set()
13385 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13388 * Set the data associated with a given toolbar widget item.
13390 * @param item The toolbar widget item handle.
13391 * @param data The new data pointer to set to @p item.
13393 * This sets new item data on @p item.
13395 * @warning The old data pointer won't be touched by this function, so
13396 * the user had better to free that old data himself/herself.
13400 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13403 * Returns a pointer to a toolbar item by its label.
13405 * @param obj The toolbar object.
13406 * @param label The label of the item to find.
13408 * @return The pointer to the toolbar item matching @p label or @c NULL
13413 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13416 * Get whether the @p item is selected or not.
13418 * @param item The toolbar item.
13419 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13420 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13422 * @see elm_toolbar_selected_item_set() for details.
13423 * @see elm_toolbar_item_selected_get()
13427 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13430 * Set the selected state of an item.
13432 * @param item The toolbar item
13433 * @param selected The selected state
13435 * This sets the selected state of the given item @p it.
13436 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13438 * If a new item is selected the previosly selected will be unselected.
13439 * Previoulsy selected item can be get with function
13440 * elm_toolbar_selected_item_get().
13442 * Selected items will be highlighted.
13444 * @see elm_toolbar_item_selected_get()
13445 * @see elm_toolbar_selected_item_get()
13449 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13452 * Get the selected item.
13454 * @param obj The toolbar object.
13455 * @return The selected toolbar item.
13457 * The selected item can be unselected with function
13458 * elm_toolbar_item_selected_set().
13460 * The selected item always will be highlighted on toolbar.
13462 * @see elm_toolbar_selected_items_get()
13466 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13469 * Set the icon associated with @p item.
13471 * @param obj The parent of this item.
13472 * @param item The toolbar item.
13473 * @param icon A string with icon name or the absolute path of an image file.
13475 * Toolbar will load icon image from fdo or current theme.
13476 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13477 * If an absolute path is provided it will load it direct from a file.
13479 * @see elm_toolbar_icon_order_lookup_set()
13480 * @see elm_toolbar_icon_order_lookup_get()
13484 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13487 * Get the string used to set the icon of @p item.
13489 * @param item The toolbar item.
13490 * @return The string associated with the icon object.
13492 * @see elm_toolbar_item_icon_set() for details.
13496 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13499 * Delete them item from the toolbar.
13501 * @param item The item of toolbar to be deleted.
13503 * @see elm_toolbar_item_append()
13504 * @see elm_toolbar_item_del_cb_set()
13508 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13511 * Set the function called when a toolbar item is freed.
13513 * @param item The item to set the callback on.
13514 * @param func The function called.
13516 * If there is a @p func, then it will be called prior item's memory release.
13517 * That will be called with the following arguments:
13519 * @li item's Evas object;
13522 * This way, a data associated to a toolbar item could be properly freed.
13526 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13529 * Get a value whether toolbar item is disabled or not.
13531 * @param item The item.
13532 * @return The disabled state.
13534 * @see elm_toolbar_item_disabled_set() for more details.
13538 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13541 * Sets the disabled/enabled state of a toolbar item.
13543 * @param item The item.
13544 * @param disabled The disabled state.
13546 * A disabled item cannot be selected or unselected. It will also
13547 * change its appearance (generally greyed out). This sets the
13548 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13553 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13556 * Set or unset item as a separator.
13558 * @param item The toolbar item.
13559 * @param setting @c EINA_TRUE to set item @p item as separator or
13560 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13562 * Items aren't set as separator by default.
13564 * If set as separator it will display separator theme, so won't display
13567 * @see elm_toolbar_item_separator_get()
13571 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13574 * Get a value whether item is a separator or not.
13576 * @param item The toolbar item.
13577 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13578 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13580 * @see elm_toolbar_item_separator_set() for details.
13584 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13587 * Set the shrink state of toolbar @p obj.
13589 * @param obj The toolbar object.
13590 * @param shrink_mode Toolbar's items display behavior.
13592 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13593 * but will enforce a minimun size so all the items will fit, won't scroll
13594 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13595 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13596 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13600 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13603 * Get the shrink mode of toolbar @p obj.
13605 * @param obj The toolbar object.
13606 * @return Toolbar's items display behavior.
13608 * @see elm_toolbar_mode_shrink_set() for details.
13612 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13615 * Enable/disable homogenous mode.
13617 * @param obj The toolbar object
13618 * @param homogeneous Assume the items within the toolbar are of the
13619 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13621 * This will enable the homogeneous mode where items are of the same size.
13622 * @see elm_toolbar_homogeneous_get()
13626 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13629 * Get whether the homogenous mode is enabled.
13631 * @param obj The toolbar object.
13632 * @return Assume the items within the toolbar are of the same height
13633 * and width (EINA_TRUE = on, EINA_FALSE = off).
13635 * @see elm_toolbar_homogeneous_set()
13639 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13642 * Enable/disable homogenous mode.
13644 * @param obj The toolbar object
13645 * @param homogeneous Assume the items within the toolbar are of the
13646 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13648 * This will enable the homogeneous mode where items are of the same size.
13649 * @see elm_toolbar_homogeneous_get()
13651 * @deprecated use elm_toolbar_homogeneous_set() instead.
13655 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13658 * Get whether the homogenous mode is enabled.
13660 * @param obj The toolbar object.
13661 * @return Assume the items within the toolbar are of the same height
13662 * and width (EINA_TRUE = on, EINA_FALSE = off).
13664 * @see elm_toolbar_homogeneous_set()
13665 * @deprecated use elm_toolbar_homogeneous_get() instead.
13669 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13672 * Set the parent object of the toolbar items' menus.
13674 * @param obj The toolbar object.
13675 * @param parent The parent of the menu objects.
13677 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13679 * For more details about setting the parent for toolbar menus, see
13680 * elm_menu_parent_set().
13682 * @see elm_menu_parent_set() for details.
13683 * @see elm_toolbar_item_menu_set() for details.
13687 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13690 * Get the parent object of the toolbar items' menus.
13692 * @param obj The toolbar object.
13693 * @return The parent of the menu objects.
13695 * @see elm_toolbar_menu_parent_set() for details.
13699 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13702 * Set the alignment of the items.
13704 * @param obj The toolbar object.
13705 * @param align The new alignment, a float between <tt> 0.0 </tt>
13706 * and <tt> 1.0 </tt>.
13708 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13709 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13712 * Centered items by default.
13714 * @see elm_toolbar_align_get()
13718 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13721 * Get the alignment of the items.
13723 * @param obj The toolbar object.
13724 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13727 * @see elm_toolbar_align_set() for details.
13731 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13734 * Set whether the toolbar item opens a menu.
13736 * @param item The toolbar item.
13737 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13739 * A toolbar item can be set to be a menu, using this function.
13741 * Once it is set to be a menu, it can be manipulated through the
13742 * menu-like function elm_toolbar_menu_parent_set() and the other
13743 * elm_menu functions, using the Evas_Object @c menu returned by
13744 * elm_toolbar_item_menu_get().
13746 * So, items to be displayed in this item's menu should be added with
13747 * elm_menu_item_add().
13749 * The following code exemplifies the most basic usage:
13751 * tb = elm_toolbar_add(win)
13752 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13753 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13754 * elm_toolbar_menu_parent_set(tb, win);
13755 * menu = elm_toolbar_item_menu_get(item);
13756 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13757 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13761 * @see elm_toolbar_item_menu_get()
13765 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13768 * Get toolbar item's menu.
13770 * @param item The toolbar item.
13771 * @return Item's menu object or @c NULL on failure.
13773 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13774 * this function will set it.
13776 * @see elm_toolbar_item_menu_set() for details.
13780 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13783 * Add a new state to @p item.
13785 * @param item The item.
13786 * @param icon A string with icon name or the absolute path of an image file.
13787 * @param label The label of the new state.
13788 * @param func The function to call when the item is clicked when this
13789 * state is selected.
13790 * @param data The data to associate with the state.
13791 * @return The toolbar item state, or @c NULL upon failure.
13793 * Toolbar will load icon image from fdo or current theme.
13794 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13795 * If an absolute path is provided it will load it direct from a file.
13797 * States created with this function can be removed with
13798 * elm_toolbar_item_state_del().
13800 * @see elm_toolbar_item_state_del()
13801 * @see elm_toolbar_item_state_sel()
13802 * @see elm_toolbar_item_state_get()
13806 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);
13809 * Delete a previoulsy added state to @p item.
13811 * @param item The toolbar item.
13812 * @param state The state to be deleted.
13813 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13815 * @see elm_toolbar_item_state_add()
13817 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13820 * Set @p state as the current state of @p it.
13822 * @param it The item.
13823 * @param state The state to use.
13824 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13826 * If @p state is @c NULL, it won't select any state and the default item's
13827 * icon and label will be used. It's the same behaviour than
13828 * elm_toolbar_item_state_unser().
13830 * @see elm_toolbar_item_state_unset()
13834 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13837 * Unset the state of @p it.
13839 * @param it The item.
13841 * The default icon and label from this item will be displayed.
13843 * @see elm_toolbar_item_state_set() for more details.
13847 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13850 * Get the current state of @p it.
13852 * @param item The item.
13853 * @return The selected state or @c NULL if none is selected or on failure.
13855 * @see elm_toolbar_item_state_set() for details.
13856 * @see elm_toolbar_item_state_unset()
13857 * @see elm_toolbar_item_state_add()
13861 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13864 * Get the state after selected state in toolbar's @p item.
13866 * @param it The toolbar item to change state.
13867 * @return The state after current state, or @c NULL on failure.
13869 * If last state is selected, this function will return first state.
13871 * @see elm_toolbar_item_state_set()
13872 * @see elm_toolbar_item_state_add()
13876 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13879 * Get the state before selected state in toolbar's @p item.
13881 * @param it The toolbar item to change state.
13882 * @return The state before current state, or @c NULL on failure.
13884 * If first state is selected, this function will return last state.
13886 * @see elm_toolbar_item_state_set()
13887 * @see elm_toolbar_item_state_add()
13891 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13894 * Set the text to be shown in a given toolbar item's tooltips.
13896 * @param item Target item.
13897 * @param text The text to set in the content.
13899 * Setup the text as tooltip to object. The item can have only one tooltip,
13900 * so any previous tooltip data - set with this function or
13901 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13903 * @see elm_object_tooltip_text_set() for more details.
13907 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13910 * Set the content to be shown in the tooltip item.
13912 * Setup the tooltip to item. The item can have only one tooltip,
13913 * so any previous tooltip data is removed. @p func(with @p data) will
13914 * be called every time that need show the tooltip and it should
13915 * return a valid Evas_Object. This object is then managed fully by
13916 * tooltip system and is deleted when the tooltip is gone.
13918 * @param item the toolbar item being attached a tooltip.
13919 * @param func the function used to create the tooltip contents.
13920 * @param data what to provide to @a func as callback data/context.
13921 * @param del_cb called when data is not needed anymore, either when
13922 * another callback replaces @a func, the tooltip is unset with
13923 * elm_toolbar_item_tooltip_unset() or the owner @a item
13924 * dies. This callback receives as the first parameter the
13925 * given @a data, and @c event_info is the item.
13927 * @see elm_object_tooltip_content_cb_set() for more details.
13931 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);
13934 * Unset tooltip from item.
13936 * @param item toolbar item to remove previously set tooltip.
13938 * Remove tooltip from item. The callback provided as del_cb to
13939 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13940 * it is not used anymore.
13942 * @see elm_object_tooltip_unset() for more details.
13943 * @see elm_toolbar_item_tooltip_content_cb_set()
13947 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13950 * Sets a different style for this item tooltip.
13952 * @note before you set a style you should define a tooltip with
13953 * elm_toolbar_item_tooltip_content_cb_set() or
13954 * elm_toolbar_item_tooltip_text_set()
13956 * @param item toolbar item with tooltip already set.
13957 * @param style the theme style to use (default, transparent, ...)
13959 * @see elm_object_tooltip_style_set() for more details.
13963 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13966 * Get the style for this item tooltip.
13968 * @param item toolbar item with tooltip already set.
13969 * @return style the theme style in use, defaults to "default". If the
13970 * object does not have a tooltip set, then NULL is returned.
13972 * @see elm_object_tooltip_style_get() for more details.
13973 * @see elm_toolbar_item_tooltip_style_set()
13977 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13980 * Set the type of mouse pointer/cursor decoration to be shown,
13981 * when the mouse pointer is over the given toolbar widget item
13983 * @param item toolbar item to customize cursor on
13984 * @param cursor the cursor type's name
13986 * This function works analogously as elm_object_cursor_set(), but
13987 * here the cursor's changing area is restricted to the item's
13988 * area, and not the whole widget's. Note that that item cursors
13989 * have precedence over widget cursors, so that a mouse over an
13990 * item with custom cursor set will always show @b that cursor.
13992 * If this function is called twice for an object, a previously set
13993 * cursor will be unset on the second call.
13995 * @see elm_object_cursor_set()
13996 * @see elm_toolbar_item_cursor_get()
13997 * @see elm_toolbar_item_cursor_unset()
14001 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14004 * Get the type of mouse pointer/cursor decoration set to be shown,
14005 * when the mouse pointer is over the given toolbar widget item
14007 * @param item toolbar item with custom cursor set
14008 * @return the cursor type's name or @c NULL, if no custom cursors
14009 * were set to @p item (and on errors)
14011 * @see elm_object_cursor_get()
14012 * @see elm_toolbar_item_cursor_set()
14013 * @see elm_toolbar_item_cursor_unset()
14017 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14020 * Unset any custom mouse pointer/cursor decoration set to be
14021 * shown, when the mouse pointer is over the given toolbar widget
14022 * item, thus making it show the @b default cursor again.
14024 * @param item a toolbar item
14026 * Use this call to undo any custom settings on this item's cursor
14027 * decoration, bringing it back to defaults (no custom style set).
14029 * @see elm_object_cursor_unset()
14030 * @see elm_toolbar_item_cursor_set()
14034 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14037 * Set a different @b style for a given custom cursor set for a
14040 * @param item toolbar item with custom cursor set
14041 * @param style the <b>theme style</b> to use (e.g. @c "default",
14042 * @c "transparent", etc)
14044 * This function only makes sense when one is using custom mouse
14045 * cursor decorations <b>defined in a theme file</b>, which can have,
14046 * given a cursor name/type, <b>alternate styles</b> on it. It
14047 * works analogously as elm_object_cursor_style_set(), but here
14048 * applyed only to toolbar item objects.
14050 * @warning Before you set a cursor style you should have definen a
14051 * custom cursor previously on the item, with
14052 * elm_toolbar_item_cursor_set()
14054 * @see elm_toolbar_item_cursor_engine_only_set()
14055 * @see elm_toolbar_item_cursor_style_get()
14059 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14062 * Get the current @b style set for a given toolbar item's custom
14065 * @param item toolbar item with custom cursor set.
14066 * @return style the cursor style in use. If the object does not
14067 * have a cursor set, then @c NULL is returned.
14069 * @see elm_toolbar_item_cursor_style_set() for more details
14073 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14076 * Set if the (custom)cursor for a given toolbar item should be
14077 * searched in its theme, also, or should only rely on the
14078 * rendering engine.
14080 * @param item item with custom (custom) cursor already set on
14081 * @param engine_only Use @c EINA_TRUE to have cursors looked for
14082 * only on those provided by the rendering engine, @c EINA_FALSE to
14083 * have them searched on the widget's theme, as well.
14085 * @note This call is of use only if you've set a custom cursor
14086 * for toolbar items, with elm_toolbar_item_cursor_set().
14088 * @note By default, cursors will only be looked for between those
14089 * provided by the rendering engine.
14093 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14096 * Get if the (custom) cursor for a given toolbar item is being
14097 * searched in its theme, also, or is only relying on the rendering
14100 * @param item a toolbar item
14101 * @return @c EINA_TRUE, if cursors are being looked for only on
14102 * those provided by the rendering engine, @c EINA_FALSE if they
14103 * are being searched on the widget's theme, as well.
14105 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14109 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14112 * Change a toolbar's orientation
14113 * @param obj The toolbar object
14114 * @param vertical If @c EINA_TRUE, the toolbar is vertical
14115 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14118 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14121 * Get a toolbar's orientation
14122 * @param obj The toolbar object
14123 * @return If @c EINA_TRUE, the toolbar is vertical
14124 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14127 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14134 * @defgroup Tooltips Tooltips
14136 * The Tooltip is an (internal, for now) smart object used to show a
14137 * content in a frame on mouse hover of objects(or widgets), with
14138 * tips/information about them.
14143 EAPI double elm_tooltip_delay_get(void);
14144 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
14145 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14146 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14147 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14148 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);
14149 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14150 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14151 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14152 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14153 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14160 * @defgroup Cursors Cursors
14162 * The Elementary cursor is an internal smart object used to
14163 * customize the mouse cursor displayed over objects (or
14164 * widgets). In the most common scenario, the cursor decoration
14165 * comes from the graphical @b engine Elementary is running
14166 * on. Those engines may provide different decorations for cursors,
14167 * and Elementary provides functions to choose them (think of X11
14168 * cursors, as an example).
14170 * There's also the possibility of, besides using engine provided
14171 * cursors, also use ones coming from Edje theming files. Both
14172 * globally and per widget, Elementary makes it possible for one to
14173 * make the cursors lookup to be held on engines only or on
14174 * Elementary's theme file, too.
14180 * Set the cursor to be shown when mouse is over the object
14182 * Set the cursor that will be displayed when mouse is over the
14183 * object. The object can have only one cursor set to it, so if
14184 * this function is called twice for an object, the previous set
14186 * If using X cursors, a definition of all the valid cursor names
14187 * is listed on Elementary_Cursors.h. If an invalid name is set
14188 * the default cursor will be used.
14190 * @param obj the object being set a cursor.
14191 * @param cursor the cursor name to be used.
14195 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14198 * Get the cursor to be shown when mouse is over the object
14200 * @param obj an object with cursor already set.
14201 * @return the cursor name.
14205 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14208 * Unset cursor for object
14210 * Unset cursor for object, and set the cursor to default if the mouse
14211 * was over this object.
14213 * @param obj Target object
14214 * @see elm_object_cursor_set()
14218 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14221 * Sets a different style for this object cursor.
14223 * @note before you set a style you should define a cursor with
14224 * elm_object_cursor_set()
14226 * @param obj an object with cursor already set.
14227 * @param style the theme style to use (default, transparent, ...)
14231 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14234 * Get the style for this object cursor.
14236 * @param obj an object with cursor already set.
14237 * @return style the theme style in use, defaults to "default". If the
14238 * object does not have a cursor set, then NULL is returned.
14242 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14245 * Set if the cursor set should be searched on the theme or should use
14246 * the provided by the engine, only.
14248 * @note before you set if should look on theme you should define a cursor
14249 * with elm_object_cursor_set(). By default it will only look for cursors
14250 * provided by the engine.
14252 * @param obj an object with cursor already set.
14253 * @param engine_only boolean to define it cursors should be looked only
14254 * between the provided by the engine or searched on widget's theme as well.
14258 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14261 * Get the cursor engine only usage for this object cursor.
14263 * @param obj an object with cursor already set.
14264 * @return engine_only boolean to define it cursors should be
14265 * looked only between the provided by the engine or searched on
14266 * widget's theme as well. If the object does not have a cursor
14267 * set, then EINA_FALSE is returned.
14271 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14274 * Get the configured cursor engine only usage
14276 * This gets the globally configured exclusive usage of engine cursors.
14278 * @return 1 if only engine cursors should be used
14281 EAPI int elm_cursor_engine_only_get(void);
14284 * Set the configured cursor engine only usage
14286 * This sets the globally configured exclusive usage of engine cursors.
14287 * It won't affect cursors set before changing this value.
14289 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14290 * look for them on theme before.
14291 * @return EINA_TRUE if value is valid and setted (0 or 1)
14294 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14301 * @defgroup Menu Menu
14303 * @image html img/widget/menu/preview-00.png
14304 * @image latex img/widget/menu/preview-00.eps
14306 * A menu is a list of items displayed above its parent. When the menu is
14307 * showing its parent is darkened. Each item can have a sub-menu. The menu
14308 * object can be used to display a menu on a right click event, in a toolbar,
14311 * Signals that you can add callbacks for are:
14312 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14313 * event_info is NULL.
14315 * @see @ref tutorial_menu
14318 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14320 * @brief Add a new menu to the parent
14322 * @param parent The parent object.
14323 * @return The new object or NULL if it cannot be created.
14325 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14327 * @brief Set the parent for the given menu widget
14329 * @param obj The menu object.
14330 * @param parent The new parent.
14332 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14334 * @brief Get the parent for the given menu widget
14336 * @param obj The menu object.
14337 * @return The parent.
14339 * @see elm_menu_parent_set()
14341 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14343 * @brief Move the menu to a new position
14345 * @param obj The menu object.
14346 * @param x The new position.
14347 * @param y The new position.
14349 * Sets the top-left position of the menu to (@p x,@p y).
14351 * @note @p x and @p y coordinates are relative to parent.
14353 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14355 * @brief Close a opened menu
14357 * @param obj the menu object
14360 * Hides the menu and all it's sub-menus.
14362 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14364 * @brief Returns a list of @p item's items.
14366 * @param obj The menu object
14367 * @return An Eina_List* of @p item's items
14369 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14371 * @brief Get the Evas_Object of an Elm_Menu_Item
14373 * @param item The menu item object.
14374 * @return The edje object containing the swallowed content
14376 * @warning Don't manipulate this object!
14378 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14380 * @brief Add an item at the end of the given menu widget
14382 * @param obj The menu object.
14383 * @param parent The parent menu item (optional)
14384 * @param icon A icon display on the item. The icon will be destryed by the menu.
14385 * @param label The label of the item.
14386 * @param func Function called when the user select the item.
14387 * @param data Data sent by the callback.
14388 * @return Returns the new item.
14390 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);
14392 * @brief Add an object swallowed in an item at the end of the given menu
14395 * @param obj The menu object.
14396 * @param parent The parent menu item (optional)
14397 * @param subobj The object to swallow
14398 * @param func Function called when the user select the item.
14399 * @param data Data sent by the callback.
14400 * @return Returns the new item.
14402 * Add an evas object as an item to the menu.
14404 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);
14406 * @brief Set the label of a menu item
14408 * @param item The menu item object.
14409 * @param label The label to set for @p item
14411 * @warning Don't use this funcion on items created with
14412 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14414 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14416 * @brief Get the label of a menu item
14418 * @param item The menu item object.
14419 * @return The label of @p item
14421 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14423 * @brief Set the icon of a menu item to the standard icon with name @p icon
14425 * @param item The menu item object.
14426 * @param icon The icon object to set for the content of @p item
14428 * Once this icon is set, any previously set icon will be deleted.
14430 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14432 * @brief Get the string representation from the icon of a menu item
14434 * @param item The menu item object.
14435 * @return The string representation of @p item's icon or NULL
14437 * @see elm_menu_item_object_icon_name_set()
14439 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14441 * @brief Set the content object of a menu item
14443 * @param item The menu item object
14444 * @param The content object or NULL
14445 * @return EINA_TRUE on success, else EINA_FALSE
14447 * Use this function to change the object swallowed by a menu item, deleting
14448 * any previously swallowed object.
14450 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14452 * @brief Get the content object of a menu item
14454 * @param item The menu item object
14455 * @return The content object or NULL
14456 * @note If @p item was added with elm_menu_item_add_object, this
14457 * function will return the object passed, else it will return the
14460 * @see elm_menu_item_object_content_set()
14462 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14464 * @brief Set the selected state of @p item.
14466 * @param item The menu item object.
14467 * @param selected The selected/unselected state of the item
14469 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14471 * @brief Get the selected state of @p item.
14473 * @param item The menu item object.
14474 * @return The selected/unselected state of the item
14476 * @see elm_menu_item_selected_set()
14478 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14480 * @brief Set the disabled state of @p item.
14482 * @param item The menu item object.
14483 * @param disabled The enabled/disabled state of the item
14485 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14487 * @brief Get the disabled state of @p item.
14489 * @param item The menu item object.
14490 * @return The enabled/disabled state of the item
14492 * @see elm_menu_item_disabled_set()
14494 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14496 * @brief Add a separator item to menu @p obj under @p parent.
14498 * @param obj The menu object
14499 * @param parent The item to add the separator under
14500 * @return The created item or NULL on failure
14502 * This is item is a @ref Separator.
14504 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14506 * @brief Returns whether @p item is a separator.
14508 * @param item The item to check
14509 * @return If true, @p item is a separator
14511 * @see elm_menu_item_separator_add()
14513 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14515 * @brief Deletes an item from the menu.
14517 * @param item The item to delete.
14519 * @see elm_menu_item_add()
14521 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14523 * @brief Set the function called when a menu item is deleted.
14525 * @param item The item to set the callback on
14526 * @param func The function called
14528 * @see elm_menu_item_add()
14529 * @see elm_menu_item_del()
14531 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14533 * @brief Returns the data associated with menu item @p item.
14535 * @param item The item
14536 * @return The data associated with @p item or NULL if none was set.
14538 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14540 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14542 * @brief Sets the data to be associated with menu item @p item.
14544 * @param item The item
14545 * @param data The data to be associated with @p item
14547 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14549 * @brief Returns a list of @p item's subitems.
14551 * @param item The item
14552 * @return An Eina_List* of @p item's subitems
14554 * @see elm_menu_add()
14556 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14558 * @brief Get the position of a menu item
14560 * @param item The menu item
14561 * @return The item's index
14563 * This function returns the index position of a menu item in a menu.
14564 * For a sub-menu, this number is relative to the first item in the sub-menu.
14566 * @note Index values begin with 0
14568 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14570 * @brief @brief Return a menu item's owner menu
14572 * @param item The menu item
14573 * @return The menu object owning @p item, or NULL on failure
14575 * Use this function to get the menu object owning an item.
14577 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14579 * @brief Get the selected item in the menu
14581 * @param obj The menu object
14582 * @return The selected item, or NULL if none
14584 * @see elm_menu_item_selected_get()
14585 * @see elm_menu_item_selected_set()
14587 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14589 * @brief Get the last item in the menu
14591 * @param obj The menu object
14592 * @return The last item, or NULL if none
14594 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14596 * @brief Get the first item in the menu
14598 * @param obj The menu object
14599 * @return The first item, or NULL if none
14601 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14603 * @brief Get the next item in the menu.
14605 * @param item The menu item object.
14606 * @return The item after it, or NULL if none
14608 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14610 * @brief Get the previous item in the menu.
14612 * @param item The menu item object.
14613 * @return The item before it, or NULL if none
14615 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14621 * @defgroup List List
14622 * @ingroup Elementary
14624 * @image html img/widget/list/preview-00.png
14625 * @image latex img/widget/list/preview-00.eps width=\textwidth
14627 * @image html img/list.png
14628 * @image latex img/list.eps width=\textwidth
14630 * A list widget is a container whose children are displayed vertically or
14631 * horizontally, in order, and can be selected.
14632 * The list can accept only one or multiple items selection. Also has many
14633 * modes of items displaying.
14635 * A list is a very simple type of list widget. For more robust
14636 * lists, @ref Genlist should probably be used.
14638 * Smart callbacks one can listen to:
14639 * - @c "activated" - The user has double-clicked or pressed
14640 * (enter|return|spacebar) on an item. The @c event_info parameter
14641 * is the item that was activated.
14642 * - @c "clicked,double" - The user has double-clicked an item.
14643 * The @c event_info parameter is the item that was double-clicked.
14644 * - "selected" - when the user selected an item
14645 * - "unselected" - when the user unselected an item
14646 * - "longpressed" - an item in the list is long-pressed
14647 * - "scroll,edge,top" - the list is scrolled until the top edge
14648 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14649 * - "scroll,edge,left" - the list is scrolled until the left edge
14650 * - "scroll,edge,right" - the list is scrolled until the right edge
14652 * Available styles for it:
14655 * List of examples:
14656 * @li @ref list_example_01
14657 * @li @ref list_example_02
14658 * @li @ref list_example_03
14667 * @enum _Elm_List_Mode
14668 * @typedef Elm_List_Mode
14670 * Set list's resize behavior, transverse axis scroll and
14671 * items cropping. See each mode's description for more details.
14673 * @note Default value is #ELM_LIST_SCROLL.
14675 * Values <b> don't </b> work as bitmask, only one can be choosen.
14677 * @see elm_list_mode_set()
14678 * @see elm_list_mode_get()
14682 typedef enum _Elm_List_Mode
14684 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. */
14685 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). */
14686 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. */
14687 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. */
14688 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14691 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(). */
14694 * Add a new list widget to the given parent Elementary
14695 * (container) object.
14697 * @param parent The parent object.
14698 * @return a new list widget handle or @c NULL, on errors.
14700 * This function inserts a new list widget on the canvas.
14704 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14709 * @param obj The list object
14711 * @note Call before running show() on the list object.
14712 * @warning If not called, it won't display the list properly.
14715 * li = elm_list_add(win);
14716 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14717 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14719 * evas_object_show(li);
14724 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14727 * Enable or disable multiple items selection on the list object.
14729 * @param obj The list object
14730 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14733 * Disabled by default. If disabled, the user can select a single item of
14734 * the list each time. Selected items are highlighted on list.
14735 * If enabled, many items can be selected.
14737 * If a selected item is selected again, it will be unselected.
14739 * @see elm_list_multi_select_get()
14743 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14746 * Get a value whether multiple items selection is enabled or not.
14748 * @see elm_list_multi_select_set() for details.
14750 * @param obj The list object.
14751 * @return @c EINA_TRUE means multiple items selection is enabled.
14752 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14753 * @c EINA_FALSE is returned.
14757 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14760 * Set which mode to use for the list object.
14762 * @param obj The list object
14763 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14764 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14766 * Set list's resize behavior, transverse axis scroll and
14767 * items cropping. See each mode's description for more details.
14769 * @note Default value is #ELM_LIST_SCROLL.
14771 * Only one can be set, if a previous one was set, it will be changed
14772 * by the new mode set. Bitmask won't work as well.
14774 * @see elm_list_mode_get()
14778 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14781 * Get the mode the list is at.
14783 * @param obj The list object
14784 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14785 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14787 * @note see elm_list_mode_set() for more information.
14791 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14794 * Enable or disable horizontal mode on the list object.
14796 * @param obj The list object.
14797 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14798 * disable it, i.e., to enable vertical mode.
14800 * @note Vertical mode is set by default.
14802 * On horizontal mode items are displayed on list from left to right,
14803 * instead of from top to bottom. Also, the list will scroll horizontally.
14804 * Each item will presents left icon on top and right icon, or end, at
14807 * @see elm_list_horizontal_get()
14811 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14814 * Get a value whether horizontal mode is enabled or not.
14816 * @param obj The list object.
14817 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14818 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14819 * @c EINA_FALSE is returned.
14821 * @see elm_list_horizontal_set() for details.
14825 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14828 * Enable or disable always select mode on the list object.
14830 * @param obj The list object
14831 * @param always_select @c EINA_TRUE to enable always select mode or
14832 * @c EINA_FALSE to disable it.
14834 * @note Always select mode is disabled by default.
14836 * Default behavior of list items is to only call its callback function
14837 * the first time it's pressed, i.e., when it is selected. If a selected
14838 * item is pressed again, and multi-select is disabled, it won't call
14839 * this function (if multi-select is enabled it will unselect the item).
14841 * If always select is enabled, it will call the callback function
14842 * everytime a item is pressed, so it will call when the item is selected,
14843 * and again when a selected item is pressed.
14845 * @see elm_list_always_select_mode_get()
14846 * @see elm_list_multi_select_set()
14850 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14853 * Get a value whether always select mode is enabled or not, meaning that
14854 * an item will always call its callback function, even if already selected.
14856 * @param obj The list object
14857 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14858 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14859 * @c EINA_FALSE is returned.
14861 * @see elm_list_always_select_mode_set() for details.
14865 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14868 * Set bouncing behaviour when the scrolled content reaches an edge.
14870 * Tell the internal scroller object whether it should bounce or not
14871 * when it reaches the respective edges for each axis.
14873 * @param obj The list object
14874 * @param h_bounce Whether to bounce or not in the horizontal axis.
14875 * @param v_bounce Whether to bounce or not in the vertical axis.
14877 * @see elm_scroller_bounce_set()
14881 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14884 * Get the bouncing behaviour of the internal scroller.
14886 * Get whether the internal scroller should bounce when the edge of each
14887 * axis is reached scrolling.
14889 * @param obj The list object.
14890 * @param h_bounce Pointer where to store the bounce state of the horizontal
14892 * @param v_bounce Pointer where to store the bounce state of the vertical
14895 * @see elm_scroller_bounce_get()
14896 * @see elm_list_bounce_set()
14900 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14903 * Set the scrollbar policy.
14905 * @param obj The list object
14906 * @param policy_h Horizontal scrollbar policy.
14907 * @param policy_v Vertical scrollbar policy.
14909 * This sets the scrollbar visibility policy for the given scroller.
14910 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
14911 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14912 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14913 * This applies respectively for the horizontal and vertical scrollbars.
14915 * The both are disabled by default, i.e., are set to
14916 * #ELM_SCROLLER_POLICY_OFF.
14920 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14923 * Get the scrollbar policy.
14925 * @see elm_list_scroller_policy_get() for details.
14927 * @param obj The list object.
14928 * @param policy_h Pointer where to store horizontal scrollbar policy.
14929 * @param policy_v Pointer where to store vertical scrollbar policy.
14933 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);
14936 * Append a new item to the list object.
14938 * @param obj The list object.
14939 * @param label The label of the list item.
14940 * @param icon The icon object to use for the left side of the item. An
14941 * icon can be any Evas object, but usually it is an icon created
14942 * with elm_icon_add().
14943 * @param end The icon object to use for the right side of the item. An
14944 * icon can be any Evas object.
14945 * @param func The function to call when the item is clicked.
14946 * @param data The data to associate with the item for related callbacks.
14948 * @return The created item or @c NULL upon failure.
14950 * A new item will be created and appended to the list, i.e., will
14951 * be set as @b last item.
14953 * Items created with this method can be deleted with
14954 * elm_list_item_del().
14956 * Associated @p data can be properly freed when item is deleted if a
14957 * callback function is set with elm_list_item_del_cb_set().
14959 * If a function is passed as argument, it will be called everytime this item
14960 * is selected, i.e., the user clicks over an unselected item.
14961 * If always select is enabled it will call this function every time
14962 * user clicks over an item (already selected or not).
14963 * If such function isn't needed, just passing
14964 * @c NULL as @p func is enough. The same should be done for @p data.
14966 * Simple example (with no function callback or data associated):
14968 * li = elm_list_add(win);
14969 * ic = elm_icon_add(win);
14970 * elm_icon_file_set(ic, "path/to/image", NULL);
14971 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14972 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14974 * evas_object_show(li);
14977 * @see elm_list_always_select_mode_set()
14978 * @see elm_list_item_del()
14979 * @see elm_list_item_del_cb_set()
14980 * @see elm_list_clear()
14981 * @see elm_icon_add()
14985 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);
14988 * Prepend a new item to the list object.
14990 * @param obj The list object.
14991 * @param label The label of the list item.
14992 * @param icon The icon object to use for the left side of the item. An
14993 * icon can be any Evas object, but usually it is an icon created
14994 * with elm_icon_add().
14995 * @param end The icon object to use for the right side of the item. An
14996 * icon can be any Evas object.
14997 * @param func The function to call when the item is clicked.
14998 * @param data The data to associate with the item for related callbacks.
15000 * @return The created item or @c NULL upon failure.
15002 * A new item will be created and prepended to the list, i.e., will
15003 * be set as @b first item.
15005 * Items created with this method can be deleted with
15006 * elm_list_item_del().
15008 * Associated @p data can be properly freed when item is deleted if a
15009 * callback function is set with elm_list_item_del_cb_set().
15011 * If a function is passed as argument, it will be called everytime this item
15012 * is selected, i.e., the user clicks over an unselected item.
15013 * If always select is enabled it will call this function every time
15014 * user clicks over an item (already selected or not).
15015 * If such function isn't needed, just passing
15016 * @c NULL as @p func is enough. The same should be done for @p data.
15018 * @see elm_list_item_append() for a simple code example.
15019 * @see elm_list_always_select_mode_set()
15020 * @see elm_list_item_del()
15021 * @see elm_list_item_del_cb_set()
15022 * @see elm_list_clear()
15023 * @see elm_icon_add()
15027 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);
15030 * Insert a new item into the list object before item @p before.
15032 * @param obj The list object.
15033 * @param before The list item to insert before.
15034 * @param label The label of the list item.
15035 * @param icon The icon object to use for the left side of the item. An
15036 * icon can be any Evas object, but usually it is an icon created
15037 * with elm_icon_add().
15038 * @param end The icon object to use for the right side of the item. An
15039 * icon can be any Evas object.
15040 * @param func The function to call when the item is clicked.
15041 * @param data The data to associate with the item for related callbacks.
15043 * @return The created item or @c NULL upon failure.
15045 * A new item will be created and added to the list. Its position in
15046 * this list will be just before item @p before.
15048 * Items created with this method can be deleted with
15049 * elm_list_item_del().
15051 * Associated @p data can be properly freed when item is deleted if a
15052 * callback function is set with elm_list_item_del_cb_set().
15054 * If a function is passed as argument, it will be called everytime this item
15055 * is selected, i.e., the user clicks over an unselected item.
15056 * If always select is enabled it will call this function every time
15057 * user clicks over an item (already selected or not).
15058 * If such function isn't needed, just passing
15059 * @c NULL as @p func is enough. The same should be done for @p data.
15061 * @see elm_list_item_append() for a simple code example.
15062 * @see elm_list_always_select_mode_set()
15063 * @see elm_list_item_del()
15064 * @see elm_list_item_del_cb_set()
15065 * @see elm_list_clear()
15066 * @see elm_icon_add()
15070 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);
15073 * Insert a new item into the list object after item @p after.
15075 * @param obj The list object.
15076 * @param after The list item to insert after.
15077 * @param label The label of the list item.
15078 * @param icon The icon object to use for the left side of the item. An
15079 * icon can be any Evas object, but usually it is an icon created
15080 * with elm_icon_add().
15081 * @param end The icon object to use for the right side of the item. An
15082 * icon can be any Evas object.
15083 * @param func The function to call when the item is clicked.
15084 * @param data The data to associate with the item for related callbacks.
15086 * @return The created item or @c NULL upon failure.
15088 * A new item will be created and added to the list. Its position in
15089 * this list will be just after item @p after.
15091 * Items created with this method can be deleted with
15092 * elm_list_item_del().
15094 * Associated @p data can be properly freed when item is deleted if a
15095 * callback function is set with elm_list_item_del_cb_set().
15097 * If a function is passed as argument, it will be called everytime this item
15098 * is selected, i.e., the user clicks over an unselected item.
15099 * If always select is enabled it will call this function every time
15100 * user clicks over an item (already selected or not).
15101 * If such function isn't needed, just passing
15102 * @c NULL as @p func is enough. The same should be done for @p data.
15104 * @see elm_list_item_append() for a simple code example.
15105 * @see elm_list_always_select_mode_set()
15106 * @see elm_list_item_del()
15107 * @see elm_list_item_del_cb_set()
15108 * @see elm_list_clear()
15109 * @see elm_icon_add()
15113 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);
15116 * Insert a new item into the sorted list object.
15118 * @param obj The list object.
15119 * @param label The label of the list item.
15120 * @param icon The icon object to use for the left side of the item. An
15121 * icon can be any Evas object, but usually it is an icon created
15122 * with elm_icon_add().
15123 * @param end The icon object to use for the right side of the item. An
15124 * icon can be any Evas object.
15125 * @param func The function to call when the item is clicked.
15126 * @param data The data to associate with the item for related callbacks.
15127 * @param cmp_func The comparing function to be used to sort list
15128 * items <b>by #Elm_List_Item item handles</b>. This function will
15129 * receive two items and compare them, returning a non-negative integer
15130 * if the second item should be place after the first, or negative value
15131 * if should be placed before.
15133 * @return The created item or @c NULL upon failure.
15135 * @note This function inserts values into a list object assuming it was
15136 * sorted and the result will be sorted.
15138 * A new item will be created and added to the list. Its position in
15139 * this list will be found comparing the new item with previously inserted
15140 * items using function @p cmp_func.
15142 * Items created with this method can be deleted with
15143 * elm_list_item_del().
15145 * Associated @p data can be properly freed when item is deleted if a
15146 * callback function is set with elm_list_item_del_cb_set().
15148 * If a function is passed as argument, it will be called everytime this item
15149 * is selected, i.e., the user clicks over an unselected item.
15150 * If always select is enabled it will call this function every time
15151 * user clicks over an item (already selected or not).
15152 * If such function isn't needed, just passing
15153 * @c NULL as @p func is enough. The same should be done for @p data.
15155 * @see elm_list_item_append() for a simple code example.
15156 * @see elm_list_always_select_mode_set()
15157 * @see elm_list_item_del()
15158 * @see elm_list_item_del_cb_set()
15159 * @see elm_list_clear()
15160 * @see elm_icon_add()
15164 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);
15167 * Remove all list's items.
15169 * @param obj The list object
15171 * @see elm_list_item_del()
15172 * @see elm_list_item_append()
15176 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15179 * Get a list of all the list items.
15181 * @param obj The list object
15182 * @return An @c Eina_List of list items, #Elm_List_Item,
15183 * or @c NULL on failure.
15185 * @see elm_list_item_append()
15186 * @see elm_list_item_del()
15187 * @see elm_list_clear()
15191 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15194 * Get the selected item.
15196 * @param obj The list object.
15197 * @return The selected list item.
15199 * The selected item can be unselected with function
15200 * elm_list_item_selected_set().
15202 * The selected item always will be highlighted on list.
15204 * @see elm_list_selected_items_get()
15208 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15211 * Return a list of the currently selected list items.
15213 * @param obj The list object.
15214 * @return An @c Eina_List of list items, #Elm_List_Item,
15215 * or @c NULL on failure.
15217 * Multiple items can be selected if multi select is enabled. It can be
15218 * done with elm_list_multi_select_set().
15220 * @see elm_list_selected_item_get()
15221 * @see elm_list_multi_select_set()
15225 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15228 * Set the selected state of an item.
15230 * @param item The list item
15231 * @param selected The selected state
15233 * This sets the selected state of the given item @p it.
15234 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15236 * If a new item is selected the previosly selected will be unselected,
15237 * unless multiple selection is enabled with elm_list_multi_select_set().
15238 * Previoulsy selected item can be get with function
15239 * elm_list_selected_item_get().
15241 * Selected items will be highlighted.
15243 * @see elm_list_item_selected_get()
15244 * @see elm_list_selected_item_get()
15245 * @see elm_list_multi_select_set()
15249 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15252 * Get whether the @p item is selected or not.
15254 * @param item The list item.
15255 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15256 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15258 * @see elm_list_selected_item_set() for details.
15259 * @see elm_list_item_selected_get()
15263 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15266 * Set or unset item as a separator.
15268 * @param it The list item.
15269 * @param setting @c EINA_TRUE to set item @p it as separator or
15270 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15272 * Items aren't set as separator by default.
15274 * If set as separator it will display separator theme, so won't display
15277 * @see elm_list_item_separator_get()
15281 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15284 * Get a value whether item is a separator or not.
15286 * @see elm_list_item_separator_set() for details.
15288 * @param it The list item.
15289 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15290 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15294 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15297 * Show @p item in the list view.
15299 * @param item The list item to be shown.
15301 * It won't animate list until item is visible. If such behavior is wanted,
15302 * use elm_list_bring_in() intead.
15306 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15309 * Bring in the given item to list view.
15311 * @param item The item.
15313 * This causes list to jump to the given item @p item and show it
15314 * (by scrolling), if it is not fully visible.
15316 * This may use animation to do so and take a period of time.
15318 * If animation isn't wanted, elm_list_item_show() can be used.
15322 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15325 * Delete them item from the list.
15327 * @param item The item of list to be deleted.
15329 * If deleting all list items is required, elm_list_clear()
15330 * should be used instead of getting items list and deleting each one.
15332 * @see elm_list_clear()
15333 * @see elm_list_item_append()
15334 * @see elm_list_item_del_cb_set()
15338 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15341 * Set the function called when a list item is freed.
15343 * @param item The item to set the callback on
15344 * @param func The function called
15346 * If there is a @p func, then it will be called prior item's memory release.
15347 * That will be called with the following arguments:
15349 * @li item's Evas object;
15352 * This way, a data associated to a list item could be properly freed.
15356 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15359 * Get the data associated to the item.
15361 * @param item The list item
15362 * @return The data associated to @p item
15364 * The return value is a pointer to data associated to @p item when it was
15365 * created, with function elm_list_item_append() or similar. If no data
15366 * was passed as argument, it will return @c NULL.
15368 * @see elm_list_item_append()
15372 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15375 * Get the left side icon associated to the item.
15377 * @param item The list item
15378 * @return The left side icon associated to @p item
15380 * The return value is a pointer to the icon associated to @p item when
15382 * created, with function elm_list_item_append() or similar, or later
15383 * with function elm_list_item_icon_set(). If no icon
15384 * was passed as argument, it will return @c NULL.
15386 * @see elm_list_item_append()
15387 * @see elm_list_item_icon_set()
15391 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15394 * Set the left side icon associated to the item.
15396 * @param item The list item
15397 * @param icon The left side icon object to associate with @p item
15399 * The icon object to use at left side of the item. An
15400 * icon can be any Evas object, but usually it is an icon created
15401 * with elm_icon_add().
15403 * Once the icon object is set, a previously set one will be deleted.
15404 * @warning Setting the same icon for two items will cause the icon to
15405 * dissapear from the first item.
15407 * If an icon was passed as argument on item creation, with function
15408 * elm_list_item_append() or similar, it will be already
15409 * associated to the item.
15411 * @see elm_list_item_append()
15412 * @see elm_list_item_icon_get()
15416 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15419 * Get the right side icon associated to the item.
15421 * @param item The list item
15422 * @return The right side icon associated to @p item
15424 * The return value is a pointer to the icon associated to @p item when
15426 * created, with function elm_list_item_append() or similar, or later
15427 * with function elm_list_item_icon_set(). If no icon
15428 * was passed as argument, it will return @c NULL.
15430 * @see elm_list_item_append()
15431 * @see elm_list_item_icon_set()
15435 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15438 * Set the right side icon associated to the item.
15440 * @param item The list item
15441 * @param end The right side icon object to associate with @p item
15443 * The icon object to use at right side of the item. An
15444 * icon can be any Evas object, but usually it is an icon created
15445 * with elm_icon_add().
15447 * Once the icon object is set, a previously set one will be deleted.
15448 * @warning Setting the same icon for two items will cause the icon to
15449 * dissapear from the first item.
15451 * If an icon was passed as argument on item creation, with function
15452 * elm_list_item_append() or similar, it will be already
15453 * associated to the item.
15455 * @see elm_list_item_append()
15456 * @see elm_list_item_end_get()
15460 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15463 * Gets the base object of the item.
15465 * @param item The list item
15466 * @return The base object associated with @p item
15468 * Base object is the @c Evas_Object that represents that item.
15472 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15473 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15476 * Get the label of item.
15478 * @param item The item of list.
15479 * @return The label of item.
15481 * The return value is a pointer to the label associated to @p item when
15482 * it was created, with function elm_list_item_append(), or later
15483 * with function elm_list_item_label_set. If no label
15484 * was passed as argument, it will return @c NULL.
15486 * @see elm_list_item_label_set() for more details.
15487 * @see elm_list_item_append()
15491 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15494 * Set the label of item.
15496 * @param item The item of list.
15497 * @param text The label of item.
15499 * The label to be displayed by the item.
15500 * Label will be placed between left and right side icons (if set).
15502 * If a label was passed as argument on item creation, with function
15503 * elm_list_item_append() or similar, it will be already
15504 * displayed by the item.
15506 * @see elm_list_item_label_get()
15507 * @see elm_list_item_append()
15511 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15515 * Get the item before @p it in list.
15517 * @param it The list item.
15518 * @return The item before @p it, or @c NULL if none or on failure.
15520 * @note If it is the first item, @c NULL will be returned.
15522 * @see elm_list_item_append()
15523 * @see elm_list_items_get()
15527 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15530 * Get the item after @p it in list.
15532 * @param it The list item.
15533 * @return The item after @p it, or @c NULL if none or on failure.
15535 * @note If it is the last item, @c NULL will be returned.
15537 * @see elm_list_item_append()
15538 * @see elm_list_items_get()
15542 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15545 * Sets the disabled/enabled state of a list item.
15547 * @param it The item.
15548 * @param disabled The disabled state.
15550 * A disabled item cannot be selected or unselected. It will also
15551 * change its appearance (generally greyed out). This sets the
15552 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15557 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15560 * Get a value whether list item is disabled or not.
15562 * @param it The item.
15563 * @return The disabled state.
15565 * @see elm_list_item_disabled_set() for more details.
15569 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15572 * Set the text to be shown in a given list item's tooltips.
15574 * @param item Target item.
15575 * @param text The text to set in the content.
15577 * Setup the text as tooltip to object. The item can have only one tooltip,
15578 * so any previous tooltip data - set with this function or
15579 * elm_list_item_tooltip_content_cb_set() - is removed.
15581 * @see elm_object_tooltip_text_set() for more details.
15585 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15589 * @brief Disable size restrictions on an object's tooltip
15590 * @param item The tooltip's anchor object
15591 * @param disable If EINA_TRUE, size restrictions are disabled
15592 * @return EINA_FALSE on failure, EINA_TRUE on success
15594 * This function allows a tooltip to expand beyond its parant window's canvas.
15595 * It will instead be limited only by the size of the display.
15597 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15599 * @brief Retrieve size restriction state of an object's tooltip
15600 * @param obj The tooltip's anchor object
15601 * @return If EINA_TRUE, size restrictions are disabled
15603 * This function returns whether a tooltip is allowed to expand beyond
15604 * its parant window's canvas.
15605 * It will instead be limited only by the size of the display.
15607 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15610 * Set the content to be shown in the tooltip item.
15612 * Setup the tooltip to item. The item can have only one tooltip,
15613 * so any previous tooltip data is removed. @p func(with @p data) will
15614 * be called every time that need show the tooltip and it should
15615 * return a valid Evas_Object. This object is then managed fully by
15616 * tooltip system and is deleted when the tooltip is gone.
15618 * @param item the list item being attached a tooltip.
15619 * @param func the function used to create the tooltip contents.
15620 * @param data what to provide to @a func as callback data/context.
15621 * @param del_cb called when data is not needed anymore, either when
15622 * another callback replaces @a func, the tooltip is unset with
15623 * elm_list_item_tooltip_unset() or the owner @a item
15624 * dies. This callback receives as the first parameter the
15625 * given @a data, and @c event_info is the item.
15627 * @see elm_object_tooltip_content_cb_set() for more details.
15631 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);
15634 * Unset tooltip from item.
15636 * @param item list item to remove previously set tooltip.
15638 * Remove tooltip from item. The callback provided as del_cb to
15639 * elm_list_item_tooltip_content_cb_set() will be called to notify
15640 * it is not used anymore.
15642 * @see elm_object_tooltip_unset() for more details.
15643 * @see elm_list_item_tooltip_content_cb_set()
15647 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15650 * Sets a different style for this item tooltip.
15652 * @note before you set a style you should define a tooltip with
15653 * elm_list_item_tooltip_content_cb_set() or
15654 * elm_list_item_tooltip_text_set()
15656 * @param item list item with tooltip already set.
15657 * @param style the theme style to use (default, transparent, ...)
15659 * @see elm_object_tooltip_style_set() for more details.
15663 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15666 * Get the style for this item tooltip.
15668 * @param item list item with tooltip already set.
15669 * @return style the theme style in use, defaults to "default". If the
15670 * object does not have a tooltip set, then NULL is returned.
15672 * @see elm_object_tooltip_style_get() for more details.
15673 * @see elm_list_item_tooltip_style_set()
15677 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15680 * Set the type of mouse pointer/cursor decoration to be shown,
15681 * when the mouse pointer is over the given list widget item
15683 * @param item list item to customize cursor on
15684 * @param cursor the cursor type's name
15686 * This function works analogously as elm_object_cursor_set(), but
15687 * here the cursor's changing area is restricted to the item's
15688 * area, and not the whole widget's. Note that that item cursors
15689 * have precedence over widget cursors, so that a mouse over an
15690 * item with custom cursor set will always show @b that cursor.
15692 * If this function is called twice for an object, a previously set
15693 * cursor will be unset on the second call.
15695 * @see elm_object_cursor_set()
15696 * @see elm_list_item_cursor_get()
15697 * @see elm_list_item_cursor_unset()
15701 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15704 * Get the type of mouse pointer/cursor decoration set to be shown,
15705 * when the mouse pointer is over the given list widget item
15707 * @param item list item with custom cursor set
15708 * @return the cursor type's name or @c NULL, if no custom cursors
15709 * were set to @p item (and on errors)
15711 * @see elm_object_cursor_get()
15712 * @see elm_list_item_cursor_set()
15713 * @see elm_list_item_cursor_unset()
15717 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15720 * Unset any custom mouse pointer/cursor decoration set to be
15721 * shown, when the mouse pointer is over the given list widget
15722 * item, thus making it show the @b default cursor again.
15724 * @param item a list item
15726 * Use this call to undo any custom settings on this item's cursor
15727 * decoration, bringing it back to defaults (no custom style set).
15729 * @see elm_object_cursor_unset()
15730 * @see elm_list_item_cursor_set()
15734 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15737 * Set a different @b style for a given custom cursor set for a
15740 * @param item list item with custom cursor set
15741 * @param style the <b>theme style</b> to use (e.g. @c "default",
15742 * @c "transparent", etc)
15744 * This function only makes sense when one is using custom mouse
15745 * cursor decorations <b>defined in a theme file</b>, which can have,
15746 * given a cursor name/type, <b>alternate styles</b> on it. It
15747 * works analogously as elm_object_cursor_style_set(), but here
15748 * applyed only to list item objects.
15750 * @warning Before you set a cursor style you should have definen a
15751 * custom cursor previously on the item, with
15752 * elm_list_item_cursor_set()
15754 * @see elm_list_item_cursor_engine_only_set()
15755 * @see elm_list_item_cursor_style_get()
15759 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15762 * Get the current @b style set for a given list item's custom
15765 * @param item list item with custom cursor set.
15766 * @return style the cursor style in use. If the object does not
15767 * have a cursor set, then @c NULL is returned.
15769 * @see elm_list_item_cursor_style_set() for more details
15773 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15776 * Set if the (custom)cursor for a given list item should be
15777 * searched in its theme, also, or should only rely on the
15778 * rendering engine.
15780 * @param item item with custom (custom) cursor already set on
15781 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15782 * only on those provided by the rendering engine, @c EINA_FALSE to
15783 * have them searched on the widget's theme, as well.
15785 * @note This call is of use only if you've set a custom cursor
15786 * for list items, with elm_list_item_cursor_set().
15788 * @note By default, cursors will only be looked for between those
15789 * provided by the rendering engine.
15793 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15796 * Get if the (custom) cursor for a given list item is being
15797 * searched in its theme, also, or is only relying on the rendering
15800 * @param item a list item
15801 * @return @c EINA_TRUE, if cursors are being looked for only on
15802 * those provided by the rendering engine, @c EINA_FALSE if they
15803 * are being searched on the widget's theme, as well.
15805 * @see elm_list_item_cursor_engine_only_set(), for more details
15809 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15816 * @defgroup Slider Slider
15817 * @ingroup Elementary
15819 * @image html img/widget/slider/preview-00.png
15820 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15822 * The slider adds a dragable “slider” widget for selecting the value of
15823 * something within a range.
15825 * A slider can be horizontal or vertical. It can contain an Icon and has a
15826 * primary label as well as a units label (that is formatted with floating
15827 * point values and thus accepts a printf-style format string, like
15828 * “%1.2f units”. There is also an indicator string that may be somewhere
15829 * else (like on the slider itself) that also accepts a format string like
15830 * units. Label, Icon Unit and Indicator strings/objects are optional.
15832 * A slider may be inverted which means values invert, with high vales being
15833 * on the left or top and low values on the right or bottom (as opposed to
15834 * normally being low on the left or top and high on the bottom and right).
15836 * The slider should have its minimum and maximum values set by the
15837 * application with elm_slider_min_max_set() and value should also be set by
15838 * the application before use with elm_slider_value_set(). The span of the
15839 * slider is its length (horizontally or vertically). This will be scaled by
15840 * the object or applications scaling factor. At any point code can query the
15841 * slider for its value with elm_slider_value_get().
15843 * Smart callbacks one can listen to:
15844 * - "changed" - Whenever the slider value is changed by the user.
15845 * - "slider,drag,start" - dragging the slider indicator around has started.
15846 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15847 * - "delay,changed" - A short time after the value is changed by the user.
15848 * This will be called only when the user stops dragging for
15849 * a very short period or when they release their
15850 * finger/mouse, so it avoids possibly expensive reactions to
15851 * the value change.
15853 * Available styles for it:
15856 * Here is an example on its usage:
15857 * @li @ref slider_example
15861 * @addtogroup Slider
15866 * Add a new slider widget to the given parent Elementary
15867 * (container) object.
15869 * @param parent The parent object.
15870 * @return a new slider widget handle or @c NULL, on errors.
15872 * This function inserts a new slider widget on the canvas.
15876 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15879 * Set the label of a given slider widget
15881 * @param obj The progress bar object
15882 * @param label The text label string, in UTF-8
15885 * @deprecated use elm_object_text_set() instead.
15887 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15890 * Get the label of a given slider widget
15892 * @param obj The progressbar object
15893 * @return The text label string, in UTF-8
15896 * @deprecated use elm_object_text_get() instead.
15898 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15901 * Set the icon object of the slider object.
15903 * @param obj The slider object.
15904 * @param icon The icon object.
15906 * On horizontal mode, icon is placed at left, and on vertical mode,
15909 * @note Once the icon object is set, a previously set one will be deleted.
15910 * If you want to keep that old content object, use the
15911 * elm_slider_icon_unset() function.
15913 * @warning If the object being set does not have minimum size hints set,
15914 * it won't get properly displayed.
15918 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15921 * Unset an icon set on a given slider widget.
15923 * @param obj The slider object.
15924 * @return The icon object that was being used, if any was set, or
15925 * @c NULL, otherwise (and on errors).
15927 * On horizontal mode, icon is placed at left, and on vertical mode,
15930 * This call will unparent and return the icon object which was set
15931 * for this widget, previously, on success.
15933 * @see elm_slider_icon_set() for more details
15934 * @see elm_slider_icon_get()
15938 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15941 * Retrieve the icon object set for a given slider widget.
15943 * @param obj The slider object.
15944 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15945 * otherwise (and on errors).
15947 * On horizontal mode, icon is placed at left, and on vertical mode,
15950 * @see elm_slider_icon_set() for more details
15951 * @see elm_slider_icon_unset()
15955 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15958 * Set the end object of the slider object.
15960 * @param obj The slider object.
15961 * @param end The end object.
15963 * On horizontal mode, end is placed at left, and on vertical mode,
15964 * placed at bottom.
15966 * @note Once the icon object is set, a previously set one will be deleted.
15967 * If you want to keep that old content object, use the
15968 * elm_slider_end_unset() function.
15970 * @warning If the object being set does not have minimum size hints set,
15971 * it won't get properly displayed.
15975 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15978 * Unset an end object set on a given slider widget.
15980 * @param obj The slider object.
15981 * @return The end object that was being used, if any was set, or
15982 * @c NULL, otherwise (and on errors).
15984 * On horizontal mode, end is placed at left, and on vertical mode,
15985 * placed at bottom.
15987 * This call will unparent and return the icon object which was set
15988 * for this widget, previously, on success.
15990 * @see elm_slider_end_set() for more details.
15991 * @see elm_slider_end_get()
15995 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15998 * Retrieve the end object set for a given slider widget.
16000 * @param obj The slider object.
16001 * @return The end object's handle, if @p obj had one set, or @c NULL,
16002 * otherwise (and on errors).
16004 * On horizontal mode, icon is placed at right, and on vertical mode,
16005 * placed at bottom.
16007 * @see elm_slider_end_set() for more details.
16008 * @see elm_slider_end_unset()
16012 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16015 * Set the (exact) length of the bar region of a given slider widget.
16017 * @param obj The slider object.
16018 * @param size The length of the slider's bar region.
16020 * This sets the minimum width (when in horizontal mode) or height
16021 * (when in vertical mode) of the actual bar area of the slider
16022 * @p obj. This in turn affects the object's minimum size. Use
16023 * this when you're not setting other size hints expanding on the
16024 * given direction (like weight and alignment hints) and you would
16025 * like it to have a specific size.
16027 * @note Icon, end, label, indicator and unit text around @p obj
16028 * will require their
16029 * own space, which will make @p obj to require more the @p size,
16032 * @see elm_slider_span_size_get()
16036 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16039 * Get the length set for the bar region of a given slider widget
16041 * @param obj The slider object.
16042 * @return The length of the slider's bar region.
16044 * If that size was not set previously, with
16045 * elm_slider_span_size_set(), this call will return @c 0.
16049 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16052 * Set the format string for the unit label.
16054 * @param obj The slider object.
16055 * @param format The format string for the unit display.
16057 * Unit label is displayed all the time, if set, after slider's bar.
16058 * In horizontal mode, at right and in vertical mode, at bottom.
16060 * If @c NULL, unit label won't be visible. If not it sets the format
16061 * string for the label text. To the label text is provided a floating point
16062 * value, so the label text can display up to 1 floating point value.
16063 * Note that this is optional.
16065 * Use a format string such as "%1.2f meters" for example, and it will
16066 * display values like: "3.14 meters" for a value equal to 3.14159.
16068 * Default is unit label disabled.
16070 * @see elm_slider_indicator_format_get()
16074 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16077 * Get the unit label format of the slider.
16079 * @param obj The slider object.
16080 * @return The unit label format string in UTF-8.
16082 * Unit label is displayed all the time, if set, after slider's bar.
16083 * In horizontal mode, at right and in vertical mode, at bottom.
16085 * @see elm_slider_unit_format_set() for more
16086 * information on how this works.
16090 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16093 * Set the format string for the indicator label.
16095 * @param obj The slider object.
16096 * @param indicator The format string for the indicator display.
16098 * The slider may display its value somewhere else then unit label,
16099 * for example, above the slider knob that is dragged around. This function
16100 * sets the format string used for this.
16102 * If @c NULL, indicator label won't be visible. If not it sets the format
16103 * string for the label text. To the label text is provided a floating point
16104 * value, so the label text can display up to 1 floating point value.
16105 * Note that this is optional.
16107 * Use a format string such as "%1.2f meters" for example, and it will
16108 * display values like: "3.14 meters" for a value equal to 3.14159.
16110 * Default is indicator label disabled.
16112 * @see elm_slider_indicator_format_get()
16116 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16119 * Get the indicator label format of the slider.
16121 * @param obj The slider object.
16122 * @return The indicator label format string in UTF-8.
16124 * The slider may display its value somewhere else then unit label,
16125 * for example, above the slider knob that is dragged around. This function
16126 * gets the format string used for this.
16128 * @see elm_slider_indicator_format_set() for more
16129 * information on how this works.
16133 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16136 * Set the format function pointer for the indicator label
16138 * @param obj The slider object.
16139 * @param func The indicator format function.
16140 * @param free_func The freeing function for the format string.
16142 * Set the callback function to format the indicator string.
16144 * @see elm_slider_indicator_format_set() for more info on how this works.
16148 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);
16151 * Set the format function pointer for the units label
16153 * @param obj The slider object.
16154 * @param func The units format function.
16155 * @param free_func The freeing function for the format string.
16157 * Set the callback function to format the indicator string.
16159 * @see elm_slider_units_format_set() for more info on how this works.
16163 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);
16166 * Set the orientation of a given slider widget.
16168 * @param obj The slider object.
16169 * @param horizontal Use @c EINA_TRUE to make @p obj to be
16170 * @b horizontal, @c EINA_FALSE to make it @b vertical.
16172 * Use this function to change how your slider is to be
16173 * disposed: vertically or horizontally.
16175 * By default it's displayed horizontally.
16177 * @see elm_slider_horizontal_get()
16181 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16184 * Retrieve the orientation of a given slider widget
16186 * @param obj The slider object.
16187 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16188 * @c EINA_FALSE if it's @b vertical (and on errors).
16190 * @see elm_slider_horizontal_set() for more details.
16194 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16197 * Set the minimum and maximum values for the slider.
16199 * @param obj The slider object.
16200 * @param min The minimum value.
16201 * @param max The maximum value.
16203 * Define the allowed range of values to be selected by the user.
16205 * If actual value is less than @p min, it will be updated to @p min. If it
16206 * is bigger then @p max, will be updated to @p max. Actual value can be
16207 * get with elm_slider_value_get().
16209 * By default, min is equal to 0.0, and max is equal to 1.0.
16211 * @warning Maximum must be greater than minimum, otherwise behavior
16214 * @see elm_slider_min_max_get()
16218 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16221 * Get the minimum and maximum values of the slider.
16223 * @param obj The slider object.
16224 * @param min Pointer where to store the minimum value.
16225 * @param max Pointer where to store the maximum value.
16227 * @note If only one value is needed, the other pointer can be passed
16230 * @see elm_slider_min_max_set() for details.
16234 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16237 * Set the value the slider displays.
16239 * @param obj The slider object.
16240 * @param val The value to be displayed.
16242 * Value will be presented on the unit label following format specified with
16243 * elm_slider_unit_format_set() and on indicator with
16244 * elm_slider_indicator_format_set().
16246 * @warning The value must to be between min and max values. This values
16247 * are set by elm_slider_min_max_set().
16249 * @see elm_slider_value_get()
16250 * @see elm_slider_unit_format_set()
16251 * @see elm_slider_indicator_format_set()
16252 * @see elm_slider_min_max_set()
16256 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16259 * Get the value displayed by the spinner.
16261 * @param obj The spinner object.
16262 * @return The value displayed.
16264 * @see elm_spinner_value_set() for details.
16268 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16271 * Invert a given slider widget's displaying values order
16273 * @param obj The slider object.
16274 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16275 * @c EINA_FALSE to bring it back to default, non-inverted values.
16277 * A slider may be @b inverted, in which state it gets its
16278 * values inverted, with high vales being on the left or top and
16279 * low values on the right or bottom, as opposed to normally have
16280 * the low values on the former and high values on the latter,
16281 * respectively, for horizontal and vertical modes.
16283 * @see elm_slider_inverted_get()
16287 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16290 * Get whether a given slider widget's displaying values are
16293 * @param obj The slider object.
16294 * @return @c EINA_TRUE, if @p obj has inverted values,
16295 * @c EINA_FALSE otherwise (and on errors).
16297 * @see elm_slider_inverted_set() for more details.
16301 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16304 * Set whether to enlarge slider indicator (augmented knob) or not.
16306 * @param obj The slider object.
16307 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16308 * let the knob always at default size.
16310 * By default, indicator will be bigger while dragged by the user.
16312 * @warning It won't display values set with
16313 * elm_slider_indicator_format_set() if you disable indicator.
16317 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16320 * Get whether a given slider widget's enlarging indicator or not.
16322 * @param obj The slider object.
16323 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16324 * @c EINA_FALSE otherwise (and on errors).
16326 * @see elm_slider_indicator_show_set() for details.
16330 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16337 * @addtogroup Actionslider Actionslider
16339 * @image html img/widget/actionslider/preview-00.png
16340 * @image latex img/widget/actionslider/preview-00.eps
16342 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16343 * properties. The indicator is the element the user drags to choose a label.
16344 * When the position is set with magnet, when released the indicator will be
16345 * moved to it if it's nearest the magnetized position.
16347 * @note By default all positions are set as enabled.
16349 * Signals that you can add callbacks for are:
16351 * "selected" - when user selects an enabled position (the label is passed
16354 * "pos_changed" - when the indicator reaches any of the positions("left",
16355 * "right" or "center").
16357 * See an example of actionslider usage @ref actionslider_example_page "here"
16360 typedef enum _Elm_Actionslider_Pos
16362 ELM_ACTIONSLIDER_NONE = 0,
16363 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16364 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16365 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16366 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16367 } Elm_Actionslider_Pos;
16370 * Add a new actionslider to the parent.
16372 * @param parent The parent object
16373 * @return The new actionslider object or NULL if it cannot be created
16375 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16377 * Set actionslider labels.
16379 * @param obj The actionslider object
16380 * @param left_label The label to be set on the left.
16381 * @param center_label The label to be set on the center.
16382 * @param right_label The label to be set on the right.
16383 * @deprecated use elm_object_text_set() instead.
16385 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);
16387 * Get actionslider labels.
16389 * @param obj The actionslider object
16390 * @param left_label A char** to place the left_label of @p obj into.
16391 * @param center_label A char** to place the center_label of @p obj into.
16392 * @param right_label A char** to place the right_label of @p obj into.
16393 * @deprecated use elm_object_text_set() instead.
16395 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);
16397 * Get actionslider selected label.
16399 * @param obj The actionslider object
16400 * @return The selected label
16402 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16404 * Set actionslider indicator position.
16406 * @param obj The actionslider object.
16407 * @param pos The position of the indicator.
16409 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16411 * Get actionslider indicator position.
16413 * @param obj The actionslider object.
16414 * @return The position of the indicator.
16416 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16418 * Set actionslider magnet position. To make multiple positions magnets @c or
16419 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16421 * @param obj The actionslider object.
16422 * @param pos Bit mask indicating the magnet positions.
16424 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16426 * Get actionslider magnet position.
16428 * @param obj The actionslider object.
16429 * @return The positions with magnet property.
16431 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16433 * Set actionslider enabled position. To set multiple positions as enabled @c or
16434 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16436 * @note All the positions are enabled by default.
16438 * @param obj The actionslider object.
16439 * @param pos Bit mask indicating the enabled positions.
16441 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16443 * Get actionslider enabled position.
16445 * @param obj The actionslider object.
16446 * @return The enabled positions.
16448 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16450 * Set the label used on the indicator.
16452 * @param obj The actionslider object
16453 * @param label The label to be set on the indicator.
16454 * @deprecated use elm_object_text_set() instead.
16456 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16458 * Get the label used on the indicator object.
16460 * @param obj The actionslider object
16461 * @return The indicator label
16462 * @deprecated use elm_object_text_get() instead.
16464 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16470 * @defgroup Genlist Genlist
16472 * @image html img/widget/genlist/preview-00.png
16473 * @image latex img/widget/genlist/preview-00.eps
16474 * @image html img/genlist.png
16475 * @image latex img/genlist.eps
16477 * This widget aims to have more expansive list than the simple list in
16478 * Elementary that could have more flexible items and allow many more entries
16479 * while still being fast and low on memory usage. At the same time it was
16480 * also made to be able to do tree structures. But the price to pay is more
16481 * complexity when it comes to usage. If all you want is a simple list with
16482 * icons and a single label, use the normal @ref List object.
16484 * Genlist has a fairly large API, mostly because it's relatively complex,
16485 * trying to be both expansive, powerful and efficient. First we will begin
16486 * an overview on the theory behind genlist.
16488 * @section Genlist_Item_Class Genlist item classes - creating items
16490 * In order to have the ability to add and delete items on the fly, genlist
16491 * implements a class (callback) system where the application provides a
16492 * structure with information about that type of item (genlist may contain
16493 * multiple different items with different classes, states and styles).
16494 * Genlist will call the functions in this struct (methods) when an item is
16495 * "realized" (i.e., created dynamically, while the user is scrolling the
16496 * grid). All objects will simply be deleted when no longer needed with
16497 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16498 * following members:
16499 * - @c item_style - This is a constant string and simply defines the name
16500 * of the item style. It @b must be specified and the default should be @c
16502 * - @c mode_item_style - This is a constant string and simply defines the
16503 * name of the style that will be used for mode animations. It can be left
16504 * as @c NULL if you don't plan to use Genlist mode. See
16505 * elm_genlist_item_mode_set() for more info.
16507 * - @c func - A struct with pointers to functions that will be called when
16508 * an item is going to be actually created. All of them receive a @c data
16509 * parameter that will point to the same data passed to
16510 * elm_genlist_item_append() and related item creation functions, and a @c
16511 * obj parameter that points to the genlist object itself.
16513 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16514 * state_get and @c del. The 3 first functions also receive a @c part
16515 * parameter described below. A brief description of these functions follows:
16517 * - @c label_get - The @c part parameter is the name string of one of the
16518 * existing text parts in the Edje group implementing the item's theme.
16519 * This function @b must return a strdup'()ed string, as the caller will
16520 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16521 * - @c icon_get - The @c part parameter is the name string of one of the
16522 * existing (icon) swallow parts in the Edje group implementing the item's
16523 * theme. It must return @c NULL, when no icon is desired, or a valid
16524 * object handle, otherwise. The object will be deleted by the genlist on
16525 * its deletion or when the item is "unrealized". See
16526 * #Elm_Genlist_Item_Icon_Get_Cb.
16527 * - @c func.state_get - The @c part parameter is the name string of one of
16528 * the state parts in the Edje group implementing the item's theme. Return
16529 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16530 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16531 * and @c "elm" as "emission" and "source" arguments, respectively, when
16532 * the state is true (the default is false), where @c XXX is the name of
16533 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16534 * - @c func.del - This is intended for use when genlist items are deleted,
16535 * so any data attached to the item (e.g. its data parameter on creation)
16536 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16538 * available item styles:
16540 * - default_style - The text part is a textblock
16542 * @image html img/widget/genlist/preview-04.png
16543 * @image latex img/widget/genlist/preview-04.eps
16547 * @image html img/widget/genlist/preview-01.png
16548 * @image latex img/widget/genlist/preview-01.eps
16550 * - icon_top_text_bottom
16552 * @image html img/widget/genlist/preview-02.png
16553 * @image latex img/widget/genlist/preview-02.eps
16557 * @image html img/widget/genlist/preview-03.png
16558 * @image latex img/widget/genlist/preview-03.eps
16560 * @section Genlist_Items Structure of items
16562 * An item in a genlist can have 0 or more text labels (they can be regular
16563 * text or textblock Evas objects - that's up to the style to determine), 0
16564 * or more icons (which are simply objects swallowed into the genlist item's
16565 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16566 * behavior left to the user to define. The Edje part names for each of
16567 * these properties will be looked up, in the theme file for the genlist,
16568 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16569 * "states", respectively. For each of those properties, if more than one
16570 * part is provided, they must have names listed separated by spaces in the
16571 * data fields. For the default genlist item theme, we have @b one label
16572 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16573 * "elm.swallow.end") and @b no state parts.
16575 * A genlist item may be at one of several styles. Elementary provides one
16576 * by default - "default", but this can be extended by system or application
16577 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16580 * @section Genlist_Manipulation Editing and Navigating
16582 * Items can be added by several calls. All of them return a @ref
16583 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16584 * They all take a data parameter that is meant to be used for a handle to
16585 * the applications internal data (eg the struct with the original item
16586 * data). The parent parameter is the parent genlist item this belongs to if
16587 * it is a tree or an indexed group, and NULL if there is no parent. The
16588 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16589 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16590 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16591 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16592 * is set then this item is group index item that is displayed at the top
16593 * until the next group comes. The func parameter is a convenience callback
16594 * that is called when the item is selected and the data parameter will be
16595 * the func_data parameter, obj be the genlist object and event_info will be
16596 * the genlist item.
16598 * elm_genlist_item_append() adds an item to the end of the list, or if
16599 * there is a parent, to the end of all the child items of the parent.
16600 * elm_genlist_item_prepend() is the same but adds to the beginning of
16601 * the list or children list. elm_genlist_item_insert_before() inserts at
16602 * item before another item and elm_genlist_item_insert_after() inserts after
16603 * the indicated item.
16605 * The application can clear the list with elm_genlist_clear() which deletes
16606 * all the items in the list and elm_genlist_item_del() will delete a specific
16607 * item. elm_genlist_item_subitems_clear() will clear all items that are
16608 * children of the indicated parent item.
16610 * To help inspect list items you can jump to the item at the top of the list
16611 * with elm_genlist_first_item_get() which will return the item pointer, and
16612 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16613 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16614 * and previous items respectively relative to the indicated item. Using
16615 * these calls you can walk the entire item list/tree. Note that as a tree
16616 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16617 * let you know which item is the parent (and thus know how to skip them if
16620 * @section Genlist_Muti_Selection Multi-selection
16622 * If the application wants multiple items to be able to be selected,
16623 * elm_genlist_multi_select_set() can enable this. If the list is
16624 * single-selection only (the default), then elm_genlist_selected_item_get()
16625 * will return the selected item, if any, or NULL I none is selected. If the
16626 * list is multi-select then elm_genlist_selected_items_get() will return a
16627 * list (that is only valid as long as no items are modified (added, deleted,
16628 * selected or unselected)).
16630 * @section Genlist_Usage_Hints Usage hints
16632 * There are also convenience functions. elm_genlist_item_genlist_get() will
16633 * return the genlist object the item belongs to. elm_genlist_item_show()
16634 * will make the scroller scroll to show that specific item so its visible.
16635 * elm_genlist_item_data_get() returns the data pointer set by the item
16636 * creation functions.
16638 * If an item changes (state of boolean changes, label or icons change),
16639 * then use elm_genlist_item_update() to have genlist update the item with
16640 * the new state. Genlist will re-realize the item thus call the functions
16641 * in the _Elm_Genlist_Item_Class for that item.
16643 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16644 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16645 * to expand/contract an item and get its expanded state, use
16646 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16647 * again to make an item disabled (unable to be selected and appear
16648 * differently) use elm_genlist_item_disabled_set() to set this and
16649 * elm_genlist_item_disabled_get() to get the disabled state.
16651 * In general to indicate how the genlist should expand items horizontally to
16652 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16653 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16654 * mode means that if items are too wide to fit, the scroller will scroll
16655 * horizontally. Otherwise items are expanded to fill the width of the
16656 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16657 * to the viewport width and limited to that size. This can be combined with
16658 * a different style that uses edjes' ellipsis feature (cutting text off like
16661 * Items will only call their selection func and callback when first becoming
16662 * selected. Any further clicks will do nothing, unless you enable always
16663 * select with elm_genlist_always_select_mode_set(). This means even if
16664 * selected, every click will make the selected callbacks be called.
16665 * elm_genlist_no_select_mode_set() will turn off the ability to select
16666 * items entirely and they will neither appear selected nor call selected
16667 * callback functions.
16669 * Remember that you can create new styles and add your own theme augmentation
16670 * per application with elm_theme_extension_add(). If you absolutely must
16671 * have a specific style that overrides any theme the user or system sets up
16672 * you can use elm_theme_overlay_add() to add such a file.
16674 * @section Genlist_Implementation Implementation
16676 * Evas tracks every object you create. Every time it processes an event
16677 * (mouse move, down, up etc.) it needs to walk through objects and find out
16678 * what event that affects. Even worse every time it renders display updates,
16679 * in order to just calculate what to re-draw, it needs to walk through many
16680 * many many objects. Thus, the more objects you keep active, the more
16681 * overhead Evas has in just doing its work. It is advisable to keep your
16682 * active objects to the minimum working set you need. Also remember that
16683 * object creation and deletion carries an overhead, so there is a
16684 * middle-ground, which is not easily determined. But don't keep massive lists
16685 * of objects you can't see or use. Genlist does this with list objects. It
16686 * creates and destroys them dynamically as you scroll around. It groups them
16687 * into blocks so it can determine the visibility etc. of a whole block at
16688 * once as opposed to having to walk the whole list. This 2-level list allows
16689 * for very large numbers of items to be in the list (tests have used up to
16690 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16691 * may be different sizes, every item added needs to be calculated as to its
16692 * size and thus this presents a lot of overhead on populating the list, this
16693 * genlist employs a queue. Any item added is queued and spooled off over
16694 * time, actually appearing some time later, so if your list has many members
16695 * you may find it takes a while for them to all appear, with your process
16696 * consuming a lot of CPU while it is busy spooling.
16698 * Genlist also implements a tree structure, but it does so with callbacks to
16699 * the application, with the application filling in tree structures when
16700 * requested (allowing for efficient building of a very deep tree that could
16701 * even be used for file-management). See the above smart signal callbacks for
16704 * @section Genlist_Smart_Events Genlist smart events
16706 * Signals that you can add callbacks for are:
16707 * - @c "activated" - The user has double-clicked or pressed
16708 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16709 * item that was activated.
16710 * - @c "clicked,double" - The user has double-clicked an item. The @c
16711 * event_info parameter is the item that was double-clicked.
16712 * - @c "selected" - This is called when a user has made an item selected.
16713 * The event_info parameter is the genlist item that was selected.
16714 * - @c "unselected" - This is called when a user has made an item
16715 * unselected. The event_info parameter is the genlist item that was
16717 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16718 * called and the item is now meant to be expanded. The event_info
16719 * parameter is the genlist item that was indicated to expand. It is the
16720 * job of this callback to then fill in the child items.
16721 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16722 * called and the item is now meant to be contracted. The event_info
16723 * parameter is the genlist item that was indicated to contract. It is the
16724 * job of this callback to then delete the child items.
16725 * - @c "expand,request" - This is called when a user has indicated they want
16726 * to expand a tree branch item. The callback should decide if the item can
16727 * expand (has any children) and then call elm_genlist_item_expanded_set()
16728 * appropriately to set the state. The event_info parameter is the genlist
16729 * item that was indicated to expand.
16730 * - @c "contract,request" - This is called when a user has indicated they
16731 * want to contract a tree branch item. The callback should decide if the
16732 * item can contract (has any children) and then call
16733 * elm_genlist_item_expanded_set() appropriately to set the state. The
16734 * event_info parameter is the genlist item that was indicated to contract.
16735 * - @c "realized" - This is called when the item in the list is created as a
16736 * real evas object. event_info parameter is the genlist item that was
16737 * created. The object may be deleted at any time, so it is up to the
16738 * caller to not use the object pointer from elm_genlist_item_object_get()
16739 * in a way where it may point to freed objects.
16740 * - @c "unrealized" - This is called just before an item is unrealized.
16741 * After this call icon objects provided will be deleted and the item
16742 * object itself delete or be put into a floating cache.
16743 * - @c "drag,start,up" - This is called when the item in the list has been
16744 * dragged (not scrolled) up.
16745 * - @c "drag,start,down" - This is called when the item in the list has been
16746 * dragged (not scrolled) down.
16747 * - @c "drag,start,left" - This is called when the item in the list has been
16748 * dragged (not scrolled) left.
16749 * - @c "drag,start,right" - This is called when the item in the list has
16750 * been dragged (not scrolled) right.
16751 * - @c "drag,stop" - This is called when the item in the list has stopped
16753 * - @c "drag" - This is called when the item in the list is being dragged.
16754 * - @c "longpressed" - This is called when the item is pressed for a certain
16755 * amount of time. By default it's 1 second.
16756 * - @c "scroll,anim,start" - This is called when scrolling animation has
16758 * - @c "scroll,anim,stop" - This is called when scrolling animation has
16760 * - @c "scroll,drag,start" - This is called when dragging the content has
16762 * - @c "scroll,drag,stop" - This is called when dragging the content has
16764 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16766 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16767 * until the bottom edge.
16768 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16769 * until the left edge.
16770 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16771 * until the right edge.
16772 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16774 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16776 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16778 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16780 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16781 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16782 * multi-touch pinched in.
16783 * - @c "swipe" - This is called when the genlist is swiped.
16785 * @section Genlist_Examples Examples
16787 * Here is a list of examples that use the genlist, trying to show some of
16788 * its capabilities:
16789 * - @ref genlist_example_01
16790 * - @ref genlist_example_02
16791 * - @ref genlist_example_03
16792 * - @ref genlist_example_04
16793 * - @ref genlist_example_05
16797 * @addtogroup Genlist
16802 * @enum _Elm_Genlist_Item_Flags
16803 * @typedef Elm_Genlist_Item_Flags
16805 * Defines if the item is of any special type (has subitems or it's the
16806 * index of a group), or is just a simple item.
16810 typedef enum _Elm_Genlist_Item_Flags
16812 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16813 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16814 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16815 } Elm_Genlist_Item_Flags;
16816 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16817 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16818 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16819 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16820 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. */
16821 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. */
16822 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16823 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16825 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16826 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16827 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16828 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16831 * @struct _Elm_Genlist_Item_Class
16833 * Genlist item class definition structs.
16835 * This struct contains the style and fetching functions that will define the
16836 * contents of each item.
16838 * @see @ref Genlist_Item_Class
16840 struct _Elm_Genlist_Item_Class
16842 const char *item_style; /**< style of this class. */
16845 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16846 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16847 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16848 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16849 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16851 const char *mode_item_style;
16855 * Add a new genlist widget to the given parent Elementary
16856 * (container) object
16858 * @param parent The parent object
16859 * @return a new genlist widget handle or @c NULL, on errors
16861 * This function inserts a new genlist widget on the canvas.
16863 * @see elm_genlist_item_append()
16864 * @see elm_genlist_item_del()
16865 * @see elm_genlist_clear()
16869 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16871 * Remove all items from a given genlist widget.
16873 * @param obj The genlist object
16875 * This removes (and deletes) all items in @p obj, leaving it empty.
16877 * @see elm_genlist_item_del(), to remove just one item.
16881 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16883 * Enable or disable multi-selection in the genlist
16885 * @param obj The genlist object
16886 * @param multi Multi-select enable/disable. Default is disabled.
16888 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16889 * the list. This allows more than 1 item to be selected. To retrieve the list
16890 * of selected items, use elm_genlist_selected_items_get().
16892 * @see elm_genlist_selected_items_get()
16893 * @see elm_genlist_multi_select_get()
16897 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16899 * Gets if multi-selection in genlist is enabled or disabled.
16901 * @param obj The genlist object
16902 * @return Multi-select enabled/disabled
16903 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16905 * @see elm_genlist_multi_select_set()
16909 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16911 * This sets the horizontal stretching mode.
16913 * @param obj The genlist object
16914 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16916 * This sets the mode used for sizing items horizontally. Valid modes
16917 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16918 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16919 * the scroller will scroll horizontally. Otherwise items are expanded
16920 * to fill the width of the viewport of the scroller. If it is
16921 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16922 * limited to that size.
16924 * @see elm_genlist_horizontal_get()
16928 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16929 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16931 * Gets the horizontal stretching mode.
16933 * @param obj The genlist object
16934 * @return The mode to use
16935 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16937 * @see elm_genlist_horizontal_set()
16941 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16942 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16944 * Set the always select mode.
16946 * @param obj The genlist object
16947 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16948 * EINA_FALSE = off). Default is @c EINA_FALSE.
16950 * Items will only call their selection func and callback when first
16951 * becoming selected. Any further clicks will do nothing, unless you
16952 * enable always select with elm_genlist_always_select_mode_set().
16953 * This means that, even if selected, every click will make the selected
16954 * callbacks be called.
16956 * @see elm_genlist_always_select_mode_get()
16960 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16962 * Get the always select mode.
16964 * @param obj The genlist object
16965 * @return The always select mode
16966 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16968 * @see elm_genlist_always_select_mode_set()
16972 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16974 * Enable/disable the no select mode.
16976 * @param obj The genlist object
16977 * @param no_select The no select mode
16978 * (EINA_TRUE = on, EINA_FALSE = off)
16980 * This will turn off the ability to select items entirely and they
16981 * will neither appear selected nor call selected callback functions.
16983 * @see elm_genlist_no_select_mode_get()
16987 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16989 * Gets whether the no select mode is enabled.
16991 * @param obj The genlist object
16992 * @return The no select mode
16993 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16995 * @see elm_genlist_no_select_mode_set()
16999 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17001 * Enable/disable compress mode.
17003 * @param obj The genlist object
17004 * @param compress The compress mode
17005 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17007 * This will enable the compress mode where items are "compressed"
17008 * horizontally to fit the genlist scrollable viewport width. This is
17009 * special for genlist. Do not rely on
17010 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17011 * work as genlist needs to handle it specially.
17013 * @see elm_genlist_compress_mode_get()
17017 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17019 * Get whether the compress mode is enabled.
17021 * @param obj The genlist object
17022 * @return The compress mode
17023 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17025 * @see elm_genlist_compress_mode_set()
17029 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17031 * Enable/disable height-for-width mode.
17033 * @param obj The genlist object
17034 * @param setting The height-for-width mode (@c EINA_TRUE = on,
17035 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17037 * With height-for-width mode the item width will be fixed (restricted
17038 * to a minimum of) to the list width when calculating its size in
17039 * order to allow the height to be calculated based on it. This allows,
17040 * for instance, text block to wrap lines if the Edje part is
17041 * configured with "text.min: 0 1".
17043 * @note This mode will make list resize slower as it will have to
17044 * recalculate every item height again whenever the list width
17047 * @note When height-for-width mode is enabled, it also enables
17048 * compress mode (see elm_genlist_compress_mode_set()) and
17049 * disables homogeneous (see elm_genlist_homogeneous_set()).
17053 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17055 * Get whether the height-for-width mode is enabled.
17057 * @param obj The genlist object
17058 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17063 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17065 * Enable/disable horizontal and vertical bouncing effect.
17067 * @param obj The genlist object
17068 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17069 * EINA_FALSE = off). Default is @c EINA_FALSE.
17070 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17071 * EINA_FALSE = off). Default is @c EINA_TRUE.
17073 * This will enable or disable the scroller bouncing effect for the
17074 * genlist. See elm_scroller_bounce_set() for details.
17076 * @see elm_scroller_bounce_set()
17077 * @see elm_genlist_bounce_get()
17081 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17083 * Get whether the horizontal and vertical bouncing effect is enabled.
17085 * @param obj The genlist object
17086 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17088 * @param v_bounce Pointer to a bool to receive if the bounce vertically
17091 * @see elm_genlist_bounce_set()
17095 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17097 * Enable/disable homogenous mode.
17099 * @param obj The genlist object
17100 * @param homogeneous Assume the items within the genlist are of the
17101 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17104 * This will enable the homogeneous mode where items are of the same
17105 * height and width so that genlist may do the lazy-loading at its
17106 * maximum (which increases the performance for scrolling the list). This
17107 * implies 'compressed' mode.
17109 * @see elm_genlist_compress_mode_set()
17110 * @see elm_genlist_homogeneous_get()
17114 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17116 * Get whether the homogenous mode is enabled.
17118 * @param obj The genlist object
17119 * @return Assume the items within the genlist are of the same height
17120 * and width (EINA_TRUE = on, EINA_FALSE = off)
17122 * @see elm_genlist_homogeneous_set()
17126 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17128 * Set the maximum number of items within an item block
17130 * @param obj The genlist object
17131 * @param n Maximum number of items within an item block. Default is 32.
17133 * This will configure the block count to tune to the target with
17134 * particular performance matrix.
17136 * A block of objects will be used to reduce the number of operations due to
17137 * many objects in the screen. It can determine the visibility, or if the
17138 * object has changed, it theme needs to be updated, etc. doing this kind of
17139 * calculation to the entire block, instead of per object.
17141 * The default value for the block count is enough for most lists, so unless
17142 * you know you will have a lot of objects visible in the screen at the same
17143 * time, don't try to change this.
17145 * @see elm_genlist_block_count_get()
17146 * @see @ref Genlist_Implementation
17150 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17152 * Get the maximum number of items within an item block
17154 * @param obj The genlist object
17155 * @return Maximum number of items within an item block
17157 * @see elm_genlist_block_count_set()
17161 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17163 * Set the timeout in seconds for the longpress event.
17165 * @param obj The genlist object
17166 * @param timeout timeout in seconds. Default is 1.
17168 * This option will change how long it takes to send an event "longpressed"
17169 * after the mouse down signal is sent to the list. If this event occurs, no
17170 * "clicked" event will be sent.
17172 * @see elm_genlist_longpress_timeout_set()
17176 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17178 * Get the timeout in seconds for the longpress event.
17180 * @param obj The genlist object
17181 * @return timeout in seconds
17183 * @see elm_genlist_longpress_timeout_get()
17187 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17189 * Append a new item in a given genlist widget.
17191 * @param obj The genlist object
17192 * @param itc The item class for the item
17193 * @param data The item data
17194 * @param parent The parent item, or NULL if none
17195 * @param flags Item flags
17196 * @param func Convenience function called when the item is selected
17197 * @param func_data Data passed to @p func above.
17198 * @return A handle to the item added or @c NULL if not possible
17200 * This adds the given item to the end of the list or the end of
17201 * the children list if the @p parent is given.
17203 * @see elm_genlist_item_prepend()
17204 * @see elm_genlist_item_insert_before()
17205 * @see elm_genlist_item_insert_after()
17206 * @see elm_genlist_item_del()
17210 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);
17212 * Prepend a new item in a given genlist widget.
17214 * @param obj The genlist object
17215 * @param itc The item class for the item
17216 * @param data The item data
17217 * @param parent The parent item, or NULL if none
17218 * @param flags Item flags
17219 * @param func Convenience function called when the item is selected
17220 * @param func_data Data passed to @p func above.
17221 * @return A handle to the item added or NULL if not possible
17223 * This adds an item to the beginning of the list or beginning of the
17224 * children of the parent if given.
17226 * @see elm_genlist_item_append()
17227 * @see elm_genlist_item_insert_before()
17228 * @see elm_genlist_item_insert_after()
17229 * @see elm_genlist_item_del()
17233 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);
17235 * Insert an item before another in a genlist widget
17237 * @param obj The genlist object
17238 * @param itc The item class for the item
17239 * @param data The item data
17240 * @param before The item to place this new one before.
17241 * @param flags Item flags
17242 * @param func Convenience function called when the item is selected
17243 * @param func_data Data passed to @p func above.
17244 * @return A handle to the item added or @c NULL if not possible
17246 * This inserts an item before another in the list. It will be in the
17247 * same tree level or group as the item it is inserted before.
17249 * @see elm_genlist_item_append()
17250 * @see elm_genlist_item_prepend()
17251 * @see elm_genlist_item_insert_after()
17252 * @see elm_genlist_item_del()
17256 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);
17258 * Insert an item after another in a genlist widget
17260 * @param obj The genlist object
17261 * @param itc The item class for the item
17262 * @param data The item data
17263 * @param after The item to place this new one after.
17264 * @param flags Item flags
17265 * @param func Convenience function called when the item is selected
17266 * @param func_data Data passed to @p func above.
17267 * @return A handle to the item added or @c NULL if not possible
17269 * This inserts an item after another in the list. It will be in the
17270 * same tree level or group as the item it is inserted after.
17272 * @see elm_genlist_item_append()
17273 * @see elm_genlist_item_prepend()
17274 * @see elm_genlist_item_insert_before()
17275 * @see elm_genlist_item_del()
17279 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);
17281 * Insert a new item into the sorted genlist object
17283 * @param obj The genlist object
17284 * @param itc The item class for the item
17285 * @param data The item data
17286 * @param parent The parent item, or NULL if none
17287 * @param flags Item flags
17288 * @param comp The function called for the sort
17289 * @param func Convenience function called when item selected
17290 * @param func_data Data passed to @p func above.
17291 * @return A handle to the item added or NULL if not possible
17295 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);
17296 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);
17297 /* operations to retrieve existing items */
17299 * Get the selectd item in the genlist.
17301 * @param obj The genlist object
17302 * @return The selected item, or NULL if none is selected.
17304 * This gets the selected item in the list (if multi-selection is enabled, only
17305 * the item that was first selected in the list is returned - which is not very
17306 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17309 * If no item is selected, NULL is returned.
17311 * @see elm_genlist_selected_items_get()
17315 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17317 * Get a list of selected items in the genlist.
17319 * @param obj The genlist object
17320 * @return The list of selected items, or NULL if none are selected.
17322 * It returns a list of the selected items. This list pointer is only valid so
17323 * long as the selection doesn't change (no items are selected or unselected, or
17324 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17325 * pointers. The order of the items in this list is the order which they were
17326 * selected, i.e. the first item in this list is the first item that was
17327 * selected, and so on.
17329 * @note If not in multi-select mode, consider using function
17330 * elm_genlist_selected_item_get() instead.
17332 * @see elm_genlist_multi_select_set()
17333 * @see elm_genlist_selected_item_get()
17337 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17339 * Get a list of realized items in genlist
17341 * @param obj The genlist object
17342 * @return The list of realized items, nor NULL if none are realized.
17344 * This returns a list of the realized items in the genlist. The list
17345 * contains Elm_Genlist_Item pointers. The list must be freed by the
17346 * caller when done with eina_list_free(). The item pointers in the
17347 * list are only valid so long as those items are not deleted or the
17348 * genlist is not deleted.
17350 * @see elm_genlist_realized_items_update()
17354 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17356 * Get the item that is at the x, y canvas coords.
17358 * @param obj The gelinst object.
17359 * @param x The input x coordinate
17360 * @param y The input y coordinate
17361 * @param posret The position relative to the item returned here
17362 * @return The item at the coordinates or NULL if none
17364 * This returns the item at the given coordinates (which are canvas
17365 * relative, not object-relative). If an item is at that coordinate,
17366 * that item handle is returned, and if @p posret is not NULL, the
17367 * integer pointed to is set to a value of -1, 0 or 1, depending if
17368 * the coordinate is on the upper portion of that item (-1), on the
17369 * middle section (0) or on the lower part (1). If NULL is returned as
17370 * an item (no item found there), then posret may indicate -1 or 1
17371 * based if the coordinate is above or below all items respectively in
17376 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);
17378 * Get the first item in the genlist
17380 * This returns the first item in the list.
17382 * @param obj The genlist object
17383 * @return The first item, or NULL if none
17387 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17389 * Get the last item in the genlist
17391 * This returns the last item in the list.
17393 * @return The last item, or NULL if none
17397 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17399 * Set the scrollbar policy
17401 * @param obj The genlist object
17402 * @param policy_h Horizontal scrollbar policy.
17403 * @param policy_v Vertical scrollbar policy.
17405 * This sets the scrollbar visibility policy for the given genlist
17406 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17407 * made visible if it is needed, and otherwise kept hidden.
17408 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17409 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17410 * respectively for the horizontal and vertical scrollbars. Default is
17411 * #ELM_SMART_SCROLLER_POLICY_AUTO
17413 * @see elm_genlist_scroller_policy_get()
17417 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17419 * Get the scrollbar policy
17421 * @param obj The genlist object
17422 * @param policy_h Pointer to store the horizontal scrollbar policy.
17423 * @param policy_v Pointer to store the vertical scrollbar policy.
17425 * @see elm_genlist_scroller_policy_set()
17429 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);
17431 * Get the @b next item in a genlist widget's internal list of items,
17432 * given a handle to one of those items.
17434 * @param item The genlist item to fetch next from
17435 * @return The item after @p item, or @c NULL if there's none (and
17438 * This returns the item placed after the @p item, on the container
17441 * @see elm_genlist_item_prev_get()
17445 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17447 * Get the @b previous item in a genlist widget's internal list of items,
17448 * given a handle to one of those items.
17450 * @param item The genlist item to fetch previous from
17451 * @return The item before @p item, or @c NULL if there's none (and
17454 * This returns the item placed before the @p item, on the container
17457 * @see elm_genlist_item_next_get()
17461 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17463 * Get the genlist object's handle which contains a given genlist
17466 * @param item The item to fetch the container from
17467 * @return The genlist (parent) object
17469 * This returns the genlist object itself that an item belongs to.
17473 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17475 * Get the parent item of the given item
17477 * @param it The item
17478 * @return The parent of the item or @c NULL if it has no parent.
17480 * This returns the item that was specified as parent of the item @p it on
17481 * elm_genlist_item_append() and insertion related functions.
17485 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17487 * Remove all sub-items (children) of the given item
17489 * @param it The item
17491 * This removes all items that are children (and their descendants) of the
17492 * given item @p it.
17494 * @see elm_genlist_clear()
17495 * @see elm_genlist_item_del()
17499 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17501 * Set whether a given genlist item is selected or not
17503 * @param it The item
17504 * @param selected Use @c EINA_TRUE, to make it selected, @c
17505 * EINA_FALSE to make it unselected
17507 * This sets the selected state of an item. If multi selection is
17508 * not enabled on the containing genlist and @p selected is @c
17509 * EINA_TRUE, any other previously selected items will get
17510 * unselected in favor of this new one.
17512 * @see elm_genlist_item_selected_get()
17516 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17518 * Get whether a given genlist item is selected or not
17520 * @param it The item
17521 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17523 * @see elm_genlist_item_selected_set() for more details
17527 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17529 * Sets the expanded state of an item.
17531 * @param it The item
17532 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17534 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17537 * The theme will respond to this change visually, and a signal "expanded" or
17538 * "contracted" will be sent from the genlist with a pointer to the item that
17539 * has been expanded/contracted.
17541 * Calling this function won't show or hide any child of this item (if it is
17542 * a parent). You must manually delete and create them on the callbacks fo
17543 * the "expanded" or "contracted" signals.
17545 * @see elm_genlist_item_expanded_get()
17549 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17551 * Get the expanded state of an item
17553 * @param it The item
17554 * @return The expanded state
17556 * This gets the expanded state of an item.
17558 * @see elm_genlist_item_expanded_set()
17562 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17564 * Get the depth of expanded item
17566 * @param it The genlist item object
17567 * @return The depth of expanded item
17571 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17573 * Set whether a given genlist item is disabled or not.
17575 * @param it The item
17576 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17577 * to enable it back.
17579 * A disabled item cannot be selected or unselected. It will also
17580 * change its appearance, to signal the user it's disabled.
17582 * @see elm_genlist_item_disabled_get()
17586 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17588 * Get whether a given genlist item is disabled or not.
17590 * @param it The item
17591 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17594 * @see elm_genlist_item_disabled_set() for more details
17598 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17600 * Sets the display only state of an item.
17602 * @param it The item
17603 * @param display_only @c EINA_TRUE if the item is display only, @c
17604 * EINA_FALSE otherwise.
17606 * A display only item cannot be selected or unselected. It is for
17607 * display only and not selecting or otherwise clicking, dragging
17608 * etc. by the user, thus finger size rules will not be applied to
17611 * It's good to set group index items to display only state.
17613 * @see elm_genlist_item_display_only_get()
17617 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17619 * Get the display only state of an item
17621 * @param it The item
17622 * @return @c EINA_TRUE if the item is display only, @c
17623 * EINA_FALSE otherwise.
17625 * @see elm_genlist_item_display_only_set()
17629 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17631 * Show the portion of a genlist's internal list containing a given
17632 * item, immediately.
17634 * @param it The item to display
17636 * This causes genlist to jump to the given item @p it and show it (by
17637 * immediately scrolling to that position), if it is not fully visible.
17639 * @see elm_genlist_item_bring_in()
17640 * @see elm_genlist_item_top_show()
17641 * @see elm_genlist_item_middle_show()
17645 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17647 * Animatedly bring in, to the visible are of a genlist, a given
17650 * @param it The item to display
17652 * This causes genlist to jump to the given item @p it and show it (by
17653 * animatedly scrolling), if it is not fully visible. This may use animation
17654 * to do so and take a period of time
17656 * @see elm_genlist_item_show()
17657 * @see elm_genlist_item_top_bring_in()
17658 * @see elm_genlist_item_middle_bring_in()
17662 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17664 * Show the portion of a genlist's internal list containing a given
17665 * item, immediately.
17667 * @param it The item to display
17669 * This causes genlist to jump to the given item @p it and show it (by
17670 * immediately scrolling to that position), if it is not fully visible.
17672 * The item will be positioned at the top of the genlist viewport.
17674 * @see elm_genlist_item_show()
17675 * @see elm_genlist_item_top_bring_in()
17679 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17681 * Animatedly bring in, to the visible are of a genlist, a given
17684 * @param it The item
17686 * This causes genlist to jump to the given item @p it and show it (by
17687 * animatedly scrolling), if it is not fully visible. This may use animation
17688 * to do so and take a period of time
17690 * The item will be positioned at the top of the genlist viewport.
17692 * @see elm_genlist_item_bring_in()
17693 * @see elm_genlist_item_top_show()
17697 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17699 * Show the portion of a genlist's internal list containing a given
17700 * item, immediately.
17702 * @param it The item to display
17704 * This causes genlist to jump to the given item @p it and show it (by
17705 * immediately scrolling to that position), if it is not fully visible.
17707 * The item will be positioned at the middle of the genlist viewport.
17709 * @see elm_genlist_item_show()
17710 * @see elm_genlist_item_middle_bring_in()
17714 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17716 * Animatedly bring in, to the visible are of a genlist, a given
17719 * @param it The item
17721 * This causes genlist to jump to the given item @p it and show it (by
17722 * animatedly scrolling), if it is not fully visible. This may use animation
17723 * to do so and take a period of time
17725 * The item will be positioned at the middle of the genlist viewport.
17727 * @see elm_genlist_item_bring_in()
17728 * @see elm_genlist_item_middle_show()
17732 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17734 * Remove a genlist item from the its parent, deleting it.
17736 * @param item The item to be removed.
17737 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17739 * @see elm_genlist_clear(), to remove all items in a genlist at
17744 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17746 * Return the data associated to a given genlist item
17748 * @param item The genlist item.
17749 * @return the data associated to this item.
17751 * This returns the @c data value passed on the
17752 * elm_genlist_item_append() and related item addition calls.
17754 * @see elm_genlist_item_append()
17755 * @see elm_genlist_item_data_set()
17759 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17761 * Set the data associated to a given genlist item
17763 * @param item The genlist item
17764 * @param data The new data pointer to set on it
17766 * This @b overrides the @c data value passed on the
17767 * elm_genlist_item_append() and related item addition calls. This
17768 * function @b won't call elm_genlist_item_update() automatically,
17769 * so you'd issue it afterwards if you want to hove the item
17770 * updated to reflect the that new data.
17772 * @see elm_genlist_item_data_get()
17776 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17778 * Tells genlist to "orphan" icons fetchs by the item class
17780 * @param it The item
17782 * This instructs genlist to release references to icons in the item,
17783 * meaning that they will no longer be managed by genlist and are
17784 * floating "orphans" that can be re-used elsewhere if the user wants
17789 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17791 * Get the real Evas object created to implement the view of a
17792 * given genlist item
17794 * @param item The genlist item.
17795 * @return the Evas object implementing this item's view.
17797 * This returns the actual Evas object used to implement the
17798 * specified genlist item's view. This may be @c NULL, as it may
17799 * not have been created or may have been deleted, at any time, by
17800 * the genlist. <b>Do not modify this object</b> (move, resize,
17801 * show, hide, etc.), as the genlist is controlling it. This
17802 * function is for querying, emitting custom signals or hooking
17803 * lower level callbacks for events on that object. Do not delete
17804 * this object under any circumstances.
17806 * @see elm_genlist_item_data_get()
17810 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17812 * Update the contents of an item
17814 * @param it The item
17816 * This updates an item by calling all the item class functions again
17817 * to get the icons, labels and states. Use this when the original
17818 * item data has changed and the changes are desired to be reflected.
17820 * Use elm_genlist_realized_items_update() to update all already realized
17823 * @see elm_genlist_realized_items_update()
17827 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17829 * Update the item class of an item
17831 * @param it The item
17832 * @param itc The item class for the item
17834 * This sets another class fo the item, changing the way that it is
17835 * displayed. After changing the item class, elm_genlist_item_update() is
17836 * called on the item @p it.
17840 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17841 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17843 * Set the text to be shown in a given genlist item's tooltips.
17845 * @param item The genlist item
17846 * @param text The text to set in the content
17848 * This call will setup the text to be used as tooltip to that item
17849 * (analogous to elm_object_tooltip_text_set(), but being item
17850 * tooltips with higher precedence than object tooltips). It can
17851 * have only one tooltip at a time, so any previous tooltip data
17852 * will get removed.
17854 * In order to set an icon or something else as a tooltip, look at
17855 * elm_genlist_item_tooltip_content_cb_set().
17859 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17861 * Set the content to be shown in a given genlist item's tooltips
17863 * @param item The genlist item.
17864 * @param func The function returning the tooltip contents.
17865 * @param data What to provide to @a func as callback data/context.
17866 * @param del_cb Called when data is not needed anymore, either when
17867 * another callback replaces @p func, the tooltip is unset with
17868 * elm_genlist_item_tooltip_unset() or the owner @p item
17869 * dies. This callback receives as its first parameter the
17870 * given @p data, being @c event_info the item handle.
17872 * This call will setup the tooltip's contents to @p item
17873 * (analogous to elm_object_tooltip_content_cb_set(), but being
17874 * item tooltips with higher precedence than object tooltips). It
17875 * can have only one tooltip at a time, so any previous tooltip
17876 * content will get removed. @p func (with @p data) will be called
17877 * every time Elementary needs to show the tooltip and it should
17878 * return a valid Evas object, which will be fully managed by the
17879 * tooltip system, getting deleted when the tooltip is gone.
17881 * In order to set just a text as a tooltip, look at
17882 * elm_genlist_item_tooltip_text_set().
17886 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);
17888 * Unset a tooltip from a given genlist item
17890 * @param item genlist item to remove a previously set tooltip from.
17892 * This call removes any tooltip set on @p item. The callback
17893 * provided as @c del_cb to
17894 * elm_genlist_item_tooltip_content_cb_set() will be called to
17895 * notify it is not used anymore (and have resources cleaned, if
17898 * @see elm_genlist_item_tooltip_content_cb_set()
17902 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17904 * Set a different @b style for a given genlist item's tooltip.
17906 * @param item genlist item with tooltip set
17907 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17908 * "default", @c "transparent", etc)
17910 * Tooltips can have <b>alternate styles</b> to be displayed on,
17911 * which are defined by the theme set on Elementary. This function
17912 * works analogously as elm_object_tooltip_style_set(), but here
17913 * applied only to genlist item objects. The default style for
17914 * tooltips is @c "default".
17916 * @note before you set a style you should define a tooltip with
17917 * elm_genlist_item_tooltip_content_cb_set() or
17918 * elm_genlist_item_tooltip_text_set()
17920 * @see elm_genlist_item_tooltip_style_get()
17924 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17926 * Get the style set a given genlist item's tooltip.
17928 * @param item genlist item with tooltip already set on.
17929 * @return style the theme style in use, which defaults to
17930 * "default". If the object does not have a tooltip set,
17931 * then @c NULL is returned.
17933 * @see elm_genlist_item_tooltip_style_set() for more details
17937 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17939 * @brief Disable size restrictions on an object's tooltip
17940 * @param item The tooltip's anchor object
17941 * @param disable If EINA_TRUE, size restrictions are disabled
17942 * @return EINA_FALSE on failure, EINA_TRUE on success
17944 * This function allows a tooltip to expand beyond its parant window's canvas.
17945 * It will instead be limited only by the size of the display.
17947 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17949 * @brief Retrieve size restriction state of an object's tooltip
17950 * @param item The tooltip's anchor object
17951 * @return If EINA_TRUE, size restrictions are disabled
17953 * This function returns whether a tooltip is allowed to expand beyond
17954 * its parant window's canvas.
17955 * It will instead be limited only by the size of the display.
17957 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17959 * Set the type of mouse pointer/cursor decoration to be shown,
17960 * when the mouse pointer is over the given genlist widget item
17962 * @param item genlist item to customize cursor on
17963 * @param cursor the cursor type's name
17965 * This function works analogously as elm_object_cursor_set(), but
17966 * here the cursor's changing area is restricted to the item's
17967 * area, and not the whole widget's. Note that that item cursors
17968 * have precedence over widget cursors, so that a mouse over @p
17969 * item will always show cursor @p type.
17971 * If this function is called twice for an object, a previously set
17972 * cursor will be unset on the second call.
17974 * @see elm_object_cursor_set()
17975 * @see elm_genlist_item_cursor_get()
17976 * @see elm_genlist_item_cursor_unset()
17980 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17982 * Get the type of mouse pointer/cursor decoration set to be shown,
17983 * when the mouse pointer is over the given genlist widget item
17985 * @param item genlist item with custom cursor set
17986 * @return the cursor type's name or @c NULL, if no custom cursors
17987 * were set to @p item (and on errors)
17989 * @see elm_object_cursor_get()
17990 * @see elm_genlist_item_cursor_set() for more details
17991 * @see elm_genlist_item_cursor_unset()
17995 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17997 * Unset any custom mouse pointer/cursor decoration set to be
17998 * shown, when the mouse pointer is over the given genlist widget
17999 * item, thus making it show the @b default cursor again.
18001 * @param item a genlist item
18003 * Use this call to undo any custom settings on this item's cursor
18004 * decoration, bringing it back to defaults (no custom style set).
18006 * @see elm_object_cursor_unset()
18007 * @see elm_genlist_item_cursor_set() for more details
18011 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18013 * Set a different @b style for a given custom cursor set for a
18016 * @param item genlist item with custom cursor set
18017 * @param style the <b>theme style</b> to use (e.g. @c "default",
18018 * @c "transparent", etc)
18020 * This function only makes sense when one is using custom mouse
18021 * cursor decorations <b>defined in a theme file</b> , which can
18022 * have, given a cursor name/type, <b>alternate styles</b> on
18023 * it. It works analogously as elm_object_cursor_style_set(), but
18024 * here applied only to genlist item objects.
18026 * @warning Before you set a cursor style you should have defined a
18027 * custom cursor previously on the item, with
18028 * elm_genlist_item_cursor_set()
18030 * @see elm_genlist_item_cursor_engine_only_set()
18031 * @see elm_genlist_item_cursor_style_get()
18035 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18037 * Get the current @b style set for a given genlist item's custom
18040 * @param item genlist item with custom cursor set.
18041 * @return style the cursor style in use. If the object does not
18042 * have a cursor set, then @c NULL is returned.
18044 * @see elm_genlist_item_cursor_style_set() for more details
18048 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18050 * Set if the (custom) cursor for a given genlist item should be
18051 * searched in its theme, also, or should only rely on the
18052 * rendering engine.
18054 * @param item item with custom (custom) cursor already set on
18055 * @param engine_only Use @c EINA_TRUE to have cursors looked for
18056 * only on those provided by the rendering engine, @c EINA_FALSE to
18057 * have them searched on the widget's theme, as well.
18059 * @note This call is of use only if you've set a custom cursor
18060 * for genlist items, with elm_genlist_item_cursor_set().
18062 * @note By default, cursors will only be looked for between those
18063 * provided by the rendering engine.
18067 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18069 * Get if the (custom) cursor for a given genlist item is being
18070 * searched in its theme, also, or is only relying on the rendering
18073 * @param item a genlist item
18074 * @return @c EINA_TRUE, if cursors are being looked for only on
18075 * those provided by the rendering engine, @c EINA_FALSE if they
18076 * are being searched on the widget's theme, as well.
18078 * @see elm_genlist_item_cursor_engine_only_set(), for more details
18082 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18084 * Update the contents of all realized items.
18086 * @param obj The genlist object.
18088 * This updates all realized items by calling all the item class functions again
18089 * to get the icons, labels and states. Use this when the original
18090 * item data has changed and the changes are desired to be reflected.
18092 * To update just one item, use elm_genlist_item_update().
18094 * @see elm_genlist_realized_items_get()
18095 * @see elm_genlist_item_update()
18099 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18101 * Activate a genlist mode on an item
18103 * @param item The genlist item
18104 * @param mode Mode name
18105 * @param mode_set Boolean to define set or unset mode.
18107 * A genlist mode is a different way of selecting an item. Once a mode is
18108 * activated on an item, any other selected item is immediately unselected.
18109 * This feature provides an easy way of implementing a new kind of animation
18110 * for selecting an item, without having to entirely rewrite the item style
18111 * theme. However, the elm_genlist_selected_* API can't be used to get what
18112 * item is activate for a mode.
18114 * The current item style will still be used, but applying a genlist mode to
18115 * an item will select it using a different kind of animation.
18117 * The current active item for a mode can be found by
18118 * elm_genlist_mode_item_get().
18120 * The characteristics of genlist mode are:
18121 * - Only one mode can be active at any time, and for only one item.
18122 * - Genlist handles deactivating other items when one item is activated.
18123 * - A mode is defined in the genlist theme (edc), and more modes can easily
18125 * - A mode style and the genlist item style are different things. They
18126 * can be combined to provide a default style to the item, with some kind
18127 * of animation for that item when the mode is activated.
18129 * When a mode is activated on an item, a new view for that item is created.
18130 * The theme of this mode defines the animation that will be used to transit
18131 * the item from the old view to the new view. This second (new) view will be
18132 * active for that item while the mode is active on the item, and will be
18133 * destroyed after the mode is totally deactivated from that item.
18135 * @see elm_genlist_mode_get()
18136 * @see elm_genlist_mode_item_get()
18140 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18142 * Get the last (or current) genlist mode used.
18144 * @param obj The genlist object
18146 * This function just returns the name of the last used genlist mode. It will
18147 * be the current mode if it's still active.
18149 * @see elm_genlist_item_mode_set()
18150 * @see elm_genlist_mode_item_get()
18154 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18156 * Get active genlist mode item
18158 * @param obj The genlist object
18159 * @return The active item for that current mode. Or @c NULL if no item is
18160 * activated with any mode.
18162 * This function returns the item that was activated with a mode, by the
18163 * function elm_genlist_item_mode_set().
18165 * @see elm_genlist_item_mode_set()
18166 * @see elm_genlist_mode_get()
18170 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18175 * @param obj The genlist object
18176 * @param reorder_mode The reorder mode
18177 * (EINA_TRUE = on, EINA_FALSE = off)
18181 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18184 * Get the reorder mode
18186 * @param obj The genlist object
18187 * @return The reorder mode
18188 * (EINA_TRUE = on, EINA_FALSE = off)
18192 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18199 * @defgroup Check Check
18201 * @image html img/widget/check/preview-00.png
18202 * @image latex img/widget/check/preview-00.eps
18203 * @image html img/widget/check/preview-01.png
18204 * @image latex img/widget/check/preview-01.eps
18205 * @image html img/widget/check/preview-02.png
18206 * @image latex img/widget/check/preview-02.eps
18208 * @brief The check widget allows for toggling a value between true and
18211 * Check objects are a lot like radio objects in layout and functionality
18212 * except they do not work as a group, but independently and only toggle the
18213 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18214 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18215 * returns the current state. For convenience, like the radio objects, you
18216 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18217 * for it to modify.
18219 * Signals that you can add callbacks for are:
18220 * "changed" - This is called whenever the user changes the state of one of
18221 * the check object(event_info is NULL).
18223 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18227 * @brief Add a new Check object
18229 * @param parent The parent object
18230 * @return The new object or NULL if it cannot be created
18232 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18234 * @brief Set the text label of the check object
18236 * @param obj The check object
18237 * @param label The text label string in UTF-8
18239 * @deprecated use elm_object_text_set() instead.
18241 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18243 * @brief Get the text label of the check object
18245 * @param obj The check object
18246 * @return The text label string in UTF-8
18248 * @deprecated use elm_object_text_get() instead.
18250 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18252 * @brief Set the icon object of the check object
18254 * @param obj The check object
18255 * @param icon The icon object
18257 * Once the icon object is set, a previously set one will be deleted.
18258 * If you want to keep that old content object, use the
18259 * elm_check_icon_unset() function.
18261 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18263 * @brief Get the icon object of the check object
18265 * @param obj The check object
18266 * @return The icon object
18268 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18270 * @brief Unset the icon used for the check object
18272 * @param obj The check object
18273 * @return The icon object that was being used
18275 * Unparent and return the icon object which was set for this widget.
18277 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18279 * @brief Set the on/off state of the check object
18281 * @param obj The check object
18282 * @param state The state to use (1 == on, 0 == off)
18284 * This sets the state of the check. If set
18285 * with elm_check_state_pointer_set() the state of that variable is also
18286 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18288 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18290 * @brief Get the state of the check object
18292 * @param obj The check object
18293 * @return The boolean state
18295 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18297 * @brief Set a convenience pointer to a boolean to change
18299 * @param obj The check object
18300 * @param statep Pointer to the boolean to modify
18302 * This sets a pointer to a boolean, that, in addition to the check objects
18303 * state will also be modified directly. To stop setting the object pointed
18304 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18305 * then when this is called, the check objects state will also be modified to
18306 * reflect the value of the boolean @p statep points to, just like calling
18307 * elm_check_state_set().
18309 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18315 * @defgroup Radio Radio
18317 * @image html img/widget/radio/preview-00.png
18318 * @image latex img/widget/radio/preview-00.eps
18320 * @brief Radio is a widget that allows for 1 or more options to be displayed
18321 * and have the user choose only 1 of them.
18323 * A radio object contains an indicator, an optional Label and an optional
18324 * icon object. While it's possible to have a group of only one radio they,
18325 * are normally used in groups of 2 or more. To add a radio to a group use
18326 * elm_radio_group_add(). The radio object(s) will select from one of a set
18327 * of integer values, so any value they are configuring needs to be mapped to
18328 * a set of integers. To configure what value that radio object represents,
18329 * use elm_radio_state_value_set() to set the integer it represents. To set
18330 * the value the whole group(which one is currently selected) is to indicate
18331 * use elm_radio_value_set() on any group member, and to get the groups value
18332 * use elm_radio_value_get(). For convenience the radio objects are also able
18333 * to directly set an integer(int) to the value that is selected. To specify
18334 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18335 * The radio objects will modify this directly. That implies the pointer must
18336 * point to valid memory for as long as the radio objects exist.
18338 * Signals that you can add callbacks for are:
18339 * @li changed - This is called whenever the user changes the state of one of
18340 * the radio objects within the group of radio objects that work together.
18342 * @ref tutorial_radio show most of this API in action.
18346 * @brief Add a new radio to the parent
18348 * @param parent The parent object
18349 * @return The new object or NULL if it cannot be created
18351 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18353 * @brief Set the text label of the radio object
18355 * @param obj The radio object
18356 * @param label The text label string in UTF-8
18358 * @deprecated use elm_object_text_set() instead.
18360 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18362 * @brief Get the text label of the radio object
18364 * @param obj The radio object
18365 * @return The text label string in UTF-8
18367 * @deprecated use elm_object_text_set() instead.
18369 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18371 * @brief Set the icon object of the radio object
18373 * @param obj The radio object
18374 * @param icon The icon object
18376 * Once the icon object is set, a previously set one will be deleted. If you
18377 * want to keep that old content object, use the elm_radio_icon_unset()
18380 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18382 * @brief Get the icon object of the radio object
18384 * @param obj The radio object
18385 * @return The icon object
18387 * @see elm_radio_icon_set()
18389 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18391 * @brief Unset the icon used for the radio object
18393 * @param obj The radio object
18394 * @return The icon object that was being used
18396 * Unparent and return the icon object which was set for this widget.
18398 * @see elm_radio_icon_set()
18400 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18402 * @brief Add this radio to a group of other radio objects
18404 * @param obj The radio object
18405 * @param group Any object whose group the @p obj is to join.
18407 * Radio objects work in groups. Each member should have a different integer
18408 * value assigned. In order to have them work as a group, they need to know
18409 * about each other. This adds the given radio object to the group of which
18410 * the group object indicated is a member.
18412 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18414 * @brief Set the integer value that this radio object represents
18416 * @param obj The radio object
18417 * @param value The value to use if this radio object is selected
18419 * This sets the value of the radio.
18421 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18423 * @brief Get the integer value that this radio object represents
18425 * @param obj The radio object
18426 * @return The value used if this radio object is selected
18428 * This gets the value of the radio.
18430 * @see elm_radio_value_set()
18432 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18434 * @brief Set the value of the radio.
18436 * @param obj The radio object
18437 * @param value The value to use for the group
18439 * This sets the value of the radio group and will also set the value if
18440 * pointed to, to the value supplied, but will not call any callbacks.
18442 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18444 * @brief Get the state of the radio object
18446 * @param obj The radio object
18447 * @return The integer state
18449 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18451 * @brief Set a convenience pointer to a integer to change
18453 * @param obj The radio object
18454 * @param valuep Pointer to the integer to modify
18456 * This sets a pointer to a integer, that, in addition to the radio objects
18457 * state will also be modified directly. To stop setting the object pointed
18458 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18459 * when this is called, the radio objects state will also be modified to
18460 * reflect the value of the integer valuep points to, just like calling
18461 * elm_radio_value_set().
18463 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18469 * @defgroup Pager Pager
18471 * @image html img/widget/pager/preview-00.png
18472 * @image latex img/widget/pager/preview-00.eps
18474 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18476 * The flipping between “pages” of objects is animated. All content in pager
18477 * is kept in a stack, the last content to be added will be on the top of the
18478 * stack(be visible).
18480 * Objects can be pushed or popped from the stack or deleted as normal.
18481 * Pushes and pops will animate (and a pop will delete the object once the
18482 * animation is finished). Any object already in the pager can be promoted to
18483 * the top(from its current stacking position) through the use of
18484 * elm_pager_content_promote(). Objects are pushed to the top with
18485 * elm_pager_content_push() and when the top item is no longer wanted, simply
18486 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18487 * object is no longer needed and is not the top item, just delete it as
18488 * normal. You can query which objects are the top and bottom with
18489 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18491 * Signals that you can add callbacks for are:
18492 * "hide,finished" - when the previous page is hided
18494 * This widget has the following styles available:
18497 * @li fade_translucide
18498 * @li fade_invisible
18499 * @note This styles affect only the flipping animations, the appearance when
18500 * not animating is unaffected by styles.
18502 * @ref tutorial_pager gives a good overview of the usage of the API.
18506 * Add a new pager to the parent
18508 * @param parent The parent object
18509 * @return The new object or NULL if it cannot be created
18513 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18515 * @brief Push an object to the top of the pager stack (and show it).
18517 * @param obj The pager object
18518 * @param content The object to push
18520 * The object pushed becomes a child of the pager, it will be controlled and
18521 * deleted when the pager is deleted.
18523 * @note If the content is already in the stack use
18524 * elm_pager_content_promote().
18525 * @warning Using this function on @p content already in the stack results in
18526 * undefined behavior.
18528 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18530 * @brief Pop the object that is on top of the stack
18532 * @param obj The pager object
18534 * This pops the object that is on the top(visible) of the pager, makes it
18535 * disappear, then deletes the object. The object that was underneath it on
18536 * the stack will become visible.
18538 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18540 * @brief Moves an object already in the pager stack to the top of the stack.
18542 * @param obj The pager object
18543 * @param content The object to promote
18545 * This will take the @p content and move it to the top of the stack as
18546 * if it had been pushed there.
18548 * @note If the content isn't already in the stack use
18549 * elm_pager_content_push().
18550 * @warning Using this function on @p content not already in the stack
18551 * results in undefined behavior.
18553 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18555 * @brief Return the object at the bottom of the pager stack
18557 * @param obj The pager object
18558 * @return The bottom object or NULL if none
18560 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18562 * @brief Return the object at the top of the pager stack
18564 * @param obj The pager object
18565 * @return The top object or NULL if none
18567 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18573 * @defgroup Slideshow Slideshow
18575 * @image html img/widget/slideshow/preview-00.png
18576 * @image latex img/widget/slideshow/preview-00.eps
18578 * This widget, as the name indicates, is a pre-made image
18579 * slideshow panel, with API functions acting on (child) image
18580 * items presentation. Between those actions, are:
18581 * - advance to next/previous image
18582 * - select the style of image transition animation
18583 * - set the exhibition time for each image
18584 * - start/stop the slideshow
18586 * The transition animations are defined in the widget's theme,
18587 * consequently new animations can be added without having to
18588 * update the widget's code.
18590 * @section Slideshow_Items Slideshow items
18592 * For slideshow items, just like for @ref Genlist "genlist" ones,
18593 * the user defines a @b classes, specifying functions that will be
18594 * called on the item's creation and deletion times.
18596 * The #Elm_Slideshow_Item_Class structure contains the following
18599 * - @c func.get - When an item is displayed, this function is
18600 * called, and it's where one should create the item object, de
18601 * facto. For example, the object can be a pure Evas image object
18602 * or an Elementary @ref Photocam "photocam" widget. See
18603 * #SlideshowItemGetFunc.
18604 * - @c func.del - When an item is no more displayed, this function
18605 * is called, where the user must delete any data associated to
18606 * the item. See #SlideshowItemDelFunc.
18608 * @section Slideshow_Caching Slideshow caching
18610 * The slideshow provides facilities to have items adjacent to the
18611 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18612 * you, so that the system does not have to decode image data
18613 * anymore at the time it has to actually switch images on its
18614 * viewport. The user is able to set the numbers of items to be
18615 * cached @b before and @b after the current item, in the widget's
18618 * Smart events one can add callbacks for are:
18620 * - @c "changed" - when the slideshow switches its view to a new
18623 * List of examples for the slideshow widget:
18624 * @li @ref slideshow_example
18628 * @addtogroup Slideshow
18632 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18633 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18634 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18635 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18636 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18639 * @struct _Elm_Slideshow_Item_Class
18641 * Slideshow item class definition. See @ref Slideshow_Items for
18644 struct _Elm_Slideshow_Item_Class
18646 struct _Elm_Slideshow_Item_Class_Func
18648 SlideshowItemGetFunc get;
18649 SlideshowItemDelFunc del;
18651 }; /**< #Elm_Slideshow_Item_Class member definitions */
18654 * Add a new slideshow widget to the given parent Elementary
18655 * (container) object
18657 * @param parent The parent object
18658 * @return A new slideshow widget handle or @c NULL, on errors
18660 * This function inserts a new slideshow widget on the canvas.
18662 * @ingroup Slideshow
18664 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18667 * Add (append) a new item in a given slideshow widget.
18669 * @param obj The slideshow object
18670 * @param itc The item class for the item
18671 * @param data The item's data
18672 * @return A handle to the item added or @c NULL, on errors
18674 * Add a new item to @p obj's internal list of items, appending it.
18675 * The item's class must contain the function really fetching the
18676 * image object to show for this item, which could be an Evas image
18677 * object or an Elementary photo, for example. The @p data
18678 * parameter is going to be passed to both class functions of the
18681 * @see #Elm_Slideshow_Item_Class
18682 * @see elm_slideshow_item_sorted_insert()
18684 * @ingroup Slideshow
18686 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18689 * Insert a new item into the given slideshow widget, using the @p func
18690 * function to sort items (by item handles).
18692 * @param obj The slideshow object
18693 * @param itc The item class for the item
18694 * @param data The item's data
18695 * @param func The comparing function to be used to sort slideshow
18696 * items <b>by #Elm_Slideshow_Item item handles</b>
18697 * @return Returns The slideshow item handle, on success, or
18698 * @c NULL, on errors
18700 * Add a new item to @p obj's internal list of items, in a position
18701 * determined by the @p func comparing function. The item's class
18702 * must contain the function really fetching the image object to
18703 * show for this item, which could be an Evas image object or an
18704 * Elementary photo, for example. The @p data parameter is going to
18705 * be passed to both class functions of the item.
18707 * @see #Elm_Slideshow_Item_Class
18708 * @see elm_slideshow_item_add()
18710 * @ingroup Slideshow
18712 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);
18715 * Display a given slideshow widget's item, programmatically.
18717 * @param obj The slideshow object
18718 * @param item The item to display on @p obj's viewport
18720 * The change between the current item and @p item will use the
18721 * transition @p obj is set to use (@see
18722 * elm_slideshow_transition_set()).
18724 * @ingroup Slideshow
18726 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18729 * Slide to the @b next item, in a given slideshow widget
18731 * @param obj The slideshow object
18733 * The sliding animation @p obj is set to use will be the
18734 * transition effect used, after this call is issued.
18736 * @note If the end of the slideshow's internal list of items is
18737 * reached, it'll wrap around to the list's beginning, again.
18739 * @ingroup Slideshow
18741 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18744 * Slide to the @b previous item, in a given slideshow widget
18746 * @param obj The slideshow object
18748 * The sliding animation @p obj is set to use will be the
18749 * transition effect used, after this call is issued.
18751 * @note If the beginning of the slideshow's internal list of items
18752 * is reached, it'll wrap around to the list's end, again.
18754 * @ingroup Slideshow
18756 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18759 * Returns the list of sliding transition/effect names available, for a
18760 * given slideshow widget.
18762 * @param obj The slideshow object
18763 * @return The list of transitions (list of @b stringshared strings
18766 * The transitions, which come from @p obj's theme, must be an EDC
18767 * data item named @c "transitions" on the theme file, with (prefix)
18768 * names of EDC programs actually implementing them.
18770 * The available transitions for slideshows on the default theme are:
18771 * - @c "fade" - the current item fades out, while the new one
18772 * fades in to the slideshow's viewport.
18773 * - @c "black_fade" - the current item fades to black, and just
18774 * then, the new item will fade in.
18775 * - @c "horizontal" - the current item slides horizontally, until
18776 * it gets out of the slideshow's viewport, while the new item
18777 * comes from the left to take its place.
18778 * - @c "vertical" - the current item slides vertically, until it
18779 * gets out of the slideshow's viewport, while the new item comes
18780 * from the bottom to take its place.
18781 * - @c "square" - the new item starts to appear from the middle of
18782 * the current one, but with a tiny size, growing until its
18783 * target (full) size and covering the old one.
18785 * @warning The stringshared strings get no new references
18786 * exclusive to the user grabbing the list, here, so if you'd like
18787 * to use them out of this call's context, you'd better @c
18788 * eina_stringshare_ref() them.
18790 * @see elm_slideshow_transition_set()
18792 * @ingroup Slideshow
18794 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18797 * Set the current slide transition/effect in use for a given
18800 * @param obj The slideshow object
18801 * @param transition The new transition's name string
18803 * If @p transition is implemented in @p obj's theme (i.e., is
18804 * contained in the list returned by
18805 * elm_slideshow_transitions_get()), this new sliding effect will
18806 * be used on the widget.
18808 * @see elm_slideshow_transitions_get() for more details
18810 * @ingroup Slideshow
18812 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18815 * Get the current slide transition/effect in use for a given
18818 * @param obj The slideshow object
18819 * @return The current transition's name
18821 * @see elm_slideshow_transition_set() for more details
18823 * @ingroup Slideshow
18825 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18828 * Set the interval between each image transition on a given
18829 * slideshow widget, <b>and start the slideshow, itself</b>
18831 * @param obj The slideshow object
18832 * @param timeout The new displaying timeout for images
18834 * After this call, the slideshow widget will start cycling its
18835 * view, sequentially and automatically, with the images of the
18836 * items it has. The time between each new image displayed is going
18837 * to be @p timeout, in @b seconds. If a different timeout was set
18838 * previously and an slideshow was in progress, it will continue
18839 * with the new time between transitions, after this call.
18841 * @note A value less than or equal to 0 on @p timeout will disable
18842 * the widget's internal timer, thus halting any slideshow which
18843 * could be happening on @p obj.
18845 * @see elm_slideshow_timeout_get()
18847 * @ingroup Slideshow
18849 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18852 * Get the interval set for image transitions on a given slideshow
18855 * @param obj The slideshow object
18856 * @return Returns the timeout set on it
18858 * @see elm_slideshow_timeout_set() for more details
18860 * @ingroup Slideshow
18862 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18865 * Set if, after a slideshow is started, for a given slideshow
18866 * widget, its items should be displayed cyclically or not.
18868 * @param obj The slideshow object
18869 * @param loop Use @c EINA_TRUE to make it cycle through items or
18870 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18873 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18874 * ignore what is set by this functions, i.e., they'll @b always
18875 * cycle through items. This affects only the "automatic"
18876 * slideshow, as set by elm_slideshow_timeout_set().
18878 * @see elm_slideshow_loop_get()
18880 * @ingroup Slideshow
18882 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18885 * Get if, after a slideshow is started, for a given slideshow
18886 * widget, its items are to be displayed cyclically or not.
18888 * @param obj The slideshow object
18889 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18890 * through or @c EINA_FALSE, otherwise
18892 * @see elm_slideshow_loop_set() for more details
18894 * @ingroup Slideshow
18896 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18899 * Remove all items from a given slideshow widget
18901 * @param obj The slideshow object
18903 * This removes (and deletes) all items in @p obj, leaving it
18906 * @see elm_slideshow_item_del(), to remove just one item.
18908 * @ingroup Slideshow
18910 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18913 * Get the internal list of items in a given slideshow widget.
18915 * @param obj The slideshow object
18916 * @return The list of items (#Elm_Slideshow_Item as data) or
18917 * @c NULL on errors.
18919 * This list is @b not to be modified in any way and must not be
18920 * freed. Use the list members with functions like
18921 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18923 * @warning This list is only valid until @p obj object's internal
18924 * items list is changed. It should be fetched again with another
18925 * call to this function when changes happen.
18927 * @ingroup Slideshow
18929 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18932 * Delete a given item from a slideshow widget.
18934 * @param item The slideshow item
18936 * @ingroup Slideshow
18938 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18941 * Return the data associated with a given slideshow item
18943 * @param item The slideshow item
18944 * @return Returns the data associated to this item
18946 * @ingroup Slideshow
18948 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18951 * Returns the currently displayed item, in a given slideshow widget
18953 * @param obj The slideshow object
18954 * @return A handle to the item being displayed in @p obj or
18955 * @c NULL, if none is (and on errors)
18957 * @ingroup Slideshow
18959 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18962 * Get the real Evas object created to implement the view of a
18963 * given slideshow item
18965 * @param item The slideshow item.
18966 * @return the Evas object implementing this item's view.
18968 * This returns the actual Evas object used to implement the
18969 * specified slideshow item's view. This may be @c NULL, as it may
18970 * not have been created or may have been deleted, at any time, by
18971 * the slideshow. <b>Do not modify this object</b> (move, resize,
18972 * show, hide, etc.), as the slideshow is controlling it. This
18973 * function is for querying, emitting custom signals or hooking
18974 * lower level callbacks for events on that object. Do not delete
18975 * this object under any circumstances.
18977 * @see elm_slideshow_item_data_get()
18979 * @ingroup Slideshow
18981 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18984 * Get the the item, in a given slideshow widget, placed at
18985 * position @p nth, in its internal items list
18987 * @param obj The slideshow object
18988 * @param nth The number of the item to grab a handle to (0 being
18990 * @return The item stored in @p obj at position @p nth or @c NULL,
18991 * if there's no item with that index (and on errors)
18993 * @ingroup Slideshow
18995 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18998 * Set the current slide layout in use for a given slideshow widget
19000 * @param obj The slideshow object
19001 * @param layout The new layout's name string
19003 * If @p layout is implemented in @p obj's theme (i.e., is contained
19004 * in the list returned by elm_slideshow_layouts_get()), this new
19005 * images layout will be used on the widget.
19007 * @see elm_slideshow_layouts_get() for more details
19009 * @ingroup Slideshow
19011 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19014 * Get the current slide layout in use for a given slideshow widget
19016 * @param obj The slideshow object
19017 * @return The current layout's name
19019 * @see elm_slideshow_layout_set() for more details
19021 * @ingroup Slideshow
19023 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19026 * Returns the list of @b layout names available, for a given
19027 * slideshow widget.
19029 * @param obj The slideshow object
19030 * @return The list of layouts (list of @b stringshared strings
19033 * Slideshow layouts will change how the widget is to dispose each
19034 * image item in its viewport, with regard to cropping, scaling,
19037 * The layouts, which come from @p obj's theme, must be an EDC
19038 * data item name @c "layouts" on the theme file, with (prefix)
19039 * names of EDC programs actually implementing them.
19041 * The available layouts for slideshows on the default theme are:
19042 * - @c "fullscreen" - item images with original aspect, scaled to
19043 * touch top and down slideshow borders or, if the image's heigh
19044 * is not enough, left and right slideshow borders.
19045 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19046 * one, but always leaving 10% of the slideshow's dimensions of
19047 * distance between the item image's borders and the slideshow
19048 * borders, for each axis.
19050 * @warning The stringshared strings get no new references
19051 * exclusive to the user grabbing the list, here, so if you'd like
19052 * to use them out of this call's context, you'd better @c
19053 * eina_stringshare_ref() them.
19055 * @see elm_slideshow_layout_set()
19057 * @ingroup Slideshow
19059 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19062 * Set the number of items to cache, on a given slideshow widget,
19063 * <b>before the current item</b>
19065 * @param obj The slideshow object
19066 * @param count Number of items to cache before the current one
19068 * The default value for this property is @c 2. See
19069 * @ref Slideshow_Caching "slideshow caching" for more details.
19071 * @see elm_slideshow_cache_before_get()
19073 * @ingroup Slideshow
19075 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19078 * Retrieve the number of items to cache, on a given slideshow widget,
19079 * <b>before the current item</b>
19081 * @param obj The slideshow object
19082 * @return The number of items set to be cached before the current one
19084 * @see elm_slideshow_cache_before_set() for more details
19086 * @ingroup Slideshow
19088 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19091 * Set the number of items to cache, on a given slideshow widget,
19092 * <b>after the current item</b>
19094 * @param obj The slideshow object
19095 * @param count Number of items to cache after the current one
19097 * The default value for this property is @c 2. See
19098 * @ref Slideshow_Caching "slideshow caching" for more details.
19100 * @see elm_slideshow_cache_after_get()
19102 * @ingroup Slideshow
19104 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19107 * Retrieve the number of items to cache, on a given slideshow widget,
19108 * <b>after the current item</b>
19110 * @param obj The slideshow object
19111 * @return The number of items set to be cached after the current one
19113 * @see elm_slideshow_cache_after_set() for more details
19115 * @ingroup Slideshow
19117 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19120 * Get the number of items stored in a given slideshow widget
19122 * @param obj The slideshow object
19123 * @return The number of items on @p obj, at the moment of this call
19125 * @ingroup Slideshow
19127 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19134 * @defgroup Fileselector File Selector
19136 * @image html img/widget/fileselector/preview-00.png
19137 * @image latex img/widget/fileselector/preview-00.eps
19139 * A file selector is a widget that allows a user to navigate
19140 * through a file system, reporting file selections back via its
19143 * It contains shortcut buttons for home directory (@c ~) and to
19144 * jump one directory upwards (..), as well as cancel/ok buttons to
19145 * confirm/cancel a given selection. After either one of those two
19146 * former actions, the file selector will issue its @c "done" smart
19149 * There's a text entry on it, too, showing the name of the current
19150 * selection. There's the possibility of making it editable, so it
19151 * is useful on file saving dialogs on applications, where one
19152 * gives a file name to save contents to, in a given directory in
19153 * the system. This custom file name will be reported on the @c
19154 * "done" smart callback (explained in sequence).
19156 * Finally, it has a view to display file system items into in two
19161 * If Elementary is built with support of the Ethumb thumbnailing
19162 * library, the second form of view will display preview thumbnails
19163 * of files which it supports.
19165 * Smart callbacks one can register to:
19167 * - @c "selected" - the user has clicked on a file (when not in
19168 * folders-only mode) or directory (when in folders-only mode)
19169 * - @c "directory,open" - the list has been populated with new
19170 * content (@c event_info is a pointer to the directory's
19171 * path, a @b stringshared string)
19172 * - @c "done" - the user has clicked on the "ok" or "cancel"
19173 * buttons (@c event_info is a pointer to the selection's
19174 * path, a @b stringshared string)
19176 * Here is an example on its usage:
19177 * @li @ref fileselector_example
19181 * @addtogroup Fileselector
19186 * Defines how a file selector widget is to layout its contents
19187 * (file system entries).
19189 typedef enum _Elm_Fileselector_Mode
19191 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19192 ELM_FILESELECTOR_GRID, /**< layout as a grid */
19193 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19194 } Elm_Fileselector_Mode;
19197 * Add a new file selector widget to the given parent Elementary
19198 * (container) object
19200 * @param parent The parent object
19201 * @return a new file selector widget handle or @c NULL, on errors
19203 * This function inserts a new file selector widget on the canvas.
19205 * @ingroup Fileselector
19207 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19210 * Enable/disable the file name entry box where the user can type
19211 * in a name for a file, in a given file selector widget
19213 * @param obj The file selector object
19214 * @param is_save @c EINA_TRUE to make the file selector a "saving
19215 * dialog", @c EINA_FALSE otherwise
19217 * Having the entry editable is useful on file saving dialogs on
19218 * applications, where one gives a file name to save contents to,
19219 * in a given directory in the system. This custom file name will
19220 * be reported on the @c "done" smart callback.
19222 * @see elm_fileselector_is_save_get()
19224 * @ingroup Fileselector
19226 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19229 * Get whether the given file selector is in "saving dialog" mode
19231 * @param obj The file selector object
19232 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19233 * mode, @c EINA_FALSE otherwise (and on errors)
19235 * @see elm_fileselector_is_save_set() for more details
19237 * @ingroup Fileselector
19239 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19242 * Enable/disable folder-only view for a given file selector widget
19244 * @param obj The file selector object
19245 * @param only @c EINA_TRUE to make @p obj only display
19246 * directories, @c EINA_FALSE to make files to be displayed in it
19249 * If enabled, the widget's view will only display folder items,
19252 * @see elm_fileselector_folder_only_get()
19254 * @ingroup Fileselector
19256 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19259 * Get whether folder-only view is set for a given file selector
19262 * @param obj The file selector object
19263 * @return only @c EINA_TRUE if @p obj is only displaying
19264 * directories, @c EINA_FALSE if files are being displayed in it
19265 * too (and on errors)
19267 * @see elm_fileselector_folder_only_get()
19269 * @ingroup Fileselector
19271 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19274 * Enable/disable the "ok" and "cancel" buttons on a given file
19277 * @param obj The file selector object
19278 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19280 * @note A file selector without those buttons will never emit the
19281 * @c "done" smart event, and is only usable if one is just hooking
19282 * to the other two events.
19284 * @see elm_fileselector_buttons_ok_cancel_get()
19286 * @ingroup Fileselector
19288 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19291 * Get whether the "ok" and "cancel" buttons on a given file
19292 * selector widget are being shown.
19294 * @param obj The file selector object
19295 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19296 * otherwise (and on errors)
19298 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19300 * @ingroup Fileselector
19302 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19305 * Enable/disable a tree view in the given file selector widget,
19306 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19308 * @param obj The file selector object
19309 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19312 * In a tree view, arrows are created on the sides of directories,
19313 * allowing them to expand in place.
19315 * @note If it's in other mode, the changes made by this function
19316 * will only be visible when one switches back to "list" mode.
19318 * @see elm_fileselector_expandable_get()
19320 * @ingroup Fileselector
19322 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19325 * Get whether tree view is enabled for the given file selector
19328 * @param obj The file selector object
19329 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19330 * otherwise (and or errors)
19332 * @see elm_fileselector_expandable_set() for more details
19334 * @ingroup Fileselector
19336 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19339 * Set, programmatically, the @b directory that a given file
19340 * selector widget will display contents from
19342 * @param obj The file selector object
19343 * @param path The path to display in @p obj
19345 * This will change the @b directory that @p obj is displaying. It
19346 * will also clear the text entry area on the @p obj object, which
19347 * displays select files' names.
19349 * @see elm_fileselector_path_get()
19351 * @ingroup Fileselector
19353 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19356 * Get the parent directory's path that a given file selector
19357 * widget is displaying
19359 * @param obj The file selector object
19360 * @return The (full) path of the directory the file selector is
19361 * displaying, a @b stringshared string
19363 * @see elm_fileselector_path_set()
19365 * @ingroup Fileselector
19367 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19370 * Set, programmatically, the currently selected file/directory in
19371 * the given file selector widget
19373 * @param obj The file selector object
19374 * @param path The (full) path to a file or directory
19375 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19376 * latter case occurs if the directory or file pointed to do not
19379 * @see elm_fileselector_selected_get()
19381 * @ingroup Fileselector
19383 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19386 * Get the currently selected item's (full) path, in the given file
19389 * @param obj The file selector object
19390 * @return The absolute path of the selected item, a @b
19391 * stringshared string
19393 * @note Custom editions on @p obj object's text entry, if made,
19394 * will appear on the return string of this function, naturally.
19396 * @see elm_fileselector_selected_set() for more details
19398 * @ingroup Fileselector
19400 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19403 * Set the mode in which a given file selector widget will display
19404 * (layout) file system entries in its view
19406 * @param obj The file selector object
19407 * @param mode The mode of the fileselector, being it one of
19408 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19409 * first one, naturally, will display the files in a list. The
19410 * latter will make the widget to display its entries in a grid
19413 * @note By using elm_fileselector_expandable_set(), the user may
19414 * trigger a tree view for that list.
19416 * @note If Elementary is built with support of the Ethumb
19417 * thumbnailing library, the second form of view will display
19418 * preview thumbnails of files which it supports. You must have
19419 * elm_need_ethumb() called in your Elementary for thumbnailing to
19422 * @see elm_fileselector_expandable_set().
19423 * @see elm_fileselector_mode_get().
19425 * @ingroup Fileselector
19427 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19430 * Get the mode in which a given file selector widget is displaying
19431 * (layouting) file system entries in its view
19433 * @param obj The fileselector object
19434 * @return The mode in which the fileselector is at
19436 * @see elm_fileselector_mode_set() for more details
19438 * @ingroup Fileselector
19440 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19447 * @defgroup Progressbar Progress bar
19449 * The progress bar is a widget for visually representing the
19450 * progress status of a given job/task.
19452 * A progress bar may be horizontal or vertical. It may display an
19453 * icon besides it, as well as primary and @b units labels. The
19454 * former is meant to label the widget as a whole, while the
19455 * latter, which is formatted with floating point values (and thus
19456 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19457 * units"</c>), is meant to label the widget's <b>progress
19458 * value</b>. Label, icon and unit strings/objects are @b optional
19459 * for progress bars.
19461 * A progress bar may be @b inverted, in which state it gets its
19462 * values inverted, with high values being on the left or top and
19463 * low values on the right or bottom, as opposed to normally have
19464 * the low values on the former and high values on the latter,
19465 * respectively, for horizontal and vertical modes.
19467 * The @b span of the progress, as set by
19468 * elm_progressbar_span_size_set(), is its length (horizontally or
19469 * vertically), unless one puts size hints on the widget to expand
19470 * on desired directions, by any container. That length will be
19471 * scaled by the object or applications scaling factor. At any
19472 * point code can query the progress bar for its value with
19473 * elm_progressbar_value_get().
19475 * Available widget styles for progress bars:
19477 * - @c "wheel" (simple style, no text, no progression, only
19478 * "pulse" effect is available)
19480 * Here is an example on its usage:
19481 * @li @ref progressbar_example
19485 * Add a new progress bar widget to the given parent Elementary
19486 * (container) object
19488 * @param parent The parent object
19489 * @return a new progress bar widget handle or @c NULL, on errors
19491 * This function inserts a new progress bar widget on the canvas.
19493 * @ingroup Progressbar
19495 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19498 * Set whether a given progress bar widget is at "pulsing mode" or
19501 * @param obj The progress bar object
19502 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19503 * @c EINA_FALSE to put it back to its default one
19505 * By default, progress bars will display values from the low to
19506 * high value boundaries. There are, though, contexts in which the
19507 * state of progression of a given task is @b unknown. For those,
19508 * one can set a progress bar widget to a "pulsing state", to give
19509 * the user an idea that some computation is being held, but
19510 * without exact progress values. In the default theme it will
19511 * animate its bar with the contents filling in constantly and back
19512 * to non-filled, in a loop. To start and stop this pulsing
19513 * animation, one has to explicitly call elm_progressbar_pulse().
19515 * @see elm_progressbar_pulse_get()
19516 * @see elm_progressbar_pulse()
19518 * @ingroup Progressbar
19520 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19523 * Get whether a given progress bar widget is at "pulsing mode" or
19526 * @param obj The progress bar object
19527 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19528 * if it's in the default one (and on errors)
19530 * @ingroup Progressbar
19532 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19535 * Start/stop a given progress bar "pulsing" animation, if its
19538 * @param obj The progress bar object
19539 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19540 * @c EINA_FALSE to @b stop it
19542 * @note This call won't do anything if @p obj is not under "pulsing mode".
19544 * @see elm_progressbar_pulse_set() for more details.
19546 * @ingroup Progressbar
19548 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19551 * Set the progress value (in percentage) on a given progress bar
19554 * @param obj The progress bar object
19555 * @param val The progress value (@b must be between @c 0.0 and @c
19558 * Use this call to set progress bar levels.
19560 * @note If you passes a value out of the specified range for @p
19561 * val, it will be interpreted as the @b closest of the @b boundary
19562 * values in the range.
19564 * @ingroup Progressbar
19566 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19569 * Get the progress value (in percentage) on a given progress bar
19572 * @param obj The progress bar object
19573 * @return The value of the progressbar
19575 * @see elm_progressbar_value_set() for more details
19577 * @ingroup Progressbar
19579 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19582 * Set the label of a given progress bar widget
19584 * @param obj The progress bar object
19585 * @param label The text label string, in UTF-8
19587 * @ingroup Progressbar
19588 * @deprecated use elm_object_text_set() instead.
19590 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19593 * Get the label of a given progress bar widget
19595 * @param obj The progressbar object
19596 * @return The text label string, in UTF-8
19598 * @ingroup Progressbar
19599 * @deprecated use elm_object_text_set() instead.
19601 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19604 * Set the icon object of a given progress bar widget
19606 * @param obj The progress bar object
19607 * @param icon The icon object
19609 * Use this call to decorate @p obj with an icon next to it.
19611 * @note Once the icon object is set, a previously set one will be
19612 * deleted. If you want to keep that old content object, use the
19613 * elm_progressbar_icon_unset() function.
19615 * @see elm_progressbar_icon_get()
19617 * @ingroup Progressbar
19619 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19622 * Retrieve the icon object set for a given progress bar widget
19624 * @param obj The progress bar object
19625 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19626 * otherwise (and on errors)
19628 * @see elm_progressbar_icon_set() for more details
19630 * @ingroup Progressbar
19632 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19635 * Unset an icon set on a given progress bar widget
19637 * @param obj The progress bar object
19638 * @return The icon object that was being used, if any was set, or
19639 * @c NULL, otherwise (and on errors)
19641 * This call will unparent and return the icon object which was set
19642 * for this widget, previously, on success.
19644 * @see elm_progressbar_icon_set() for more details
19646 * @ingroup Progressbar
19648 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19651 * Set the (exact) length of the bar region of a given progress bar
19654 * @param obj The progress bar object
19655 * @param size The length of the progress bar's bar region
19657 * This sets the minimum width (when in horizontal mode) or height
19658 * (when in vertical mode) of the actual bar area of the progress
19659 * bar @p obj. This in turn affects the object's minimum size. Use
19660 * this when you're not setting other size hints expanding on the
19661 * given direction (like weight and alignment hints) and you would
19662 * like it to have a specific size.
19664 * @note Icon, label and unit text around @p obj will require their
19665 * own space, which will make @p obj to require more the @p size,
19668 * @see elm_progressbar_span_size_get()
19670 * @ingroup Progressbar
19672 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19675 * Get the length set for the bar region of a given progress bar
19678 * @param obj The progress bar object
19679 * @return The length of the progress bar's bar region
19681 * If that size was not set previously, with
19682 * elm_progressbar_span_size_set(), this call will return @c 0.
19684 * @ingroup Progressbar
19686 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19689 * Set the format string for a given progress bar widget's units
19692 * @param obj The progress bar object
19693 * @param format The format string for @p obj's units label
19695 * If @c NULL is passed on @p format, it will make @p obj's units
19696 * area to be hidden completely. If not, it'll set the <b>format
19697 * string</b> for the units label's @b text. The units label is
19698 * provided a floating point value, so the units text is up display
19699 * at most one floating point falue. Note that the units label is
19700 * optional. Use a format string such as "%1.2f meters" for
19703 * @note The default format string for a progress bar is an integer
19704 * percentage, as in @c "%.0f %%".
19706 * @see elm_progressbar_unit_format_get()
19708 * @ingroup Progressbar
19710 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19713 * Retrieve the format string set for a given progress bar widget's
19716 * @param obj The progress bar object
19717 * @return The format set string for @p obj's units label or
19718 * @c NULL, if none was set (and on errors)
19720 * @see elm_progressbar_unit_format_set() for more details
19722 * @ingroup Progressbar
19724 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19727 * Set the orientation of a given progress bar widget
19729 * @param obj The progress bar object
19730 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19731 * @b horizontal, @c EINA_FALSE to make it @b vertical
19733 * Use this function to change how your progress bar is to be
19734 * disposed: vertically or horizontally.
19736 * @see elm_progressbar_horizontal_get()
19738 * @ingroup Progressbar
19740 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19743 * Retrieve the orientation of a given progress bar widget
19745 * @param obj The progress bar object
19746 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19747 * @c EINA_FALSE if it's @b vertical (and on errors)
19749 * @see elm_progressbar_horizontal_set() for more details
19751 * @ingroup Progressbar
19753 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19756 * Invert a given progress bar widget's displaying values order
19758 * @param obj The progress bar object
19759 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19760 * @c EINA_FALSE to bring it back to default, non-inverted values.
19762 * A progress bar may be @b inverted, in which state it gets its
19763 * values inverted, with high values being on the left or top and
19764 * low values on the right or bottom, as opposed to normally have
19765 * the low values on the former and high values on the latter,
19766 * respectively, for horizontal and vertical modes.
19768 * @see elm_progressbar_inverted_get()
19770 * @ingroup Progressbar
19772 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19775 * Get whether a given progress bar widget's displaying values are
19778 * @param obj The progress bar object
19779 * @return @c EINA_TRUE, if @p obj has inverted values,
19780 * @c EINA_FALSE otherwise (and on errors)
19782 * @see elm_progressbar_inverted_set() for more details
19784 * @ingroup Progressbar
19786 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19789 * @defgroup Separator Separator
19791 * @brief Separator is a very thin object used to separate other objects.
19793 * A separator can be vertical or horizontal.
19795 * @ref tutorial_separator is a good example of how to use a separator.
19799 * @brief Add a separator object to @p parent
19801 * @param parent The parent object
19803 * @return The separator object, or NULL upon failure
19805 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19807 * @brief Set the horizontal mode of a separator object
19809 * @param obj The separator object
19810 * @param horizontal If true, the separator is horizontal
19812 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19814 * @brief Get the horizontal mode of a separator object
19816 * @param obj The separator object
19817 * @return If true, the separator is horizontal
19819 * @see elm_separator_horizontal_set()
19821 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19827 * @defgroup Spinner Spinner
19828 * @ingroup Elementary
19830 * @image html img/widget/spinner/preview-00.png
19831 * @image latex img/widget/spinner/preview-00.eps
19833 * A spinner is a widget which allows the user to increase or decrease
19834 * numeric values using arrow buttons, or edit values directly, clicking
19835 * over it and typing the new value.
19837 * By default the spinner will not wrap and has a label
19838 * of "%.0f" (just showing the integer value of the double).
19840 * A spinner has a label that is formatted with floating
19841 * point values and thus accepts a printf-style format string, like
19844 * It also allows specific values to be replaced by pre-defined labels.
19846 * Smart callbacks one can register to:
19848 * - "changed" - Whenever the spinner value is changed.
19849 * - "delay,changed" - A short time after the value is changed by the user.
19850 * This will be called only when the user stops dragging for a very short
19851 * period or when they release their finger/mouse, so it avoids possibly
19852 * expensive reactions to the value change.
19854 * Available styles for it:
19856 * - @c "vertical": up/down buttons at the right side and text left aligned.
19858 * Here is an example on its usage:
19859 * @ref spinner_example
19863 * @addtogroup Spinner
19868 * Add a new spinner widget to the given parent Elementary
19869 * (container) object.
19871 * @param parent The parent object.
19872 * @return a new spinner widget handle or @c NULL, on errors.
19874 * This function inserts a new spinner widget on the canvas.
19879 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19882 * Set the format string of the displayed label.
19884 * @param obj The spinner object.
19885 * @param fmt The format string for the label display.
19887 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19888 * string for the label text. The label text is provided a floating point
19889 * value, so the label text can display up to 1 floating point value.
19890 * Note that this is optional.
19892 * Use a format string such as "%1.2f meters" for example, and it will
19893 * display values like: "3.14 meters" for a value equal to 3.14159.
19895 * Default is "%0.f".
19897 * @see elm_spinner_label_format_get()
19901 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19904 * Get the label format of the spinner.
19906 * @param obj The spinner object.
19907 * @return The text label format string in UTF-8.
19909 * @see elm_spinner_label_format_set() for details.
19913 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19916 * Set the minimum and maximum values for the spinner.
19918 * @param obj The spinner object.
19919 * @param min The minimum value.
19920 * @param max The maximum value.
19922 * Define the allowed range of values to be selected by the user.
19924 * If actual value is less than @p min, it will be updated to @p min. If it
19925 * is bigger then @p max, will be updated to @p max. Actual value can be
19926 * get with elm_spinner_value_get().
19928 * By default, min is equal to 0, and max is equal to 100.
19930 * @warning Maximum must be greater than minimum.
19932 * @see elm_spinner_min_max_get()
19936 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19939 * Get the minimum and maximum values of the spinner.
19941 * @param obj The spinner object.
19942 * @param min Pointer where to store the minimum value.
19943 * @param max Pointer where to store the maximum value.
19945 * @note If only one value is needed, the other pointer can be passed
19948 * @see elm_spinner_min_max_set() for details.
19952 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19955 * Set the step used to increment or decrement the spinner value.
19957 * @param obj The spinner object.
19958 * @param step The step value.
19960 * This value will be incremented or decremented to the displayed value.
19961 * It will be incremented while the user keep right or top arrow pressed,
19962 * and will be decremented while the user keep left or bottom arrow pressed.
19964 * The interval to increment / decrement can be set with
19965 * elm_spinner_interval_set().
19967 * By default step value is equal to 1.
19969 * @see elm_spinner_step_get()
19973 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19976 * Get the step used to increment or decrement the spinner value.
19978 * @param obj The spinner object.
19979 * @return The step value.
19981 * @see elm_spinner_step_get() for more details.
19985 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19988 * Set the value the spinner displays.
19990 * @param obj The spinner object.
19991 * @param val The value to be displayed.
19993 * Value will be presented on the label following format specified with
19994 * elm_spinner_format_set().
19996 * @warning The value must to be between min and max values. This values
19997 * are set by elm_spinner_min_max_set().
19999 * @see elm_spinner_value_get().
20000 * @see elm_spinner_format_set().
20001 * @see elm_spinner_min_max_set().
20005 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20008 * Get the value displayed by the spinner.
20010 * @param obj The spinner object.
20011 * @return The value displayed.
20013 * @see elm_spinner_value_set() for details.
20017 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20020 * Set whether the spinner should wrap when it reaches its
20021 * minimum or maximum value.
20023 * @param obj The spinner object.
20024 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20027 * Disabled by default. If disabled, when the user tries to increment the
20029 * but displayed value plus step value is bigger than maximum value,
20031 * won't allow it. The same happens when the user tries to decrement it,
20032 * but the value less step is less than minimum value.
20034 * When wrap is enabled, in such situations it will allow these changes,
20035 * but will get the value that would be less than minimum and subtracts
20036 * from maximum. Or add the value that would be more than maximum to
20040 * @li min value = 10
20041 * @li max value = 50
20042 * @li step value = 20
20043 * @li displayed value = 20
20045 * When the user decrement value (using left or bottom arrow), it will
20046 * displays @c 40, because max - (min - (displayed - step)) is
20047 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20049 * @see elm_spinner_wrap_get().
20053 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20056 * Get whether the spinner should wrap when it reaches its
20057 * minimum or maximum value.
20059 * @param obj The spinner object
20060 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20061 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20063 * @see elm_spinner_wrap_set() for details.
20067 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20070 * Set whether the spinner can be directly edited by the user or not.
20072 * @param obj The spinner object.
20073 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20074 * don't allow users to edit it directly.
20076 * Spinner objects can have edition @b disabled, in which state they will
20077 * be changed only by arrows.
20078 * Useful for contexts
20079 * where you don't want your users to interact with it writting the value.
20081 * when using special values, the user can see real value instead
20082 * of special label on edition.
20084 * It's enabled by default.
20086 * @see elm_spinner_editable_get()
20090 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20093 * Get whether the spinner can be directly edited by the user or not.
20095 * @param obj The spinner object.
20096 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20097 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20099 * @see elm_spinner_editable_set() for details.
20103 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20106 * Set a special string to display in the place of the numerical value.
20108 * @param obj The spinner object.
20109 * @param value The value to be replaced.
20110 * @param label The label to be used.
20112 * It's useful for cases when a user should select an item that is
20113 * better indicated by a label than a value. For example, weekdays or months.
20117 * sp = elm_spinner_add(win);
20118 * elm_spinner_min_max_set(sp, 1, 3);
20119 * elm_spinner_special_value_add(sp, 1, "January");
20120 * elm_spinner_special_value_add(sp, 2, "February");
20121 * elm_spinner_special_value_add(sp, 3, "March");
20122 * evas_object_show(sp);
20127 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20130 * Set the interval on time updates for an user mouse button hold
20131 * on spinner widgets' arrows.
20133 * @param obj The spinner object.
20134 * @param interval The (first) interval value in seconds.
20136 * This interval value is @b decreased while the user holds the
20137 * mouse pointer either incrementing or decrementing spinner's value.
20139 * This helps the user to get to a given value distant from the
20140 * current one easier/faster, as it will start to change quicker and
20141 * quicker on mouse button holds.
20143 * The calculation for the next change interval value, starting from
20144 * the one set with this call, is the previous interval divided by
20145 * @c 1.05, so it decreases a little bit.
20147 * The default starting interval value for automatic changes is
20150 * @see elm_spinner_interval_get()
20154 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20157 * Get the interval on time updates for an user mouse button hold
20158 * on spinner widgets' arrows.
20160 * @param obj The spinner object.
20161 * @return The (first) interval value, in seconds, set on it.
20163 * @see elm_spinner_interval_set() for more details.
20167 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20174 * @defgroup Index Index
20176 * @image html img/widget/index/preview-00.png
20177 * @image latex img/widget/index/preview-00.eps
20179 * An index widget gives you an index for fast access to whichever
20180 * group of other UI items one might have. It's a list of text
20181 * items (usually letters, for alphabetically ordered access).
20183 * Index widgets are by default hidden and just appear when the
20184 * user clicks over it's reserved area in the canvas. In its
20185 * default theme, it's an area one @ref Fingers "finger" wide on
20186 * the right side of the index widget's container.
20188 * When items on the index are selected, smart callbacks get
20189 * called, so that its user can make other container objects to
20190 * show a given area or child object depending on the index item
20191 * selected. You'd probably be using an index together with @ref
20192 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20195 * Smart events one can add callbacks for are:
20196 * - @c "changed" - When the selected index item changes. @c
20197 * event_info is the selected item's data pointer.
20198 * - @c "delay,changed" - When the selected index item changes, but
20199 * after a small idling period. @c event_info is the selected
20200 * item's data pointer.
20201 * - @c "selected" - When the user releases a mouse button and
20202 * selects an item. @c event_info is the selected item's data
20204 * - @c "level,up" - when the user moves a finger from the first
20205 * level to the second level
20206 * - @c "level,down" - when the user moves a finger from the second
20207 * level to the first level
20209 * The @c "delay,changed" event is so that it'll wait a small time
20210 * before actually reporting those events and, moreover, just the
20211 * last event happening on those time frames will actually be
20214 * Here are some examples on its usage:
20215 * @li @ref index_example_01
20216 * @li @ref index_example_02
20220 * @addtogroup Index
20224 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20227 * Add a new index widget to the given parent Elementary
20228 * (container) object
20230 * @param parent The parent object
20231 * @return a new index widget handle or @c NULL, on errors
20233 * This function inserts a new index widget on the canvas.
20237 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20240 * Set whether a given index widget is or not visible,
20243 * @param obj The index object
20244 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20246 * Not to be confused with visible as in @c evas_object_show() --
20247 * visible with regard to the widget's auto hiding feature.
20249 * @see elm_index_active_get()
20253 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20256 * Get whether a given index widget is currently visible or not.
20258 * @param obj The index object
20259 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20261 * @see elm_index_active_set() for more details
20265 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20268 * Set the items level for a given index widget.
20270 * @param obj The index object.
20271 * @param level @c 0 or @c 1, the currently implemented levels.
20273 * @see elm_index_item_level_get()
20277 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20280 * Get the items level set for a given index widget.
20282 * @param obj The index object.
20283 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20285 * @see elm_index_item_level_set() for more information
20289 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20292 * Returns the last selected item's data, for a given index widget.
20294 * @param obj The index object.
20295 * @return The item @b data associated to the last selected item on
20296 * @p obj (or @c NULL, on errors).
20298 * @warning The returned value is @b not an #Elm_Index_Item item
20299 * handle, but the data associated to it (see the @c item parameter
20300 * in elm_index_item_append(), as an example).
20304 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20307 * Append a new item on a given index widget.
20309 * @param obj The index object.
20310 * @param letter Letter under which the item should be indexed
20311 * @param item The item data to set for the index's item
20313 * Despite the most common usage of the @p letter argument is for
20314 * single char strings, one could use arbitrary strings as index
20317 * @c item will be the pointer returned back on @c "changed", @c
20318 * "delay,changed" and @c "selected" smart events.
20322 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20325 * Prepend a new item on a given index widget.
20327 * @param obj The index object.
20328 * @param letter Letter under which the item should be indexed
20329 * @param item The item data to set for the index's item
20331 * Despite the most common usage of the @p letter argument is for
20332 * single char strings, one could use arbitrary strings as index
20335 * @c item will be the pointer returned back on @c "changed", @c
20336 * "delay,changed" and @c "selected" smart events.
20340 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20343 * Append a new item, on a given index widget, <b>after the item
20344 * having @p relative as data</b>.
20346 * @param obj The index object.
20347 * @param letter Letter under which the item should be indexed
20348 * @param item The item data to set for the index's item
20349 * @param relative The item data of the index item to be the
20350 * predecessor of this new one
20352 * Despite the most common usage of the @p letter argument is for
20353 * single char strings, one could use arbitrary strings as index
20356 * @c item will be the pointer returned back on @c "changed", @c
20357 * "delay,changed" and @c "selected" smart events.
20359 * @note If @p relative is @c NULL or if it's not found to be data
20360 * set on any previous item on @p obj, this function will behave as
20361 * elm_index_item_append().
20365 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20368 * Prepend a new item, on a given index widget, <b>after the item
20369 * having @p relative as data</b>.
20371 * @param obj The index object.
20372 * @param letter Letter under which the item should be indexed
20373 * @param item The item data to set for the index's item
20374 * @param relative The item data of the index item to be the
20375 * successor of this new one
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.
20384 * @note If @p relative is @c NULL or if it's not found to be data
20385 * set on any previous item on @p obj, this function will behave as
20386 * elm_index_item_prepend().
20390 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20393 * Insert a new item into the given index widget, using @p cmp_func
20394 * function to sort items (by item handles).
20396 * @param obj The index object.
20397 * @param letter Letter under which the item should be indexed
20398 * @param item The item data to set for the index's item
20399 * @param cmp_func The comparing function to be used to sort index
20400 * items <b>by #Elm_Index_Item item handles</b>
20401 * @param cmp_data_func A @b fallback function to be called for the
20402 * sorting of index items <b>by item data</b>). It will be used
20403 * when @p cmp_func returns @c 0 (equality), which means an index
20404 * item with provided item data already exists. To decide which
20405 * data item should be pointed to by the index item in question, @p
20406 * cmp_data_func will be used. If @p cmp_data_func returns a
20407 * non-negative value, the previous index item data will be
20408 * replaced by the given @p item pointer. If the previous data need
20409 * to be freed, it should be done by the @p cmp_data_func function,
20410 * because all references to it will be lost. If this function is
20411 * not provided (@c NULL is given), index items will be @b
20412 * duplicated, if @p cmp_func returns @c 0.
20414 * Despite the most common usage of the @p letter argument is for
20415 * single char strings, one could use arbitrary strings as index
20418 * @c item will be the pointer returned back on @c "changed", @c
20419 * "delay,changed" and @c "selected" smart events.
20423 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);
20426 * Remove an item from a given index widget, <b>to be referenced by
20427 * it's data value</b>.
20429 * @param obj The index object
20430 * @param item The item's data pointer for the item to be removed
20433 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20434 * that callback function will be called by this one.
20436 * @warning The item to be removed from @p obj will be found via
20437 * its item data pointer, and not by an #Elm_Index_Item handle.
20441 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20444 * Find a given index widget's item, <b>using item data</b>.
20446 * @param obj The index object
20447 * @param item The item data pointed to by the desired index item
20448 * @return The index item handle, if found, or @c NULL otherwise
20452 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20455 * Removes @b all items from a given index widget.
20457 * @param obj The index object.
20459 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20460 * that callback function will be called for each item in @p obj.
20464 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20467 * Go to a given items level on a index widget
20469 * @param obj The index object
20470 * @param level The index level (one of @c 0 or @c 1)
20474 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20477 * Return the data associated with a given index widget item
20479 * @param it The index widget item handle
20480 * @return The data associated with @p it
20482 * @see elm_index_item_data_set()
20486 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20489 * Set the data associated with a given index widget item
20491 * @param it The index widget item handle
20492 * @param data The new data pointer to set to @p it
20494 * This sets new item data on @p it.
20496 * @warning The old data pointer won't be touched by this function, so
20497 * the user had better to free that old data himself/herself.
20501 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20504 * Set the function to be called when a given index widget item is freed.
20506 * @param it The item to set the callback on
20507 * @param func The function to call on the item's deletion
20509 * When called, @p func will have both @c data and @c event_info
20510 * arguments with the @p it item's data value and, naturally, the
20511 * @c obj argument with a handle to the parent index widget.
20515 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20518 * Get the letter (string) set on a given index widget item.
20520 * @param it The index item handle
20521 * @return The letter string set on @p it
20525 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20532 * @defgroup Photocam Photocam
20534 * @image html img/widget/photocam/preview-00.png
20535 * @image latex img/widget/photocam/preview-00.eps
20537 * This is a widget specifically for displaying high-resolution digital
20538 * camera photos giving speedy feedback (fast load), low memory footprint
20539 * and zooming and panning as well as fitting logic. It is entirely focused
20540 * on jpeg images, and takes advantage of properties of the jpeg format (via
20541 * evas loader features in the jpeg loader).
20543 * Signals that you can add callbacks for are:
20544 * @li "clicked" - This is called when a user has clicked the photo without
20546 * @li "press" - This is called when a user has pressed down on the photo.
20547 * @li "longpressed" - This is called when a user has pressed down on the
20548 * photo for a long time without dragging around.
20549 * @li "clicked,double" - This is called when a user has double-clicked the
20551 * @li "load" - Photo load begins.
20552 * @li "loaded" - This is called when the image file load is complete for the
20553 * first view (low resolution blurry version).
20554 * @li "load,detail" - Photo detailed data load begins.
20555 * @li "loaded,detail" - This is called when the image file load is complete
20556 * for the detailed image data (full resolution needed).
20557 * @li "zoom,start" - Zoom animation started.
20558 * @li "zoom,stop" - Zoom animation stopped.
20559 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20560 * @li "scroll" - the content has been scrolled (moved)
20561 * @li "scroll,anim,start" - scrolling animation has started
20562 * @li "scroll,anim,stop" - scrolling animation has stopped
20563 * @li "scroll,drag,start" - dragging the contents around has started
20564 * @li "scroll,drag,stop" - dragging the contents around has stopped
20566 * @ref tutorial_photocam shows the API in action.
20570 * @brief Types of zoom available.
20572 typedef enum _Elm_Photocam_Zoom_Mode
20574 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20575 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20576 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20577 ELM_PHOTOCAM_ZOOM_MODE_LAST
20578 } Elm_Photocam_Zoom_Mode;
20580 * @brief Add a new Photocam object
20582 * @param parent The parent object
20583 * @return The new object or NULL if it cannot be created
20585 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20587 * @brief Set the photo file to be shown
20589 * @param obj The photocam object
20590 * @param file The photo file
20591 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20593 * This sets (and shows) the specified file (with a relative or absolute
20594 * path) and will return a load error (same error that
20595 * evas_object_image_load_error_get() will return). The image will change and
20596 * adjust its size at this point and begin a background load process for this
20597 * photo that at some time in the future will be displayed at the full
20600 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20602 * @brief Returns the path of the current image file
20604 * @param obj The photocam object
20605 * @return Returns the path
20607 * @see elm_photocam_file_set()
20609 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20611 * @brief Set the zoom level of the photo
20613 * @param obj The photocam object
20614 * @param zoom The zoom level to set
20616 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20617 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20618 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20619 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20622 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20624 * @brief Get the zoom level of the photo
20626 * @param obj The photocam object
20627 * @return The current zoom level
20629 * This returns the current zoom level of the photocam object. Note that if
20630 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20631 * (which is the default), the zoom level may be changed at any time by the
20632 * photocam object itself to account for photo size and photocam viewpoer
20635 * @see elm_photocam_zoom_set()
20636 * @see elm_photocam_zoom_mode_set()
20638 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20640 * @brief Set the zoom mode
20642 * @param obj The photocam object
20643 * @param mode The desired mode
20645 * This sets the zoom mode to manual or one of several automatic levels.
20646 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20647 * elm_photocam_zoom_set() and will stay at that level until changed by code
20648 * or until zoom mode is changed. This is the default mode. The Automatic
20649 * modes will allow the photocam object to automatically adjust zoom mode
20650 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20651 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20652 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20653 * pixels within the frame are left unfilled.
20655 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20657 * @brief Get the zoom mode
20659 * @param obj The photocam object
20660 * @return The current zoom mode
20662 * This gets the current zoom mode of the photocam object.
20664 * @see elm_photocam_zoom_mode_set()
20666 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20668 * @brief Get the current image pixel width and height
20670 * @param obj The photocam object
20671 * @param w A pointer to the width return
20672 * @param h A pointer to the height return
20674 * This gets the current photo pixel width and height (for the original).
20675 * The size will be returned in the integers @p w and @p h that are pointed
20678 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20680 * @brief Get the area of the image that is currently shown
20683 * @param x A pointer to the X-coordinate of region
20684 * @param y A pointer to the Y-coordinate of region
20685 * @param w A pointer to the width
20686 * @param h A pointer to the height
20688 * @see elm_photocam_image_region_show()
20689 * @see elm_photocam_image_region_bring_in()
20691 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20693 * @brief Set the viewed portion of the image
20695 * @param obj The photocam object
20696 * @param x X-coordinate of region in image original pixels
20697 * @param y Y-coordinate of region in image original pixels
20698 * @param w Width of region in image original pixels
20699 * @param h Height of region in image original pixels
20701 * This shows the region of the image without using animation.
20703 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20705 * @brief Bring in the viewed portion of the image
20707 * @param obj The photocam object
20708 * @param x X-coordinate of region in image original pixels
20709 * @param y Y-coordinate of region in image original pixels
20710 * @param w Width of region in image original pixels
20711 * @param h Height of region in image original pixels
20713 * This shows the region of the image using animation.
20715 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20717 * @brief Set the paused state for photocam
20719 * @param obj The photocam object
20720 * @param paused The pause state to set
20722 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20723 * photocam. The default is off. This will stop zooming using animation on
20724 * zoom levels changes and change instantly. This will stop any existing
20725 * animations that are running.
20727 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20729 * @brief Get the paused state for photocam
20731 * @param obj The photocam object
20732 * @return The current paused state
20734 * This gets the current paused state for the photocam object.
20736 * @see elm_photocam_paused_set()
20738 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20740 * @brief Get the internal low-res image used for photocam
20742 * @param obj The photocam object
20743 * @return The internal image object handle, or NULL if none exists
20745 * This gets the internal image object inside photocam. Do not modify it. It
20746 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20747 * deleted at any time as well.
20749 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20751 * @brief Set the photocam scrolling bouncing.
20753 * @param obj The photocam object
20754 * @param h_bounce bouncing for horizontal
20755 * @param v_bounce bouncing for vertical
20757 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20759 * @brief Get the photocam scrolling bouncing.
20761 * @param obj The photocam object
20762 * @param h_bounce bouncing for horizontal
20763 * @param v_bounce bouncing for vertical
20765 * @see elm_photocam_bounce_set()
20767 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20773 * @defgroup Map Map
20774 * @ingroup Elementary
20776 * @image html img/widget/map/preview-00.png
20777 * @image latex img/widget/map/preview-00.eps
20779 * This is a widget specifically for displaying a map. It uses basically
20780 * OpenStreetMap provider http://www.openstreetmap.org/,
20781 * but custom providers can be added.
20783 * It supports some basic but yet nice features:
20784 * @li zoom and scroll
20785 * @li markers with content to be displayed when user clicks over it
20786 * @li group of markers
20789 * Smart callbacks one can listen to:
20791 * - "clicked" - This is called when a user has clicked the map without
20793 * - "press" - This is called when a user has pressed down on the map.
20794 * - "longpressed" - This is called when a user has pressed down on the map
20795 * for a long time without dragging around.
20796 * - "clicked,double" - This is called when a user has double-clicked
20798 * - "load,detail" - Map detailed data load begins.
20799 * - "loaded,detail" - This is called when all currently visible parts of
20800 * the map are loaded.
20801 * - "zoom,start" - Zoom animation started.
20802 * - "zoom,stop" - Zoom animation stopped.
20803 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20804 * - "scroll" - the content has been scrolled (moved).
20805 * - "scroll,anim,start" - scrolling animation has started.
20806 * - "scroll,anim,stop" - scrolling animation has stopped.
20807 * - "scroll,drag,start" - dragging the contents around has started.
20808 * - "scroll,drag,stop" - dragging the contents around has stopped.
20809 * - "downloaded" - This is called when all currently required map images
20811 * - "route,load" - This is called when route request begins.
20812 * - "route,loaded" - This is called when route request ends.
20813 * - "name,load" - This is called when name request begins.
20814 * - "name,loaded- This is called when name request ends.
20816 * Available style for map widget:
20819 * Available style for markers:
20824 * Available style for marker bubble:
20827 * List of examples:
20828 * @li @ref map_example_01
20829 * @li @ref map_example_02
20830 * @li @ref map_example_03
20839 * @enum _Elm_Map_Zoom_Mode
20840 * @typedef Elm_Map_Zoom_Mode
20842 * Set map's zoom behavior. It can be set to manual or automatic.
20844 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20846 * Values <b> don't </b> work as bitmask, only one can be choosen.
20848 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20849 * than the scroller view.
20851 * @see elm_map_zoom_mode_set()
20852 * @see elm_map_zoom_mode_get()
20856 typedef enum _Elm_Map_Zoom_Mode
20858 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20859 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20860 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20861 ELM_MAP_ZOOM_MODE_LAST
20862 } Elm_Map_Zoom_Mode;
20865 * @enum _Elm_Map_Route_Sources
20866 * @typedef Elm_Map_Route_Sources
20868 * Set route service to be used. By default used source is
20869 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20871 * @see elm_map_route_source_set()
20872 * @see elm_map_route_source_get()
20876 typedef enum _Elm_Map_Route_Sources
20878 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20879 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. */
20880 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20881 ELM_MAP_ROUTE_SOURCE_LAST
20882 } Elm_Map_Route_Sources;
20884 typedef enum _Elm_Map_Name_Sources
20886 ELM_MAP_NAME_SOURCE_NOMINATIM,
20887 ELM_MAP_NAME_SOURCE_LAST
20888 } Elm_Map_Name_Sources;
20891 * @enum _Elm_Map_Route_Type
20892 * @typedef Elm_Map_Route_Type
20894 * Set type of transport used on route.
20896 * @see elm_map_route_add()
20900 typedef enum _Elm_Map_Route_Type
20902 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20903 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20904 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20905 ELM_MAP_ROUTE_TYPE_LAST
20906 } Elm_Map_Route_Type;
20909 * @enum _Elm_Map_Route_Method
20910 * @typedef Elm_Map_Route_Method
20912 * Set the routing method, what should be priorized, time or distance.
20914 * @see elm_map_route_add()
20918 typedef enum _Elm_Map_Route_Method
20920 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20921 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20922 ELM_MAP_ROUTE_METHOD_LAST
20923 } Elm_Map_Route_Method;
20925 typedef enum _Elm_Map_Name_Method
20927 ELM_MAP_NAME_METHOD_SEARCH,
20928 ELM_MAP_NAME_METHOD_REVERSE,
20929 ELM_MAP_NAME_METHOD_LAST
20930 } Elm_Map_Name_Method;
20932 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(). */
20933 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(). */
20934 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(). */
20935 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(). */
20936 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20937 typedef struct _Elm_Map_Track Elm_Map_Track;
20939 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. */
20940 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20941 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20942 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20944 typedef char *(*ElmMapModuleSourceFunc) (void);
20945 typedef int (*ElmMapModuleZoomMinFunc) (void);
20946 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20947 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20948 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20949 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20950 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20951 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20952 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20955 * Add a new map widget to the given parent Elementary (container) object.
20957 * @param parent The parent object.
20958 * @return a new map widget handle or @c NULL, on errors.
20960 * This function inserts a new map widget on the canvas.
20964 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20967 * Set the zoom level of the map.
20969 * @param obj The map object.
20970 * @param zoom The zoom level to set.
20972 * This sets the zoom level.
20974 * It will respect limits defined by elm_map_source_zoom_min_set() and
20975 * elm_map_source_zoom_max_set().
20977 * By default these values are 0 (world map) and 18 (maximum zoom).
20979 * This function should be used when zoom mode is set to
20980 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20981 * with elm_map_zoom_mode_set().
20983 * @see elm_map_zoom_mode_set().
20984 * @see elm_map_zoom_get().
20988 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20991 * Get the zoom level of the map.
20993 * @param obj The map object.
20994 * @return The current zoom level.
20996 * This returns the current zoom level of the map object.
20998 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20999 * (which is the default), the zoom level may be changed at any time by the
21000 * map object itself to account for map size and map viewport size.
21002 * @see elm_map_zoom_set() for details.
21006 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21009 * Set the zoom mode used by the map object.
21011 * @param obj The map object.
21012 * @param mode The zoom mode of the map, being it one of
21013 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21014 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21016 * This sets the zoom mode to manual or one of the automatic levels.
21017 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21018 * elm_map_zoom_set() and will stay at that level until changed by code
21019 * or until zoom mode is changed. This is the default mode.
21021 * The Automatic modes will allow the map object to automatically
21022 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21023 * adjust zoom so the map fits inside the scroll frame with no pixels
21024 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21025 * ensure no pixels within the frame are left unfilled. Do not forget that
21026 * the valid sizes are 2^zoom, consequently the map may be smaller than
21027 * the scroller view.
21029 * @see elm_map_zoom_set()
21033 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21036 * Get the zoom mode used by the map object.
21038 * @param obj The map object.
21039 * @return The zoom mode of the map, being it one of
21040 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21041 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21043 * This function returns the current zoom mode used by the map object.
21045 * @see elm_map_zoom_mode_set() for more details.
21049 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21052 * Get the current coordinates of the map.
21054 * @param obj The map object.
21055 * @param lon Pointer where to store longitude.
21056 * @param lat Pointer where to store latitude.
21058 * This gets the current center coordinates of the map object. It can be
21059 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21061 * @see elm_map_geo_region_bring_in()
21062 * @see elm_map_geo_region_show()
21066 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21069 * Animatedly bring in given coordinates to the center of the map.
21071 * @param obj The map object.
21072 * @param lon Longitude to center at.
21073 * @param lat Latitude to center at.
21075 * This causes map to jump to the given @p lat and @p lon coordinates
21076 * and show it (by scrolling) in the center of the viewport, if it is not
21077 * already centered. This will use animation to do so and take a period
21078 * of time to complete.
21080 * @see elm_map_geo_region_show() for a function to avoid animation.
21081 * @see elm_map_geo_region_get()
21085 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21088 * Show the given coordinates at the center of the map, @b immediately.
21090 * @param obj The map object.
21091 * @param lon Longitude to center at.
21092 * @param lat Latitude to center at.
21094 * This causes map to @b redraw its viewport's contents to the
21095 * region contining the given @p lat and @p lon, that will be moved to the
21096 * center of the map.
21098 * @see elm_map_geo_region_bring_in() for a function to move with animation.
21099 * @see elm_map_geo_region_get()
21103 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21106 * Pause or unpause the map.
21108 * @param obj The map object.
21109 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21112 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21115 * The default is off.
21117 * This will stop zooming using animation, changing zoom levels will
21118 * change instantly. This will stop any existing animations that are running.
21120 * @see elm_map_paused_get()
21124 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21127 * Get a value whether map is paused or not.
21129 * @param obj The map object.
21130 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21131 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21133 * This gets the current paused state for the map object.
21135 * @see elm_map_paused_set() for details.
21139 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21142 * Set to show markers during zoom level changes or not.
21144 * @param obj The map object.
21145 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21148 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21151 * The default is off.
21153 * This will stop zooming using animation, changing zoom levels will
21154 * change instantly. This will stop any existing animations that are running.
21156 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21159 * The default is off.
21161 * Enabling it will force the map to stop displaying the markers during
21162 * zoom level changes. Set to on if you have a large number of markers.
21164 * @see elm_map_paused_markers_get()
21168 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21171 * Get a value whether markers will be displayed on zoom level changes or not
21173 * @param obj The map object.
21174 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21175 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21177 * This gets the current markers paused state for the map object.
21179 * @see elm_map_paused_markers_set() for details.
21183 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21186 * Get the information of downloading status.
21188 * @param obj The map object.
21189 * @param try_num Pointer where to store number of tiles being downloaded.
21190 * @param finish_num Pointer where to store number of tiles successfully
21193 * This gets the current downloading status for the map object, the number
21194 * of tiles being downloaded and the number of tiles already downloaded.
21198 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21201 * Convert a pixel coordinate (x,y) into a geographic coordinate
21202 * (longitude, latitude).
21204 * @param obj The map object.
21205 * @param x the coordinate.
21206 * @param y the coordinate.
21207 * @param size the size in pixels of the map.
21208 * The map is a square and generally his size is : pow(2.0, zoom)*256.
21209 * @param lon Pointer where to store the longitude that correspond to x.
21210 * @param lat Pointer where to store the latitude that correspond to y.
21212 * @note Origin pixel point is the top left corner of the viewport.
21213 * Map zoom and size are taken on account.
21215 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21219 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);
21222 * Convert a geographic coordinate (longitude, latitude) into a pixel
21223 * coordinate (x, y).
21225 * @param obj The map object.
21226 * @param lon the longitude.
21227 * @param lat the latitude.
21228 * @param size the size in pixels of the map. The map is a square
21229 * and generally his size is : pow(2.0, zoom)*256.
21230 * @param x Pointer where to store the horizontal pixel coordinate that
21231 * correspond to the longitude.
21232 * @param y Pointer where to store the vertical pixel coordinate that
21233 * correspond to the latitude.
21235 * @note Origin pixel point is the top left corner of the viewport.
21236 * Map zoom and size are taken on account.
21238 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21242 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);
21245 * Convert a geographic coordinate (longitude, latitude) into a name
21248 * @param obj The map object.
21249 * @param lon the longitude.
21250 * @param lat the latitude.
21251 * @return name A #Elm_Map_Name handle for this coordinate.
21253 * To get the string for this address, elm_map_name_address_get()
21256 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21260 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21263 * Convert a name (address) into a geographic coordinate
21264 * (longitude, latitude).
21266 * @param obj The map object.
21267 * @param name The address.
21268 * @return name A #Elm_Map_Name handle for this address.
21270 * To get the longitude and latitude, elm_map_name_region_get()
21273 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21277 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21280 * Convert a pixel coordinate into a rotated pixel coordinate.
21282 * @param obj The map object.
21283 * @param x horizontal coordinate of the point to rotate.
21284 * @param y vertical coordinate of the point to rotate.
21285 * @param cx rotation's center horizontal position.
21286 * @param cy rotation's center vertical position.
21287 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21288 * @param xx Pointer where to store rotated x.
21289 * @param yy Pointer where to store rotated y.
21293 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);
21296 * Add a new marker to the map object.
21298 * @param obj The map object.
21299 * @param lon The longitude of the marker.
21300 * @param lat The latitude of the marker.
21301 * @param clas The class, to use when marker @b isn't grouped to others.
21302 * @param clas_group The class group, to use when marker is grouped to others
21303 * @param data The data passed to the callbacks.
21305 * @return The created marker or @c NULL upon failure.
21307 * A marker will be created and shown in a specific point of the map, defined
21308 * by @p lon and @p lat.
21310 * It will be displayed using style defined by @p class when this marker
21311 * is displayed alone (not grouped). A new class can be created with
21312 * elm_map_marker_class_new().
21314 * If the marker is grouped to other markers, it will be displayed with
21315 * style defined by @p class_group. Markers with the same group are grouped
21316 * if they are close. A new group class can be created with
21317 * elm_map_marker_group_class_new().
21319 * Markers created with this method can be deleted with
21320 * elm_map_marker_remove().
21322 * A marker can have associated content to be displayed by a bubble,
21323 * when a user click over it, as well as an icon. These objects will
21324 * be fetch using class' callback functions.
21326 * @see elm_map_marker_class_new()
21327 * @see elm_map_marker_group_class_new()
21328 * @see elm_map_marker_remove()
21332 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);
21335 * Set the maximum numbers of markers' content to be displayed in a group.
21337 * @param obj The map object.
21338 * @param max The maximum numbers of items displayed in a bubble.
21340 * A bubble will be displayed when the user clicks over the group,
21341 * and will place the content of markers that belong to this group
21344 * A group can have a long list of markers, consequently the creation
21345 * of the content of the bubble can be very slow.
21347 * In order to avoid this, a maximum number of items is displayed
21350 * By default this number is 30.
21352 * Marker with the same group class are grouped if they are close.
21354 * @see elm_map_marker_add()
21358 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21361 * Remove a marker from the map.
21363 * @param marker The marker to remove.
21365 * @see elm_map_marker_add()
21369 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21372 * Get the current coordinates of the marker.
21374 * @param marker marker.
21375 * @param lat Pointer where to store the marker's latitude.
21376 * @param lon Pointer where to store the marker's longitude.
21378 * These values are set when adding markers, with function
21379 * elm_map_marker_add().
21381 * @see elm_map_marker_add()
21385 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21388 * Animatedly bring in given marker to the center of the map.
21390 * @param marker The marker to center at.
21392 * This causes map to jump to the given @p marker's coordinates
21393 * and show it (by scrolling) in the center of the viewport, if it is not
21394 * already centered. This will use animation to do so and take a period
21395 * of time to complete.
21397 * @see elm_map_marker_show() for a function to avoid animation.
21398 * @see elm_map_marker_region_get()
21402 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21405 * Show the given marker at the center of the map, @b immediately.
21407 * @param marker The marker to center at.
21409 * This causes map to @b redraw its viewport's contents to the
21410 * region contining the given @p marker's coordinates, that will be
21411 * moved to the center of the map.
21413 * @see elm_map_marker_bring_in() for a function to move with animation.
21414 * @see elm_map_markers_list_show() if more than one marker need to be
21416 * @see elm_map_marker_region_get()
21420 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21423 * Move and zoom the map to display a list of markers.
21425 * @param markers A list of #Elm_Map_Marker handles.
21427 * The map will be centered on the center point of the markers in the list.
21428 * Then the map will be zoomed in order to fit the markers using the maximum
21429 * zoom which allows display of all the markers.
21431 * @warning All the markers should belong to the same map object.
21433 * @see elm_map_marker_show() to show a single marker.
21434 * @see elm_map_marker_bring_in()
21438 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21441 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21443 * @param marker The marker wich content should be returned.
21444 * @return Return the evas object if it exists, else @c NULL.
21446 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21447 * elm_map_marker_class_get_cb_set() should be used.
21449 * This content is what will be inside the bubble that will be displayed
21450 * when an user clicks over the marker.
21452 * This returns the actual Evas object used to be placed inside
21453 * the bubble. This may be @c NULL, as it may
21454 * not have been created or may have been deleted, at any time, by
21455 * the map. <b>Do not modify this object</b> (move, resize,
21456 * show, hide, etc.), as the map is controlling it. This
21457 * function is for querying, emitting custom signals or hooking
21458 * lower level callbacks for events on that object. Do not delete
21459 * this object under any circumstances.
21463 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21466 * Update the marker
21468 * @param marker The marker to be updated.
21470 * If a content is set to this marker, it will call function to delete it,
21471 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21472 * #ElmMapMarkerGetFunc.
21474 * These functions are set for the marker class with
21475 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21479 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21482 * Close all the bubbles opened by the user.
21484 * @param obj The map object.
21486 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21487 * when the user clicks on a marker.
21489 * This functions is set for the marker class with
21490 * elm_map_marker_class_get_cb_set().
21494 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21497 * Create a new group class.
21499 * @param obj The map object.
21500 * @return Returns the new group class.
21502 * Each marker must be associated to a group class. Markers in the same
21503 * group are grouped if they are close.
21505 * The group class defines the style of the marker when a marker is grouped
21506 * to others markers. When it is alone, another class will be used.
21508 * A group class will need to be provided when creating a marker with
21509 * elm_map_marker_add().
21511 * Some properties and functions can be set by class, as:
21512 * - style, with elm_map_group_class_style_set()
21513 * - data - to be associated to the group class. It can be set using
21514 * elm_map_group_class_data_set().
21515 * - min zoom to display markers, set with
21516 * elm_map_group_class_zoom_displayed_set().
21517 * - max zoom to group markers, set using
21518 * elm_map_group_class_zoom_grouped_set().
21519 * - visibility - set if markers will be visible or not, set with
21520 * elm_map_group_class_hide_set().
21521 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21522 * It can be set using elm_map_group_class_icon_cb_set().
21524 * @see elm_map_marker_add()
21525 * @see elm_map_group_class_style_set()
21526 * @see elm_map_group_class_data_set()
21527 * @see elm_map_group_class_zoom_displayed_set()
21528 * @see elm_map_group_class_zoom_grouped_set()
21529 * @see elm_map_group_class_hide_set()
21530 * @see elm_map_group_class_icon_cb_set()
21534 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21537 * Set the marker's style of a group class.
21539 * @param clas The group class.
21540 * @param style The style to be used by markers.
21542 * Each marker must be associated to a group class, and will use the style
21543 * defined by such class when grouped to other markers.
21545 * The following styles are provided by default theme:
21546 * @li @c radio - blue circle
21547 * @li @c radio2 - green circle
21550 * @see elm_map_group_class_new() for more details.
21551 * @see elm_map_marker_add()
21555 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21558 * Set the icon callback function of a group class.
21560 * @param clas The group class.
21561 * @param icon_get The callback function that will return the icon.
21563 * Each marker must be associated to a group class, and it can display a
21564 * custom icon. The function @p icon_get must return this icon.
21566 * @see elm_map_group_class_new() for more details.
21567 * @see elm_map_marker_add()
21571 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21574 * Set the data associated to the group class.
21576 * @param clas The group class.
21577 * @param data The new user data.
21579 * This data will be passed for callback functions, like icon get callback,
21580 * that can be set with elm_map_group_class_icon_cb_set().
21582 * If a data was previously set, the object will lose the pointer for it,
21583 * so if needs to be freed, you must do it yourself.
21585 * @see elm_map_group_class_new() for more details.
21586 * @see elm_map_group_class_icon_cb_set()
21587 * @see elm_map_marker_add()
21591 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21594 * Set the minimum zoom from where the markers are displayed.
21596 * @param clas The group class.
21597 * @param zoom The minimum zoom.
21599 * Markers only will be displayed when the map is displayed at @p zoom
21602 * @see elm_map_group_class_new() for more details.
21603 * @see elm_map_marker_add()
21607 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21610 * Set the zoom from where the markers are no more grouped.
21612 * @param clas The group class.
21613 * @param zoom The maximum zoom.
21615 * Markers only will be grouped when the map is displayed at
21616 * less than @p zoom.
21618 * @see elm_map_group_class_new() for more details.
21619 * @see elm_map_marker_add()
21623 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21626 * Set if the markers associated to the group class @clas are hidden or not.
21628 * @param clas The group class.
21629 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21632 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21637 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21640 * Create a new marker class.
21642 * @param obj The map object.
21643 * @return Returns the new group class.
21645 * Each marker must be associated to a class.
21647 * The marker class defines the style of the marker when a marker is
21648 * displayed alone, i.e., not grouped to to others markers. When grouped
21649 * it will use group class style.
21651 * A marker class will need to be provided when creating a marker with
21652 * elm_map_marker_add().
21654 * Some properties and functions can be set by class, as:
21655 * - style, with elm_map_marker_class_style_set()
21656 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21657 * It can be set using elm_map_marker_class_icon_cb_set().
21658 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21659 * Set using elm_map_marker_class_get_cb_set().
21660 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21661 * Set using elm_map_marker_class_del_cb_set().
21663 * @see elm_map_marker_add()
21664 * @see elm_map_marker_class_style_set()
21665 * @see elm_map_marker_class_icon_cb_set()
21666 * @see elm_map_marker_class_get_cb_set()
21667 * @see elm_map_marker_class_del_cb_set()
21671 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21674 * Set the marker's style of a marker class.
21676 * @param clas The marker class.
21677 * @param style The style to be used by markers.
21679 * Each marker must be associated to a marker class, and will use the style
21680 * defined by such class when alone, i.e., @b not grouped to other markers.
21682 * The following styles are provided by default theme:
21687 * @see elm_map_marker_class_new() for more details.
21688 * @see elm_map_marker_add()
21692 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21695 * Set the icon callback function of a marker class.
21697 * @param clas The marker class.
21698 * @param icon_get The callback function that will return the icon.
21700 * Each marker must be associated to a marker class, and it can display a
21701 * custom icon. The function @p icon_get must return this icon.
21703 * @see elm_map_marker_class_new() for more details.
21704 * @see elm_map_marker_add()
21708 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21711 * Set the bubble content callback function of a marker class.
21713 * @param clas The marker class.
21714 * @param get The callback function that will return the content.
21716 * Each marker must be associated to a marker class, and it can display a
21717 * a content on a bubble that opens when the user click over the marker.
21718 * The function @p get must return this content object.
21720 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21723 * @see elm_map_marker_class_new() for more details.
21724 * @see elm_map_marker_class_del_cb_set()
21725 * @see elm_map_marker_add()
21729 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21732 * Set the callback function used to delete bubble content of a marker class.
21734 * @param clas The marker class.
21735 * @param del The callback function that will delete the content.
21737 * Each marker must be associated to a marker class, and it can display a
21738 * a content on a bubble that opens when the user click over the marker.
21739 * The function to return such content can be set with
21740 * elm_map_marker_class_get_cb_set().
21742 * If this content must be freed, a callback function need to be
21743 * set for that task with this function.
21745 * If this callback is defined it will have to delete (or not) the
21746 * object inside, but if the callback is not defined the object will be
21747 * destroyed with evas_object_del().
21749 * @see elm_map_marker_class_new() for more details.
21750 * @see elm_map_marker_class_get_cb_set()
21751 * @see elm_map_marker_add()
21755 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21758 * Get the list of available sources.
21760 * @param obj The map object.
21761 * @return The source names list.
21763 * It will provide a list with all available sources, that can be set as
21764 * current source with elm_map_source_name_set(), or get with
21765 * elm_map_source_name_get().
21767 * Available sources:
21773 * @see elm_map_source_name_set() for more details.
21774 * @see elm_map_source_name_get()
21778 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21781 * Set the source of the map.
21783 * @param obj The map object.
21784 * @param source The source to be used.
21786 * Map widget retrieves images that composes the map from a web service.
21787 * This web service can be set with this method.
21789 * A different service can return a different maps with different
21790 * information and it can use different zoom values.
21792 * The @p source_name need to match one of the names provided by
21793 * elm_map_source_names_get().
21795 * The current source can be get using elm_map_source_name_get().
21797 * @see elm_map_source_names_get()
21798 * @see elm_map_source_name_get()
21803 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21806 * Get the name of currently used source.
21808 * @param obj The map object.
21809 * @return Returns the name of the source in use.
21811 * @see elm_map_source_name_set() for more details.
21815 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21818 * Set the source of the route service to be used by the map.
21820 * @param obj The map object.
21821 * @param source The route service to be used, being it one of
21822 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21823 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21825 * Each one has its own algorithm, so the route retrieved may
21826 * differ depending on the source route. Now, only the default is working.
21828 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21829 * http://www.yournavigation.org/.
21831 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21832 * assumptions. Its routing core is based on Contraction Hierarchies.
21834 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21836 * @see elm_map_route_source_get().
21840 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21843 * Get the current route source.
21845 * @param obj The map object.
21846 * @return The source of the route service used by the map.
21848 * @see elm_map_route_source_set() for details.
21852 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21855 * Set the minimum zoom of the source.
21857 * @param obj The map object.
21858 * @param zoom New minimum zoom value to be used.
21860 * By default, it's 0.
21864 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21867 * Get the minimum zoom of the source.
21869 * @param obj The map object.
21870 * @return Returns the minimum zoom of the source.
21872 * @see elm_map_source_zoom_min_set() for details.
21876 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21879 * Set the maximum zoom of the source.
21881 * @param obj The map object.
21882 * @param zoom New maximum zoom value to be used.
21884 * By default, it's 18.
21888 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21891 * Get the maximum zoom of the source.
21893 * @param obj The map object.
21894 * @return Returns the maximum zoom of the source.
21896 * @see elm_map_source_zoom_min_set() for details.
21900 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21903 * Set the user agent used by the map object to access routing services.
21905 * @param obj The map object.
21906 * @param user_agent The user agent to be used by the map.
21908 * User agent is a client application implementing a network protocol used
21909 * in communications within a client–server distributed computing system
21911 * The @p user_agent identification string will transmitted in a header
21912 * field @c User-Agent.
21914 * @see elm_map_user_agent_get()
21918 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21921 * Get the user agent used by the map object.
21923 * @param obj The map object.
21924 * @return The user agent identification string used by the map.
21926 * @see elm_map_user_agent_set() for details.
21930 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21933 * Add a new route to the map object.
21935 * @param obj The map object.
21936 * @param type The type of transport to be considered when tracing a route.
21937 * @param method The routing method, what should be priorized.
21938 * @param flon The start longitude.
21939 * @param flat The start latitude.
21940 * @param tlon The destination longitude.
21941 * @param tlat The destination latitude.
21943 * @return The created route or @c NULL upon failure.
21945 * A route will be traced by point on coordinates (@p flat, @p flon)
21946 * to point on coordinates (@p tlat, @p tlon), using the route service
21947 * set with elm_map_route_source_set().
21949 * It will take @p type on consideration to define the route,
21950 * depending if the user will be walking or driving, the route may vary.
21951 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21952 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21954 * Another parameter is what the route should priorize, the minor distance
21955 * or the less time to be spend on the route. So @p method should be one
21956 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21958 * Routes created with this method can be deleted with
21959 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21960 * and distance can be get with elm_map_route_distance_get().
21962 * @see elm_map_route_remove()
21963 * @see elm_map_route_color_set()
21964 * @see elm_map_route_distance_get()
21965 * @see elm_map_route_source_set()
21969 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);
21972 * Remove a route from the map.
21974 * @param route The route to remove.
21976 * @see elm_map_route_add()
21980 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21983 * Set the route color.
21985 * @param route The route object.
21986 * @param r Red channel value, from 0 to 255.
21987 * @param g Green channel value, from 0 to 255.
21988 * @param b Blue channel value, from 0 to 255.
21989 * @param a Alpha channel value, from 0 to 255.
21991 * It uses an additive color model, so each color channel represents
21992 * how much of each primary colors must to be used. 0 represents
21993 * ausence of this color, so if all of the three are set to 0,
21994 * the color will be black.
21996 * These component values should be integers in the range 0 to 255,
21997 * (single 8-bit byte).
21999 * This sets the color used for the route. By default, it is set to
22000 * solid red (r = 255, g = 0, b = 0, a = 255).
22002 * For alpha channel, 0 represents completely transparent, and 255, opaque.
22004 * @see elm_map_route_color_get()
22008 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22011 * Get the route color.
22013 * @param route The route object.
22014 * @param r Pointer where to store the red channel value.
22015 * @param g Pointer where to store the green channel value.
22016 * @param b Pointer where to store the blue channel value.
22017 * @param a Pointer where to store the alpha channel value.
22019 * @see elm_map_route_color_set() for details.
22023 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22026 * Get the route distance in kilometers.
22028 * @param route The route object.
22029 * @return The distance of route (unit : km).
22033 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22036 * Get the information of route nodes.
22038 * @param route The route object.
22039 * @return Returns a string with the nodes of route.
22043 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22046 * Get the information of route waypoint.
22048 * @param route the route object.
22049 * @return Returns a string with information about waypoint of route.
22053 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22056 * Get the address of the name.
22058 * @param name The name handle.
22059 * @return Returns the address string of @p name.
22061 * This gets the coordinates of the @p name, created with one of the
22062 * conversion functions.
22064 * @see elm_map_utils_convert_name_into_coord()
22065 * @see elm_map_utils_convert_coord_into_name()
22069 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22072 * Get the current coordinates of the name.
22074 * @param name The name handle.
22075 * @param lat Pointer where to store the latitude.
22076 * @param lon Pointer where to store The longitude.
22078 * This gets the coordinates of the @p name, created with one of the
22079 * conversion functions.
22081 * @see elm_map_utils_convert_name_into_coord()
22082 * @see elm_map_utils_convert_coord_into_name()
22086 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22089 * Remove a name from the map.
22091 * @param name The name to remove.
22093 * Basically the struct handled by @p name will be freed, so convertions
22094 * between address and coordinates will be lost.
22096 * @see elm_map_utils_convert_name_into_coord()
22097 * @see elm_map_utils_convert_coord_into_name()
22101 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22106 * @param obj The map object.
22107 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22108 * @param cx Rotation's center horizontal position.
22109 * @param cy Rotation's center vertical position.
22111 * @see elm_map_rotate_get()
22115 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22118 * Get the rotate degree of the map
22120 * @param obj The map object
22121 * @param degree Pointer where to store degrees from 0.0 to 360.0
22122 * to rotate arount Z axis.
22123 * @param cx Pointer where to store rotation's center horizontal position.
22124 * @param cy Pointer where to store rotation's center vertical position.
22126 * @see elm_map_rotate_set() to set map rotation.
22130 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);
22133 * Enable or disable mouse wheel to be used to zoom in / out the map.
22135 * @param obj The map object.
22136 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22139 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22141 * It's disabled by default.
22143 * @see elm_map_wheel_disabled_get()
22147 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22150 * Get a value whether mouse wheel is enabled or not.
22152 * @param obj The map object.
22153 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22154 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22156 * Mouse wheel can be used for the user to zoom in or zoom out the map.
22158 * @see elm_map_wheel_disabled_set() for details.
22162 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22166 * Add a track on the map
22168 * @param obj The map object.
22169 * @param emap The emap route object.
22170 * @return The route object. This is an elm object of type Route.
22172 * @see elm_route_add() for details.
22176 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22180 * Remove a track from the map
22182 * @param obj The map object.
22183 * @param route The track to remove.
22187 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22194 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22196 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22198 EAPI double elm_route_lon_min_get(Evas_Object *obj);
22199 EAPI double elm_route_lat_min_get(Evas_Object *obj);
22200 EAPI double elm_route_lon_max_get(Evas_Object *obj);
22201 EAPI double elm_route_lat_max_get(Evas_Object *obj);
22205 * @defgroup Panel Panel
22207 * @image html img/widget/panel/preview-00.png
22208 * @image latex img/widget/panel/preview-00.eps
22210 * @brief A panel is a type of animated container that contains subobjects.
22211 * It can be expanded or contracted by clicking the button on it's edge.
22213 * Orientations are as follows:
22214 * @li ELM_PANEL_ORIENT_TOP
22215 * @li ELM_PANEL_ORIENT_LEFT
22216 * @li ELM_PANEL_ORIENT_RIGHT
22218 * @ref tutorial_panel shows one way to use this widget.
22221 typedef enum _Elm_Panel_Orient
22223 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22224 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22225 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22226 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22227 } Elm_Panel_Orient;
22229 * @brief Adds a panel object
22231 * @param parent The parent object
22233 * @return The panel object, or NULL on failure
22235 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22237 * @brief Sets the orientation of the panel
22239 * @param parent The parent object
22240 * @param orient The panel orientation. Can be one of the following:
22241 * @li ELM_PANEL_ORIENT_TOP
22242 * @li ELM_PANEL_ORIENT_LEFT
22243 * @li ELM_PANEL_ORIENT_RIGHT
22245 * Sets from where the panel will (dis)appear.
22247 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22249 * @brief Get the orientation of the panel.
22251 * @param obj The panel object
22252 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22254 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22256 * @brief Set the content of the panel.
22258 * @param obj The panel object
22259 * @param content The panel content
22261 * Once the content object is set, a previously set one will be deleted.
22262 * If you want to keep that old content object, use the
22263 * elm_panel_content_unset() function.
22265 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22267 * @brief Get the content of the panel.
22269 * @param obj The panel object
22270 * @return The content that is being used
22272 * Return the content object which is set for this widget.
22274 * @see elm_panel_content_set()
22276 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22278 * @brief Unset the content of the panel.
22280 * @param obj The panel object
22281 * @return The content that was being used
22283 * Unparent and return the content object which was set for this widget.
22285 * @see elm_panel_content_set()
22287 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22289 * @brief Set the state of the panel.
22291 * @param obj The panel object
22292 * @param hidden If true, the panel will run the animation to contract
22294 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22296 * @brief Get the state of the panel.
22298 * @param obj The panel object
22299 * @param hidden If true, the panel is in the "hide" state
22301 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22303 * @brief Toggle the hidden state of the panel from code
22305 * @param obj The panel object
22307 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22313 * @defgroup Panes Panes
22314 * @ingroup Elementary
22316 * @image html img/widget/panes/preview-00.png
22317 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22319 * @image html img/panes.png
22320 * @image latex img/panes.eps width=\textwidth
22322 * The panes adds a dragable bar between two contents. When dragged
22323 * this bar will resize contents size.
22325 * Panes can be displayed vertically or horizontally, and contents
22326 * size proportion can be customized (homogeneous by default).
22328 * Smart callbacks one can listen to:
22329 * - "press" - The panes has been pressed (button wasn't released yet).
22330 * - "unpressed" - The panes was released after being pressed.
22331 * - "clicked" - The panes has been clicked>
22332 * - "clicked,double" - The panes has been double clicked
22334 * Available styles for it:
22337 * Here is an example on its usage:
22338 * @li @ref panes_example
22342 * @addtogroup Panes
22347 * Add a new panes widget to the given parent Elementary
22348 * (container) object.
22350 * @param parent The parent object.
22351 * @return a new panes widget handle or @c NULL, on errors.
22353 * This function inserts a new panes widget on the canvas.
22357 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22360 * Set the left content of the panes widget.
22362 * @param obj The panes object.
22363 * @param content The new left content object.
22365 * Once the content object is set, a previously set one will be deleted.
22366 * If you want to keep that old content object, use the
22367 * elm_panes_content_left_unset() function.
22369 * If panes is displayed vertically, left content will be displayed at
22372 * @see elm_panes_content_left_get()
22373 * @see elm_panes_content_right_set() to set content on the other side.
22377 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22380 * Set the right content of the panes widget.
22382 * @param obj The panes object.
22383 * @param content The new right content object.
22385 * Once the content object is set, a previously set one will be deleted.
22386 * If you want to keep that old content object, use the
22387 * elm_panes_content_right_unset() function.
22389 * If panes is displayed vertically, left content will be displayed at
22392 * @see elm_panes_content_right_get()
22393 * @see elm_panes_content_left_set() to set content on the other side.
22397 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22400 * Get the left content of the panes.
22402 * @param obj The panes object.
22403 * @return The left content object that is being used.
22405 * Return the left content object which is set for this widget.
22407 * @see elm_panes_content_left_set() for details.
22411 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22414 * Get the right content of the panes.
22416 * @param obj The panes object
22417 * @return The right content object that is being used
22419 * Return the right content object which is set for this widget.
22421 * @see elm_panes_content_right_set() for details.
22425 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22428 * Unset the left content used for the panes.
22430 * @param obj The panes object.
22431 * @return The left content object that was being used.
22433 * Unparent and return the left content object which was set for this widget.
22435 * @see elm_panes_content_left_set() for details.
22436 * @see elm_panes_content_left_get().
22440 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22443 * Unset the right content used for the panes.
22445 * @param obj The panes object.
22446 * @return The right content object that was being used.
22448 * Unparent and return the right content object which was set for this
22451 * @see elm_panes_content_right_set() for details.
22452 * @see elm_panes_content_right_get().
22456 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22459 * Get the size proportion of panes widget's left side.
22461 * @param obj The panes object.
22462 * @return float value between 0.0 and 1.0 representing size proportion
22465 * @see elm_panes_content_left_size_set() for more details.
22469 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22472 * Set the size proportion of panes widget's left side.
22474 * @param obj The panes object.
22475 * @param size Value between 0.0 and 1.0 representing size proportion
22478 * By default it's homogeneous, i.e., both sides have the same size.
22480 * If something different is required, it can be set with this function.
22481 * For example, if the left content should be displayed over
22482 * 75% of the panes size, @p size should be passed as @c 0.75.
22483 * This way, right content will be resized to 25% of panes size.
22485 * If displayed vertically, left content is displayed at top, and
22486 * right content at bottom.
22488 * @note This proportion will change when user drags the panes bar.
22490 * @see elm_panes_content_left_size_get()
22494 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22497 * Set the orientation of a given panes widget.
22499 * @param obj The panes object.
22500 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22501 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22503 * Use this function to change how your panes is to be
22504 * disposed: vertically or horizontally.
22506 * By default it's displayed horizontally.
22508 * @see elm_panes_horizontal_get()
22512 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22515 * Retrieve the orientation of a given panes widget.
22517 * @param obj The panes object.
22518 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22519 * @c EINA_FALSE if it's @b vertical (and on errors).
22521 * @see elm_panes_horizontal_set() for more details.
22525 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22532 * @defgroup Flip Flip
22534 * @image html img/widget/flip/preview-00.png
22535 * @image latex img/widget/flip/preview-00.eps
22537 * This widget holds 2 content objects(Evas_Object): one on the front and one
22538 * on the back. It allows you to flip from front to back and vice-versa using
22539 * various animations.
22541 * If either the front or back contents are not set the flip will treat that
22542 * as transparent. So if you wore to set the front content but not the back,
22543 * and then call elm_flip_go() you would see whatever is below the flip.
22545 * For a list of supported animations see elm_flip_go().
22547 * Signals that you can add callbacks for are:
22548 * "animate,begin" - when a flip animation was started
22549 * "animate,done" - when a flip animation is finished
22551 * @ref tutorial_flip show how to use most of the API.
22555 typedef enum _Elm_Flip_Mode
22557 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22558 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22559 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22560 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22561 ELM_FLIP_CUBE_LEFT,
22562 ELM_FLIP_CUBE_RIGHT,
22564 ELM_FLIP_CUBE_DOWN,
22565 ELM_FLIP_PAGE_LEFT,
22566 ELM_FLIP_PAGE_RIGHT,
22570 typedef enum _Elm_Flip_Interaction
22572 ELM_FLIP_INTERACTION_NONE,
22573 ELM_FLIP_INTERACTION_ROTATE,
22574 ELM_FLIP_INTERACTION_CUBE,
22575 ELM_FLIP_INTERACTION_PAGE
22576 } Elm_Flip_Interaction;
22577 typedef enum _Elm_Flip_Direction
22579 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22580 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22581 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22582 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22583 } Elm_Flip_Direction;
22585 * @brief Add a new flip to the parent
22587 * @param parent The parent object
22588 * @return The new object or NULL if it cannot be created
22590 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22592 * @brief Set the front content of the flip widget.
22594 * @param obj The flip object
22595 * @param content The new front content object
22597 * Once the content object is set, a previously set one will be deleted.
22598 * If you want to keep that old content object, use the
22599 * elm_flip_content_front_unset() function.
22601 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22603 * @brief Set the back content of the flip widget.
22605 * @param obj The flip object
22606 * @param content The new back content object
22608 * Once the content object is set, a previously set one will be deleted.
22609 * If you want to keep that old content object, use the
22610 * elm_flip_content_back_unset() function.
22612 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22614 * @brief Get the front content used for the flip
22616 * @param obj The flip object
22617 * @return The front content object that is being used
22619 * Return the front content object which is set for this widget.
22621 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22623 * @brief Get the back content used for the flip
22625 * @param obj The flip object
22626 * @return The back content object that is being used
22628 * Return the back content object which is set for this widget.
22630 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22632 * @brief Unset the front content used for the flip
22634 * @param obj The flip object
22635 * @return The front content object that was being used
22637 * Unparent and return the front content object which was set for this widget.
22639 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22641 * @brief Unset the back content used for the flip
22643 * @param obj The flip object
22644 * @return The back content object that was being used
22646 * Unparent and return the back content object which was set for this widget.
22648 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22650 * @brief Get flip front visibility state
22652 * @param obj The flip objct
22653 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22656 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22658 * @brief Set flip perspective
22660 * @param obj The flip object
22661 * @param foc The coordinate to set the focus on
22662 * @param x The X coordinate
22663 * @param y The Y coordinate
22665 * @warning This function currently does nothing.
22667 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22669 * @brief Runs the flip animation
22671 * @param obj The flip object
22672 * @param mode The mode type
22674 * Flips the front and back contents using the @p mode animation. This
22675 * efectively hides the currently visible content and shows the hidden one.
22677 * There a number of possible animations to use for the flipping:
22678 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22679 * around a horizontal axis in the middle of its height, the other content
22680 * is shown as the other side of the flip.
22681 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22682 * around a vertical axis in the middle of its width, the other content is
22683 * shown as the other side of the flip.
22684 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22685 * around a diagonal axis in the middle of its width, the other content is
22686 * shown as the other side of the flip.
22687 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22688 * around a diagonal axis in the middle of its height, the other content is
22689 * shown as the other side of the flip.
22690 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22691 * as if the flip was a cube, the other content is show as the right face of
22693 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22694 * right as if the flip was a cube, the other content is show as the left
22695 * face of the cube.
22696 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22697 * flip was a cube, the other content is show as the bottom face of the cube.
22698 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22699 * the flip was a cube, the other content is show as the upper face of the
22701 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22702 * if the flip was a book, the other content is shown as the page below that.
22703 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22704 * as if the flip was a book, the other content is shown as the page below
22706 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22707 * flip was a book, the other content is shown as the page below that.
22708 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22709 * flip was a book, the other content is shown as the page below that.
22711 * @image html elm_flip.png
22712 * @image latex elm_flip.eps width=\textwidth
22714 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22716 * @brief Set the interactive flip mode
22718 * @param obj The flip object
22719 * @param mode The interactive flip mode to use
22721 * This sets if the flip should be interactive (allow user to click and
22722 * drag a side of the flip to reveal the back page and cause it to flip).
22723 * By default a flip is not interactive. You may also need to set which
22724 * sides of the flip are "active" for flipping and how much space they use
22725 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22726 * and elm_flip_interacton_direction_hitsize_set()
22728 * The four avilable mode of interaction are:
22729 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22730 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22731 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22732 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22734 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22735 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22736 * happen, those can only be acheived with elm_flip_go();
22738 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22740 * @brief Get the interactive flip mode
22742 * @param obj The flip object
22743 * @return The interactive flip mode
22745 * Returns the interactive flip mode set by elm_flip_interaction_set()
22747 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22749 * @brief Set which directions of the flip respond to interactive flip
22751 * @param obj The flip object
22752 * @param dir The direction to change
22753 * @param enabled If that direction is enabled or not
22755 * By default all directions are disabled, so you may want to enable the
22756 * desired directions for flipping if you need interactive flipping. You must
22757 * call this function once for each direction that should be enabled.
22759 * @see elm_flip_interaction_set()
22761 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22763 * @brief Get the enabled state of that flip direction
22765 * @param obj The flip object
22766 * @param dir The direction to check
22767 * @return If that direction is enabled or not
22769 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22771 * @see elm_flip_interaction_set()
22773 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22775 * @brief Set the amount of the flip that is sensitive to interactive flip
22777 * @param obj The flip object
22778 * @param dir The direction to modify
22779 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22781 * Set the amount of the flip that is sensitive to interactive flip, with 0
22782 * representing no area in the flip and 1 representing the entire flip. There
22783 * is however a consideration to be made in that the area will never be
22784 * smaller than the finger size set(as set in your Elementary configuration).
22786 * @see elm_flip_interaction_set()
22788 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22790 * @brief Get the amount of the flip that is sensitive to interactive flip
22792 * @param obj The flip object
22793 * @param dir The direction to check
22794 * @return The size set for that direction
22796 * Returns the amount os sensitive area set by
22797 * elm_flip_interacton_direction_hitsize_set().
22799 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22804 /* scrolledentry */
22805 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22806 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22807 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22808 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22809 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22810 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22811 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22812 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22813 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22814 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22815 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22816 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22817 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22818 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22819 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22820 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22821 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22822 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22823 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22824 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22825 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22826 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22827 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22828 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22829 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22830 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22831 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22832 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22833 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22834 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22835 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22836 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22837 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22838 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22839 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22840 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);
22841 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22842 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22843 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);
22844 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22845 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);
22846 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22847 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22848 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22849 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22850 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22851 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22852 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22853 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22854 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);
22855 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);
22856 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);
22857 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);
22858 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);
22859 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);
22860 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22861 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22862 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22863 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22864 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22865 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22866 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22869 * @defgroup Conformant Conformant
22870 * @ingroup Elementary
22872 * @image html img/widget/conformant/preview-00.png
22873 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22875 * @image html img/conformant.png
22876 * @image latex img/conformant.eps width=\textwidth
22878 * The aim is to provide a widget that can be used in elementary apps to
22879 * account for space taken up by the indicator, virtual keypad & softkey
22880 * windows when running the illume2 module of E17.
22882 * So conformant content will be sized and positioned considering the
22883 * space required for such stuff, and when they popup, as a keyboard
22884 * shows when an entry is selected, conformant content won't change.
22886 * Available styles for it:
22889 * See how to use this widget in this example:
22890 * @ref conformant_example
22894 * @addtogroup Conformant
22899 * Add a new conformant widget to the given parent Elementary
22900 * (container) object.
22902 * @param parent The parent object.
22903 * @return A new conformant widget handle or @c NULL, on errors.
22905 * This function inserts a new conformant widget on the canvas.
22907 * @ingroup Conformant
22909 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22912 * Set the content of the conformant widget.
22914 * @param obj The conformant object.
22915 * @param content The content to be displayed by the conformant.
22917 * Content will be sized and positioned considering the space required
22918 * to display a virtual keyboard. So it won't fill all the conformant
22919 * size. This way is possible to be sure that content won't resize
22920 * or be re-positioned after the keyboard is displayed.
22922 * Once the content object is set, a previously set one will be deleted.
22923 * If you want to keep that old content object, use the
22924 * elm_conformat_content_unset() function.
22926 * @see elm_conformant_content_unset()
22927 * @see elm_conformant_content_get()
22929 * @ingroup Conformant
22931 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22934 * Get the content of the conformant widget.
22936 * @param obj The conformant object.
22937 * @return The content that is being used.
22939 * Return the content object which is set for this widget.
22940 * It won't be unparent from conformant. For that, use
22941 * elm_conformant_content_unset().
22943 * @see elm_conformant_content_set() for more details.
22944 * @see elm_conformant_content_unset()
22946 * @ingroup Conformant
22948 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22951 * Unset the content of the conformant widget.
22953 * @param obj The conformant object.
22954 * @return The content that was being used.
22956 * Unparent and return the content object which was set for this widget.
22958 * @see elm_conformant_content_set() for more details.
22960 * @ingroup Conformant
22962 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22965 * Returns the Evas_Object that represents the content area.
22967 * @param obj The conformant object.
22968 * @return The content area of the widget.
22970 * @ingroup Conformant
22972 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22979 * @defgroup Mapbuf Mapbuf
22980 * @ingroup Elementary
22982 * @image html img/widget/mapbuf/preview-00.png
22983 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22985 * This holds one content object and uses an Evas Map of transformation
22986 * points to be later used with this content. So the content will be
22987 * moved, resized, etc as a single image. So it will improve performance
22988 * when you have a complex interafce, with a lot of elements, and will
22989 * need to resize or move it frequently (the content object and its
22992 * See how to use this widget in this example:
22993 * @ref mapbuf_example
22997 * @addtogroup Mapbuf
23002 * Add a new mapbuf widget to the given parent Elementary
23003 * (container) object.
23005 * @param parent The parent object.
23006 * @return A new mapbuf widget handle or @c NULL, on errors.
23008 * This function inserts a new mapbuf widget on the canvas.
23012 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23015 * Set the content of the mapbuf.
23017 * @param obj The mapbuf object.
23018 * @param content The content that will be filled in this mapbuf object.
23020 * Once the content object is set, a previously set one will be deleted.
23021 * If you want to keep that old content object, use the
23022 * elm_mapbuf_content_unset() function.
23024 * To enable map, elm_mapbuf_enabled_set() should be used.
23028 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23031 * Get the content of the mapbuf.
23033 * @param obj The mapbuf object.
23034 * @return The content that is being used.
23036 * Return the content object which is set for this widget.
23038 * @see elm_mapbuf_content_set() for details.
23042 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23045 * Unset the content of the mapbuf.
23047 * @param obj The mapbuf object.
23048 * @return The content that was being used.
23050 * Unparent and return the content object which was set for this widget.
23052 * @see elm_mapbuf_content_set() for details.
23056 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23059 * Enable or disable the map.
23061 * @param obj The mapbuf object.
23062 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23064 * This enables the map that is set or disables it. On enable, the object
23065 * geometry will be saved, and the new geometry will change (position and
23066 * size) to reflect the map geometry set.
23068 * Also, when enabled, alpha and smooth states will be used, so if the
23069 * content isn't solid, alpha should be enabled, for example, otherwise
23070 * a black retangle will fill the content.
23072 * When disabled, the stored map will be freed and geometry prior to
23073 * enabling the map will be restored.
23075 * It's disabled by default.
23077 * @see elm_mapbuf_alpha_set()
23078 * @see elm_mapbuf_smooth_set()
23082 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23085 * Get a value whether map is enabled or not.
23087 * @param obj The mapbuf object.
23088 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23089 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23091 * @see elm_mapbuf_enabled_set() for details.
23095 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23098 * Enable or disable smooth map rendering.
23100 * @param obj The mapbuf object.
23101 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23104 * This sets smoothing for map rendering. If the object is a type that has
23105 * its own smoothing settings, then both the smooth settings for this object
23106 * and the map must be turned off.
23108 * By default smooth maps are enabled.
23112 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23115 * Get a value whether smooth map rendering is enabled or not.
23117 * @param obj The mapbuf object.
23118 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23119 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23121 * @see elm_mapbuf_smooth_set() for details.
23125 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23128 * Set or unset alpha flag for map rendering.
23130 * @param obj The mapbuf object.
23131 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23134 * This sets alpha flag for map rendering. If the object is a type that has
23135 * its own alpha settings, then this will take precedence. Only image objects
23136 * have this currently. It stops alpha blending of the map area, and is
23137 * useful if you know the object and/or all sub-objects is 100% solid.
23139 * Alpha is enabled by default.
23143 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23146 * Get a value whether alpha blending is enabled or not.
23148 * @param obj The mapbuf object.
23149 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23150 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23152 * @see elm_mapbuf_alpha_set() for details.
23156 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23163 * @defgroup Flipselector Flip Selector
23165 * @image html img/widget/flipselector/preview-00.png
23166 * @image latex img/widget/flipselector/preview-00.eps
23168 * A flip selector is a widget to show a set of @b text items, one
23169 * at a time, with the same sheet switching style as the @ref Clock
23170 * "clock" widget, when one changes the current displaying sheet
23171 * (thus, the "flip" in the name).
23173 * User clicks to flip sheets which are @b held for some time will
23174 * make the flip selector to flip continuosly and automatically for
23175 * the user. The interval between flips will keep growing in time,
23176 * so that it helps the user to reach an item which is distant from
23177 * the current selection.
23179 * Smart callbacks one can register to:
23180 * - @c "selected" - when the widget's selected text item is changed
23181 * - @c "overflowed" - when the widget's current selection is changed
23182 * from the first item in its list to the last
23183 * - @c "underflowed" - when the widget's current selection is changed
23184 * from the last item in its list to the first
23186 * Available styles for it:
23189 * Here is an example on its usage:
23190 * @li @ref flipselector_example
23194 * @addtogroup Flipselector
23198 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23201 * Add a new flip selector widget to the given parent Elementary
23202 * (container) widget
23204 * @param parent The parent object
23205 * @return a new flip selector widget handle or @c NULL, on errors
23207 * This function inserts a new flip selector widget on the canvas.
23209 * @ingroup Flipselector
23211 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23214 * Programmatically select the next item of a flip selector widget
23216 * @param obj The flipselector object
23218 * @note The selection will be animated. Also, if it reaches the
23219 * end of its list of member items, it will continue with the first
23222 * @ingroup Flipselector
23224 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23227 * Programmatically select the previous item of a flip selector
23230 * @param obj The flipselector object
23232 * @note The selection will be animated. Also, if it reaches the
23233 * beginning of its list of member items, it will continue with the
23234 * last one backwards.
23236 * @ingroup Flipselector
23238 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23241 * Append a (text) item to a flip selector widget
23243 * @param obj The flipselector object
23244 * @param label The (text) label of the new item
23245 * @param func Convenience callback function to take place when
23247 * @param data Data passed to @p func, above
23248 * @return A handle to the item added or @c NULL, on errors
23250 * The widget's list of labels to show will be appended with the
23251 * given value. If the user wishes so, a callback function pointer
23252 * can be passed, which will get called when this same item is
23255 * @note The current selection @b won't be modified by appending an
23256 * element to the list.
23258 * @note The maximum length of the text label is going to be
23259 * determined <b>by the widget's theme</b>. Strings larger than
23260 * that value are going to be @b truncated.
23262 * @ingroup Flipselector
23264 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23267 * Prepend a (text) item to a flip selector widget
23269 * @param obj The flipselector object
23270 * @param label The (text) label of the new item
23271 * @param func Convenience callback function to take place when
23273 * @param data Data passed to @p func, above
23274 * @return A handle to the item added or @c NULL, on errors
23276 * The widget's list of labels to show will be prepended with the
23277 * given value. If the user wishes so, a callback function pointer
23278 * can be passed, which will get called when this same item is
23281 * @note The current selection @b won't be modified by prepending
23282 * an element to the list.
23284 * @note The maximum length of the text label is going to be
23285 * determined <b>by the widget's theme</b>. Strings larger than
23286 * that value are going to be @b truncated.
23288 * @ingroup Flipselector
23290 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23293 * Get the internal list of items in a given flip selector widget.
23295 * @param obj The flipselector object
23296 * @return The list of items (#Elm_Flipselector_Item as data) or
23297 * @c NULL on errors.
23299 * This list is @b not to be modified in any way and must not be
23300 * freed. Use the list members with functions like
23301 * elm_flipselector_item_label_set(),
23302 * elm_flipselector_item_label_get(),
23303 * elm_flipselector_item_del(),
23304 * elm_flipselector_item_selected_get(),
23305 * elm_flipselector_item_selected_set().
23307 * @warning This list is only valid until @p obj object's internal
23308 * items list is changed. It should be fetched again with another
23309 * call to this function when changes happen.
23311 * @ingroup Flipselector
23313 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23316 * Get the first item in the given flip selector widget's list of
23319 * @param obj The flipselector object
23320 * @return The first item or @c NULL, if it has no items (and on
23323 * @see elm_flipselector_item_append()
23324 * @see elm_flipselector_last_item_get()
23326 * @ingroup Flipselector
23328 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23331 * Get the last item in the given flip selector widget's list of
23334 * @param obj The flipselector object
23335 * @return The last item or @c NULL, if it has no items (and on
23338 * @see elm_flipselector_item_prepend()
23339 * @see elm_flipselector_first_item_get()
23341 * @ingroup Flipselector
23343 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23346 * Get the currently selected item in a flip selector widget.
23348 * @param obj The flipselector object
23349 * @return The selected item or @c NULL, if the widget has no items
23352 * @ingroup Flipselector
23354 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23357 * Set whether a given flip selector widget's item should be the
23358 * currently selected one.
23360 * @param item The flip selector item
23361 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23363 * This sets whether @p item is or not the selected (thus, under
23364 * display) one. If @p item is different than one under display,
23365 * the latter will be unselected. If the @p item is set to be
23366 * unselected, on the other hand, the @b first item in the widget's
23367 * internal members list will be the new selected one.
23369 * @see elm_flipselector_item_selected_get()
23371 * @ingroup Flipselector
23373 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23376 * Get whether a given flip selector widget's item is the currently
23379 * @param item The flip selector item
23380 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23383 * @see elm_flipselector_item_selected_set()
23385 * @ingroup Flipselector
23387 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23390 * Delete a given item from a flip selector widget.
23392 * @param item The item to delete
23394 * @ingroup Flipselector
23396 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23399 * Get the label of a given flip selector widget's item.
23401 * @param item The item to get label from
23402 * @return The text label of @p item or @c NULL, on errors
23404 * @see elm_flipselector_item_label_set()
23406 * @ingroup Flipselector
23408 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23411 * Set the label of a given flip selector widget's item.
23413 * @param item The item to set label on
23414 * @param label The text label string, in UTF-8 encoding
23416 * @see elm_flipselector_item_label_get()
23418 * @ingroup Flipselector
23420 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23423 * Gets the item before @p item in a flip selector widget's
23424 * internal list of items.
23426 * @param item The item to fetch previous from
23427 * @return The item before the @p item, in its parent's list. If
23428 * there is no previous item for @p item or there's an
23429 * error, @c NULL is returned.
23431 * @see elm_flipselector_item_next_get()
23433 * @ingroup Flipselector
23435 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23438 * Gets the item after @p item in a flip selector widget's
23439 * internal list of items.
23441 * @param item The item to fetch next from
23442 * @return The item after the @p item, in its parent's list. If
23443 * there is no next item for @p item or there's an
23444 * error, @c NULL is returned.
23446 * @see elm_flipselector_item_next_get()
23448 * @ingroup Flipselector
23450 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23453 * Set the interval on time updates for an user mouse button hold
23454 * on a flip selector widget.
23456 * @param obj The flip selector object
23457 * @param interval The (first) interval value in seconds
23459 * This interval value is @b decreased while the user holds the
23460 * mouse pointer either flipping up or flipping doww a given flip
23463 * This helps the user to get to a given item distant from the
23464 * current one easier/faster, as it will start to flip quicker and
23465 * quicker on mouse button holds.
23467 * The calculation for the next flip interval value, starting from
23468 * the one set with this call, is the previous interval divided by
23469 * 1.05, so it decreases a little bit.
23471 * The default starting interval value for automatic flips is
23474 * @see elm_flipselector_interval_get()
23476 * @ingroup Flipselector
23478 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23481 * Get the interval on time updates for an user mouse button hold
23482 * on a flip selector widget.
23484 * @param obj The flip selector object
23485 * @return The (first) interval value, in seconds, set on it
23487 * @see elm_flipselector_interval_set() for more details
23489 * @ingroup Flipselector
23491 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23497 * @addtogroup Calendar
23502 * @enum _Elm_Calendar_Mark_Repeat
23503 * @typedef Elm_Calendar_Mark_Repeat
23505 * Event periodicity, used to define if a mark should be repeated
23506 * @b beyond event's day. It's set when a mark is added.
23508 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23509 * there will be marks every week after this date. Marks will be displayed
23510 * at 13th, 20th, 27th, 3rd June ...
23512 * Values don't work as bitmask, only one can be choosen.
23514 * @see elm_calendar_mark_add()
23516 * @ingroup Calendar
23518 typedef enum _Elm_Calendar_Mark_Repeat
23520 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23521 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23522 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23523 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*/
23524 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. */
23525 } Elm_Calendar_Mark_Repeat;
23527 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(). */
23530 * Add a new calendar widget to the given parent Elementary
23531 * (container) object.
23533 * @param parent The parent object.
23534 * @return a new calendar widget handle or @c NULL, on errors.
23536 * This function inserts a new calendar widget on the canvas.
23538 * @ref calendar_example_01
23540 * @ingroup Calendar
23542 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23545 * Get weekdays names displayed by the calendar.
23547 * @param obj The calendar object.
23548 * @return Array of seven strings to be used as weekday names.
23550 * By default, weekdays abbreviations get from system are displayed:
23551 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23552 * The first string is related to Sunday, the second to Monday...
23554 * @see elm_calendar_weekdays_name_set()
23556 * @ref calendar_example_05
23558 * @ingroup Calendar
23560 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23563 * Set weekdays names to be displayed by the calendar.
23565 * @param obj The calendar object.
23566 * @param weekdays Array of seven strings to be used as weekday names.
23567 * @warning It must have 7 elements, or it will access invalid memory.
23568 * @warning The strings must be NULL terminated ('@\0').
23570 * By default, weekdays abbreviations get from system are displayed:
23571 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23573 * The first string should be related to Sunday, the second to Monday...
23575 * The usage should be like this:
23577 * const char *weekdays[] =
23579 * "Sunday", "Monday", "Tuesday", "Wednesday",
23580 * "Thursday", "Friday", "Saturday"
23582 * elm_calendar_weekdays_names_set(calendar, weekdays);
23585 * @see elm_calendar_weekdays_name_get()
23587 * @ref calendar_example_02
23589 * @ingroup Calendar
23591 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23594 * Set the minimum and maximum values for the year
23596 * @param obj The calendar object
23597 * @param min The minimum year, greater than 1901;
23598 * @param max The maximum year;
23600 * Maximum must be greater than minimum, except if you don't wan't to set
23602 * Default values are 1902 and -1.
23604 * If the maximum year is a negative value, it will be limited depending
23605 * on the platform architecture (year 2037 for 32 bits);
23607 * @see elm_calendar_min_max_year_get()
23609 * @ref calendar_example_03
23611 * @ingroup Calendar
23613 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23616 * Get the minimum and maximum values for the year
23618 * @param obj The calendar object.
23619 * @param min The minimum year.
23620 * @param max The maximum year.
23622 * Default values are 1902 and -1.
23624 * @see elm_calendar_min_max_year_get() for more details.
23626 * @ref calendar_example_05
23628 * @ingroup Calendar
23630 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23633 * Enable or disable day selection
23635 * @param obj The calendar object.
23636 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23639 * Enabled by default. If disabled, the user still can select months,
23640 * but not days. Selected days are highlighted on calendar.
23641 * It should be used if you won't need such selection for the widget usage.
23643 * When a day is selected, or month is changed, smart callbacks for
23644 * signal "changed" will be called.
23646 * @see elm_calendar_day_selection_enable_get()
23648 * @ref calendar_example_04
23650 * @ingroup Calendar
23652 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23655 * Get a value whether day selection is enabled or not.
23657 * @see elm_calendar_day_selection_enable_set() for details.
23659 * @param obj The calendar object.
23660 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23661 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23663 * @ref calendar_example_05
23665 * @ingroup Calendar
23667 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23671 * Set selected date to be highlighted on calendar.
23673 * @param obj The calendar object.
23674 * @param selected_time A @b tm struct to represent the selected date.
23676 * Set the selected date, changing the displayed month if needed.
23677 * Selected date changes when the user goes to next/previous month or
23678 * select a day pressing over it on calendar.
23680 * @see elm_calendar_selected_time_get()
23682 * @ref calendar_example_04
23684 * @ingroup Calendar
23686 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23689 * Get selected date.
23691 * @param obj The calendar object
23692 * @param selected_time A @b tm struct to point to selected date
23693 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23696 * Get date selected by the user or set by function
23697 * elm_calendar_selected_time_set().
23698 * Selected date changes when the user goes to next/previous month or
23699 * select a day pressing over it on calendar.
23701 * @see elm_calendar_selected_time_get()
23703 * @ref calendar_example_05
23705 * @ingroup Calendar
23707 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23710 * Set a function to format the string that will be used to display
23713 * @param obj The calendar object
23714 * @param format_function Function to set the month-year string given
23715 * the selected date
23717 * By default it uses strftime with "%B %Y" format string.
23718 * It should allocate the memory that will be used by the string,
23719 * that will be freed by the widget after usage.
23720 * A pointer to the string and a pointer to the time struct will be provided.
23725 * _format_month_year(struct tm *selected_time)
23728 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23729 * return strdup(buf);
23732 * elm_calendar_format_function_set(calendar, _format_month_year);
23735 * @ref calendar_example_02
23737 * @ingroup Calendar
23739 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23742 * Add a new mark to the calendar
23744 * @param obj The calendar object
23745 * @param mark_type A string used to define the type of mark. It will be
23746 * emitted to the theme, that should display a related modification on these
23747 * days representation.
23748 * @param mark_time A time struct to represent the date of inclusion of the
23749 * mark. For marks that repeats it will just be displayed after the inclusion
23750 * date in the calendar.
23751 * @param repeat Repeat the event following this periodicity. Can be a unique
23752 * mark (that don't repeat), daily, weekly, monthly or annually.
23753 * @return The created mark or @p NULL upon failure.
23755 * Add a mark that will be drawn in the calendar respecting the insertion
23756 * time and periodicity. It will emit the type as signal to the widget theme.
23757 * Default theme supports "holiday" and "checked", but it can be extended.
23759 * It won't immediately update the calendar, drawing the marks.
23760 * For this, call elm_calendar_marks_draw(). However, when user selects
23761 * next or previous month calendar forces marks drawn.
23763 * Marks created with this method can be deleted with
23764 * elm_calendar_mark_del().
23768 * struct tm selected_time;
23769 * time_t current_time;
23771 * current_time = time(NULL) + 5 * 84600;
23772 * localtime_r(¤t_time, &selected_time);
23773 * elm_calendar_mark_add(cal, "holiday", selected_time,
23774 * ELM_CALENDAR_ANNUALLY);
23776 * current_time = time(NULL) + 1 * 84600;
23777 * localtime_r(¤t_time, &selected_time);
23778 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23780 * elm_calendar_marks_draw(cal);
23783 * @see elm_calendar_marks_draw()
23784 * @see elm_calendar_mark_del()
23786 * @ref calendar_example_06
23788 * @ingroup Calendar
23790 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);
23793 * Delete mark from the calendar.
23795 * @param mark The mark to be deleted.
23797 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23798 * should be used instead of getting marks list and deleting each one.
23800 * @see elm_calendar_mark_add()
23802 * @ref calendar_example_06
23804 * @ingroup Calendar
23806 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23809 * Remove all calendar's marks
23811 * @param obj The calendar object.
23813 * @see elm_calendar_mark_add()
23814 * @see elm_calendar_mark_del()
23816 * @ingroup Calendar
23818 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23822 * Get a list of all the calendar marks.
23824 * @param obj The calendar object.
23825 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23827 * @see elm_calendar_mark_add()
23828 * @see elm_calendar_mark_del()
23829 * @see elm_calendar_marks_clear()
23831 * @ingroup Calendar
23833 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23836 * Draw calendar marks.
23838 * @param obj The calendar object.
23840 * Should be used after adding, removing or clearing marks.
23841 * It will go through the entire marks list updating the calendar.
23842 * If lots of marks will be added, add all the marks and then call
23845 * When the month is changed, i.e. user selects next or previous month,
23846 * marks will be drawed.
23848 * @see elm_calendar_mark_add()
23849 * @see elm_calendar_mark_del()
23850 * @see elm_calendar_marks_clear()
23852 * @ref calendar_example_06
23854 * @ingroup Calendar
23856 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23859 * Set a day text color to the same that represents Saturdays.
23861 * @param obj The calendar object.
23862 * @param pos The text position. Position is the cell counter, from left
23863 * to right, up to down. It starts on 0 and ends on 41.
23865 * @deprecated use elm_calendar_mark_add() instead like:
23868 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23869 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23872 * @see elm_calendar_mark_add()
23874 * @ingroup Calendar
23876 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23879 * Set a day text color to the same that represents Sundays.
23881 * @param obj The calendar object.
23882 * @param pos The text position. Position is the cell counter, from left
23883 * to right, up to down. It starts on 0 and ends on 41.
23885 * @deprecated use elm_calendar_mark_add() instead like:
23888 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23889 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23892 * @see elm_calendar_mark_add()
23894 * @ingroup Calendar
23896 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23899 * Set a day text color to the same that represents Weekdays.
23901 * @param obj The calendar object
23902 * @param pos The text position. Position is the cell counter, from left
23903 * to right, up to down. It starts on 0 and ends on 41.
23905 * @deprecated use elm_calendar_mark_add() instead like:
23908 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23910 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23911 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23912 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23913 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23914 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23915 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23916 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23917 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23918 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23921 * @see elm_calendar_mark_add()
23923 * @ingroup Calendar
23925 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23928 * Set the interval on time updates for an user mouse button hold
23929 * on calendar widgets' month selection.
23931 * @param obj The calendar object
23932 * @param interval The (first) interval value in seconds
23934 * This interval value is @b decreased while the user holds the
23935 * mouse pointer either selecting next or previous month.
23937 * This helps the user to get to a given month distant from the
23938 * current one easier/faster, as it will start to change quicker and
23939 * quicker on mouse button holds.
23941 * The calculation for the next change interval value, starting from
23942 * the one set with this call, is the previous interval divided by
23943 * 1.05, so it decreases a little bit.
23945 * The default starting interval value for automatic changes is
23948 * @see elm_calendar_interval_get()
23950 * @ingroup Calendar
23952 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23955 * Get the interval on time updates for an user mouse button hold
23956 * on calendar widgets' month selection.
23958 * @param obj The calendar object
23959 * @return The (first) interval value, in seconds, set on it
23961 * @see elm_calendar_interval_set() for more details
23963 * @ingroup Calendar
23965 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23972 * @defgroup Diskselector Diskselector
23973 * @ingroup Elementary
23975 * @image html img/widget/diskselector/preview-00.png
23976 * @image latex img/widget/diskselector/preview-00.eps
23978 * A diskselector is a kind of list widget. It scrolls horizontally,
23979 * and can contain label and icon objects. Three items are displayed
23980 * with the selected one in the middle.
23982 * It can act like a circular list with round mode and labels can be
23983 * reduced for a defined length for side items.
23985 * Smart callbacks one can listen to:
23986 * - "selected" - when item is selected, i.e. scroller stops.
23988 * Available styles for it:
23991 * List of examples:
23992 * @li @ref diskselector_example_01
23993 * @li @ref diskselector_example_02
23997 * @addtogroup Diskselector
24001 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(). */
24004 * Add a new diskselector widget to the given parent Elementary
24005 * (container) object.
24007 * @param parent The parent object.
24008 * @return a new diskselector widget handle or @c NULL, on errors.
24010 * This function inserts a new diskselector widget on the canvas.
24012 * @ingroup Diskselector
24014 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24017 * Enable or disable round mode.
24019 * @param obj The diskselector object.
24020 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24023 * Disabled by default. If round mode is enabled the items list will
24024 * work like a circle list, so when the user reaches the last item,
24025 * the first one will popup.
24027 * @see elm_diskselector_round_get()
24029 * @ingroup Diskselector
24031 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24034 * Get a value whether round mode is enabled or not.
24036 * @see elm_diskselector_round_set() for details.
24038 * @param obj The diskselector object.
24039 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24040 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24042 * @ingroup Diskselector
24044 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24047 * Get the side labels max length.
24049 * @deprecated use elm_diskselector_side_label_length_get() instead:
24051 * @param obj The diskselector object.
24052 * @return The max length defined for side labels, or 0 if not a valid
24055 * @ingroup Diskselector
24057 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24060 * Set the side labels max length.
24062 * @deprecated use elm_diskselector_side_label_length_set() instead:
24064 * @param obj The diskselector object.
24065 * @param len The max length defined for side labels.
24067 * @ingroup Diskselector
24069 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24072 * Get the side labels max length.
24074 * @see elm_diskselector_side_label_length_set() for details.
24076 * @param obj The diskselector object.
24077 * @return The max length defined for side labels, or 0 if not a valid
24080 * @ingroup Diskselector
24082 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24085 * Set the side labels max length.
24087 * @param obj The diskselector object.
24088 * @param len The max length defined for side labels.
24090 * Length is the number of characters of items' label that will be
24091 * visible when it's set on side positions. It will just crop
24092 * the string after defined size. E.g.:
24094 * An item with label "January" would be displayed on side position as
24095 * "Jan" if max length is set to 3, or "Janu", if this property
24098 * When it's selected, the entire label will be displayed, except for
24099 * width restrictions. In this case label will be cropped and "..."
24100 * will be concatenated.
24102 * Default side label max length is 3.
24104 * This property will be applyed over all items, included before or
24105 * later this function call.
24107 * @ingroup Diskselector
24109 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24112 * Set the number of items to be displayed.
24114 * @param obj The diskselector object.
24115 * @param num The number of items the diskselector will display.
24117 * Default value is 3, and also it's the minimun. If @p num is less
24118 * than 3, it will be set to 3.
24120 * Also, it can be set on theme, using data item @c display_item_num
24121 * on group "elm/diskselector/item/X", where X is style set.
24124 * group { name: "elm/diskselector/item/X";
24126 * item: "display_item_num" "5";
24129 * @ingroup Diskselector
24131 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24134 * Get the number of items in the diskselector object.
24136 * @param obj The diskselector object.
24138 * @ingroup Diskselector
24140 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24143 * Set bouncing behaviour when the scrolled content reaches an edge.
24145 * Tell the internal scroller object whether it should bounce or not
24146 * when it reaches the respective edges for each axis.
24148 * @param obj The diskselector object.
24149 * @param h_bounce Whether to bounce or not in the horizontal axis.
24150 * @param v_bounce Whether to bounce or not in the vertical axis.
24152 * @see elm_scroller_bounce_set()
24154 * @ingroup Diskselector
24156 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24159 * Get the bouncing behaviour of the internal scroller.
24161 * Get whether the internal scroller should bounce when the edge of each
24162 * axis is reached scrolling.
24164 * @param obj The diskselector object.
24165 * @param h_bounce Pointer where to store the bounce state of the horizontal
24167 * @param v_bounce Pointer where to store the bounce state of the vertical
24170 * @see elm_scroller_bounce_get()
24171 * @see elm_diskselector_bounce_set()
24173 * @ingroup Diskselector
24175 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24178 * Get the scrollbar policy.
24180 * @see elm_diskselector_scroller_policy_get() for details.
24182 * @param obj The diskselector object.
24183 * @param policy_h Pointer where to store horizontal scrollbar policy.
24184 * @param policy_v Pointer where to store vertical scrollbar policy.
24186 * @ingroup Diskselector
24188 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);
24191 * Set the scrollbar policy.
24193 * @param obj The diskselector object.
24194 * @param policy_h Horizontal scrollbar policy.
24195 * @param policy_v Vertical scrollbar policy.
24197 * This sets the scrollbar visibility policy for the given scroller.
24198 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24199 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24200 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24201 * This applies respectively for the horizontal and vertical scrollbars.
24203 * The both are disabled by default, i.e., are set to
24204 * #ELM_SCROLLER_POLICY_OFF.
24206 * @ingroup Diskselector
24208 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24211 * Remove all diskselector's items.
24213 * @param obj The diskselector object.
24215 * @see elm_diskselector_item_del()
24216 * @see elm_diskselector_item_append()
24218 * @ingroup Diskselector
24220 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24223 * Get a list of all the diskselector items.
24225 * @param obj The diskselector object.
24226 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24227 * or @c NULL on failure.
24229 * @see elm_diskselector_item_append()
24230 * @see elm_diskselector_item_del()
24231 * @see elm_diskselector_clear()
24233 * @ingroup Diskselector
24235 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24238 * Appends a new item to the diskselector object.
24240 * @param obj The diskselector object.
24241 * @param label The label of the diskselector item.
24242 * @param icon The icon object to use at left side of the item. An
24243 * icon can be any Evas object, but usually it is an icon created
24244 * with elm_icon_add().
24245 * @param func The function to call when the item is selected.
24246 * @param data The data to associate with the item for related callbacks.
24248 * @return The created item or @c NULL upon failure.
24250 * A new item will be created and appended to the diskselector, i.e., will
24251 * be set as last item. Also, if there is no selected item, it will
24252 * be selected. This will always happens for the first appended item.
24254 * If no icon is set, label will be centered on item position, otherwise
24255 * the icon will be placed at left of the label, that will be shifted
24258 * Items created with this method can be deleted with
24259 * elm_diskselector_item_del().
24261 * Associated @p data can be properly freed when item is deleted if a
24262 * callback function is set with elm_diskselector_item_del_cb_set().
24264 * If a function is passed as argument, it will be called everytime this item
24265 * is selected, i.e., the user stops the diskselector with this
24266 * item on center position. If such function isn't needed, just passing
24267 * @c NULL as @p func is enough. The same should be done for @p data.
24269 * Simple example (with no function callback or data associated):
24271 * disk = elm_diskselector_add(win);
24272 * ic = elm_icon_add(win);
24273 * elm_icon_file_set(ic, "path/to/image", NULL);
24274 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24275 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24278 * @see elm_diskselector_item_del()
24279 * @see elm_diskselector_item_del_cb_set()
24280 * @see elm_diskselector_clear()
24281 * @see elm_icon_add()
24283 * @ingroup Diskselector
24285 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);
24289 * Delete them item from the diskselector.
24291 * @param it The item of diskselector to be deleted.
24293 * If deleting all diskselector items is required, elm_diskselector_clear()
24294 * should be used instead of getting items list and deleting each one.
24296 * @see elm_diskselector_clear()
24297 * @see elm_diskselector_item_append()
24298 * @see elm_diskselector_item_del_cb_set()
24300 * @ingroup Diskselector
24302 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24305 * Set the function called when a diskselector item is freed.
24307 * @param it The item to set the callback on
24308 * @param func The function called
24310 * If there is a @p func, then it will be called prior item's memory release.
24311 * That will be called with the following arguments:
24313 * @li item's Evas object;
24316 * This way, a data associated to a diskselector item could be properly
24319 * @ingroup Diskselector
24321 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24324 * Get the data associated to the item.
24326 * @param it The diskselector item
24327 * @return The data associated to @p it
24329 * The return value is a pointer to data associated to @p item when it was
24330 * created, with function elm_diskselector_item_append(). If no data
24331 * was passed as argument, it will return @c NULL.
24333 * @see elm_diskselector_item_append()
24335 * @ingroup Diskselector
24337 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24340 * Set the icon associated to the item.
24342 * @param it The diskselector item
24343 * @param icon The icon object to associate with @p it
24345 * The icon object to use at left side of the item. An
24346 * icon can be any Evas object, but usually it is an icon created
24347 * with elm_icon_add().
24349 * Once the icon object is set, a previously set one will be deleted.
24350 * @warning Setting the same icon for two items will cause the icon to
24351 * dissapear from the first item.
24353 * If an icon was passed as argument on item creation, with function
24354 * elm_diskselector_item_append(), it will be already
24355 * associated to the item.
24357 * @see elm_diskselector_item_append()
24358 * @see elm_diskselector_item_icon_get()
24360 * @ingroup Diskselector
24362 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24365 * Get the icon associated to the item.
24367 * @param it The diskselector item
24368 * @return The icon associated to @p it
24370 * The return value is a pointer to the icon associated to @p item when it was
24371 * created, with function elm_diskselector_item_append(), or later
24372 * with function elm_diskselector_item_icon_set. If no icon
24373 * was passed as argument, it will return @c NULL.
24375 * @see elm_diskselector_item_append()
24376 * @see elm_diskselector_item_icon_set()
24378 * @ingroup Diskselector
24380 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24383 * Set the label of item.
24385 * @param it The item of diskselector.
24386 * @param label The label of item.
24388 * The label to be displayed by the item.
24390 * If no icon is set, label will be centered on item position, otherwise
24391 * the icon will be placed at left of the label, that will be shifted
24394 * An item with label "January" would be displayed on side position as
24395 * "Jan" if max length is set to 3 with function
24396 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24399 * When this @p item is selected, the entire label will be displayed,
24400 * except for width restrictions.
24401 * In this case label will be cropped and "..." will be concatenated,
24402 * but only for display purposes. It will keep the entire string, so
24403 * if diskselector is resized the remaining characters will be displayed.
24405 * If a label was passed as argument on item creation, with function
24406 * elm_diskselector_item_append(), it will be already
24407 * displayed by the item.
24409 * @see elm_diskselector_side_label_lenght_set()
24410 * @see elm_diskselector_item_label_get()
24411 * @see elm_diskselector_item_append()
24413 * @ingroup Diskselector
24415 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24418 * Get the label of item.
24420 * @param it The item of diskselector.
24421 * @return The label of item.
24423 * The return value is a pointer to the label associated to @p item when it was
24424 * created, with function elm_diskselector_item_append(), or later
24425 * with function elm_diskselector_item_label_set. If no label
24426 * was passed as argument, it will return @c NULL.
24428 * @see elm_diskselector_item_label_set() for more details.
24429 * @see elm_diskselector_item_append()
24431 * @ingroup Diskselector
24433 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24436 * Get the selected item.
24438 * @param obj The diskselector object.
24439 * @return The selected diskselector item.
24441 * The selected item can be unselected with function
24442 * elm_diskselector_item_selected_set(), and the first item of
24443 * diskselector will be selected.
24445 * The selected item always will be centered on diskselector, with
24446 * full label displayed, i.e., max lenght set to side labels won't
24447 * apply on the selected item. More details on
24448 * elm_diskselector_side_label_length_set().
24450 * @ingroup Diskselector
24452 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24455 * Set the selected state of an item.
24457 * @param it The diskselector item
24458 * @param selected The selected state
24460 * This sets the selected state of the given item @p it.
24461 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24463 * If a new item is selected the previosly selected will be unselected.
24464 * Previoulsy selected item can be get with function
24465 * elm_diskselector_selected_item_get().
24467 * If the item @p it is unselected, the first item of diskselector will
24470 * Selected items will be visible on center position of diskselector.
24471 * So if it was on another position before selected, or was invisible,
24472 * diskselector will animate items until the selected item reaches center
24475 * @see elm_diskselector_item_selected_get()
24476 * @see elm_diskselector_selected_item_get()
24478 * @ingroup Diskselector
24480 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24483 * Get whether the @p item is selected or not.
24485 * @param it The diskselector item.
24486 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24487 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24489 * @see elm_diskselector_selected_item_set() for details.
24490 * @see elm_diskselector_item_selected_get()
24492 * @ingroup Diskselector
24494 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24497 * Get the first item of the diskselector.
24499 * @param obj The diskselector object.
24500 * @return The first item, or @c NULL if none.
24502 * The list of items follows append order. So it will return the first
24503 * item appended to the widget that wasn't deleted.
24505 * @see elm_diskselector_item_append()
24506 * @see elm_diskselector_items_get()
24508 * @ingroup Diskselector
24510 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24513 * Get the last item of the diskselector.
24515 * @param obj The diskselector object.
24516 * @return The last item, or @c NULL if none.
24518 * The list of items follows append order. So it will return last first
24519 * item appended to the widget that wasn't deleted.
24521 * @see elm_diskselector_item_append()
24522 * @see elm_diskselector_items_get()
24524 * @ingroup Diskselector
24526 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24529 * Get the item before @p item in diskselector.
24531 * @param it The diskselector item.
24532 * @return The item before @p item, or @c NULL if none or on failure.
24534 * The list of items follows append order. So it will return item appended
24535 * just before @p item and that wasn't deleted.
24537 * If it is the first item, @c NULL will be returned.
24538 * First item can be get by elm_diskselector_first_item_get().
24540 * @see elm_diskselector_item_append()
24541 * @see elm_diskselector_items_get()
24543 * @ingroup Diskselector
24545 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24548 * Get the item after @p item in diskselector.
24550 * @param it The diskselector item.
24551 * @return The item after @p item, or @c NULL if none or on failure.
24553 * The list of items follows append order. So it will return item appended
24554 * just after @p item and that wasn't deleted.
24556 * If it is the last item, @c NULL will be returned.
24557 * Last item can be get by elm_diskselector_last_item_get().
24559 * @see elm_diskselector_item_append()
24560 * @see elm_diskselector_items_get()
24562 * @ingroup Diskselector
24564 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24567 * Set the text to be shown in the diskselector item.
24569 * @param item Target item
24570 * @param text The text to set in the content
24572 * Setup the text as tooltip to object. The item can have only one tooltip,
24573 * so any previous tooltip data is removed.
24575 * @see elm_object_tooltip_text_set() for more details.
24577 * @ingroup Diskselector
24579 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24582 * Set the content to be shown in the tooltip item.
24584 * Setup the tooltip to item. The item can have only one tooltip,
24585 * so any previous tooltip data is removed. @p func(with @p data) will
24586 * be called every time that need show the tooltip and it should
24587 * return a valid Evas_Object. This object is then managed fully by
24588 * tooltip system and is deleted when the tooltip is gone.
24590 * @param item the diskselector item being attached a tooltip.
24591 * @param func the function used to create the tooltip contents.
24592 * @param data what to provide to @a func as callback data/context.
24593 * @param del_cb called when data is not needed anymore, either when
24594 * another callback replaces @p func, the tooltip is unset with
24595 * elm_diskselector_item_tooltip_unset() or the owner @a item
24596 * dies. This callback receives as the first parameter the
24597 * given @a data, and @c event_info is the item.
24599 * @see elm_object_tooltip_content_cb_set() for more details.
24601 * @ingroup Diskselector
24603 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);
24606 * Unset tooltip from item.
24608 * @param item diskselector item to remove previously set tooltip.
24610 * Remove tooltip from item. The callback provided as del_cb to
24611 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24612 * it is not used anymore.
24614 * @see elm_object_tooltip_unset() for more details.
24615 * @see elm_diskselector_item_tooltip_content_cb_set()
24617 * @ingroup Diskselector
24619 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24623 * Sets a different style for this item tooltip.
24625 * @note before you set a style you should define a tooltip with
24626 * elm_diskselector_item_tooltip_content_cb_set() or
24627 * elm_diskselector_item_tooltip_text_set()
24629 * @param item diskselector item with tooltip already set.
24630 * @param style the theme style to use (default, transparent, ...)
24632 * @see elm_object_tooltip_style_set() for more details.
24634 * @ingroup Diskselector
24636 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24639 * Get the style for this item tooltip.
24641 * @param item diskselector item with tooltip already set.
24642 * @return style the theme style in use, defaults to "default". If the
24643 * object does not have a tooltip set, then NULL is returned.
24645 * @see elm_object_tooltip_style_get() for more details.
24646 * @see elm_diskselector_item_tooltip_style_set()
24648 * @ingroup Diskselector
24650 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24653 * Set the cursor to be shown when mouse is over the diskselector item
24655 * @param item Target item
24656 * @param cursor the cursor name to be used.
24658 * @see elm_object_cursor_set() for more details.
24660 * @ingroup Diskselector
24662 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24665 * Get the cursor to be shown when mouse is over the diskselector item
24667 * @param item diskselector item with cursor already set.
24668 * @return the cursor name.
24670 * @see elm_object_cursor_get() for more details.
24671 * @see elm_diskselector_cursor_set()
24673 * @ingroup Diskselector
24675 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24679 * Unset the cursor to be shown when mouse is over the diskselector item
24681 * @param item Target item
24683 * @see elm_object_cursor_unset() for more details.
24684 * @see elm_diskselector_cursor_set()
24686 * @ingroup Diskselector
24688 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24691 * Sets a different style for this item cursor.
24693 * @note before you set a style you should define a cursor with
24694 * elm_diskselector_item_cursor_set()
24696 * @param item diskselector item with cursor already set.
24697 * @param style the theme style to use (default, transparent, ...)
24699 * @see elm_object_cursor_style_set() for more details.
24701 * @ingroup Diskselector
24703 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24707 * Get the style for this item cursor.
24709 * @param item diskselector item with cursor already set.
24710 * @return style the theme style in use, defaults to "default". If the
24711 * object does not have a cursor set, then @c NULL is returned.
24713 * @see elm_object_cursor_style_get() for more details.
24714 * @see elm_diskselector_item_cursor_style_set()
24716 * @ingroup Diskselector
24718 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24722 * Set if the cursor set should be searched on the theme or should use
24723 * the provided by the engine, only.
24725 * @note before you set if should look on theme you should define a cursor
24726 * with elm_diskselector_item_cursor_set().
24727 * By default it will only look for cursors provided by the engine.
24729 * @param item widget item with cursor already set.
24730 * @param engine_only boolean to define if cursors set with
24731 * elm_diskselector_item_cursor_set() should be searched only
24732 * between cursors provided by the engine or searched on widget's
24735 * @see elm_object_cursor_engine_only_set() for more details.
24737 * @ingroup Diskselector
24739 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24742 * Get the cursor engine only usage for this item cursor.
24744 * @param item widget item with cursor already set.
24745 * @return engine_only boolean to define it cursors should be looked only
24746 * between the provided by the engine or searched on widget's theme as well.
24747 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24749 * @see elm_object_cursor_engine_only_get() for more details.
24750 * @see elm_diskselector_item_cursor_engine_only_set()
24752 * @ingroup Diskselector
24754 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24761 * @defgroup Colorselector Colorselector
24765 * @image html img/widget/colorselector/preview-00.png
24766 * @image latex img/widget/colorselector/preview-00.eps
24768 * @brief Widget for user to select a color.
24770 * Signals that you can add callbacks for are:
24771 * "changed" - When the color value changes(event_info is NULL).
24773 * See @ref tutorial_colorselector.
24776 * @brief Add a new colorselector to the parent
24778 * @param parent The parent object
24779 * @return The new object or NULL if it cannot be created
24781 * @ingroup Colorselector
24783 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24785 * Set a color for the colorselector
24787 * @param obj Colorselector object
24788 * @param r r-value of color
24789 * @param g g-value of color
24790 * @param b b-value of color
24791 * @param a a-value of color
24793 * @ingroup Colorselector
24795 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24797 * Get a color from the colorselector
24799 * @param obj Colorselector object
24800 * @param r integer pointer for r-value of color
24801 * @param g integer pointer for g-value of color
24802 * @param b integer pointer for b-value of color
24803 * @param a integer pointer for a-value of color
24805 * @ingroup Colorselector
24807 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24813 * @defgroup Ctxpopup Ctxpopup
24815 * @image html img/widget/ctxpopup/preview-00.png
24816 * @image latex img/widget/ctxpopup/preview-00.eps
24818 * @brief Context popup widet.
24820 * A ctxpopup is a widget that, when shown, pops up a list of items.
24821 * It automatically chooses an area inside its parent object's view
24822 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24823 * optimally fit into it. In the default theme, it will also point an
24824 * arrow to it's top left position at the time one shows it. Ctxpopup
24825 * items have a label and/or an icon. It is intended for a small
24826 * number of items (hence the use of list, not genlist).
24828 * @note Ctxpopup is a especialization of @ref Hover.
24830 * Signals that you can add callbacks for are:
24831 * "dismissed" - the ctxpopup was dismissed
24833 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24836 typedef enum _Elm_Ctxpopup_Direction
24838 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24840 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24841 the clicked area */
24842 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24843 the clicked area */
24844 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24846 ELM_CTXPOPUP_DIRECTION_DONT_KNOW, /**< ctxpopup does not determine it's direction yet*/
24847 } Elm_Ctxpopup_Direction;
24850 * @brief Add a new Ctxpopup object to the parent.
24852 * @param parent Parent object
24853 * @return New object or @c NULL, if it cannot be created
24855 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24857 * @brief Set the Ctxpopup's parent
24859 * @param obj The ctxpopup object
24860 * @param area The parent to use
24862 * Set the parent object.
24864 * @note elm_ctxpopup_add() will automatically call this function
24865 * with its @c parent argument.
24867 * @see elm_ctxpopup_add()
24868 * @see elm_hover_parent_set()
24870 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24872 * @brief Get the Ctxpopup's parent
24874 * @param obj The ctxpopup object
24876 * @see elm_ctxpopup_hover_parent_set() for more information
24878 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24880 * @brief Clear all items in the given ctxpopup object.
24882 * @param obj Ctxpopup object
24884 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24886 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24888 * @param obj Ctxpopup object
24889 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24891 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24893 * @brief Get the value of current ctxpopup object's orientation.
24895 * @param obj Ctxpopup object
24896 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24898 * @see elm_ctxpopup_horizontal_set()
24900 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24902 * @brief Add a new item to a ctxpopup object.
24904 * @param obj Ctxpopup object
24905 * @param icon Icon to be set on new item
24906 * @param label The Label of the new item
24907 * @param func Convenience function called when item selected
24908 * @param data Data passed to @p func
24909 * @return A handle to the item added or @c NULL, on errors
24911 * @warning Ctxpopup can't hold both an item list and a content at the same
24912 * time. When an item is added, any previous content will be removed.
24914 * @see elm_ctxpopup_content_set()
24916 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);
24918 * @brief Delete the given item in a ctxpopup object.
24920 * @param it Ctxpopup item to be deleted
24922 * @see elm_ctxpopup_item_append()
24924 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24926 * @brief Set the ctxpopup item's state as disabled or enabled.
24928 * @param it Ctxpopup item to be enabled/disabled
24929 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24931 * When disabled the item is greyed out to indicate it's state.
24933 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24935 * @brief Get the ctxpopup item's disabled/enabled state.
24937 * @param it Ctxpopup item to be enabled/disabled
24938 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24940 * @see elm_ctxpopup_item_disabled_set()
24942 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24944 * @brief Get the icon object for the given ctxpopup item.
24946 * @param it Ctxpopup item
24947 * @return icon object or @c NULL, if the item does not have icon or an error
24950 * @see elm_ctxpopup_item_append()
24951 * @see elm_ctxpopup_item_icon_set()
24953 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24955 * @brief Sets the side icon associated with the ctxpopup item
24957 * @param it Ctxpopup item
24958 * @param icon Icon object to be set
24960 * Once the icon object is set, a previously set one will be deleted.
24961 * @warning Setting the same icon for two items will cause the icon to
24962 * dissapear from the first item.
24964 * @see elm_ctxpopup_item_append()
24966 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24968 * @brief Get the label for the given ctxpopup item.
24970 * @param it Ctxpopup item
24971 * @return label string or @c NULL, if the item does not have label or an
24974 * @see elm_ctxpopup_item_append()
24975 * @see elm_ctxpopup_item_label_set()
24977 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24979 * @brief (Re)set the label on the given ctxpopup item.
24981 * @param it Ctxpopup item
24982 * @param label String to set as label
24984 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24986 * @brief Set an elm widget as the content of the ctxpopup.
24988 * @param obj Ctxpopup object
24989 * @param content Content to be swallowed
24991 * If the content object is already set, a previous one will bedeleted. If
24992 * you want to keep that old content object, use the
24993 * elm_ctxpopup_content_unset() function.
24995 * @deprecated use elm_object_content_set()
24997 * @warning Ctxpopup can't hold both a item list and a content at the same
24998 * time. When a content is set, any previous items will be removed.
25000 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25002 * @brief Unset the ctxpopup content
25004 * @param obj Ctxpopup object
25005 * @return The content that was being used
25007 * Unparent and return the content object which was set for this widget.
25009 * @deprecated use elm_object_content_unset()
25011 * @see elm_ctxpopup_content_set()
25013 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25015 * @brief Set the direction priority of a ctxpopup.
25017 * @param obj Ctxpopup object
25018 * @param first 1st priority of direction
25019 * @param second 2nd priority of direction
25020 * @param third 3th priority of direction
25021 * @param fourth 4th priority of direction
25023 * This functions gives a chance to user to set the priority of ctxpopup
25024 * showing direction. This doesn't guarantee the ctxpopup will appear in the
25025 * requested direction.
25027 * @see Elm_Ctxpopup_Direction
25029 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);
25031 * @brief Get the direction priority of a ctxpopup.
25033 * @param obj Ctxpopup object
25034 * @param first 1st priority of direction to be returned
25035 * @param second 2nd priority of direction to be returned
25036 * @param third 3th priority of direction to be returned
25037 * @param fourth 4th priority of direction to be returned
25039 * @see elm_ctxpopup_direction_priority_set() for more information.
25041 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);
25044 * @brief Get the current direction of a ctxpopup.
25046 * @param obj Ctxpopup object
25047 * @return current direction of a ctxpopup
25049 * @warning Once the ctxpopup showed up, the direction would be determined
25051 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25060 * @defgroup Transit Transit
25061 * @ingroup Elementary
25063 * Transit is designed to apply various animated transition effects to @c
25064 * Evas_Object, such like translation, rotation, etc. For using these
25065 * effects, create an @ref Elm_Transit and add the desired transition effects.
25067 * Once the effects are added into transit, they will be automatically
25068 * managed (their callback will be called until the duration is ended, and
25069 * they will be deleted on completion).
25073 * Elm_Transit *trans = elm_transit_add();
25074 * elm_transit_object_add(trans, obj);
25075 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25076 * elm_transit_duration_set(transit, 1);
25077 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25078 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25079 * elm_transit_repeat_times_set(transit, 3);
25082 * Some transition effects are used to change the properties of objects. They
25084 * @li @ref elm_transit_effect_translation_add
25085 * @li @ref elm_transit_effect_color_add
25086 * @li @ref elm_transit_effect_rotation_add
25087 * @li @ref elm_transit_effect_wipe_add
25088 * @li @ref elm_transit_effect_zoom_add
25089 * @li @ref elm_transit_effect_resizing_add
25091 * Other transition effects are used to make one object disappear and another
25092 * object appear on its old place. These effects are:
25094 * @li @ref elm_transit_effect_flip_add
25095 * @li @ref elm_transit_effect_resizable_flip_add
25096 * @li @ref elm_transit_effect_fade_add
25097 * @li @ref elm_transit_effect_blend_add
25099 * It's also possible to make a transition chain with @ref
25100 * elm_transit_chain_transit_add.
25102 * @warning We strongly recommend to use elm_transit just when edje can not do
25103 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25104 * animations can be manipulated inside the theme.
25106 * List of examples:
25107 * @li @ref transit_example_01_explained
25108 * @li @ref transit_example_02_explained
25109 * @li @ref transit_example_03_c
25110 * @li @ref transit_example_04_c
25116 * @enum Elm_Transit_Tween_Mode
25118 * The type of acceleration used in the transition.
25122 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25123 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25124 over time, then decrease again
25126 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25128 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25130 } Elm_Transit_Tween_Mode;
25133 * @enum Elm_Transit_Effect_Flip_Axis
25135 * The axis where flip effect should be applied.
25139 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25140 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25141 } Elm_Transit_Effect_Flip_Axis;
25143 * @enum Elm_Transit_Effect_Wipe_Dir
25145 * The direction where the wipe effect should occur.
25149 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25150 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25151 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25152 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25153 } Elm_Transit_Effect_Wipe_Dir;
25154 /** @enum Elm_Transit_Effect_Wipe_Type
25156 * Whether the wipe effect should show or hide the object.
25160 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25162 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25164 } Elm_Transit_Effect_Wipe_Type;
25167 * @typedef Elm_Transit
25169 * The Transit created with elm_transit_add(). This type has the information
25170 * about the objects which the transition will be applied, and the
25171 * transition effects that will be used. It also contains info about
25172 * duration, number of repetitions, auto-reverse, etc.
25174 typedef struct _Elm_Transit Elm_Transit;
25175 typedef void Elm_Transit_Effect;
25177 * @typedef Elm_Transit_Effect_Transition_Cb
25179 * Transition callback called for this effect on each transition iteration.
25181 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25183 * Elm_Transit_Effect_End_Cb
25185 * Transition callback called for this effect when the transition is over.
25187 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25190 * Elm_Transit_Del_Cb
25192 * A callback called when the transit is deleted.
25194 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25199 * @note Is not necessary to delete the transit object, it will be deleted at
25200 * the end of its operation.
25201 * @note The transit will start playing when the program enter in the main loop, is not
25202 * necessary to give a start to the transit.
25204 * @return The transit object.
25208 EAPI Elm_Transit *elm_transit_add(void);
25211 * Stops the animation and delete the @p transit object.
25213 * Call this function if you wants to stop the animation before the duration
25214 * time. Make sure the @p transit object is still alive with
25215 * elm_transit_del_cb_set() function.
25216 * All added effects will be deleted, calling its repective data_free_cb
25217 * functions. The function setted by elm_transit_del_cb_set() will be called.
25219 * @see elm_transit_del_cb_set()
25221 * @param transit The transit object to be deleted.
25224 * @warning Just call this function if you are sure the transit is alive.
25226 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25229 * Add a new effect to the transit.
25231 * @note The cb function and the data are the key to the effect. If you try to
25232 * add an already added effect, nothing is done.
25233 * @note After the first addition of an effect in @p transit, if its
25234 * effect list become empty again, the @p transit will be killed by
25235 * elm_transit_del(transit) function.
25239 * Elm_Transit *transit = elm_transit_add();
25240 * elm_transit_effect_add(transit,
25241 * elm_transit_effect_blend_op,
25242 * elm_transit_effect_blend_context_new(),
25243 * elm_transit_effect_blend_context_free);
25246 * @param transit The transit object.
25247 * @param transition_cb The operation function. It is called when the
25248 * animation begins, it is the function that actually performs the animation.
25249 * It is called with the @p data, @p transit and the time progression of the
25250 * animation (a double value between 0.0 and 1.0).
25251 * @param effect The context data of the effect.
25252 * @param end_cb The function to free the context data, it will be called
25253 * at the end of the effect, it must finalize the animation and free the
25257 * @warning The transit free the context data at the and of the transition with
25258 * the data_free_cb function, do not use the context data in another transit.
25260 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);
25263 * Delete an added effect.
25265 * This function will remove the effect from the @p transit, calling the
25266 * data_free_cb to free the @p data.
25268 * @see elm_transit_effect_add()
25270 * @note If the effect is not found, nothing is done.
25271 * @note If the effect list become empty, this function will call
25272 * elm_transit_del(transit), that is, it will kill the @p transit.
25274 * @param transit The transit object.
25275 * @param transition_cb The operation function.
25276 * @param effect The context data of the effect.
25280 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);
25283 * Add new object to apply the effects.
25285 * @note After the first addition of an object in @p transit, if its
25286 * object list become empty again, the @p transit will be killed by
25287 * elm_transit_del(transit) function.
25288 * @note If the @p obj belongs to another transit, the @p obj will be
25289 * removed from it and it will only belong to the @p transit. If the old
25290 * transit stays without objects, it will die.
25291 * @note When you add an object into the @p transit, its state from
25292 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25293 * transit ends, if you change this state whith evas_object_pass_events_set()
25294 * after add the object, this state will change again when @p transit stops to
25297 * @param transit The transit object.
25298 * @param obj Object to be animated.
25301 * @warning It is not allowed to add a new object after transit begins to go.
25303 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25306 * Removes an added object from the transit.
25308 * @note If the @p obj is not in the @p transit, nothing is done.
25309 * @note If the list become empty, this function will call
25310 * elm_transit_del(transit), that is, it will kill the @p transit.
25312 * @param transit The transit object.
25313 * @param obj Object to be removed from @p transit.
25316 * @warning It is not allowed to remove objects after transit begins to go.
25318 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25321 * Get the objects of the transit.
25323 * @param transit The transit object.
25324 * @return a Eina_List with the objects from the transit.
25328 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25331 * Enable/disable keeping up the objects states.
25332 * If it is not kept, the objects states will be reset when transition ends.
25334 * @note @p transit can not be NULL.
25335 * @note One state includes geometry, color, map data.
25337 * @param transit The transit object.
25338 * @param state_keep Keeping or Non Keeping.
25342 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25345 * Get a value whether the objects states will be reset or not.
25347 * @note @p transit can not be NULL
25349 * @see elm_transit_objects_final_state_keep_set()
25351 * @param transit The transit object.
25352 * @return EINA_TRUE means the states of the objects will be reset.
25353 * If @p transit is NULL, EINA_FALSE is returned
25357 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25360 * Set the event enabled when transit is operating.
25362 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25363 * events from mouse and keyboard during the animation.
25364 * @note When you add an object with elm_transit_object_add(), its state from
25365 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25366 * transit ends, if you change this state with evas_object_pass_events_set()
25367 * after adding the object, this state will change again when @p transit stops
25370 * @param transit The transit object.
25371 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25372 * ignored otherwise.
25376 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25379 * Get the value of event enabled status.
25381 * @see elm_transit_event_enabled_set()
25383 * @param transit The Transit object
25384 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25385 * EINA_FALSE is returned
25389 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25392 * Set the user-callback function when the transit is deleted.
25394 * @note Using this function twice will overwrite the first function setted.
25395 * @note the @p transit object will be deleted after call @p cb function.
25397 * @param transit The transit object.
25398 * @param cb Callback function pointer. This function will be called before
25399 * the deletion of the transit.
25400 * @param data Callback funtion user data. It is the @p op parameter.
25404 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25407 * Set reverse effect automatically.
25409 * If auto reverse is setted, after running the effects with the progress
25410 * parameter from 0 to 1, it will call the effecs again with the progress
25411 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25412 * where the duration was setted with the function elm_transit_add and
25413 * the repeat with the function elm_transit_repeat_times_set().
25415 * @param transit The transit object.
25416 * @param reverse EINA_TRUE means the auto_reverse is on.
25420 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25423 * Get if the auto reverse is on.
25425 * @see elm_transit_auto_reverse_set()
25427 * @param transit The transit object.
25428 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25429 * EINA_FALSE is returned
25433 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25436 * Set the transit repeat count. Effect will be repeated by repeat count.
25438 * This function sets the number of repetition the transit will run after
25439 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25440 * If the @p repeat is a negative number, it will repeat infinite times.
25442 * @note If this function is called during the transit execution, the transit
25443 * will run @p repeat times, ignoring the times it already performed.
25445 * @param transit The transit object
25446 * @param repeat Repeat count
25450 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25453 * Get the transit repeat count.
25455 * @see elm_transit_repeat_times_set()
25457 * @param transit The Transit object.
25458 * @return The repeat count. If @p transit is NULL
25463 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25466 * Set the transit animation acceleration type.
25468 * This function sets the tween mode of the transit that can be:
25469 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25470 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25471 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25472 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25474 * @param transit The transit object.
25475 * @param tween_mode The tween type.
25479 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25482 * Get the transit animation acceleration type.
25484 * @note @p transit can not be NULL
25486 * @param transit The transit object.
25487 * @return The tween type. If @p transit is NULL
25488 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25492 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25495 * Set the transit animation time
25497 * @note @p transit can not be NULL
25499 * @param transit The transit object.
25500 * @param duration The animation time.
25504 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25507 * Get the transit animation time
25509 * @note @p transit can not be NULL
25511 * @param transit The transit object.
25513 * @return The transit animation time.
25517 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25520 * Starts the transition.
25521 * Once this API is called, the transit begins to measure the time.
25523 * @note @p transit can not be NULL
25525 * @param transit The transit object.
25529 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25532 * Pause/Resume the transition.
25534 * If you call elm_transit_go again, the transit will be started from the
25535 * beginning, and will be unpaused.
25537 * @note @p transit can not be NULL
25539 * @param transit The transit object.
25540 * @param paused Whether the transition should be paused or not.
25544 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25547 * Get the value of paused status.
25549 * @see elm_transit_paused_set()
25551 * @note @p transit can not be NULL
25553 * @param transit The transit object.
25554 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25555 * EINA_FALSE is returned
25559 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25562 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25564 * The value returned is a fraction (current time / total time). It
25565 * represents the progression position relative to the total.
25567 * @note @p transit can not be NULL
25569 * @param transit The transit object.
25571 * @return The time progression value. If @p transit is NULL
25576 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25579 * Makes the chain relationship between two transits.
25581 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25582 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25584 * @param transit The transit object.
25585 * @param chain_transit The chain transit object. This transit will be operated
25586 * after transit is done.
25588 * This function adds @p chain_transit transition to a chain after the @p
25589 * transit, and will be started as soon as @p transit ends. See @ref
25590 * transit_example_02_explained for a full example.
25594 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25597 * Cut off the chain relationship between two transits.
25599 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25600 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25602 * @param transit The transit object.
25603 * @param chain_transit The chain transit object.
25605 * This function remove the @p chain_transit transition from the @p transit.
25609 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25612 * Get the current chain transit list.
25614 * @note @p transit can not be NULL.
25616 * @param transit The transit object.
25617 * @return chain transit list.
25621 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25624 * Add the Resizing Effect to Elm_Transit.
25626 * @note This API is one of the facades. It creates resizing effect context
25627 * and add it's required APIs to elm_transit_effect_add.
25629 * @see elm_transit_effect_add()
25631 * @param transit Transit object.
25632 * @param from_w Object width size when effect begins.
25633 * @param from_h Object height size when effect begins.
25634 * @param to_w Object width size when effect ends.
25635 * @param to_h Object height size when effect ends.
25636 * @return Resizing effect context data.
25640 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);
25643 * Add the Translation Effect to Elm_Transit.
25645 * @note This API is one of the facades. It creates translation effect context
25646 * and add it's required APIs to elm_transit_effect_add.
25648 * @see elm_transit_effect_add()
25650 * @param transit Transit object.
25651 * @param from_dx X Position variation when effect begins.
25652 * @param from_dy Y Position variation when effect begins.
25653 * @param to_dx X Position variation when effect ends.
25654 * @param to_dy Y Position variation when effect ends.
25655 * @return Translation effect context data.
25658 * @warning It is highly recommended just create a transit with this effect when
25659 * the window that the objects of the transit belongs has already been created.
25660 * This is because this effect needs the geometry information about the objects,
25661 * and if the window was not created yet, it can get a wrong information.
25663 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);
25666 * Add the Zoom Effect to Elm_Transit.
25668 * @note This API is one of the facades. It creates zoom effect context
25669 * and add it's required APIs to elm_transit_effect_add.
25671 * @see elm_transit_effect_add()
25673 * @param transit Transit object.
25674 * @param from_rate Scale rate when effect begins (1 is current rate).
25675 * @param to_rate Scale rate when effect ends.
25676 * @return Zoom effect context data.
25679 * @warning It is highly recommended just create a transit with this effect when
25680 * the window that the objects of the transit belongs has already been created.
25681 * This is because this effect needs the geometry information about the objects,
25682 * and if the window was not created yet, it can get a wrong information.
25684 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25687 * Add the Flip Effect to Elm_Transit.
25689 * @note This API is one of the facades. It creates flip effect context
25690 * and add it's required APIs to elm_transit_effect_add.
25691 * @note This effect is applied to each pair of objects in the order they are listed
25692 * in the transit list of objects. The first object in the pair will be the
25693 * "front" object and the second will be the "back" object.
25695 * @see elm_transit_effect_add()
25697 * @param transit Transit object.
25698 * @param axis Flipping Axis(X or Y).
25699 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25700 * @return Flip effect context data.
25703 * @warning It is highly recommended just create a transit with this effect when
25704 * the window that the objects of the transit belongs has already been created.
25705 * This is because this effect needs the geometry information about the objects,
25706 * and if the window was not created yet, it can get a wrong information.
25708 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25711 * Add the Resizable Flip Effect to Elm_Transit.
25713 * @note This API is one of the facades. It creates resizable flip effect context
25714 * and add it's required APIs to elm_transit_effect_add.
25715 * @note This effect is applied to each pair of objects in the order they are listed
25716 * in the transit list of objects. The first object in the pair will be the
25717 * "front" object and the second will be the "back" object.
25719 * @see elm_transit_effect_add()
25721 * @param transit Transit object.
25722 * @param axis Flipping Axis(X or Y).
25723 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25724 * @return Resizable flip effect context data.
25727 * @warning It is highly recommended just create a transit with this effect when
25728 * the window that the objects of the transit belongs has already been created.
25729 * This is because this effect needs the geometry information about the objects,
25730 * and if the window was not created yet, it can get a wrong information.
25732 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25735 * Add the Wipe Effect to Elm_Transit.
25737 * @note This API is one of the facades. It creates wipe effect context
25738 * and add it's required APIs to elm_transit_effect_add.
25740 * @see elm_transit_effect_add()
25742 * @param transit Transit object.
25743 * @param type Wipe type. Hide or show.
25744 * @param dir Wipe Direction.
25745 * @return Wipe effect context data.
25748 * @warning It is highly recommended just create a transit with this effect when
25749 * the window that the objects of the transit belongs has already been created.
25750 * This is because this effect needs the geometry information about the objects,
25751 * and if the window was not created yet, it can get a wrong information.
25753 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25756 * Add the Color Effect to Elm_Transit.
25758 * @note This API is one of the facades. It creates color effect context
25759 * and add it's required APIs to elm_transit_effect_add.
25761 * @see elm_transit_effect_add()
25763 * @param transit Transit object.
25764 * @param from_r RGB R when effect begins.
25765 * @param from_g RGB G when effect begins.
25766 * @param from_b RGB B when effect begins.
25767 * @param from_a RGB A when effect begins.
25768 * @param to_r RGB R when effect ends.
25769 * @param to_g RGB G when effect ends.
25770 * @param to_b RGB B when effect ends.
25771 * @param to_a RGB A when effect ends.
25772 * @return Color effect context data.
25776 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);
25779 * Add the Fade Effect to Elm_Transit.
25781 * @note This API is one of the facades. It creates fade effect context
25782 * and add it's required APIs to elm_transit_effect_add.
25783 * @note This effect is applied to each pair of objects in the order they are listed
25784 * in the transit list of objects. The first object in the pair will be the
25785 * "before" object and the second will be the "after" object.
25787 * @see elm_transit_effect_add()
25789 * @param transit Transit object.
25790 * @return Fade effect context data.
25793 * @warning It is highly recommended just create a transit with this effect when
25794 * the window that the objects of the transit belongs has already been created.
25795 * This is because this effect needs the color information about the objects,
25796 * and if the window was not created yet, it can get a wrong information.
25798 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25801 * Add the Blend Effect to Elm_Transit.
25803 * @note This API is one of the facades. It creates blend effect context
25804 * and add it's required APIs to elm_transit_effect_add.
25805 * @note This effect is applied to each pair of objects in the order they are listed
25806 * in the transit list of objects. The first object in the pair will be the
25807 * "before" object and the second will be the "after" object.
25809 * @see elm_transit_effect_add()
25811 * @param transit Transit object.
25812 * @return Blend effect context data.
25815 * @warning It is highly recommended just create a transit with this effect when
25816 * the window that the objects of the transit belongs has already been created.
25817 * This is because this effect needs the color information about the objects,
25818 * and if the window was not created yet, it can get a wrong information.
25820 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25823 * Add the Rotation Effect to Elm_Transit.
25825 * @note This API is one of the facades. It creates rotation effect context
25826 * and add it's required APIs to elm_transit_effect_add.
25828 * @see elm_transit_effect_add()
25830 * @param transit Transit object.
25831 * @param from_degree Degree when effect begins.
25832 * @param to_degree Degree when effect is ends.
25833 * @return Rotation effect context data.
25836 * @warning It is highly recommended just create a transit with this effect when
25837 * the window that the objects of the transit belongs has already been created.
25838 * This is because this effect needs the geometry information about the objects,
25839 * and if the window was not created yet, it can get a wrong information.
25841 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25844 * Add the ImageAnimation Effect to Elm_Transit.
25846 * @note This API is one of the facades. It creates image animation effect context
25847 * and add it's required APIs to elm_transit_effect_add.
25848 * The @p images parameter is a list images paths. This list and
25849 * its contents will be deleted at the end of the effect by
25850 * elm_transit_effect_image_animation_context_free() function.
25854 * char buf[PATH_MAX];
25855 * Eina_List *images = NULL;
25856 * Elm_Transit *transi = elm_transit_add();
25858 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25859 * images = eina_list_append(images, eina_stringshare_add(buf));
25861 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25862 * images = eina_list_append(images, eina_stringshare_add(buf));
25863 * elm_transit_effect_image_animation_add(transi, images);
25867 * @see elm_transit_effect_add()
25869 * @param transit Transit object.
25870 * @param images Eina_List of images file paths. This list and
25871 * its contents will be deleted at the end of the effect by
25872 * elm_transit_effect_image_animation_context_free() function.
25873 * @return Image Animation effect context data.
25877 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25882 typedef struct _Elm_Store Elm_Store;
25883 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25884 typedef struct _Elm_Store_Item Elm_Store_Item;
25885 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25886 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25887 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25888 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25889 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25890 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25891 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25892 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25894 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25895 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25896 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25897 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25901 ELM_STORE_ITEM_MAPPING_NONE = 0,
25902 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25903 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25904 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25905 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25906 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25907 // can add more here as needed by common apps
25908 ELM_STORE_ITEM_MAPPING_LAST
25909 } Elm_Store_Item_Mapping_Type;
25911 struct _Elm_Store_Item_Mapping_Icon
25913 // FIXME: allow edje file icons
25915 Elm_Icon_Lookup_Order lookup_order;
25916 Eina_Bool standard_name : 1;
25917 Eina_Bool no_scale : 1;
25918 Eina_Bool smooth : 1;
25919 Eina_Bool scale_up : 1;
25920 Eina_Bool scale_down : 1;
25923 struct _Elm_Store_Item_Mapping_Empty
25928 struct _Elm_Store_Item_Mapping_Photo
25933 struct _Elm_Store_Item_Mapping_Custom
25935 Elm_Store_Item_Mapping_Cb func;
25938 struct _Elm_Store_Item_Mapping
25940 Elm_Store_Item_Mapping_Type type;
25945 Elm_Store_Item_Mapping_Empty empty;
25946 Elm_Store_Item_Mapping_Icon icon;
25947 Elm_Store_Item_Mapping_Photo photo;
25948 Elm_Store_Item_Mapping_Custom custom;
25949 // add more types here
25953 struct _Elm_Store_Item_Info
25955 Elm_Genlist_Item_Class *item_class;
25956 const Elm_Store_Item_Mapping *mapping;
25961 struct _Elm_Store_Item_Info_Filesystem
25963 Elm_Store_Item_Info base;
25967 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25968 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25970 EAPI void elm_store_free(Elm_Store *st);
25972 EAPI Elm_Store *elm_store_filesystem_new(void);
25973 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25974 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25975 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25977 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25979 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25980 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25981 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25982 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25983 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25984 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25986 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25987 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25988 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25989 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25990 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25991 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25992 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25995 * @defgroup SegmentControl SegmentControl
25996 * @ingroup Elementary
25998 * @image html img/widget/segment_control/preview-00.png
25999 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26001 * @image html img/segment_control.png
26002 * @image latex img/segment_control.eps width=\textwidth
26004 * Segment control widget is a horizontal control made of multiple segment
26005 * items, each segment item functioning similar to discrete two state button.
26006 * A segment control groups the items together and provides compact
26007 * single button with multiple equal size segments.
26009 * Segment item size is determined by base widget
26010 * size and the number of items added.
26011 * Only one segment item can be at selected state. A segment item can display
26012 * combination of Text and any Evas_Object like Images or other widget.
26014 * Smart callbacks one can listen to:
26015 * - "changed" - When the user clicks on a segment item which is not
26016 * previously selected and get selected. The event_info parameter is the
26017 * segment item index.
26019 * Available styles for it:
26022 * Here is an example on its usage:
26023 * @li @ref segment_control_example
26027 * @addtogroup SegmentControl
26031 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26034 * Add a new segment control widget to the given parent Elementary
26035 * (container) object.
26037 * @param parent The parent object.
26038 * @return a new segment control widget handle or @c NULL, on errors.
26040 * This function inserts a new segment control widget on the canvas.
26042 * @ingroup SegmentControl
26044 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26047 * Append a new item to the segment control object.
26049 * @param obj The segment control object.
26050 * @param icon The icon object to use for the left side of the item. An
26051 * icon can be any Evas object, but usually it is an icon created
26052 * with elm_icon_add().
26053 * @param label The label of the item.
26054 * Note that, NULL is different from empty string "".
26055 * @return The created item or @c NULL upon failure.
26057 * A new item will be created and appended to the segment control, i.e., will
26058 * be set as @b last item.
26060 * If it should be inserted at another position,
26061 * elm_segment_control_item_insert_at() should be used instead.
26063 * Items created with this function can be deleted with function
26064 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26066 * @note @p label set to @c NULL is different from empty string "".
26068 * only has icon, it will be displayed bigger and centered. If it has
26069 * icon and label, even that an empty string, icon will be smaller and
26070 * positioned at left.
26074 * sc = elm_segment_control_add(win);
26075 * ic = elm_icon_add(win);
26076 * elm_icon_file_set(ic, "path/to/image", NULL);
26077 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26078 * elm_segment_control_item_add(sc, ic, "label");
26079 * evas_object_show(sc);
26082 * @see elm_segment_control_item_insert_at()
26083 * @see elm_segment_control_item_del()
26085 * @ingroup SegmentControl
26087 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26090 * Insert a new item to the segment control object at specified position.
26092 * @param obj The segment control object.
26093 * @param icon The icon object to use for the left side of the item. An
26094 * icon can be any Evas object, but usually it is an icon created
26095 * with elm_icon_add().
26096 * @param label The label of the item.
26097 * @param index Item position. Value should be between 0 and items count.
26098 * @return The created item or @c NULL upon failure.
26100 * Index values must be between @c 0, when item will be prepended to
26101 * segment control, and items count, that can be get with
26102 * elm_segment_control_item_count_get(), case when item will be appended
26103 * to segment control, just like elm_segment_control_item_add().
26105 * Items created with this function can be deleted with function
26106 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26108 * @note @p label set to @c NULL is different from empty string "".
26110 * only has icon, it will be displayed bigger and centered. If it has
26111 * icon and label, even that an empty string, icon will be smaller and
26112 * positioned at left.
26114 * @see elm_segment_control_item_add()
26115 * @see elm_segment_control_item_count_get()
26116 * @see elm_segment_control_item_del()
26118 * @ingroup SegmentControl
26120 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);
26123 * Remove a segment control item from its parent, deleting it.
26125 * @param it The item to be removed.
26127 * Items can be added with elm_segment_control_item_add() or
26128 * elm_segment_control_item_insert_at().
26130 * @ingroup SegmentControl
26132 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26135 * Remove a segment control item at given index from its parent,
26138 * @param obj The segment control object.
26139 * @param index The position of the segment control item to be deleted.
26141 * Items can be added with elm_segment_control_item_add() or
26142 * elm_segment_control_item_insert_at().
26144 * @ingroup SegmentControl
26146 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26149 * Get the Segment items count from segment control.
26151 * @param obj The segment control object.
26152 * @return Segment items count.
26154 * It will just return the number of items added to segment control @p obj.
26156 * @ingroup SegmentControl
26158 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26161 * Get the item placed at specified index.
26163 * @param obj The segment control object.
26164 * @param index The index of the segment item.
26165 * @return The segment control item or @c NULL on failure.
26167 * Index is the position of an item in segment control widget. Its
26168 * range is from @c 0 to <tt> count - 1 </tt>.
26169 * Count is the number of items, that can be get with
26170 * elm_segment_control_item_count_get().
26172 * @ingroup SegmentControl
26174 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26177 * Get the label of item.
26179 * @param obj The segment control object.
26180 * @param index The index of the segment item.
26181 * @return The label of the item at @p index.
26183 * The return value is a pointer to the label associated to the item when
26184 * it was created, with function elm_segment_control_item_add(), or later
26185 * with function elm_segment_control_item_label_set. If no label
26186 * was passed as argument, it will return @c NULL.
26188 * @see elm_segment_control_item_label_set() for more details.
26189 * @see elm_segment_control_item_add()
26191 * @ingroup SegmentControl
26193 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26196 * Set the label of item.
26198 * @param it The item of segment control.
26199 * @param text The label of item.
26201 * The label to be displayed by the item.
26202 * Label will be at right of the icon (if set).
26204 * If a label was passed as argument on item creation, with function
26205 * elm_control_segment_item_add(), it will be already
26206 * displayed by the item.
26208 * @see elm_segment_control_item_label_get()
26209 * @see elm_segment_control_item_add()
26211 * @ingroup SegmentControl
26213 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26216 * Get the icon associated to the item.
26218 * @param obj The segment control object.
26219 * @param index The index of the segment item.
26220 * @return The left side icon associated to the item at @p index.
26222 * The return value is a pointer to the icon associated to the item when
26223 * it was created, with function elm_segment_control_item_add(), or later
26224 * with function elm_segment_control_item_icon_set(). If no icon
26225 * was passed as argument, it will return @c NULL.
26227 * @see elm_segment_control_item_add()
26228 * @see elm_segment_control_item_icon_set()
26230 * @ingroup SegmentControl
26232 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26235 * Set the icon associated to the item.
26237 * @param it The segment control item.
26238 * @param icon The icon object to associate with @p it.
26240 * The icon object to use at left side of the item. An
26241 * icon can be any Evas object, but usually it is an icon created
26242 * with elm_icon_add().
26244 * Once the icon object is set, a previously set one will be deleted.
26245 * @warning Setting the same icon for two items will cause the icon to
26246 * dissapear from the first item.
26248 * If an icon was passed as argument on item creation, with function
26249 * elm_segment_control_item_add(), it will be already
26250 * associated to the item.
26252 * @see elm_segment_control_item_add()
26253 * @see elm_segment_control_item_icon_get()
26255 * @ingroup SegmentControl
26257 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26260 * Get the index of an item.
26262 * @param it The segment control item.
26263 * @return The position of item in segment control widget.
26265 * Index is the position of an item in segment control widget. Its
26266 * range is from @c 0 to <tt> count - 1 </tt>.
26267 * Count is the number of items, that can be get with
26268 * elm_segment_control_item_count_get().
26270 * @ingroup SegmentControl
26272 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26275 * Get the base object of the item.
26277 * @param it The segment control item.
26278 * @return The base object associated with @p it.
26280 * Base object is the @c Evas_Object that represents that item.
26282 * @ingroup SegmentControl
26284 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26287 * Get the selected item.
26289 * @param obj The segment control object.
26290 * @return The selected item or @c NULL if none of segment items is
26293 * The selected item can be unselected with function
26294 * elm_segment_control_item_selected_set().
26296 * The selected item always will be highlighted on segment control.
26298 * @ingroup SegmentControl
26300 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26303 * Set the selected state of an item.
26305 * @param it The segment control item
26306 * @param select The selected state
26308 * This sets the selected state of the given item @p it.
26309 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26311 * If a new item is selected the previosly selected will be unselected.
26312 * Previoulsy selected item can be get with function
26313 * elm_segment_control_item_selected_get().
26315 * The selected item always will be highlighted on segment control.
26317 * @see elm_segment_control_item_selected_get()
26319 * @ingroup SegmentControl
26321 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26328 * @defgroup Grid Grid
26330 * The grid is a grid layout widget that lays out a series of children as a
26331 * fixed "grid" of widgets using a given percentage of the grid width and
26332 * height each using the child object.
26334 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26335 * widgets size itself. The default is 100 x 100, so that means the
26336 * position and sizes of children will effectively be percentages (0 to 100)
26337 * of the width or height of the grid widget
26343 * Add a new grid to the parent
26345 * @param parent The parent object
26346 * @return The new object or NULL if it cannot be created
26350 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26353 * Set the virtual size of the grid
26355 * @param obj The grid object
26356 * @param w The virtual width of the grid
26357 * @param h The virtual height of the grid
26361 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26364 * Get the virtual size of the grid
26366 * @param obj The grid object
26367 * @param w Pointer to integer to store the virtual width of the grid
26368 * @param h Pointer to integer to store the virtual height of the grid
26372 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26375 * Pack child at given position and size
26377 * @param obj The grid object
26378 * @param subobj The child to pack
26379 * @param x The virtual x coord at which to pack it
26380 * @param y The virtual y coord at which to pack it
26381 * @param w The virtual width at which to pack it
26382 * @param h The virtual height at which to pack it
26386 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26389 * Unpack a child from a grid object
26391 * @param obj The grid object
26392 * @param subobj The child to unpack
26396 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26399 * Faster way to remove all child objects from a grid object.
26401 * @param obj The grid object
26402 * @param clear If true, it will delete just removed children
26406 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26409 * Set packing of an existing child at to position and size
26411 * @param subobj The child to set packing of
26412 * @param x The virtual x coord at which to pack it
26413 * @param y The virtual y coord at which to pack it
26414 * @param w The virtual width at which to pack it
26415 * @param h The virtual height at which to pack it
26419 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26422 * get packing of a child
26424 * @param subobj The child to query
26425 * @param x Pointer to integer to store the virtual x coord
26426 * @param y Pointer to integer to store the virtual y coord
26427 * @param w Pointer to integer to store the virtual width
26428 * @param h Pointer to integer to store the virtual height
26432 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26438 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26439 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26440 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26441 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26442 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
26443 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
26446 * @defgroup Video Video
26448 * This object display an player that let you control an Elm_Video
26449 * object. It take care of updating it's content according to what is
26450 * going on inside the Emotion object. It does activate the remember
26451 * function on the linked Elm_Video object.
26453 * Signals that you cann add callback for are :
26455 * "forward,clicked" - the user clicked the forward button.
26456 * "info,clicked" - the user clicked the info button.
26457 * "next,clicked" - the user clicked the next button.
26458 * "pause,clicked" - the user clicked the pause button.
26459 * "play,clicked" - the user clicked the play button.
26460 * "prev,clicked" - the user clicked the prev button.
26461 * "rewind,clicked" - the user clicked the rewind button.
26462 * "stop,clicked" - the user clicked the stop button.
26464 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26465 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26466 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26467 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26468 EAPI void elm_video_play(Evas_Object *video);
26469 EAPI void elm_video_pause(Evas_Object *video);
26470 EAPI void elm_video_stop(Evas_Object *video);
26471 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26472 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26473 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26474 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26475 EAPI double elm_video_audio_level_get(Evas_Object *video);
26476 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26477 EAPI double elm_video_play_position_get(Evas_Object *video);
26478 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26479 EAPI double elm_video_play_length_get(Evas_Object *video);
26480 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26481 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26482 EAPI const char *elm_video_title_get(Evas_Object *video);
26484 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26485 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26488 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26489 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);
26490 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26491 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26492 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26493 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26494 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26495 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26496 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26497 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26498 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26499 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26500 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26501 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26502 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);